oid4vcwallet/dev.idfoundry.oid4vcwallet/FileCredentialStore

FileCredentialStore

class FileCredentialStore(val directory: File, val options: FileCredentialStore.Options = Options()) : CredentialStore(source)

A credential store of files: one per credential record, in a directory of the app's (noBackupFilesDir/credentials, by default, which no backup or device transfer copies). Each record is encrypted (AES-256-GCM, its ID as associated data) under an Android Keystore key that, by default, works only while the device is unlocked — iOS's complete file protection. A credential is useless without its holder key, which is in this device's Keystore and can't be restored elsewhere; so is a record without the store's key.

A directory of your own should be one no backup copies too (noBackupFilesDir, or excluded in the app's backup rules): a restored record can't be read without the key, which isn't restored. records skips a record that doesn't decrypt, logging its ID, rather than make every other credential unreadable; record reports it.

Constructors

FileCredentialStore

constructor(directory: File, options: FileCredentialStore.Options = Options())

Types

Companion

object Companion

Stores in the app's standard places.

Options

data class Options(val protection: FileCredentialStore.Protection = Protection.WHEN_UNLOCKED, val keyAlias: String = FileCredentialStore.DEFAULT_KEY_ALIAS)

How a FileCredentialStore encrypts its records: by default under a key that works only while the device is unlocked.

Protection

enum Protection : Enum<FileCredentialStore.Protection>

When records can be read and written.