Struct hdk::prelude::CapSecret

source · [−]

pub struct CapSecret(_);

Expand description

A CapSecret is used by a caller to prove to a callee access to a committed CapGrant.

It is a random, unique identifier for the capability, which is shared by the grantor to allow access to others. The grantor can optionally further restrict usage of the secret to specific agents.

@todo enforce that secrets are unique across all grants in a chain.

Trait Implementations

impl AsRef<[u8 ]> for CapSecret

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CapSecret

fn clone(&self) -> CapSecret

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for CapSecret

The only meaningful debug information for a cryptograhpic secret is the literal bytes. Also, encodings like base64 are not constant time so debugging could open some weird side channel issue trying to be ‘human friendly’. It seems better to never try to encode secrets.

Note that when using this crate with feature “subtle-encoding”, a hex representation will be used.

@todo maybe we want something like HIDDEN by default and putting the actual bytes behind a feature flag?

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for CapSecret

fn deserialize<D>(
deserializer: D
) -> Result<CapSecret, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<[u8 ; 64]> for CapSecret

Trivial new type derivation. Secrets should have private interiors and be constructed directly from fixed length arrays of known length.

fn from(b: [u8 ; 64]) -> CapSecret

Converts to this type from the input type.

impl From<CapSecret> for CapAccess

Implements secret.into() shorthand for CapAccess::Transferable(secret)

fn from(secret: CapSecret) -> CapAccess

Converts to this type from the input type.

impl PartialEq<CapSecret> for CapSecret

Constant time equality check. This mitigates timing attacks where a remote agent can reverse engineer data by measuring tiny changes in latency associated with optimised equality checks. More matching bytes = more latency = vulnerability. This type of attack has been successfully demonstrated over a network despite varied latencies.

fn eq(&self, other: &CapSecret) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for CapSecret

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<'_> TryFrom<&'_ [u8 ]> for CapSecret

type Error = SecurePrimitiveError

The type returned in the event of a conversion error.

fn try_from(
slice: &[u8 ]
) -> Result<CapSecret, <CapSecret as TryFrom<&'_ [u8 ]>>::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ CapSecret> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &CapSecret) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<CapSecret> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: CapSecret) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for CapSecret

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<CapSecret, SerializedBytesError>

Performs the conversion.

impl TryFrom<Vec<u8, Global>> for CapSecret

type Error = SecurePrimitiveError

The type returned in the event of a conversion error.

fn try_from(
v: Vec<u8, Global>
) -> Result<CapSecret, <CapSecret as TryFrom<Vec<u8, Global>>>::Error>

Performs the conversion.

impl TryFromRandom for CapSecret

fn try_from_random() -> ExternResult<Self>

impl Copy for CapSecret

impl Eq for CapSecret

Auto Trait Implementations

impl RefUnwindSafe for CapSecret

impl Send for CapSecret

impl Sync for CapSecret

impl Unpin for CapSecret

impl UnwindSafe for CapSecret

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,