//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `auth/oob/grant`. Version: `0.3`.
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
/// Error from a `TryFrom` or `FromStr` implementation.
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
/**
A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.
Multihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.
This definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.
Restricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that "interoperability is not guaranteed between implementations using such values", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.*/
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "DigestMultibase",
/// "description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
/// "examples": [
/// "zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
/// ],
/// "type": "string",
/// "minLength": 16,
/// "pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct DigestMultibase(::std::string::String);
impl ::std::ops::Deref for DigestMultibase {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<DigestMultibase> for ::std::string::String {
fn from(value: DigestMultibase) -> Self {
value.0
}
}
impl ::std::str::FromStr for DigestMultibase {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 16usize {
return Err("shorter than 16 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err(
"doesn't match pattern \"^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$\"".into(),
);
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for DigestMultibase {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for DigestMultibase {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for DigestMultibase {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for DigestMultibase {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///A starter key (`K_b`) or an approver lock key (`K_a`), as an Ed25519 `did:key` (`z6Mk…`) generated for this one request and used nowhere else. Ed25519 only: a service refuses any other key type with `auth/oob:keyUnsupported` before parsing beyond the multicodec prefix.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "OobKey",
/// "description": "A starter key (`K_b`) or an approver lock key (`K_a`), as an Ed25519 `did:key` (`z6Mk…`) generated for this one request and used nowhere else. Ed25519 only: a service refuses any other key type with `auth/oob:keyUnsupported` before parsing beyond the multicodec prefix.",
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 48,
/// "pattern": "^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct OobKey(::std::string::String);
impl ::std::ops::Deref for OobKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<OobKey> for ::std::string::String {
fn from(value: OobKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for OobKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 64usize {
return Err("longer than 64 characters".into());
}
if value.chars().count() < 48usize {
return Err("shorter than 48 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for OobKey {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for OobKey {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for OobKey {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for OobKey {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///A web origin (`https://host[:port]`, no path, no trailing slash) — for `login`, the origin of the portal where the starter runs, which is the origin of the `serviceEndpoint` of the service's `SignInPortal` service in its DID document.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Origin",
/// "description": "A web origin (`https://host[:port]`, no path, no trailing slash) — for `login`, the origin of the portal where the starter runs, which is the origin of the `serviceEndpoint` of the service's `SignInPortal` service in its DID document.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 9,
/// "pattern": "^https://[^/?#\\s]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct Origin(::std::string::String);
impl ::std::ops::Deref for Origin {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<Origin> for ::std::string::String {
fn from(value: Origin) -> Self {
value.0
}
}
impl ::std::str::FromStr for Origin {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 2048usize {
return Err("longer than 2048 characters".into());
}
if value.chars().count() < 9usize {
return Err("shorter than 9 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^https://[^/?#\\s]+$").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^https://[^/?#\\s]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for Origin {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for Origin {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for Origin {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for Origin {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///The member's decision on one out-of-band request, as an attestation: "let this starter key act as me at this origin until sessionEndsAt, having seen this context" — and, where the grant carries `signingScope`, "and sign documents of these task families as me, for that session" — or a decline. Issued by the DID that proved membership and signed by its VTA for `assertionMethod`, only after user verification. Never sent on its own, only carried inside auth/oob/respond/0.3. Closed: additionalProperties false and no `ext`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/auth/oob/grant/0.3",
/// "title": "Payload",
/// "description": "The member's decision on one out-of-band request, as an attestation: \"let this starter key act as me at this origin until sessionEndsAt, having seen this context\" — and, where the grant carries `signingScope`, \"and sign documents of these task families as me, for that session\" — or a decline. Issued by the DID that proved membership and signed by its VTA for `assertionMethod`, only after user verification. Never sent on its own, only carried inside auth/oob/respond/0.3. Closed: additionalProperties false and no `ext`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
/// "type": "object",
/// "required": [
/// "approverKey",
/// "contextDigest",
/// "decision",
/// "origin",
/// "requestId",
/// "sessionEndsAt",
/// "sessionKey"
/// ],
/// "properties": {
/// "approverKey": {
/// "description": "The lock key `K_a`. MUST equal the issuer of the respond that carries this document.",
/// "$ref": "#/definitions/OobKey"
/// },
/// "contextDigest": {
/// "description": "SHA-256 multihash over the RFC 8785 (JCS) canonical form of the signed step 2 response document (the auth/oob/prove/0.3 response), proof included, written as multibase. Producers emit base58btc (`z…`). Binds the decision to exactly what the member was shown.",
/// "$ref": "#/definitions/DigestMultibase"
/// },
/// "decision": {
/// "description": "The member's decision. A decline still names the context it declines, and needs no user verification.",
/// "type": "string",
/// "enum": [
/// "approve",
/// "decline"
/// ]
/// },
/// "origin": {
/// "description": "The portal origin from step 2, at which the session key may act.",
/// "$ref": "#/definitions/Origin"
/// },
/// "requestId": {
/// "$ref": "#/definitions/RequestId"
/// },
/// "sessionEndsAt": {
/// "description": "The latest instant the session key may act as the issuer, as an RFC 3339 date-time. The service ends the session at the earlier of this and its own session limit.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "sessionKey": {
/// "description": "The starter key `K_b`, from step 2. On approve, the only key the grant lets act as the issuer.",
/// "$ref": "#/definitions/OobKey"
/// },
/// "signingScope": {
/// "description": "The task families the starter key may sign documents for as the issuer, for the session this grant arms — step 2's `signingScope`, copied unchanged. Absent: the grant delegates no signing. Whatever it names, a service never accepts the key for the exclusions auth/oob/grant/0.3 states (Conformance, consumer item 6), and never beyond the member's own standing.",
/// "$ref": "#/definitions/SigningScope"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
///The lock key `K_a`. MUST equal the issuer of the respond that carries this document.
#[serde(rename = "approverKey")]
pub approver_key: OobKey,
///SHA-256 multihash over the RFC 8785 (JCS) canonical form of the signed step 2 response document (the auth/oob/prove/0.3 response), proof included, written as multibase. Producers emit base58btc (`z…`). Binds the decision to exactly what the member was shown.
#[serde(rename = "contextDigest")]
pub context_digest: DigestMultibase,
///The member's decision. A decline still names the context it declines, and needs no user verification.
pub decision: PayloadDecision,
///The portal origin from step 2, at which the session key may act.
pub origin: Origin,
#[serde(rename = "requestId")]
pub request_id: RequestId,
///The latest instant the session key may act as the issuer, as an RFC 3339 date-time. The service ends the session at the earlier of this and its own session limit.
#[serde(rename = "sessionEndsAt")]
pub session_ends_at: ::chrono::DateTime<::chrono::offset::Utc>,
///The starter key `K_b`, from step 2. On approve, the only key the grant lets act as the issuer.
#[serde(rename = "sessionKey")]
pub session_key: OobKey,
///The task families the starter key may sign documents for as the issuer, for the session this grant arms — step 2's `signingScope`, copied unchanged. Absent: the grant delegates no signing. Whatever it names, a service never accepts the key for the exclusions auth/oob/grant/0.3 states (Conformance, consumer item 6), and never beyond the member's own standing.
#[serde(
rename = "signingScope",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub signing_scope: ::std::option::Option<SigningScope>,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///The member's decision. A decline still names the context it declines, and needs no user verification.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The member's decision. A decline still names the context it declines, and needs no user verification.",
/// "type": "string",
/// "enum": [
/// "approve",
/// "decline"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum PayloadDecision {
#[serde(rename = "approve")]
Approve,
#[serde(rename = "decline")]
Decline,
}
impl ::std::fmt::Display for PayloadDecision {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Approve => f.write_str("approve"),
Self::Decline => f.write_str("decline"),
}
}
}
impl ::std::str::FromStr for PayloadDecision {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"approve" => Ok(Self::Approve),
"decline" => Ok(Self::Decline),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for PayloadDecision {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadDecision {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadDecision {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///The service-generated handle of one request: 16 to 32 bytes from a cryptographically secure random source, written as unpadded base64url (22 to 43 characters; 16 bytes, 22 characters, is RECOMMENDED). It is also the nonce of the exchange, so the family needs no separate challenge, and it is the `_id` of the trigger link (VTI-LNK-033). Compared as a string. It confers no authority on its holder.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "RequestId",
/// "description": "The service-generated handle of one request: 16 to 32 bytes from a cryptographically secure random source, written as unpadded base64url (22 to 43 characters; 16 bytes, 22 characters, is RECOMMENDED). It is also the nonce of the exchange, so the family needs no separate challenge, and it is the `_id` of the trigger link (VTI-LNK-033). Compared as a string. It confers no authority on its holder.",
/// "type": "string",
/// "maxLength": 43,
/// "minLength": 22,
/// "pattern": "^[A-Za-z0-9_-]{22,43}$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RequestId(::std::string::String);
impl ::std::ops::Deref for RequestId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RequestId> for ::std::string::String {
fn from(value: RequestId) -> Self {
value.0
}
}
impl ::std::str::FromStr for RequestId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 43usize {
return Err("longer than 43 characters".into());
}
if value.chars().count() < 22usize {
return Err("shorter than 22 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^[A-Za-z0-9_-]{22,43}$").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[A-Za-z0-9_-]{22,43}$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RequestId {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for RequestId {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for RequestId {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for RequestId {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///The task families a `login` grant lets the starter key sign documents for, as the approving DID, for the session the grant arms (auth/oob/grant/0.2). Offered by the service in step 2, copied unchanged into the grant, and bounded further by the exclusions auth/oob/grant/0.2 states. Absent means the starter key signs nothing beyond the family's own tasks.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "SigningScope",
/// "description": "The task families a `login` grant lets the starter key sign documents for, as the approving DID, for the session the grant arms (auth/oob/grant/0.2). Offered by the service in step 2, copied unchanged into the grant, and bounded further by the exclusions auth/oob/grant/0.2 states. Absent means the starter key signs nothing beyond the family's own tasks.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/TaskFamily"
/// },
/// "maxItems": 8,
/// "minItems": 1,
/// "uniqueItems": true
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct SigningScope(pub Vec<TaskFamily>);
impl ::std::ops::Deref for SigningScope {
type Target = Vec<TaskFamily>;
fn deref(&self) -> &Vec<TaskFamily> {
&self.0
}
}
impl ::std::convert::From<SigningScope> for Vec<TaskFamily> {
fn from(value: SigningScope) -> Self {
value.0
}
}
impl ::std::convert::From<Vec<TaskFamily>> for SigningScope {
fn from(value: Vec<TaskFamily>) -> Self {
Self(value)
}
}
///A family of Trust Tasks, named by a slug prefix of whole segments (SPEC §6.1 grammar): `vtc/directory` names every task whose slug is `vtc/directory` or begins `vtc/directory/`, at any version. A prefix matches on segment boundaries only, so `vtc/dir` names nothing under `vtc/directory`.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "TaskFamily",
/// "description": "A family of Trust Tasks, named by a slug prefix of whole segments (SPEC §6.1 grammar): `vtc/directory` names every task whose slug is `vtc/directory` or begins `vtc/directory/`, at any version. A prefix matches on segment boundaries only, so `vtc/dir` names nothing under `vtc/directory`.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1,
/// "pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct TaskFamily(::std::string::String);
impl ::std::ops::Deref for TaskFamily {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<TaskFamily> for ::std::string::String {
fn from(value: TaskFamily) -> Self {
value.0
}
}
impl ::std::str::FromStr for TaskFamily {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 128usize {
return Err("longer than 128 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new(
"^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$",
)
.unwrap()
});
if PATTERN.find(value).is_none() {
return Err(
"doesn't match pattern \"^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$\""
.into(),
);
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for TaskFamily {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for TaskFamily {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for TaskFamily {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for TaskFamily {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct Payload {
approver_key: ::std::result::Result<super::OobKey, ::std::string::String>,
context_digest: ::std::result::Result<super::DigestMultibase, ::std::string::String>,
decision: ::std::result::Result<super::PayloadDecision, ::std::string::String>,
origin: ::std::result::Result<super::Origin, ::std::string::String>,
request_id: ::std::result::Result<super::RequestId, ::std::string::String>,
session_ends_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
session_key: ::std::result::Result<super::OobKey, ::std::string::String>,
signing_scope: ::std::result::Result<
::std::option::Option<super::SigningScope>,
::std::string::String,
>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
approver_key: Err("no value supplied for approver_key".to_string()),
context_digest: Err("no value supplied for context_digest".to_string()),
decision: Err("no value supplied for decision".to_string()),
origin: Err("no value supplied for origin".to_string()),
request_id: Err("no value supplied for request_id".to_string()),
session_ends_at: Err("no value supplied for session_ends_at".to_string()),
session_key: Err("no value supplied for session_key".to_string()),
signing_scope: Ok(Default::default()),
}
}
}
impl Payload {
pub fn approver_key<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::OobKey>,
T::Error: ::std::fmt::Display,
{
self.approver_key = value
.try_into()
.map_err(|e| format!("error converting supplied value for approver_key: {e}"));
self
}
pub fn context_digest<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::DigestMultibase>,
T::Error: ::std::fmt::Display,
{
self.context_digest = value
.try_into()
.map_err(|e| format!("error converting supplied value for context_digest: {e}"));
self
}
pub fn decision<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PayloadDecision>,
T::Error: ::std::fmt::Display,
{
self.decision = value
.try_into()
.map_err(|e| format!("error converting supplied value for decision: {e}"));
self
}
pub fn origin<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Origin>,
T::Error: ::std::fmt::Display,
{
self.origin = value
.try_into()
.map_err(|e| format!("error converting supplied value for origin: {e}"));
self
}
pub fn request_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::RequestId>,
T::Error: ::std::fmt::Display,
{
self.request_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for request_id: {e}"));
self
}
pub fn session_ends_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.session_ends_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for session_ends_at: {e}"));
self
}
pub fn session_key<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::OobKey>,
T::Error: ::std::fmt::Display,
{
self.session_key = value
.try_into()
.map_err(|e| format!("error converting supplied value for session_key: {e}"));
self
}
pub fn signing_scope<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::SigningScope>>,
T::Error: ::std::fmt::Display,
{
self.signing_scope = value
.try_into()
.map_err(|e| format!("error converting supplied value for signing_scope: {e}"));
self
}
}
impl ::std::convert::TryFrom<Payload> for super::Payload {
type Error = super::error::ConversionError;
fn try_from(value: Payload) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
approver_key: value.approver_key?,
context_digest: value.context_digest?,
decision: value.decision?,
origin: value.origin?,
request_id: value.request_id?,
session_ends_at: value.session_ends_at?,
session_key: value.session_key?,
signing_scope: value.signing_scope?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
approver_key: Ok(value.approver_key),
context_digest: Ok(value.context_digest),
decision: Ok(value.decision),
origin: Ok(value.origin),
request_id: Ok(value.request_id),
session_ends_at: Ok(value.session_ends_at),
session_key: Ok(value.session_key),
signing_scope: Ok(value.signing_scope),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/auth/oob/grant/0.3";
const IS_PROOF_REQUIRED: bool = true;
const IS_ISSUED_AT_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"DigestMultibase\": {\n \"description\": \"A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\\n\\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\\n\\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\\n\\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \\\"interoperability is not guaranteed between implementations using such values\\\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.\",\n \"examples\": [\n \"zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR\"\n ],\n \"minLength\": 16,\n \"pattern\": \"^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$\",\n \"title\": \"DigestMultibase\",\n \"type\": \"string\"\n },\n \"OobKey\": {\n \"description\": \"A starter key (`K_b`) or an approver lock key (`K_a`), as an Ed25519 `did:key` (`z6Mk…`) generated for this one request and used nowhere else. Ed25519 only: a service refuses any other key type with `auth/oob:keyUnsupported` before parsing beyond the multicodec prefix.\",\n \"maxLength\": 64,\n \"minLength\": 48,\n \"pattern\": \"^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$\",\n \"title\": \"OobKey\",\n \"type\": \"string\"\n },\n \"Origin\": {\n \"description\": \"A web origin (`https://host[:port]`, no path, no trailing slash) — for `login`, the origin of the portal where the starter runs, which is the origin of the `serviceEndpoint` of the service's `SignInPortal` service in its DID document.\",\n \"maxLength\": 2048,\n \"minLength\": 9,\n \"pattern\": \"^https://[^/?#\\\\s]+$\",\n \"title\": \"Origin\",\n \"type\": \"string\"\n },\n \"RequestId\": {\n \"description\": \"The service-generated handle of one request: 16 to 32 bytes from a cryptographically secure random source, written as unpadded base64url (22 to 43 characters; 16 bytes, 22 characters, is RECOMMENDED). It is also the nonce of the exchange, so the family needs no separate challenge, and it is the `_id` of the trigger link (VTI-LNK-033). Compared as a string. It confers no authority on its holder.\",\n \"maxLength\": 43,\n \"minLength\": 22,\n \"pattern\": \"^[A-Za-z0-9_-]{22,43}$\",\n \"title\": \"RequestId\",\n \"type\": \"string\"\n },\n \"SigningScope\": {\n \"description\": \"The task families a `login` grant lets the starter key sign documents for, as the approving DID, for the session the grant arms (auth/oob/grant/0.2). Offered by the service in step 2, copied unchanged into the grant, and bounded further by the exclusions auth/oob/grant/0.2 states. Absent means the starter key signs nothing beyond the family's own tasks.\",\n \"items\": {\n \"$ref\": \"#/$defs/TaskFamily\"\n },\n \"maxItems\": 8,\n \"minItems\": 1,\n \"title\": \"SigningScope\",\n \"type\": \"array\",\n \"uniqueItems\": true\n },\n \"TaskFamily\": {\n \"description\": \"A family of Trust Tasks, named by a slug prefix of whole segments (SPEC §6.1 grammar): `vtc/directory` names every task whose slug is `vtc/directory` or begins `vtc/directory/`, at any version. A prefix matches on segment boundaries only, so `vtc/dir` names nothing under `vtc/directory`.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"pattern\": \"^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$\",\n \"title\": \"TaskFamily\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/auth/oob/grant/0.3\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"The member's decision on one out-of-band request, as an attestation: \\\"let this starter key act as me at this origin until sessionEndsAt, having seen this context\\\" — and, where the grant carries `signingScope`, \\\"and sign documents of these task families as me, for that session\\\" — or a decline. Issued by the DID that proved membership and signed by its VTA for `assertionMethod`, only after user verification. Never sent on its own, only carried inside auth/oob/respond/0.3. Closed: additionalProperties false and no `ext`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.\",\n \"properties\": {\n \"approverKey\": {\n \"$ref\": \"#/$defs/OobKey\",\n \"description\": \"The lock key `K_a`. MUST equal the issuer of the respond that carries this document.\"\n },\n \"contextDigest\": {\n \"$ref\": \"#/$defs/DigestMultibase\",\n \"description\": \"SHA-256 multihash over the RFC 8785 (JCS) canonical form of the signed step 2 response document (the auth/oob/prove/0.3 response), proof included, written as multibase. Producers emit base58btc (`z…`). Binds the decision to exactly what the member was shown.\"\n },\n \"decision\": {\n \"description\": \"The member's decision. A decline still names the context it declines, and needs no user verification.\",\n \"enum\": [\n \"approve\",\n \"decline\"\n ],\n \"type\": \"string\"\n },\n \"origin\": {\n \"$ref\": \"#/$defs/Origin\",\n \"description\": \"The portal origin from step 2, at which the session key may act.\"\n },\n \"requestId\": {\n \"$ref\": \"#/$defs/RequestId\"\n },\n \"sessionEndsAt\": {\n \"description\": \"The latest instant the session key may act as the issuer, as an RFC 3339 date-time. The service ends the session at the earlier of this and its own session limit.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"sessionKey\": {\n \"$ref\": \"#/$defs/OobKey\",\n \"description\": \"The starter key `K_b`, from step 2. On approve, the only key the grant lets act as the issuer.\"\n },\n \"signingScope\": {\n \"$ref\": \"#/$defs/SigningScope\",\n \"description\": \"The task families the starter key may sign documents for as the issuer, for the session this grant arms — step 2's `signingScope`, copied unchanged. Absent: the grant delegates no signing. Whatever it names, a service never accepts the key for the exclusions auth/oob/grant/0.3 states (Conformance, consumer item 6), and never beyond the member's own standing.\"\n }\n },\n \"required\": [\n \"requestId\",\n \"decision\",\n \"sessionKey\",\n \"approverKey\",\n \"origin\",\n \"contextDigest\",\n \"sessionEndsAt\"\n ],\n \"title\": \"Auth — OOB Grant — payload\",\n \"type\": \"object\"\n}\n",
);
}
/// The extended error codes this specification declares (SPEC §7.3 item 9,
/// §8.5), in declaration order. Empty when it declares none.
pub const ERROR_CODES: &[crate::DeclaredErrorCode] = &[];