react-native-device-crypto/lib/typescript/index.d.ts

Cryptographic operations inside the secure hardware for React Native

export interface BiometryParams {
    biometryTitle: string;
    biometrySubTitle: string;
    biometryDescription: string;
}
export declare enum AccessLevel {
    ALWAYS = 0,
    UNLOCKED_DEVICE = 1,
    AUTHENTICATION_REQUIRED = 2
}
export interface KeyCreationParams {
    accessLevel: AccessLevel;
    invalidateOnNewBiometry?: boolean;
}
export declare enum KeyTypes {
    ASYMMETRIC = 0,
    SYMMETRIC = 1
}
export interface EncryptionResult {
    iv: string;
    encryptedText: string;
}
export declare enum BiometryType {
    NONE = "NONE",
    TOUCH = "TOUCH",
    FACE = "FACE",
    IRIS = "IRIS"
}
export declare enum SecurityLevel {
    NOT_PROTECTED = "NOT_PROTECTED",
    PIN_OR_PATTERN = "PIN_OR_PATTERN",
    BIOMETRY = "BIOMETRY"
}
declare const DeviceCrypto: {
    /**
     * Create public/private key pair inside the secure hardware or get the existing public key
     * Secure enclave/TEE/StrongBox
     *
     * Cryptography algorithms
     * EC secp256k1 on iOS
     * EC secp256r1 on Android
     *
     * @return {Promise} Resolves to public key when successful
     */
    getOrCreateAsymmetricKey(alias: string, options: KeyCreationParams): Promise<string>;
    /**
     * Create AES key inside the secure hardware. Returns `true` if the key already exists.
     * Secure enclave/TEE/StrongBox
     *
     * Cryptography algorithms AES256
     *
     * @return {Promise} Resolves to `true` when successful
     */
    getOrCreateSymmetricKey(alias: string, options: KeyCreationParams): Promise<boolean>;
    /**
     * Delete the key from secure hardware
     *
     * @return {Promise} Resolves to `true` when successful
     */
    deleteKey(alias: string): Promise<boolean>;
    /**
     * Get the public key as PEM formatted
     *
     * @return {Promise} Resolves to public key when successful
     */
    getPublicKey(alias: string): Promise<string>;
    /**
     * Signs the given text with given private key
     *
     * @param {String} plainText Text to be signed
     * @return {Promise} Resolves to signature in `Base64` when successful
     */
    sign(alias: string, plainText: string, options: BiometryParams): Promise<string>;
    /**
     * Encrypt the given text
     *
     * @param {String} plainText Text to be encrypted
     * @return {Promise} Resolves to encrypted text `Base64` formatted
     */
    encrypt(alias: string, plainText: string, options: BiometryParams): Promise<EncryptionResult>;
    /**
     * Decrypt the encrypted text with given IV
     *
     * @param {String} plainText Text to be signed
     * @param {String} iv Base64 formatted IV
     * @return {Promise} Resolves to decrypted text when successful
     */
    decrypt(alias: string, plainText: string, iv: string, options: BiometryParams): Promise<string>;
    /**
     * Checks the key existence
     *
     * @return {Promise} Resolves to `true` if exists
     */
    isKeyExists(alias: string, keyType: KeyTypes): Promise<boolean>;
    /**
     * Checks the biometry is enrolled on device
     *
     * @returns {Promise} Resolves `true` if biometry is enrolled on the device
     */
    isBiometryEnrolled(): Promise<boolean>;
    /**
     * Checks the device security level
     *
     * @return {Promise} Resolves one of `SecurityLevel`
     */
    deviceSecurityLevel(): Promise<SecurityLevel>;
    /**
     * Returns biometry type already enrolled on the device
     *
     * @returns {Promise} Resolves `BiometryType`
     */
    getBiometryType(): Promise<BiometryType>;
    /**
     * Authenticate user with device biometry
     *
     * @returns {Promise} Resolves `true` if user passes biometry or fallback pin
     */
    authenticateWithBiometry(options: BiometryParams): Promise<boolean>;
};
export default DeviceCrypto;