kotlin-components-docs/mozilla.appservices.logins

Package-level declarations

Types

BulkResultEntry

sealed class BulkResultEntry

A bulk insert result entry, returned by add_many and add_many_with_meta

Disposable

interface Disposable

EncryptorDecryptor

interface EncryptorDecryptor

EncryptorDecryptorImpl

open class EncryptorDecryptorImpl : Disposable, AutoCloseable, EncryptorDecryptor

InternalException

class InternalException(message: String) : Exception

KeyManager

interface KeyManager

KeyManagerImpl

open class KeyManagerImpl : Disposable, AutoCloseable, KeyManager

data class Login(var id: String, var timesUsed: Long, var timeCreated: Long, var timeLastUsed: Long, var timePasswordChanged: Long, var timeOfLastBreach: Long?, var timeLastBreachAlertDismissed: Long?, var origin: String, var httpRealm: String?, var formActionOrigin: String?, var usernameField: String, var passwordField: String, var password: String, var username: String)

A login stored in the database

LoginEntry

data class LoginEntry(var origin: String, var httpRealm: String?, var formActionOrigin: String?, var usernameField: String, var passwordField: String, var password: String, var username: String)

A login entry from the user, not linked to any database record. The add/update APIs input these.

LoginEntryWithMeta

data class LoginEntryWithMeta(var entry: LoginEntry, var meta: LoginMeta)

A login together with record fields, handed over to the store API; ie a login persisted elsewhere, useful for migrations

LoginMeta

data class LoginMeta(var id: String, var timesUsed: Long, var timeCreated: Long, var timeLastUsed: Long, var timePasswordChanged: Long, var timeOfLastBreach: Long?, var timeLastBreachAlertDismissed: Long?)

Metadata fields managed internally by the library. These are automatically set on add() and updated on operations like touch() and update(). Not included in LoginEntry; use add_with_meta() when importing records with existing metadata.

LoginOrErrorMessage

enum LoginOrErrorMessage : Enum<LoginOrErrorMessage>

LoginsApiException

sealed class LoginsApiException : Exception

These are the errors returned by our public API.

LoginsDeletionMetrics

data class LoginsDeletionMetrics(var localDeleted: ULong, var mirrorDeleted: ULong)

Metrics tracking deletion of logins that cannot be decrypted, see delete_undecryptable_records_for_remote_replacement for more details

LoginStore

open class LoginStore : Disposable, AutoCloseable, LoginStoreInterface

LoginStoreInterface

interface LoginStoreInterface

ManagedEncryptorDecryptor

open class ManagedEncryptorDecryptor : Disposable, AutoCloseable, ManagedEncryptorDecryptorInterface

ManagedEncryptorDecryptorInterface

interface ManagedEncryptorDecryptorInterface

StaticKeyManager

open class StaticKeyManager : Disposable, AutoCloseable, StaticKeyManagerInterface

StaticKeyManagerInterface

interface StaticKeyManagerInterface

Functions

checkCanary

fun checkCanary(canary: String, text: String, encryptionKey: String): Boolean

Check that key is still valid using the output of create_canary.

createCanary

fun createCanary(text: String, encryptionKey: String): String

Create a "canary" string, which can be used to test if the encryption

createKey

fun createKey(): String

We expose the crypto primitives on the namespace Create a new, random, encryption key.

createLoginStoreWithStaticKeyManager

fun createLoginStoreWithStaticKeyManager(path: String, key: String): LoginStore

Create a LoginStore with StaticKeyManager by passing in a db path and a static key

createManagedEncdec

fun createManagedEncdec(keyManager: KeyManager): EncryptorDecryptor

Similar to create_static_key_manager above, create a ManagedEncryptorDecryptor by passing in a KeyManager

createStaticKeyManager

fun createStaticKeyManager(key: String): KeyManager

Utility function to create a StaticKeyManager to be used for the time being until support lands for trait implementation of an UniFFI * interface in UniFFI.