passkeyjslibdemo
v1.0.43
Published
해당 라이브러리는 SK텔레콤에서 제공하는 Passkey Server와 간편하게 연동할 수 있도록 설계되었습니다. Passkey Server와의 연동을 위해 다양한 속성과 엔티티를 사용해야 하는 필요성이 있지만, 이 라이브러리를 사용하면 속성 및 엔티티의 복잡한 구현 없이 필요한 값만 설정하면 Passkey Server와의 연동이 가능합니다. (CommonJS에 해당하는 사용자들을 위한 라이브러리)
Readme
Passkey Server 연동 라이브러리
해당 라이브러리는 SK텔레콤에서 제공하는 Passkey Server와 간편하게 연동할 수 있도록 설계되었습니다. Passkey Server와의 연동을 위해 다양한 속성과 엔티티를 사용해야 하는 필요성이 있지만, 이 라이브러리를 사용하면 속성 및 엔티티의 복잡한 구현 없이 필요한 값만 설정하면 Passkey Server와의 연동이 가능합니다. (CommonJS에 해당하는 사용자들을 위한 라이브러리)
주요 특징
- Passkey Server와의 연동을 위한 다양한 속성과 엔티티 지원
- 파라메터 객체 구성 없이 속성값 설정만으로 Passkey Server 연동 기능
핵심 기능
- RegistrationRequest (Credential 등록 옵션 요청):
RP 사용자가 Passkey Server에게 credential 등록을 요청하는 기능 - RegistrationResponse (Credential 등록 결과 전달):
Passkey Server로부터 받은 credential 등록 결과를 처리하는 기능 - AuthenticationRequest (Credential 획득을 통한 인증 옵션 요청):
Credential을 사용하여 인증을 요청하는 기능 - AuthenticationResponse (Credential 획득을 통한 결과 전달):
Passkey Server로부터 받은 인증 결과를 처리하는 기능
환경 설정
- Node >= v14
설정 파일
- ~.env 라이브러리 사용자가 필수값 이외에 다른 속성값을 입력하지 않았을 경우 default 값을 설정 가능
사용 모듈
- express
Library 사용법
Rp 아이디 설정
const {passkeyServerCall } = require('passkeyjslibdemo');
passkeyServerCall.setRpid('your rpId')1. RegistrationRequest (Credential 등록 옵션 요청)
- Credential 등록 옵션 요청 하기 위한 함수 호출
const { genarateRegistRequest, RegistMakeReqOptionDto } = require('passkeyjslibdemo');
const registRequest = new RegistMakeReqOptionDto();- registMakeReqOptionsDTO 안에 필수값인 user 정보 Set, 원하는 속성값 Set
registRequest.set();- set 한 값을 패스키 서버와 연동하는 함수 호출
const response = await genarateRegistRequest(registRequest);2. RegistrationResponse (Credential 등록 결과 전달)
- Credential 등록 결과 전달 하기 위한 함수 호출
const { genarateRegistRsponse, RegistMakeResOptionsDto } = require('passkeyjslibdemo');
const regisetResponse = new RegistMakeResOptionsDto();- registMakeResOptionsDTO 안에 필수값인 Credential, transactionId 값 Set, 원하는 속성값 Set
regisetResponse.set();- set 한 값을 패스키 서버와 연동하는 함수 호출
const response = await genarateRegistRsponse(regisetResponse);3. AuthenticationRequest (Credential 획득을 통한 인증 옵션 요청)
- Credential 획득을 통한 인증 옵션 요청 하기 위한 함수 호출
const { genarateAuthRequestEntity, AuthMakeReqOptionsDto } = require('passkeyjslibdemo');
const authtitaionRequest = new AuthMakeReqOptionsDto();- authMakeReqOptionsDTO 안에 원하는 속성값 Set
- Auto-fill 시(userId 필수 X)
authtitaionRequest.set();- 로그인 시(userId 필수 O)
authtitaionRequest.setUserId();- set 한 값을 패스키 서버와 연동하는 함수 호출
const response = await genarateAuthRequest(authtitaionRequest);4. AuthenticationResponse (Credential 획득을 통한 결과 전달)
- Credential 획득을 통한 인증 옵션 요청 하기 위한 함수 호출
const { genarateAuthResponse, AuthMakeResOptionsDto } = require('passkeyjslibdemo');
const authResponse = new AuthMakeResOptionsDto();- authMakeResOptionsDTO 필수값인 Credential, transactionId 값 Set, 원하는 속성값 Set
authResponse.set();- set 한 값을 패스키 서버와 연동하는 함수 호출
const response = await genarateAuthResponse(authResponse);