Firebase 앱 체크 웹 SDK
Firebase 앱 체크는 ReCaptchaV3Provider 또는 ReCaptchaEnterpriseProvider를 사용하는 Node.js 환경에서는 작동하지 않지만 CustomProvider를 사용하고 자체 증명 메서드를 작성하면 Node.js에서 사용할 수 있습니다.
함수
| 함수 | 설명 |
|---|---|
| function(앱, ...) | |
| initialAppCheck(app, options)를 | 지정된 앱의 앱 체크를 활성화합니다. 앱당 한 번만 호출할 수 있습니다. |
| function(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | Firebase 앱 체크 토큰을 요청합니다. 이 메서드는 Firebase 이외의 백엔드에 대한 요청을 승인해야 하는 경우에만 사용해야 합니다. Replay Protection으로 보호되는 Firebase 외의 백엔드 엔드포인트에서 사용하기 위한 제한된 사용 토큰을 반환합니다. 이 메서드는 #getAppCheckToken() 메서드의 토큰 생성 동작에 영향을 주지 않습니다. |
| getToken(appCheckInstance, forceRefresh) | 현재 앱 체크 토큰을 가져옵니다. forceRefresh가 false이면 이 함수는 먼저 메모리에 유효한 토큰이 있는지 확인한 다음 로컬 지속성 (IndexedDB)을 검사합니다. 찾을 수 없거나 forceRefresh이 true이면 앱 체크 엔드포인트에 새 토큰을 요청합니다. 진행 중인 가장 최근 요청이 있는 경우 이 요청에 첨부됩니다. |
| onTokenChanged(appCheckInstance, 관찰자) | 토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 동시에 두 개 이상의 리스너가 등록될 수 있습니다. 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 리스너가 UI 스레드에서 콜백합니다. |
| onTokenChanged(appCheckInstance, onNext, onError, onCOMPLETE) | 토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 동시에 두 개 이상의 리스너가 등록될 수 있습니다. 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 리스너가 UI 스레드에서 콜백합니다. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | 필요에 따라 앱 체크에서 자동으로 토큰을 새로고침할지 여부를 설정합니다. |
클래스
| 클래스 | 설명 |
|---|---|
| CustomProvider | 커스텀 제공자 클래스 |
| ReCaptchaEnterpriseProvider | reCAPTCHA Enterprise 토큰을 가져와 앱 체크 토큰으로 교환할 수 있는 앱 체크 제공자입니다. |
| ReCaptchaV3Provider를 사용하세요. | reCAPTCHA V3 토큰을 가져와 앱 체크 토큰으로 교환할 수 있는 앱 체크 제공자입니다. |
인터페이스
| 인터페이스 | 설명 |
|---|---|
| 앱 체크 | Firebase 앱 체크 서비스 인터페이스 |
| AppCheckOptions | 앱 체크 초기화 옵션입니다. |
| AppCheckToken | 앱 체크 제공업체에서 반환된 토큰입니다. |
| AppCheckTokenResult의 | getToken()에서 반환된 결과입니다. |
| CustomProviderOptions | CustomProvider 생성 시의 옵션 |
유형 별칭
| 별칭 입력 | 설명 |
|---|---|
| AppCheckTokenListener를 호출하여 | 앱 체크 토큰이 변경될 때마다 호출되는 리스너입니다. |
함수(앱, ...)
initAppCheck(앱, 옵션)
지정된 앱의 앱 체크를 활성화합니다. 앱당 한 번만 호출할 수 있습니다.
서명:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 앱 | FirebaseApp | 정의되지 않음 | 앱 체크를 활성화하기 위한 FirebaseApp |
| 옵션 | AppCheckOptions | 앱 체크 초기화 옵션 |
반환:
function(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Firebase 앱 체크 토큰을 요청합니다. 이 메서드는 Firebase 이외의 백엔드에 대한 요청을 승인해야 하는 경우에만 사용해야 합니다.
재생 보호로 보호되는 Firebase 외의 백엔드 엔드포인트에서 사용하기 위한 제한된 사용 토큰을 반환합니다. 이 메서드는 #getAppCheckToken() 메서드의 토큰 생성 동작에 영향을 주지 않습니다.
서명:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| appCheckInstance | 앱 체크 | 앱 체크 서비스 인스턴스 |
반환:
프라미스<AppCheckTokenResult>
제한된 사용 토큰입니다.
getToken(appCheckInstance, forceRefresh)
현재 앱 체크 토큰을 가져옵니다. forceRefresh가 false이면 이 함수는 먼저 메모리에 유효한 토큰이 있는지 확인한 다음 로컬 지속성 (IndexedDB)을 검사합니다. 찾을 수 없거나 forceRefresh이 true이면 앱 체크 엔드포인트에 새 토큰을 요청합니다. 진행 중인 가장 최근 요청이 있는 경우 이 요청에 첨부됩니다.
서명:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| appCheckInstance | 앱 체크 | 앱 체크 서비스 인스턴스 |
| forceRefresh | 부울 | true인 경우 항상 새 토큰을 가져오려고 시도합니다. false인 경우 저장소에서 찾은 경우 캐시된 토큰을 사용합니다. |
반환:
프라미스<AppCheckTokenResult>
onTokenChanged(appCheckInstance, 관찰자)
토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 동시에 두 개 이상의 리스너가 등록될 수 있습니다. 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 리스너가 UI 스레드에서 콜백합니다.
서명:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| appCheckInstance | 앱 체크 | 앱 체크 서비스 인스턴스 |
| 관찰자 | PartialObserver<AppCheckTokenResult>를 확인할 수 있습니다. | next, error, complete 속성이 있는 객체입니다. 토큰이 변경될 때마다 next가 AppCheckTokenResult와 함께 호출됩니다. error는 선택사항이며 리스너 (next 함수)에서 오류가 발생하면 호출됩니다. 토큰 스트림이 끝나지 않으므로 complete는 사용되지 않습니다. |
반환:
이 리스너를 구독 취소하는 함수입니다.
onTokenChanged(appCheckInstance, onNext, onError, onFinished)
토큰 상태 변경에 대한 리스너를 등록합니다. 하나 이상의 앱 체크 인스턴스에 동시에 두 개 이상의 리스너가 등록될 수 있습니다. 이 앱 체크 인스턴스와 연결된 현재 토큰이 변경될 때마다 리스너가 UI 스레드에서 콜백합니다.
서명:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| appCheckInstance | 앱 체크 | 앱 체크 서비스 인스턴스 |
| onNext | (tokenResult: AppCheckTokenResult) => 무효 | 토큰이 변경되면 이 함수는 AppCheckTokenResult와 함께 호출됩니다. |
| onError | (오류: 오류) => 무효 | 선택사항입니다. 리스너 (onNext 함수)에서 오류가 발생하면 호출됩니다. |
| oncomplete | () => 무효 | 토큰 스트림이 끝나지 않으므로 현재는 사용되지 않습니다. |
반환:
이 리스너를 구독 취소하는 함수입니다.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
필요에 따라 앱 체크에서 자동으로 토큰을 새로고침할지 여부를 설정합니다.
서명:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| appCheckInstance | 앱 체크 | 앱 체크 서비스 인스턴스 |
| isTokenAutoRefreshEnabled | 부울 | true이면 SDK가 필요에 따라 앱 체크 토큰을 자동으로 새로고침합니다. 이는 initializeAppCheck() 중에 설정된 모든 값을 재정의합니다. |
반환:
void
AppCheckTokenListener
앱 체크 토큰이 변경될 때마다 호출되는 리스너입니다.
서명:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;