Skip to main content

KeyStore

Struct KeyStore 

Source
pub struct KeyStore { /* private fields */ }
Expand description

Key store for managing Ed25519 keypairs

Uses the OS keyring for secure storage when available, with automatic fallback to encrypted file-based storage in ~/.aion/keys/.

Implementations§

Source§

impl KeyStore

Source

pub fn new() -> Self

Create a new key store

Automatically detects whether OS keyring is available and falls back to file-based storage if not.

Source

pub fn file_based() -> Self

Create a key store that always uses file-based storage

Useful for testing or environments where keyring access is restricted.

Source

pub const fn with_storage_dir(storage_dir: PathBuf) -> Self

Create a key store with a custom storage directory

Useful for testing with isolated storage.

Source

pub fn generate_keypair( &self, author_id: AuthorId, ) -> Result<(SigningKey, VerifyingKey)>

Generate a new keypair and store it in the OS keyring

§Errors

Returns error if keyring access fails

Source

pub fn store_signing_key( &self, author_id: AuthorId, key: &SigningKey, ) -> Result<()>

Store a signing key

Uses OS keyring when available, otherwise falls back to encrypted file storage.

§Errors

Returns error if storage fails

Source

pub fn load_signing_key(&self, author_id: AuthorId) -> Result<SigningKey>

Load a signing key

Uses OS keyring when available, otherwise loads from encrypted file storage.

§Errors

Returns error if key not found or access fails

Source

pub fn delete_signing_key(&self, author_id: AuthorId) -> Result<()>

Delete a signing key

§Errors

Returns error if key not found or access fails

Source

pub fn has_signing_key(&self, author_id: AuthorId) -> bool

Check if a signing key exists

Source

pub fn list_keys(&self) -> Result<Vec<AuthorId>>

List all stored key IDs (file-based storage only)

Returns author IDs for all keys stored in the keys directory. For keyring-based storage, returns an empty list.

Source

pub fn export_encrypted( &self, author_id: AuthorId, password: &str, ) -> Result<Vec<u8>>

Export a signing key with password encryption

Returns encrypted bytes that can be written to a file for backup. Format: MAGIC (4) + VERSION (1) + SALT (16) + NONCE (12) + CIPHERTEXT (32+16)

Uses Argon2id for password-based key derivation (memory-hard, resistant to GPU/ASIC attacks) and ChaCha20-Poly1305 for authenticated encryption.

§Errors

Returns error if key not found or encryption fails

Source

pub fn import_encrypted( &self, author_id: AuthorId, password: &str, encrypted_data: &[u8], ) -> Result<SigningKey>

Import a signing key from password-encrypted bytes

Decrypts a key file created by export_encrypted and stores the key in the OS keyring.

§Errors

Returns error if:

  • File format is invalid (wrong magic, unsupported version)
  • Decryption fails (wrong password, corrupted data)
  • Key storage fails

Trait Implementations§

Source§

impl Debug for KeyStore

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for KeyStore

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more