생체 인증

Android

Android SDK의 인증 기능 구현 방법을 안내합니다.

기능 설명

GCCS 인증 후 추가 인증 수단으로 생체 인증을 활용합니다.
사용자가 Android 디바이스에 등록한 생체 정보를 사용하며, 생체 정보가 없는 경우 사용자가 등록한 패턴 또는 비밀번호를 사용하여 생체 인증을 진행합니다.

디바이스의 Android 버전이 Android 6.0 (Marshmallow) 이하인 경우 생체 인증이 지원되지 않습니다. 이를 대체하기 위해 패턴 혹은 비밀번호로 기능이 제공됩니다.

해당 기능은 Android에서 제공한 BiometricPrompt 클래스를 활용하여 개발 되었습니다.만약 Android SDK를 사용하는 앱이 이미 사용 중인 경우에는 앱의 생체 인증 정보를 활용할 수 있습니다. 

생체 정보 등록

생체 정보를 등록하기 위해 GuardianSdk의 registerBiometric()로 API를 호출합니다.
생체 인증을 사용하기 위해서는 우선적으로 생체 정보 등록이 필요합니다.

Parameter

• FragmentActivity : AppCompatActivity 클래스를 상속받는 경우 this를 파라미터로 넘겨줍니다.

Example

// 생체 정보 등록GuardianSdk.getInstance().registerBiometric(this, new GuardianResponseCallback<AuthBiometricResponse>() {    @Override    public void onSuccess(AuthBiometricResponse result) {        Log.i(TAG, result.rtCode); // 결과 코드    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());        Log.e(TAG, "에러코드 : " + errorResult.getErrorMessage());    }});

AuthBiometricResponse

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

생체 정보 등록 API 호출 성공 시 rtCode 로 0이 수신 되며, 생체 인증 정보가 등록 됩니다.

ErrorResult

Key	Value	Description
errorCode	Int	에러코드
errorMessage	String	에러메시지

생체 정보 등록 API 호출 실패 시 에러코드가 수신 됩니다.
에러 코드에 대한 정보는 에러 코드 를 참조 바랍니다.

---

생체 인증

생체 인증을 위해 GuardianSdk 의 authenticateBiometric()로 API를 호출합니다.
사용자 디바이스에 등록 된 지문 또는 얼굴 정보로 인증합니다.
만약 생체 정보를 사용하지 않는 경우 등록된 패턴 또는 비밀번호를 사용하여 인증합니다.

Parameter

• FragmentActivity : AppCompatActivity 클래스를 상속받는 경우 this를 파라미터로 넘겨줍니다.

Example

// 생체 인증GuardianSdk.getInstance().authenticateBiometric(this, new GuardianResponseCallback<AuthBiometricResponse>() {    @Override    public void onSuccess(AuthBiometricResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode);    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());        Log.e(TAG, "에러코드 : " + errorResult.getErrorMessage());    }});

AuthBiometricResponse

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

생체 인증 API 호출 성공 시 rtCode로 0이 수신됩니다.

ErrorResult

Key	Value	Description
errorCode	Int	에러코드
errorMessage	String	에러메시지

생체 인증 API 호출 실패 시 에러코드가 수신됩니다.
에러 코드에 대한 정보는 에러 코드 를 참조 바랍니다.

---

생체 정보 변경 확인

생체 인증 정보의 변경 유무를 확인합니다. GuardianSdk의 hasNewBiometricEnrolled()로 API를 호출합니다.
사용자가 디바이스에 등록한 생체 정보를 변경하거나 추가로 등록한 경우, 생체 정보 변경을 확인합니다.

Parameter

• none

Example

// 생체 정보 변경 확인GuardianSdk.getInstance().hasNewBiometricEnrolled(new GuardianResponseCallback<AuthBiometricResponse>() {    @Override    public void onSuccess(AuthBiometricResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode); // 9000 or 9006    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());        Log.e(TAG, "에러코드 : " + errorResult.getErrorMessage());    }});

AuthBiometricResponse

Key	Value	Description
rtCode	9000	결과코드
rtMsg	String	결과 메시지

생체 정보 변경 확인 API 호출이 성공적으로 된 다음, 만약 해당 생체 정보가 변경 되지 않은 경우 rtCode 로 9000이 수신됩니다. 생체 정보가 변경된 경우에는 rtCode 로 9006이 수신됩니다.

ErrorResult

Key	Value	Description
errorCode	Int	에러코드
errorMessage	String	에러메시지

생체 정보 변경 확인 API 호출 실패 시 에러코드가 수신됩니다.
에러 코드에 대한 정보는 에러 코드 를 참조 바랍니다.

---

생체 정보 초기화

생체 정보를 초기화합니다. GuardianSdk의 resetBiometricChange()로 API를 호출합니다.
생체 정보가 변경된 경우 해당 메소드로 초기화를 진행합니다.
기존의 생체 정보로 먼저 생체 인증이 성공한 경우에 생체 정보 초기화가 가능합니다.

Parameter

• FragmentActivity : AppCompatActivity클래스를 상속받는 경우 this를 파라미터로 넘겨줍니다.

Example

// 생체 정보 초기화GuardianSdk.getInstance().resetBiometricChange(this, new GuardianResponseCallback<AuthBiometricResponse>() {    @Override    public void onSuccess(AuthBiometricResponse result) {        Log.i(TAG, "결과코드 : " + result.rtCode); // 결과 코드    }
    @Override    public void onFailed(ErrorResult errorResult) {        Log.e(TAG, "에러코드 : " + errorResult.getErrorCode());        Log.e(TAG, "에러코드 : " + errorResult.getErrorMessage());    }});

AuthBiometricResponse

Key	Value	Description
rtCode	0	결과코드
rtMsg	String	결과 메시지

생체 정보 초기화 API 호출 성공 시 rtCode 로 0이 수신됩니다.

ErrorResult

Key	Value	Description
errorCode	Int	에러코드
errorMessage	String	에러메시지

생체 정보 초기화 API 호출 실패 시 에러코드가 수신됩니다.
에러 코드에 대한 정보는 에러 코드 를 참조 바랍니다.

---