Struct IdentifyResponse

pub struct IdentifyResponse {
    pub gateway_identity: Did,
    pub sphere_identity: Did,
    pub signature: String,
    pub proof: String,
}

The response from the “identify” API route; this is a signed response that allows the client to verify the authority of the API host

Fields

gateway_identity: Did

The DID of the API host

sphere_identity: Did

The DID of the “counterpart” sphere

signature: String

The signature of the API host over this payload, as base64-encoded bytes

proof: String

The proof that the API host was authorized by the “counterpart” sphere in the form of a UCAN JWT

Implementations

impl IdentifyResponse

pub async fn sign<K>( sphere_identity: &str, key: &K, proof: &Ucan, ) -> Result<Self>

where K: KeyMaterial,

pub fn shares_identity_with(&self, other: &IdentifyResponse) -> bool

pub async fn verify<S: UcanStore>( &self, did_parser: &mut DidParser, store: &S, ) -> Result<()>

Verifies that the signature scheme on the payload. The signature is made by signing the bytes of the gateway’s key DID plus the bytes of the sphere DID that the gateway claims to manage. Remember: this sphere is not the user’s sphere, but rather the “counterpart” sphere created and modified by the gateway. Additionally, a proof is given that the gateway has been authorized to modify its own sphere.

This verification is intended to check two things:

1. The gateway has control of the key that it represents with its DID
2. The gateway is authorized to modify the sphere it claims to manage

Trait Implementations

impl Clone for IdentifyResponse

fn clone(&self) -> IdentifyResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentifyResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IdentifyResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IdentifyResponse

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

Formats the value using the given formatter.

impl Serialize for IdentifyResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.