AWS WAF 모바일 SDK 사양 - AWS WAF, AWS Firewall Manager 및 AWS Shield Advanced

AWS WAF 모바일 SDK 사양

이 섹션에는 사용 가능한 최신 버전의 AWS WAF 모바일 SDK에 대한 SDK 객체, 작업 및 구성 설정이 나열되어 있습니다. 다양한 구성 설정 조합에 적합한 토큰 공급자 및 작업의 작동 방식에 대한 자세한 내용은 AWS WAF 모바일 SDK 작동 방식 섹션을 참조하세요.

WAFToken

AWS WAF 토큰을 보관합니다.

getValue()

WAFToken의 String 표현을 가져옵니다.

WAFTokenProvider

모바일 앱에서 토큰을 관리합니다. WAFConfiguration 객체를 사용하여 이를 구현합니다.

getToken()

백그라운드 새로 고침이 활성화된 경우 캐시된 토큰이 반환됩니다. 백그라운드 새로 고침이 비활성화된 경우 새 토큰을 검색하기 위한 AWS WAF 호출을 동기 차단합니다.

onTokenReady(WAFTokenResultCallback)

활성 토큰이 준비되면 토큰 공급자에게 토큰을 새로 고치고 제공된 콜백을 호출하도록 지시합니다. 토큰이 캐시되고 준비되면 토큰 공급자는 백그라운드 스레드에서 콜백을 호출합니다. 이 콜백은 앱을 처음 로드할 때와 활성 상태로 복원될 때호출합니다. 활성 상태로 복원하는 방법에 대한 자세한 내용은 앱 비활성 이후 토큰 검색 섹션을 참조하세요.

Android 또는 iOS 앱의 경우 요청된 토큰이 준비되었을 때 토큰 공급자가 호출할 작업을 WAFTokenResultCallback으로 설정할 수 있습니다. WAFTokenResultCallback의 구현에는 WAFToken, SdkError 파라미터를 사용해야 합니다. iOS 앱의 경우 인라인 함수를 번갈아 생성할 수 있습니다.

storeTokenInCookieStorage(WAFToken)

지정된 AWS WAF 토큰을 SDK의 쿠키 관리자에 저장하도록 WAFTokenProvider 에 지시합니다. 기본적으로 토큰은 처음 획득했을 때와 새로 고칠 때만 쿠키 저장소에 추가됩니다. 애플리케이션이 어떤 이유로든 공유 쿠키 저장소를 삭제하면 SDK는 다음 새로 고침이 발생할 때까지 AWS WAF 토큰을 자동으로 다시 추가하지 않습니다.

WAFConfiguration

WAFTokenProvider의 구현을 위해 구성을 보관합니다. 이를 구현할 때는 웹 ACL의 통합 URL, 토큰에 사용할 도메인 이름, 토큰 공급자가 사용할 기본 이외의 모든 설정을 제공합니다.

다음 목록은 WAFConfiguration 객체에서 관리할 수 있는 구성 설정을 지정합니다.

applicationIntegrationUrl

애플리케이션 통합 URL. 이것은 AWS WAF 콘솔이나 getWebACL API 호출을 통해 가져올 수 있습니다.

필수 여부: 예

유형: 앱별 URL. iOS의 경우 iOS URL을 참조하세요. Android의 경우 java.net URL을 참조하세요.

backgroundRefreshEnabled

토큰 공급자가 백그라운드에서 토큰을 새로 고치도록 할지 여부를 나타냅니다. 이를 설정하면 토큰 공급자가 자동 토큰 새로 고침 활동을 제어하는 구성 설정에 따라 백그라운드에서 토큰을 새로 고칩니다.

필수 항목 여부: 아니요

유형: Boolean

기본 값: TRUE

domainName

토큰에 사용할 도메인으로, 토큰 획득 및 쿠키 저장에 사용됩니다. 예: example.com또는 aws.amazon.com. 일반적으로 이 도메인은 웹 요청을 보내는 웹 ACL과 연결된 리소스의 호스트 도메인입니다. ACFP 관리형 규칙 그룹 AWSManagedRulesACFPRuleSet의 경우 이는 일반적으로 규칙 그룹 구성에 제공한 계정 생성 경로의 도메인과 일치하는 단일 도메인입니다. ATP 관리형 규칙 그룹 AWSManagedRulesATPRuleSet의 경우 이는 일반적으로 규칙 그룹 구성에 제공한 로그인 경로의 도메인과 일치하는 단일 도메인입니다.

공개 접미사는 허용되지 않습니다. 예를 들어 gov.au 또는 co.uk를 토큰 도메인으로 사용할 수 없습니다.

도메인은 AWS WAF에서 보호된 호스트 도메인과 웹 ACL의 토큰 도메인 목록에 기반하여 허용할 도메인이어야 합니다. 자세한 내용은 AWS WAF 웹 ACL 토큰 도메인 목록 구성 섹션을 참조하세요.

필수 여부: 예

유형: String

maxErrorTokenRefreshDelayMsec

시도 실패 후 토큰 새로 고침을 반복할 때까지 대기하는 최대 시간 (밀리초) 입니다. 이 값은 토큰 검색이 실패하고 maxRetryCount회 재시도된 후에 사용됩니다.

필수 항목 여부: 아니요

유형: Integer

기본값: 5000(5초)

허용된 최소값: 1(1밀리초)

허용된 최대값: 30000(30초)

maxRetryCount

토큰 요청 시 지수 백오프를 사용하여 수행할 최대 재시도 횟수입니다.

필수 항목 여부: 아니요

유형: Integer

기본값: 백그라운드 새로 고침이 활성화된 경우, 5입니다. 그렇지 않을 경우 3입니다.

허용된 최소값: 0

허용되는 최대값: 10

setTokenCookie

SDK의 쿠키 관리자를 통해 요청에 토큰 쿠키를 추가할지 여부를 나타냅니다. 기본적으로 이렇게 설정하면 모든 요청에 토큰 쿠키가 추가됩니다. 쿠키 관리자는 tokenCookiePath에 지정된 경로 아래에 경로가 있는 모든 요청에 토큰 쿠키를 추가합니다.

필수 항목 여부: 아니요

유형: Boolean

기본 값: TRUE

tokenCookiePath

setTokenCookie가 TRUE일 때 사용됩니다. SDK의 쿠키 관리자를 통해 토큰 쿠키를 추가하려는 최상위 경로를 나타냅니다. 관리자는 이 경로와 모든 하위 경로로 보내는 모든 요청에 토큰 쿠키를 추가합니다.

예를 들어, 이 값을 /web/login로 설정하면 관리자는 받는 모든 항목 /web/login 및 하위 경로(예: /web/login/help)로 전송된 모든 것에 대한 토큰 쿠키를 포함합니다. /, /web 또는 /web/order와 같은 다른 경로로 전송된 요청에 대한 토큰은 포함하지 않습니다.

필수 항목 여부: 아니요

유형: String

기본 값: /

tokenRefreshDelaySec

백그라운드 새로 고침에 사용됩니다. 백그라운드 토큰 새로 고침 최대 시간 간격(초).

필수 항목 여부: 아니요

유형: Integer

기본 값: 88

허용된 최소값: 88

허용된 최대값: 300(5분)