Struct XID 

pub struct XID(/* private fields */);

A XID (eXtensible IDentifier).

A XID is a unique 32-byte identifier for a subject entity (person, organization, device, or any other entity). XIDs have the following characteristics:

• They’re cryptographically tied to a public key at inception (the “inception key”)
• They remain stable throughout their lifecycle even as their keys and permissions change
• They can be extended to XID documents containing keys, endpoints, permissions, and delegation info
• They support key rotation and multiple verification schemes
• They allow for delegation of specific permissions to other entities
• They can include resolution methods to locate and verify the XID document

A XID is created by taking the SHA-256 hash of the CBOR encoding of a public signing key. This ensures the XID is cryptographically tied to the key.

As defined in BCR-2024-010.

Implementations

impl XID

pub const XID_SIZE: usize = 32usize

pub fn from_data(data: [u8; 32]) -> Self

Create a new XID from data.

pub fn from_data_ref(data: impl AsRef<[u8]>) -> Result<Self>

Create a new XID from data.

Returns None if the data is not the correct length.

pub fn data(&self) -> &[u8; 32]

Return the data of the XID.

pub fn as_bytes(&self) -> &[u8]

Get the data of the XID as a byte slice.

pub fn new(genesis_key: impl AsRef<SigningPublicKey>) -> Self

Create a new XID from the given public key (the “genesis key”).

The XID is the SHA-256 digest of the CBOR encoding of the public key.

pub fn validate(&self, key: &SigningPublicKey) -> bool

Validate the XID against the given public key.

pub fn from_hex(hex: impl AsRef<str>) -> Self

Create a new XID from the given hexadecimal string.

Panics

Panics if the string is not exactly 64 hexadecimal digits.

pub fn to_hex(&self) -> String

The data as a hexadecimal string.

pub fn short_description(&self) -> String

The first four bytes of the XID as a hexadecimal string.

pub fn bytewords_identifier(&self, prefix: bool) -> String

The first four bytes of the XID as upper-case ByteWords.

pub fn bytemoji_identifier(&self, prefix: bool) -> String

The first four bytes of the XID as Bytemoji.

Trait Implementations

impl AsRef<[u8]> for XID

Implements AsRef<u8> to allow XID to be treated as a byte slice.

fn as_ref(&self) -> &[u8]

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

impl CBORTagged for XID

Implements CBORTagged trait to provide CBOR tag information for XID.

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tags associated with this type.

impl CBORTaggedDecodable for XID

Implements CBORTaggedDecodable to provide CBOR decoding functionality for XID.

fn from_untagged_cbor(cbor: CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for XID

Implements CBORTaggedEncodable to provide CBOR encoding functionality for XID.

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for XID

fn clone(&self) -> XID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XID

Implements Debug formatting for XID showing the full hex representation.

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

Formats the value using the given formatter.

impl Display for XID

Implements Display formatting for XID showing a shortened hex representation.

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

Formats the value using the given formatter.

impl From<&PrivateKeyBase> for XID

Implements conversion from PrivateKeyBase reference to XID via the Schnorr signing key.

fn from(key: &PrivateKeyBase) -> Self

Converts to this type from the input type.

impl From<&PublicKeys> for XID

Implements conversion from PublicKeys reference to XID via the signing public key.

fn from(key: &PublicKeys) -> Self

Converts to this type from the input type.

impl From<&SigningPublicKey> for XID

Implements conversion from SigningPublicKey reference to XID.

fn from(key: &SigningPublicKey) -> Self

Converts to this type from the input type.

impl<'a> From<&'a XID> for &'a [u8]

Implements conversion from a XID reference to a byte slice reference.

fn from(value: &'a XID) -> Self

Converts to this type from the input type.

impl<'a> From<&'a XID> for &'a [u8; 32]

Implements conversion from a XID reference to a byte array reference.

fn from(value: &'a XID) -> Self

Converts to this type from the input type.

impl From<XID> for CBOR

Implements conversion from XID to CBOR for serialization.

fn from(value: XID) -> Self

Converts to this type from the input type.

impl From<XID> for Vec<u8>

Implements conversion from XID to Vec<u8> to allow access to the raw bytes.

fn from(xid: XID) -> Self

Converts to this type from the input type.

impl Hash for XID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for XID

Implements Ord to allow XIDs to be fully ordered.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for XID

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for XID

Implements PartialOrd to allow XIDs to be compared and partially ordered.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ReferenceProvider for XID

Implements ReferenceProvider for XID to generate a Reference from the XID.

fn reference(&self) -> Reference

Returns a cryptographic reference that uniquely identifies this object.

fn ref_hex(&self) -> String

Returns the reference data as a hexadecimal string.

fn ref_data_short(&self) -> [u8; 4]

Returns the first four bytes of the reference.

fn ref_hex_short(&self) -> String

Returns the first four bytes of the reference as a hexadecimal string.

fn ref_bytewords(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as upper-case ByteWords.

fn ref_bytemoji(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as Bytemoji.

impl TryFrom<&SigningPrivateKey> for XID

Implements conversion from SigningPrivateKey reference to XID via the public key.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key: &SigningPrivateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CBOR> for XID

Implements conversion from CBOR to XID for deserialization.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.

impl XIDProvider for XID

Implements XIDProvider for XID to return itself.

fn xid(&self) -> XID

Returns the XID for this object.

impl Copy for XID

impl Eq for XID

impl StructuralPartialEq for XID