@capgo/capacitor-native-biometric

안드로이드와 iOS에서 보안 인증 정보 저장 및 생체 인식 게이트를 제공합니다.

개요

Native Biometric은 iOS 및 Android에서 안전한 자격 증명 보관소입니다. Keychain 또는 Keystore에서 자격 증명을 저장하고, sensitive 값이 반환되기 전에 생체 인증을 요구할 수 있습니다. Ionic Identity Vault 자격 증명 보관소 흐름의 직접적인 대체품입니다. 앱이 타임아웃, 라이프 사이클, privay 스크린 및 커스텀 패스코드 정책을 제어합니다.

기본 기능

setCredentials and getCredentials context
getSecureCredentials - 네이티브 생체 인증 후만 인증 정보를 읽습니다.
isCredentialsSaved and deleteCredentials - 로그인, 잠금 상태, 로그아웃 흐름을 구축합니다.
isAvailable and verifyIdentity - 사용자 인증 가능 여부를 확인하고 필요할 때 사용자에게 알립니다.

공개 API

메서드	설명
`isAvailable`	비омет릭 인증 장치가 있는지 확인합니다.
`addListener`	앱이 백그라운드에서 재개될 때 호출되는 리스너를 추가합니다. 이 기능은 앱이 백그라운드에서 실행 중일 때(예: 사용자가 생체 인증을 등록/해제했습니다) 비омет릭 인증 가능 여부가 변경되었는지 감지하는 데 유용합니다.
`verifyIdentity`	사용자에게 생체 인증을 요청합니다.
`getCredentials`	지정된 서버에 저장된 자격 증명을 가져옵니다.
`setCredentials`	지정된 서버에 저장된 자격 증명을 저장합니다.
`deleteCredentials`	지정된 서버에 저장된 자격 증명을 삭제합니다.
`getSecureCredentials`	생체 인증을 필요로 하는 지정된 서버에 저장된 자격 증명을 가져옵니다. 자격 증명은 BIOMETRY_CURRENT_SET 또는 BIOMETRY_ANY로 설정된 경우에만 가져올 수 있습니다.
`isCredentialsSaved`	인증된 서버에 저장된 자격 증명을 확인합니다.
`getPluginVersion`	Capacitor 네이티브 플러그인 버전을 가져옵니다.

참조 값

이 값을 사용하여 biometricError 결과에서 authenticate.

생체 인증 오류

값	Code	플랫폼	의미
`UNKNOWN_ERROR`	`0`	__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`BIOMETRICS_UNAVAILABLE`	`1`	__CAPGO_KEEP_0__	하드웨어가 없거나 사용할 수 없어서 생체 인증이 사용할 수 없습니다.
`USER_LOCKOUT`	`2`	__CAPGO_KEEP_0__	비밀번호를 너무 많이 틀어서 사용자 계정이 잠금 상태입니다.
`BIOMETRICS_NOT_ENROLLED`	`3`	__CAPGO_KEEP_0__	장치에 생체 인증 정보가 등록되어 있지 않습니다.
`USER_TEMPORARY_LOCKOUT`	`4`	Android	30초 동안 잠금 상태입니다.
`AUTHENTICATION_FAILED`	`10`	__CAPGO_KEEP_0__	인증이 실패했습니다.
`APP_CANCEL`	`11`	iOS	인증 흐름이 취소되었습니다.
`INVALID_CONTEXT`	`12`	iOS	인증 컨텍스트가 유효하지 않습니다.
`NOT_INTERACTIVE`	`13`	iOS	인증이 비활성화되었습니다.
`PASSCODE_NOT_SET`	`14`	__CAPGO_KEEP_0__, __CAPGO_KEEP_0__	장치 패스코드, PIN, 또는 대체 인증 정보가 설정되지 않았습니다.
`SYSTEM_CANCEL`	`15`	__CAPGO_KEEP_0__, __CAPGO_KEEP_0__	시스템이 인증을 취소했습니다. 예를 들어, 화면 잠금 후.
`USER_CANCEL`	`16`	__CAPGO_KEEP_0__, __CAPGO_KEEP_0__	사용자가 인증을 취소했습니다.
`USER_FALLBACK`	`17`	안드로이드, iOS	사용자가 대체 인증을 선택했습니다.

진실의 근원

이 참조는 다음에서 동기화됩니다. src/definitions.ts 에서 capacitor-native-biometric.

capgo에서 계속 @capacitor/capacitor-native-biometric

Capgo를 사용하여 인증 및 계정 흐름을 계획하고 있다면 @capgo/capacitor-native-biometric 그것을 다음과 연결하세요. capgo/capacitor-네이티브 생체 인식 capgo/capacitor-네이티브 생체 인식 capgo/capacitor-소셜 로그인 capgo/capacitor-소셜 로그인 capgo/capacitor-패스키 capgo/capacitor-패스키 두 단계 인증 두 단계 인증 SSO (기업) SSO (기업)