Skip to main content

ApiKey

aranya_daemon_api::crypto

Struct ApiKey 

Source 
pub struct ApiKey<CS: CipherSuite>(/* private fields */);
Expand description

The daemon’s secret key used to encrypt data sent over the API.

Implementations§

Source§

impl<CS: CipherSuite> ApiKey<CS>

Source

pub fn id(&self) -> Result<ApiKeyId, IdError>

Returns the key’s unique ID.

Source

pub fn public(&self) -> Result<PublicApiKey<CS>, PkError>

Returns the public half of the key.

Source

pub fn generate<CE>(eng: &CE) -> Self
where CE: Engine<CS = CS>,

Generates a random API key.

Trait Implementations§

Source§

impl<CS: CipherSuite> Clone for ApiKey<CS>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<CS: CipherSuite> Debug for ApiKey<CS>

Source§

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

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

impl<CS: CipherSuite> Display for ApiKey<CS>

Source§

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

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

impl<CS: CipherSuite> Identified for ApiKey<CS>

Source§

type Id = Id<ApiKeyIdTag>

Uniquely identifies the object.
Source§

fn id(&self) -> Result<Self::Id, IdError>

Uniquely identifies the object.
Source§

impl<CS: CipherSuite> UnwrappedKey<CS> for ApiKey<CS>

Source§

const ID: AlgId

The key’s algorithm identifier.
Source§

fn into_secret(self) -> Secret<CS>

Converts itself into the underlying Secret.
Source§

fn try_from_secret(key: UnwrappedSecret<CS>) -> Result<Self, WrongKeyType>

Converts itself from a UnwrappedSecret.

Auto Trait Implementations§

§

impl<CS> Freeze for ApiKey<CS>
where <<CS as CipherSuite>::Kem as Kem>::DecapKey: Freeze,

§

impl<CS> RefUnwindSafe for ApiKey<CS>
where <<CS as CipherSuite>::Kem as Kem>::DecapKey: RefUnwindSafe,

§

impl<CS> Send for ApiKey<CS>
where <<CS as CipherSuite>::Kem as Kem>::DecapKey: Send,

§

impl<CS> Sync for ApiKey<CS>
where <<CS as CipherSuite>::Kem as Kem>::DecapKey: Sync,

§

impl<CS> Unpin for ApiKey<CS>
where <<CS as CipherSuite>::Kem as Kem>::DecapKey: Unpin,

§

impl<CS> UnsafeUnpin for ApiKey<CS>
where <<CS as CipherSuite>::Kem as Kem>::DecapKey: UnsafeUnpin,

§

impl<CS> UnwindSafe for ApiKey<CS>
where <<CS as CipherSuite>::Kem as Kem>::DecapKey: UnwindSafe,

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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<T, U> Upcast<T> for U
where T: UpcastFrom<U>,

Source§

fn upcast(self) -> T

Source§

impl<T, B> UpcastFrom<Counter<T, B>> for T

Source§

fn upcast_from(value: Counter<T, B>) -> T

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