Skip to main content

InfoAwareIdentity

Struct InfoAwareIdentity 

Source
pub struct InfoAwareIdentity<I: Identity> { /* private fields */ }
Expand description

An identity wrapper that attaches canister-certified sender information to every request.

The inner identity’s public key must be a canister signature key (OID 1.3.6.1.4.1.56387.1.2). sig must be a canister signature over \x0Eic-sender-info || info using that same key.

Implementations§

Source§

impl<I: Identity> InfoAwareIdentity<I>

Source

pub fn new( inner: I, info: Vec<u8>, sig: Vec<u8>, ) -> Result<Self, DelegationError>

Wraps inner and attaches info/sig as certified sender information.

Verifies the canister signature against the IC mainnet root key. inner must have a canister signature public key.

Source

pub fn new_with_root_key( inner: I, info: Vec<u8>, sig: Vec<u8>, root_key: &[u8], ) -> Result<Self, DelegationError>

Like new, but verifies against a custom root key (e.g. local replica or testnet).

Source

pub fn new_unchecked( inner: I, info: Vec<u8>, sig: Vec<u8>, ) -> Result<Self, DelegationError>

Like new, but skips cryptographic verification of the canister signature.

The replica will still reject an invalid signature. The signer principal is still parsed from the inner identity’s public key.

Trait Implementations§

Source§

impl<I: Identity> Identity for InfoAwareIdentity<I>

Source§

fn sender(&self) -> Result<Principal, String>

Returns a sender, ie. the Principal ID that is used to sign a request. Read more
Source§

fn public_key(&self) -> Option<Vec<u8>>

Produce the public key commonly returned in Signature. Read more
Source§

fn sign(&self, content: &EnvelopeContent) -> Result<Signature, String>

Sign a request ID derived from a content map. Read more
Source§

fn sign_delegation(&self, content: &Delegation) -> Result<Signature, String>

Sign a delegation to let another key be used to authenticate sender. Read more
Source§

fn sign_arbitrary(&self, content: &[u8]) -> Result<Signature, String>

Sign arbitrary bytes. Read more
Source§

fn delegation_chain(&self) -> Vec<SignedDelegation>

A list of signed delegations connecting sender to public_key, and in that order.
Source§

fn sender_info(&self) -> Option<SenderInfo>

Returns canister-certified sender information to include in the request envelope, or None. Read more

Auto Trait Implementations§

§

impl<I> Freeze for InfoAwareIdentity<I>
where I: Freeze,

§

impl<I> RefUnwindSafe for InfoAwareIdentity<I>
where I: RefUnwindSafe,

§

impl<I> Send for InfoAwareIdentity<I>

§

impl<I> Sync for InfoAwareIdentity<I>

§

impl<I> Unpin for InfoAwareIdentity<I>
where I: Unpin,

§

impl<I> UnsafeUnpin for InfoAwareIdentity<I>
where I: UnsafeUnpin,

§

impl<I> UnwindSafe for InfoAwareIdentity<I>
where I: 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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