Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more missed documentation #34

Merged
merged 3 commits into from
Dec 9, 2024
Merged

Add more missed documentation #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b18ee94
Add more missed documentation
Hinton Dec 9, 2024
66c1f3a
Remove trailing /#
Hinton Dec 9, 2024
314b37a
Fix clippy
Hinton Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions credential-exchange-types/src/format/document.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use crate::B64Url;
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NoteCredential {
/// This member is a user-defined value encoded as a UTF-8 string.
pub content: String,
}

Expand Down
88 changes: 88 additions & 0 deletions credential-exchange-types/src/format/login.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,46 +10,134 @@ use crate::{
B64Url, Uri,
};

/// A [BasicAuthCredential] contains a username/password login credential.
/// Can either represent a [Basic access authentication](https://www.rfc-editor.org/rfc/rfc7617)
/// or a form on a web page.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BasicAuthCredential {
/// The URLs that this credential is associated with.
pub urls: Vec<Uri>,
/// The username associated with the credential.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub username: Option<EditableField>,
/// The password associated with the credential.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub password: Option<EditableField>,
}

/// Passkey
///
/// Note: Passkeys using a non-zero signature counter MUST be excluded from the export and the
/// exporter SHOULD inform the user that such passkeys are excluded from the export. Importers MUST
/// set a zero value for the imported passkey signature counters and MUST NOT increment them after
/// the fact.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PasskeyCredential {
/// This member contains a [WebAuthn](https://www.w3.org/TR/webauthn-3)
/// [Credential ID](https://www.w3.org/TR/webauthn-3/#credential-id) which uniquely identifies
/// the passkey instance. The decoded raw value MUST be equal to the value given in
/// [PublicKeyCredential](https://www.w3.org/TR/webauthn-3/#iface-pkcredential)'s
/// [rawId](https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-rawid) field during
/// [registration](https://www.w3.org/TR/webauthn-3/#registration).
pub credential_id: B64Url,
/// This member specifies the [WebAuthn](https://www.w3.org/TR/webauthn-3)
/// [Relying Party Identifier](https://www.w3.org/TR/webauthn-3/#relying-party-identifier) to
/// which the passkey instance is tied to. The value MUST be equal to the
/// [RP ID](https://www.w3.org/TR/webauthn-3/#rp-id) that was defined by the authenticator
/// during credential [registration](https://www.w3.org/TR/webauthn-3/#registration).
pub rp_id: String,
/// This member contains a [human-palatable](https://www.w3.org/TR/webauthn-3/#human-palatability)
/// identifier for the [user account](https://www.w3.org/TR/webauthn-3/#user-account) to which
/// the passkey instance is tied to. The value SHOULD be equal to the value in
/// [PublicKeyCredentialUserEntity](https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialuserentity)'s
/// [name](https://www.w3.org/TR/webauthn-3/#dom-publickeycredentialentity-name) member given
/// to the authenticator during [registration](https://www.w3.org/TR/webauthn-3/#registration).
///
/// The only case where the value MAY not be the one set during [registration](https://www.w3.org/TR/webauthn-3/#registration)
/// is if the [exporting provider](https://fidoalliance.org/specs/cx/cxp-v1.0-wd-20241003.html#exporting-provider)
/// allows the user to edit their username. In such a case, the value of
/// this field MUST be the user edited value. See [§ 3.3.3.1 Editability of passkey fields](https://fidoalliance.org/specs/cx/cxf-v1.0-wd-20241003.html#sctn-editability-of-passkey-fields)
/// for more details.
pub user_name: String,
/// This member contains a [human-palatable](https://www.w3.org/TR/webauthn-3/#human-palatability)
/// identifier for the [user account](https://www.w3.org/TR/webauthn-3/#user-account), intended
/// only for display. The value SHOULD be equal to the value in
/// [PublicKeyCredentialUserEntity](https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialuserentity)'s
/// [displayName](https://www.w3.org/TR/webauthn-3/#dom-publickeycredentialuserentity-displayname)
/// member given to the authenticator during [registration](https://www.w3.org/TR/webauthn-3/#registration).
///
/// The only case where the value MAY not be the one set during [registration](https://www.w3.org/TR/webauthn-3/#registration)
/// is if the [exporting provider](https://fidoalliance.org/specs/cx/cxp-v1.0-wd-20241003.html#exporting-provider)
/// allows the user to edit their username. In such a case, the value of
/// this field MUST be the user edited value. See [§ 3.3.3.1 Editability of passkey fields](https://fidoalliance.org/specs/cx/cxf-v1.0-wd-20241003.html#sctn-editability-of-passkey-fields)
/// for more details.
pub user_display_name: String,
/// This member contains the [user handle](https://www.w3.org/TR/webauthn-3/#user-handle) which
/// is the value used to identify the [user account](https://www.w3.org/TR/webauthn-3/#user-account)
/// associated to this passkey instance. The value MUST be equal to the value in
/// [PublicKeyCredentialUserEntity](https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialuserentity)'s
/// [id](https://www.w3.org/TR/webauthn-3/#dom-publickeycredentialuserentity-id) member given
/// to the authenticator during [registration](https://www.w3.org/TR/webauthn-3/#registration).
pub user_handle: B64Url,
/// The [private key](https://www.w3.org/TR/webauthn-3/#credential-private-key) associated to
/// this passkey instance. The value MUST be [PKCS#8](https://www.rfc-editor.org/rfc/rfc5958)
/// [ASN.1 DER](https://fidoalliance.org/specs/cx/cxf-v1.0-wd-20241003.html#biblio-itu-x690-2008)
/// formatted byte string which is then [Base64url encoded](https://www.rfc-editor.org/rfc/rfc4648#section-5).
/// The value MUST give the same [public key](https://www.w3.org/TR/webauthn-3/#credential-public-key)
/// value that was provided by the original authenticator during [registration](https://www.w3.org/TR/webauthn-3/#registration).
pub key: B64Url,
/// This OPTIONAL member denotes the WebAuthn or CTAP2 extensions that are associated to this
/// passkey instance.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub fido2_extensions: Option<Fido2Extensions>,
}

/// Note: Enrollment in TOTP credentials historically has been quite non-standardized but typically
/// authenticator and RP implementations have more or less aligned with the early Google
/// Authenticator implementation spelled out at <https://github.com/google/google-authenticator/wiki/Key-Uri-Format>.
/// This specification was designed with that in mind.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TotpCredential {
/// The [shared secret](https://www.rfc-editor.org/rfc/rfc4226#section-5) used to generate the
/// OTPs. This MUST be a [Base32 string](https://www.rfc-editor.org/rfc/rfc4648#section-6)
pub secret: B32,
/// The time step used to refresh the OTP in seconds. The default SHOULD be 30 seconds,
/// although the [relying party](https://www.w3.org/TR/webauthn-3/#relying-party) MAY customize
/// this to a different value.
pub period: u8,
/// The number of digits to generate and display to the user each period. The default SHOULD be
/// 6, although the [relying party](https://www.w3.org/TR/webauthn-3/#relying-party) MAY
/// customize this to a different value.
pub digits: u8,
/// The username of the account this [TotpCredential] is used for.
pub username: String,
/// The algorithm used to generate the OTP hashes. This value SHOULD be a member of
/// [OTPHashAlgorithm] but importers MUST ignore [TotpCredential] entries with unknown
/// algorithm values.
pub algorithm: OTPHashAlgorithm,
/// This OPTIONAL member contains the relying party that issued the credential and should be
/// user consumable.
///
/// Note: While this member is optional, it is strongly recommended to be included if
/// available.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub issuer: Option<String>,
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum OTPHashAlgorithm {
/// This algorithm denotes that [SHA1](https://www.rfc-editor.org/rfc/rfc3174) MUST be used to
/// generate the OTP hash.
Sha1,
/// This algorithm denotes that [SHA256](https://www.rfc-editor.org/rfc/rfc6234) MUST be used
/// to generate the OTP hash.
Sha256,
/// This algorithm denotes that [SHA512](https://www.rfc-editor.org/rfc/rfc6234) MUST be used
/// to generate the OTP hash.
Sha512,
#[serde(untagged)]
Unknown(String),
Expand Down
Loading