개요
개요 섹션네이티브 바이오메트릭스는 iOS 및 Android용 안전한 자격 증명 보관소입니다. Keychain 또는 Keystore에서 자격 증명을 저장하고 sensitive 값이 반환되기 전에 바이오메트릭스 인증을 요구할 수 있습니다. Ionic Identity Vault 자격 증명 보관소 흐름의 직접적인 대체품입니다. 앱이 타임아웃, 라이프 사이클, privay 스크린 및 사용자 지정 패스코드 정책을 제어합니다.
주요 기능
주요 기능 섹션setCredentials및getCredentials- 특정 서버에 대한 자격 증명을 안전하게 저장하고 검색합니다.getSecureCredentials- 네이티브 생체 인증 확인 후에만 자격 증명을 읽습니다.isCredentialsSaved및deleteCredentials- 로그인, 잠금 상태, 로그아웃 흐름을 구축합니다.isAvailable및verifyIdentity- 인증 가능 여부를 확인하고 필요할 때 사용자에게 알립니다.
공개 API
제목: "공개 API"| 메서드 | 설명 |
|---|---|
isAvailable | 생체 인증 장치가 있는지 확인합니다. |
addListener | 백그라운드에서 앱이 재개되면 호출되는 리스너를 추가합니다. 이 기능은 앱이 백그라운드에서 실행 중일 때 생긴 바이오메트릭스 사용 가능성의 변경을 감지하는 데 유용합니다 (예: 사용자가 바이오메트릭스 등록/해제). |
verifyIdentity | 사용자에게 바이오메트릭스 인증을 요청합니다. |
getCredentials | 지정된 서버에 저장된 자격 증명을 가져옵니다. |
setCredentials | 지정된 서버에 저장된 자격 증명을 저장합니다. |
deleteCredentials | 지정된 서버에 저장된 자격 증명을 삭제합니다. |
getSecureCredentials | BIOMETRY_CURRENT_SET 또는 BIOMETRY_ANY로 저장된 자격 증명이 있는지 확인하고, 해당 서버에 대한 자격 증명이 저장되어 있는지 확인합니다. |
isCredentialsSaved | 지정된 서버에 대한 저장된 자격 증명을 가져옵니다. 이 메서드는 바이오메트릭스 인증이 필요합니다. 자격 증명은 accessControl이 BIOMETRY_CURRENT_SET 또는 BIOMETRY_ANY로 설정되어 있어야 합니다. |
getPluginVersion | Get the native Capacitor plugin version. |
자연어 __CAPGO_KEEP_0__ 플러그인 버전을 가져옵니다.
참조 값바이오메트릭스 인증 결과를 처리할 때 사용하는 값입니다. biometricError 이 섹션의 값은 결과를 처리할 때 사용합니다. authenticate.
__CAPGO_KEEP_0__
바이омет릭 인증 오류| Section titled “Biometric Auth Errors” | Code | __CAPGO_KEEP_0__ | 플랫폼 |
|---|---|---|---|
UNKNOWN_ERROR | 0 | 의미 | 안드로이드, iOS |
BIOMETRICS_UNAVAILABLE | 1 | 알 수 없는 오류가 발생했습니다. | 안드로이드, iOS |
USER_LOCKOUT | 2 | 바이омет릭이 사용할 수 없습니다. 하드웨어가 없거나 사용할 수 없습니다. | 안드로이드, iOS |
BIOMETRICS_NOT_ENROLLED | 3 | 안드로이드, iOS | 장치에 등록된 생체 인증 정보가 없습니다. |
USER_TEMPORARY_LOCKOUT | 4 | 안드로이드 | 사용자는 일반적으로 30초 동안 잠시 잠금 상태입니다. |
AUTHENTICATION_FAILED | 10 | 안드로이드, iOS | 인증이 실패했습니다. |
APP_CANCEL | 11 | iOS | 앱이 인증 흐름을 취소했습니다. |
INVALID_CONTEXT | 12 | iOS | 인증 컨텍스트가 유효하지 않습니다. |
NOT_INTERACTIVE | 13 | iOS | 인증이 비활성화 상태였습니다. |
PASSCODE_NOT_SET | 14 | 안드로이드, iOS | 장치 패스코드, PIN, 또는 대체 인증 정보가 설정되지 않았습니다. |
SYSTEM_CANCEL | 15 | 안드로이드, iOS | 시스템이 인증을 취소했습니다. 예를 들어, 화면 잠금 후. |
USER_CANCEL | 16 | 안드로이드, iOS | 사용자가 인증을 취소했습니다. |
USER_FALLBACK | 17 | 안드로이드, iOS | 사용자가 대체 인증을 선택했습니다. |
Source Of Truth
“Source Of Truth”라는 제목의 섹션이 참조는 src/definitions.ts 에서同步됩니다. capacitor-native-biometric.
Keep going from @capgo/capacitor-native-biometric
Section titled “Keep going from @capgo/capacitor-native-biometric”Capgo __CAPGO_KEEP_0__-native-biometric @capgo/capacitor-native-biometric Capgo __CAPGO_KEEP_0__-native-biometric를 사용 중이시면 Using @capgo/capacitor-native-biometric for the native capability in Using @capgo/capacitor-native-biometric, @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, 두 단계 인증 두 단계 인증 구현 세부 정보에 대한 SSO (기업) SSO (기업) 구현 세부 정보에 대한