Struct holochain_zome_types::capability::CapSecret

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<'a> Arbitrary<'a> for CapSecret

fn arbitrary(u: &mut Unstructured<'a>) -> Result<CapSecret, Error>

Generate an arbitrary value of Self from the given unstructured data. Read more

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more

impl AsRef<[u8]> for CapSecret

fn as_ref(&self) -> &[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.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

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 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 Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

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

Converts some archived metadata to the pointer metadata for itself.

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more

impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
    W: DeserializeWith<F, T, D>,
    D: Fallible + ?Sized,
    F: ?Sized,

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer

impl<Q, K> Equivalent<K> for Qwhere
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>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for Twhere
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> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Scalar for Twhere
T: Copy + PartialEq<T> + Debug + Any,

fn inlined_clone(&self) -> T

Performance hack: Clone doesn’t get inlined for Copy types in debug mode, so make it inline anyway.

fn is<T>() -> boolwhere
T: Scalar,

Tests if Self the same as the type T Read more

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for Twhere
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)

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

impl<T, U> TryFrom<U> for Twhere
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 Twhere
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> Upcastable for Twhere
T: 'static + Any + Send + Sync,

fn upcast_any_ref(&self) -> &(dyn Any + 'static)

upcast ref

fn upcast_any_mut(&mut self) -> &mut (dyn Any + 'static)

upcast mut ref

fn upcast_any_box(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

upcast boxed dyn

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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