forgerock-core

4.8.0

org.forgerock.android.auth

AppPinAuthenticator

convertToTime()

CookieInterceptor

CoreEventDispatcher

EncryptedFileKeyStore

EncryptedPreferences

EncryptionException

FRRequestInterceptor

InterceptorProvider

isAbsoluteUrl()

KeyStoreManager

KeyStoreRepository

NetworkConfigBuilder

OkHttpClientProvider

OkHttpCookieInterceptor

OkHttpRequestInterceptor

RequestInterceptor

RequestInterceptorRegistry

SecuredSharedPreferences

org.forgerock.android.auth.biometric

org.forgerock.android.auth.detector

BuildTagsDetector

BusyBoxProgramFileDetector

CommandDetector

DangerousPropertyDetector

PackageDetector

PermissionDetector

RootApkDetector

RootAppDetector

RootCloakingAppDetector

RootProgramFileDetector

RootRequiredAppDetector

SuCommandDetector

SystemPropertyDetector

org.forgerock.android.auth.encrypt

AES_GCM_NO_PADDING

ANDROID_KEYSTORE

EncryptorDelegate

RSA_ECB_OAEP_PADDING

SecretKeyEncryptor

SecretKeyEncryptorConfig

SuspendEncryptor

org.forgerock.android.auth.storage

StorageDelegate

forgerock-core/org.forgerock.android.auth.encrypt/SecretKeyEncryptor

SecretKeyEncryptor

class SecretKeyEncryptor(block: SecretKeyEncryptorConfig.() -> Unit = {}) : SuspendEncryptor

An encryptor that uses Android's SecretKey to encrypt and decrypt data. It uses AES/GCM/NoPadding as the cipher and HmacSHA256 for the MAC.

Constructors

SecretKeyEncryptor

constructor(block: SecretKeyEncryptorConfig.() -> Unit = {})

Types

object Companion

Properties

val config: SecretKeyEncryptorConfig

private val lock: Mutex

private val mac: Mac

private val macLength: Int

secretKeyGenerator

private val secretKeyGenerator: KeyGenerator

Functions

open suspend override fun decrypt(data: ByteArray): ByteArray

Decrypts the given data. It uses a lock to ensure thread safety.

open suspend override fun encrypt(data: ByteArray): ByteArray

Encrypts the given data. It uses a lock to ensure thread safety.

generateAndroidKeyStoreAsymmetricKey

private fun generateAndroidKeyStoreAsymmetricKey()

Generates an asymmetric key pair in the Android keystore. This method configures the key generation parameters, including key size, block modes, encryption paddings, and user authentication requirements. It also handles the case where StrongBox is unavailable and falls back to generating the key without StrongBox support.

generateAndroidKeyStoreSecretKey

private fun generateAndroidKeyStoreSecretKey(): SecretKey

Generates a secret key in the Android keystore. This method configures the key generation parameters, including key size, block modes, encryption paddings, and user authentication requirements. It also handles the case where StrongBox is unavailable and falls back to generating the key without StrongBox support.

generateEmbeddedSecretKey

private fun generateEmbeddedSecretKey(publicKey: PublicKey? = null): SymmetricKey

Generates an embedded secret key. If a private key is provided, it uses it to encrypt the secret key. Otherwise, it generates a new asymmetric key pair in the Android keystore.

getEmbeddedSecretKey

private fun getEmbeddedSecretKey(privateKey: PrivateKey, encryptedData: ByteArray): SymmetricKey

Retrieves the embedded secret key from the encrypted data using the provided private key.

private suspend fun secretKey(): SymmetricKey

Retrieves the secret key for encryption

private suspend fun secretKey(encryptedData: ByteArray): SymmetricKey

private inline fun <T> withRetry(default: T, reset: (Throwable) -> Unit = {}, block: () -> T): T

Executes the given block and retries if an exception is thrown.