secure-vault/io.github.alimsrepo.secure.vault

Package-level declarations

Types

Accessibility

enum Accessibility : Enum<Accessibility>

Controls when stored values may be decrypted.

SecureVault

interface SecureVault

A small, coroutine-first façade over the platform's native secure storage:

SecureVaultFactory

actual class SecureVaultFactory

Android implementation. Hold on to the application Context only — never the supplied one — so factories created inside an Activity or Fragment do not leak it.

expect class ~~SecureVaultFactory~~

Platform entry point for building SecureVault instances.

actual class SecureVaultFactory

iOS implementation. The Keychain is a process-wide singleton, so no platform handle is required at construction time.

VaultConfig

data class VaultConfig(val namespace: String, val accessibility: Accessibility = Accessibility.AfterFirstUnlock)

Immutable configuration for a SecureVault instance.

VaultException

sealed class VaultException

Hierarchy of recoverable errors that SecureVault operations may raise.

Functions

initialize

fun SecureVault.Companion.initialize(context: <Error class: unknown class>)

Manually supplies the application Context to the SecureVault library.

SecureVault

actual fun SecureVault(config: VaultConfig): SecureVault

Android actual for the top-level SecureVault factory.

expect fun SecureVault(config: VaultConfig): SecureVault

Builds a SecureVault for the given config.

fun SecureVault(namespace: String, accessibility: Accessibility = Accessibility.AfterFirstUnlock): SecureVault

Convenience overload — equivalent to SecureVault(VaultConfig(namespace, accessibility)).

actual fun SecureVault(config: <Error class: unknown class>): <Error class: unknown class>

iOS actual for the top-level SecureVault factory. The Keychain is a process-wide singleton, so no platform handle is required.