Struct Credential 

pub struct Credential { /* private fields */ }

A cryptographic credential.

This is tied to a particular client via either its client id or certificate bundle, depending on its credential type, but is independent of any client instance or storage.

To attach to a particular client instance and store, see TransactionContext::add_credential.

Note: the current database design makes some questionable assumptions:

• There are always either 0 or 1 StoredSignatureKeypair instances in the DB for a particular signature scheme
• There may be multiple StoredCredential instances in the DB for a particular signature scheme, but they all share the same ClientId / signing key. In other words, the same signing keypair is reused between credentials.
• Practically, the code ensures that there is a 1:1 correspondence between signing scheme <-> identity/credential, and we need to maintain that property for now.

Work is ongoing to fix those limitations; see WPB-20844. Until that is resolved, we enforce those restrictions by raising errors as required to preserve DB integrity.

Implementations

impl Credential

pub fn x509(cert: CertificateBundle) -> Result<Self, Error>

Create a new x509 credential from a certificate bundle.

impl Credential

pub fn basic( signature_scheme: SignatureScheme, client_id: ClientId, crypto: impl OpenMlsCrypto, ) -> Result<Self, Error>

Generate a basic credential.

The result is independent of any client instance and the database; it lives in memory only.

pub fn mls_credential(&self) -> &MlsCredential

Get the Openmls Credential type.

This stores the credential type (basic/x509).

pub fn credential_type(&self) -> CredentialType

Get the credential type

pub fn signature_scheme(&self) -> SignatureScheme

Get the signature scheme

pub fn to_mls_credential_with_key(&self) -> CredentialWithKey

Generate a CredentialWithKey, which combines the credential type with the public portion of the keypair.

pub fn earliest_validity(&self) -> u64

Earliest valid time of creation for this credential.

This is represented as seconds after the unix epoch.

Only meaningful for X509, where it is the “valid_from” claim of the leaf credential. For basic credentials, this is always 0 when the credential is first created. It is updated upon being persisted to the database.

pub fn client_id(&self) -> &ClientIdRef

Get the client ID associated with this credential

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credential

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Credential> for CredentialWithKey

fn from(cb: Credential) -> Self

Converts to this type from the input type.

impl PartialEq for Credential

fn eq(&self, other: &Self) -> 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 Serialize for Credential

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for Credential

fn to_value(&self) -> Value<'_>

Perform the conversion.

impl Eq for Credential