Trait Identity

pub trait Identity: Send + Sync {
    // Required methods
    fn sender(&self) -> Result<Principal, String>;
    fn public_key(&self) -> Option<Vec<u8>>;
    fn sign(&self, content: &EnvelopeContent) -> Result<Signature, String>;

    // Provided methods
    fn sign_delegation(&self, content: &Delegation) -> Result<Signature, String> { ... }
    fn sign_arbitrary(&self, content: &[u8]) -> Result<Signature, String> { ... }
    fn delegation_chain(&self) -> Vec<SignedDelegation> { ... }
}

An Identity produces Signatures for requests or delegations. It knows or represents the Principal of the sender.

Agents are assigned a single Identity object, but there can be multiple identities used.

Required Methods

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

Returns a sender, ie. the Principal ID that is used to sign a request.

Only one sender can be used per request.

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

Produce the public key commonly returned in Signature.

Should only return None if sign would do the same.

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

Sign a request ID derived from a content map.

Implementors should call content.to_request_id().signable() for the actual bytes that need to be signed.

Provided Methods

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

Sign a delegation to let another key be used to authenticate sender.

Not all Identity implementations support this operation, though all ic-agent implementations other than AnonymousIdentity do.

Implementors should call content.signable() for the actual bytes that need to be signed.

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

Sign arbitrary bytes.

Not all Identity implementations support this operation, though all ic-agent implementations do.

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

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

Trait Implementations

impl Identity for &dyn Identity

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

Returns a sender, ie. the Principal ID that is used to sign a request.

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

Produce the public key commonly returned in Signature.

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

Sign a request ID derived from a content map.

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

Sign a delegation to let another key be used to authenticate sender.

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

Sign arbitrary bytes.

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

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

impl Identity for Box<dyn Identity>

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

Returns a sender, ie. the Principal ID that is used to sign a request.

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

Produce the public key commonly returned in Signature.

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

Sign a request ID derived from a content map.

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

Sign a delegation to let another key be used to authenticate sender.

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

Sign arbitrary bytes.

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

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

Implementations on Foreign Types

impl Identity for Box<dyn Identity>

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

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

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

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

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

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

impl Identity for Arc<dyn Identity>

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

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

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

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

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

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

Implementors

impl Identity for &dyn Identity

impl Identity for AnonymousIdentity

impl Identity for BasicIdentity

impl Identity for DelegatedIdentity

impl Identity for Prime256v1Identity

impl Identity for Secp256k1Identity