keyring_core #

Core types and interfaces for the Dart keyring ecosystem. This package has zero runtime dependencies and is the foundation that all other keyring packages build on.

Types #

KeyringEntry #

An immutable data class representing a credential lookup key.

const entry = KeyringEntry('my-app', 'alice');
const withMods = KeyringEntry.withModifiers('app', 'bob', {'env': 'prod'});

KeyringException #

Typed exception carrying structured error information.

try {
  await store.getPassword(entry);
} on KeyringException catch (e) {
  if (e.type == KeyringErrorType.noEntry) {
    print('Credential not found');
  }
}

KeyringErrorType #

CredentialPersistence #

KeyringStore Interface #

The abstract class all keyring implementations must extend:

abstract class KeyringStore {
  String get vendor;
  String get id;
  CredentialPersistence get persistence;

  Future<KeyringEntry> build(String service, String user, {Map<String, String>? modifiers});
  Future<List<KeyringEntry>> search(Map<String, String> spec);

  Future<void> setPassword(KeyringEntry entry, String password);
  Future<String> getPassword(KeyringEntry entry);
  Future<void> setSecret(KeyringEntry entry, List<int> secret);
  Future<List<int>> getSecret(KeyringEntry entry);
  Future<void> deleteCredential(KeyringEntry entry);

  Future<Map<String, String>> getAttributes(KeyringEntry entry);
  Future<void> updateAttributes(KeyringEntry entry, Map<String, String> attributes);
}

Implementations: keyring_native (Rust FFI), keyring_web (in-memory).