//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `auth/oob/prove`. Version: `0.3`.
/// Why this specification version is deprecated (SPEC "Superseded and
/// Withdrawn Versions"), or `None` while it is current.
pub const DEPRECATION: Option<&str> = None;
#[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())
}
}
}
///Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Ext(pub ::std::collections::HashMap<ExtKey, ::serde_json::Value>);
impl ::std::ops::Deref for Ext {
type Target = ::std::collections::HashMap<ExtKey, ::serde_json::Value>;
fn deref(&self) -> &::std::collections::HashMap<ExtKey, ::serde_json::Value> {
&self.0
}
}
impl ::std::convert::From<Ext> for ::std::collections::HashMap<ExtKey, ::serde_json::Value> {
fn from(value: Ext) -> Self {
value.0
}
}
impl ::std::convert::From<::std::collections::HashMap<ExtKey, ::serde_json::Value>> for Ext {
fn from(value: ::std::collections::HashMap<ExtKey, ::serde_json::Value>) -> Self {
Self(value)
}
}
///`ExtKey`
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ExtKey(::std::string::String);
impl ::std::ops::Deref for ExtKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ExtKey> for ::std::string::String {
fn from(value: ExtKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for ExtKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^[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-]+)+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ExtKey {
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 ExtKey {
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 ExtKey {
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 ExtKey {
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.
///
#[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.
///
#[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 lock holder proves membership and the number on the starter's screen by carrying a signed auth/oob/identify document, and gets back the service-signed step 2. Issued and signed by the lock key `K_a`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, parentThreadId, proof) are owned by the framework — SPEC §6.3.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///A complete, signed auth/oob/identify/0.1 Trust Task document, issued by the approving DID and signed by its VTA for `authentication`. The service verifies it as a document in its own right — envelope, proof and payload against that specification's schema — over the members exactly as received: its proof covers every member, so it is deliberately an open object here rather than a typed one a binding could narrow.
pub identify: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///What the request is for. A CLOSED list: each purpose has a fixed row in CONVENTIONS.md §3 stating what is revealed at each step, what the grant contains, what redeem returns and the window lengths. Version 0.1 defines `login` only. `stepUp` and `deviceEnrol` are reserved names; adding one is a new version of this component and of every task that references it, never an in-place edit.
///
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum Purpose {
#[serde(rename = "login")]
Login,
}
impl ::std::fmt::Display for Purpose {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Login => f.write_str("login"),
}
}
}
impl ::std::str::FromStr for Purpose {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"login" => Ok(Self::Login),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for Purpose {
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 Purpose {
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 Purpose {
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.
///
#[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())
})
}
}
///What the service reports about where the request came from. Revealed only in the step 2 response, to the lock holder, after a membership and number proof. Reported by the service, signed by it, and a heuristic: a relaying attacker controls what is observed.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Requester {
///Browser family of the starter (e.g. `Chrome`), never the full User-Agent; `unknown` when it cannot be told.
pub browser: RequesterBrowser,
///When the service accepted the starter's auth/oob/request.
#[serde(rename = "createdAt")]
pub created_at: ::chrono::DateTime<::chrono::offset::Utc>,
///City and country of the starter's connection, from a local lookup with no third-party call, or the literal `unknown`. Never an IP address.
pub location: RequesterLocation,
///Operating system family of the starter (e.g. `macOS`); `unknown` when it cannot be told.
pub os: RequesterOs,
#[serde(rename = "sameNetwork")]
pub same_network: SameNetwork,
}
impl Requester {
pub fn builder() -> builder::Requester {
Default::default()
}
}
///Browser family of the starter (e.g. `Chrome`), never the full User-Agent; `unknown` when it cannot be told.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RequesterBrowser(::std::string::String);
impl ::std::ops::Deref for RequesterBrowser {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RequesterBrowser> for ::std::string::String {
fn from(value: RequesterBrowser) -> Self {
value.0
}
}
impl ::std::str::FromStr for RequesterBrowser {
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() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RequesterBrowser {
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 RequesterBrowser {
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 RequesterBrowser {
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 RequesterBrowser {
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())
})
}
}
///City and country of the starter's connection, from a local lookup with no third-party call, or the literal `unknown`. Never an IP address.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RequesterLocation(::std::string::String);
impl ::std::ops::Deref for RequesterLocation {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RequesterLocation> for ::std::string::String {
fn from(value: RequesterLocation) -> Self {
value.0
}
}
impl ::std::str::FromStr for RequesterLocation {
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());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RequesterLocation {
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 RequesterLocation {
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 RequesterLocation {
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 RequesterLocation {
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())
})
}
}
///Operating system family of the starter (e.g. `macOS`); `unknown` when it cannot be told.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct RequesterOs(::std::string::String);
impl ::std::ops::Deref for RequesterOs {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<RequesterOs> for ::std::string::String {
fn from(value: RequesterOs) -> Self {
value.0
}
}
impl ::std::str::FromStr for RequesterOs {
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() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for RequesterOs {
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 RequesterOs {
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 RequesterOs {
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 RequesterOs {
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())
})
}
}
///Step 2 of the disclosure ladder, signed by the service's assertionMethod key: the step 1 members unchanged, plus the starter's key, where the request came from, which DID was identified and, optionally, the task families the starter key would sign for. The SHA-256 of its JCS canonical form, proof included, is the grant's `contextDigest`.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
///Unchanged from step 1 (auth/oob/claim/0.2): when the decision window closes, as an RFC 3339 date-time.
#[serde(rename = "decisionClosesAt")]
pub decision_closes_at: ::chrono::DateTime<::chrono::offset::Utc>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///The DID that issued the verified identify document. A grant must come from this DID.
#[serde(rename = "identifiedAs")]
pub identified_as: ResponseIdentifiedAs,
pub origin: Origin,
pub purpose: Purpose,
#[serde(rename = "requestId")]
pub request_id: RequestId,
pub requester: Requester,
pub service: Service,
///The starter key `K_b`: the key a grant would let act as the identified DID.
#[serde(rename = "sessionKey")]
pub session_key: OobKey,
///The task families the service offers to let the starter key sign for, as `identifiedAs`, for the session a grant would arm (auth/oob/grant/0.3). Fixed by the service for the surface at `origin`. Absent: the grant delegates no signing.
#[serde(
rename = "signingScope",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub signing_scope: ::std::option::Option<SigningScope>,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///The DID that issued the verified identify document. A grant must come from this DID.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseIdentifiedAs(::std::string::String);
impl ::std::ops::Deref for ResponseIdentifiedAs {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseIdentifiedAs> for ::std::string::String {
fn from(value: ResponseIdentifiedAs) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseIdentifiedAs {
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() < 5usize {
return Err("shorter than 5 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseIdentifiedAs {
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 ResponseIdentifiedAs {
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 ResponseIdentifiedAs {
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 ResponseIdentifiedAs {
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())
})
}
}
///Whether the starter's request and the approver's prove came from the same egress network, as the service saw them: `true`, `false`, or the string `unknown` when the service cannot tell. The service compares addresses; it never discloses them.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(untagged)]
#[non_exhaustive]
pub enum SameNetwork {
Boolean(bool),
String(::std::string::String),
}
impl ::std::fmt::Display for SameNetwork {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match self {
Self::Boolean(x) => x.fmt(f),
Self::String(x) => x.fmt(f),
}
}
}
impl ::std::convert::From<bool> for SameNetwork {
fn from(value: bool) -> Self {
Self::Boolean(value)
}
}
///Who the service says it is.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Service {
///The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.
pub did: ServiceDid,
///The name the service calls itself. Supplied by the service: an approver shows the name from its OWN records and flags a difference from this one (VTI-LNK-104); it never shows this value as the community's name on its own authority.
pub name: ServiceName,
}
impl Service {
pub fn builder() -> builder::Service {
Default::default()
}
}
///The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ServiceDid(::std::string::String);
impl ::std::ops::Deref for ServiceDid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ServiceDid> for ::std::string::String {
fn from(value: ServiceDid) -> Self {
value.0
}
}
impl ::std::str::FromStr for ServiceDid {
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() < 5usize {
return Err("shorter than 5 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ServiceDid {
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 ServiceDid {
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 ServiceDid {
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 ServiceDid {
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 name the service calls itself. Supplied by the service: an approver shows the name from its OWN records and flags a difference from this one (VTI-LNK-104); it never shows this value as the community's name on its own authority.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ServiceName(::std::string::String);
impl ::std::ops::Deref for ServiceName {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ServiceName> for ::std::string::String {
fn from(value: ServiceName) -> Self {
value.0
}
}
impl ::std::str::FromStr for ServiceName {
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());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ServiceName {
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 ServiceName {
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 ServiceName {
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 ServiceName {
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.
///
#[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`.
///
#[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 {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
identify: ::std::result::Result<
::serde_json::Map<::std::string::String, ::serde_json::Value>,
::std::string::String,
>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
identify: Err("no value supplied for identify".to_string()),
}
}
}
impl Payload {
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn identify<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::serde_json::Map<::std::string::String, ::serde_json::Value>,
>,
T::Error: ::std::fmt::Display,
{
self.identify = value
.try_into()
.map_err(|e| format!("error converting supplied value for identify: {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 {
ext: value.ext?,
identify: value.identify?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
ext: Ok(value.ext),
identify: Ok(value.identify),
}
}
}
#[derive(Clone, Debug)]
pub struct Requester {
browser: ::std::result::Result<super::RequesterBrowser, ::std::string::String>,
created_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
location: ::std::result::Result<super::RequesterLocation, ::std::string::String>,
os: ::std::result::Result<super::RequesterOs, ::std::string::String>,
same_network: ::std::result::Result<super::SameNetwork, ::std::string::String>,
}
impl ::std::default::Default for Requester {
fn default() -> Self {
Self {
browser: Err("no value supplied for browser".to_string()),
created_at: Err("no value supplied for created_at".to_string()),
location: Err("no value supplied for location".to_string()),
os: Err("no value supplied for os".to_string()),
same_network: Err("no value supplied for same_network".to_string()),
}
}
}
impl Requester {
pub fn browser<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::RequesterBrowser>,
T::Error: ::std::fmt::Display,
{
self.browser = value
.try_into()
.map_err(|e| format!("error converting supplied value for browser: {e}"));
self
}
pub fn created_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.created_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for created_at: {e}"));
self
}
pub fn location<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::RequesterLocation>,
T::Error: ::std::fmt::Display,
{
self.location = value
.try_into()
.map_err(|e| format!("error converting supplied value for location: {e}"));
self
}
pub fn os<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::RequesterOs>,
T::Error: ::std::fmt::Display,
{
self.os = value
.try_into()
.map_err(|e| format!("error converting supplied value for os: {e}"));
self
}
pub fn same_network<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::SameNetwork>,
T::Error: ::std::fmt::Display,
{
self.same_network = value
.try_into()
.map_err(|e| format!("error converting supplied value for same_network: {e}"));
self
}
}
impl ::std::convert::TryFrom<Requester> for super::Requester {
type Error = super::error::ConversionError;
fn try_from(
value: Requester,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
browser: value.browser?,
created_at: value.created_at?,
location: value.location?,
os: value.os?,
same_network: value.same_network?,
})
}
}
impl ::std::convert::From<super::Requester> for Requester {
fn from(value: super::Requester) -> Self {
Self {
browser: Ok(value.browser),
created_at: Ok(value.created_at),
location: Ok(value.location),
os: Ok(value.os),
same_network: Ok(value.same_network),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
decision_closes_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
identified_as: ::std::result::Result<super::ResponseIdentifiedAs, ::std::string::String>,
origin: ::std::result::Result<super::Origin, ::std::string::String>,
purpose: ::std::result::Result<super::Purpose, ::std::string::String>,
request_id: ::std::result::Result<super::RequestId, ::std::string::String>,
requester: ::std::result::Result<super::Requester, ::std::string::String>,
service: ::std::result::Result<super::Service, ::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 Response {
fn default() -> Self {
Self {
decision_closes_at: Err("no value supplied for decision_closes_at".to_string()),
ext: Ok(Default::default()),
identified_as: Err("no value supplied for identified_as".to_string()),
origin: Err("no value supplied for origin".to_string()),
purpose: Err("no value supplied for purpose".to_string()),
request_id: Err("no value supplied for request_id".to_string()),
requester: Err("no value supplied for requester".to_string()),
service: Err("no value supplied for service".to_string()),
session_key: Err("no value supplied for session_key".to_string()),
signing_scope: Ok(Default::default()),
}
}
}
impl Response {
pub fn decision_closes_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.decision_closes_at = value.try_into().map_err(|e| {
format!("error converting supplied value for decision_closes_at: {e}")
});
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn identified_as<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseIdentifiedAs>,
T::Error: ::std::fmt::Display,
{
self.identified_as = value
.try_into()
.map_err(|e| format!("error converting supplied value for identified_as: {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 purpose<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Purpose>,
T::Error: ::std::fmt::Display,
{
self.purpose = value
.try_into()
.map_err(|e| format!("error converting supplied value for purpose: {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 requester<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Requester>,
T::Error: ::std::fmt::Display,
{
self.requester = value
.try_into()
.map_err(|e| format!("error converting supplied value for requester: {e}"));
self
}
pub fn service<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Service>,
T::Error: ::std::fmt::Display,
{
self.service = value
.try_into()
.map_err(|e| format!("error converting supplied value for service: {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<Response> for super::Response {
type Error = super::error::ConversionError;
fn try_from(value: Response) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
decision_closes_at: value.decision_closes_at?,
ext: value.ext?,
identified_as: value.identified_as?,
origin: value.origin?,
purpose: value.purpose?,
request_id: value.request_id?,
requester: value.requester?,
service: value.service?,
session_key: value.session_key?,
signing_scope: value.signing_scope?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
decision_closes_at: Ok(value.decision_closes_at),
ext: Ok(value.ext),
identified_as: Ok(value.identified_as),
origin: Ok(value.origin),
purpose: Ok(value.purpose),
request_id: Ok(value.request_id),
requester: Ok(value.requester),
service: Ok(value.service),
session_key: Ok(value.session_key),
signing_scope: Ok(value.signing_scope),
}
}
}
#[derive(Clone, Debug)]
pub struct Service {
did: ::std::result::Result<super::ServiceDid, ::std::string::String>,
name: ::std::result::Result<super::ServiceName, ::std::string::String>,
}
impl ::std::default::Default for Service {
fn default() -> Self {
Self {
did: Err("no value supplied for did".to_string()),
name: Err("no value supplied for name".to_string()),
}
}
}
impl Service {
pub fn did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceDid>,
T::Error: ::std::fmt::Display,
{
self.did = value
.try_into()
.map_err(|e| format!("error converting supplied value for did: {e}"));
self
}
pub fn name<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceName>,
T::Error: ::std::fmt::Display,
{
self.name = value
.try_into()
.map_err(|e| format!("error converting supplied value for name: {e}"));
self
}
}
impl ::std::convert::TryFrom<Service> for super::Service {
type Error = super::error::ConversionError;
fn try_from(value: Service) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
did: value.did?,
name: value.name?,
})
}
}
impl ::std::convert::From<super::Service> for Service {
fn from(value: super::Service) -> Self {
Self {
did: Ok(value.did),
name: Ok(value.name),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/auth/oob/prove/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(
"{\"$defs\":{\"Ext\":{\"additionalProperties\":true,\"description\":\"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"},\"title\":\"Ext\",\"type\":\"object\"},\"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.\",\"maxLength\":64,\"minLength\":48,\"pattern\":\"^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$\",\"title\":\"OobKey\",\"type\":\"string\"},\"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.\",\"maxLength\":2048,\"minLength\":9,\"pattern\":\"^https://[^/?#\\\\s]+$\",\"title\":\"Origin\",\"type\":\"string\"},\"Purpose\":{\"description\":\"What the request is for. A CLOSED list: each purpose has a fixed row in CONVENTIONS.md §3 stating what is revealed at each step, what the grant contains, what redeem returns and the window lengths. Version 0.1 defines `login` only. `stepUp` and `deviceEnrol` are reserved names; adding one is a new version of this component and of every task that references it, never an in-place edit.\",\"enum\":[\"login\"],\"title\":\"Purpose\",\"type\":\"string\"},\"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.\",\"maxLength\":43,\"minLength\":22,\"pattern\":\"^[A-Za-z0-9_-]{22,43}$\",\"title\":\"RequestId\",\"type\":\"string\"},\"Requester\":{\"additionalProperties\":false,\"description\":\"What the service reports about where the request came from. Revealed only in the step 2 response, to the lock holder, after a membership and number proof. Reported by the service, signed by it, and a heuristic: a relaying attacker controls what is observed.\",\"properties\":{\"browser\":{\"description\":\"Browser family of the starter (e.g. `Chrome`), never the full User-Agent; `unknown` when it cannot be told.\",\"maxLength\":64,\"minLength\":1,\"type\":\"string\"},\"createdAt\":{\"description\":\"When the service accepted the starter's auth/oob/request.\",\"format\":\"date-time\",\"type\":\"string\"},\"location\":{\"description\":\"City and country of the starter's connection, from a local lookup with no third-party call, or the literal `unknown`. Never an IP address.\",\"maxLength\":128,\"minLength\":1,\"type\":\"string\"},\"os\":{\"description\":\"Operating system family of the starter (e.g. `macOS`); `unknown` when it cannot be told.\",\"maxLength\":64,\"minLength\":1,\"type\":\"string\"},\"sameNetwork\":{\"$ref\":\"#/$defs/SameNetwork\"}},\"required\":[\"location\",\"browser\",\"os\",\"createdAt\",\"sameNetwork\"],\"title\":\"Requester\",\"type\":\"object\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Step 2 of the disclosure ladder, signed by the service's assertionMethod key: the step 1 members unchanged, plus the starter's key, where the request came from, which DID was identified and, optionally, the task families the starter key would sign for. The SHA-256 of its JCS canonical form, proof included, is the grant's `contextDigest`.\",\"properties\":{\"decisionClosesAt\":{\"description\":\"Unchanged from step 1 (auth/oob/claim/0.2): when the decision window closes, as an RFC 3339 date-time.\",\"format\":\"date-time\",\"type\":\"string\"},\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"identifiedAs\":{\"description\":\"The DID that issued the verified identify document. A grant must come from this DID.\",\"maxLength\":2048,\"minLength\":5,\"pattern\":\"^did:\",\"type\":\"string\"},\"origin\":{\"$ref\":\"#/$defs/Origin\"},\"purpose\":{\"$ref\":\"#/$defs/Purpose\"},\"requestId\":{\"$ref\":\"#/$defs/RequestId\"},\"requester\":{\"$ref\":\"#/$defs/Requester\"},\"service\":{\"$ref\":\"#/$defs/Service\"},\"sessionKey\":{\"$ref\":\"#/$defs/OobKey\",\"description\":\"The starter key `K_b`: the key a grant would let act as the identified DID.\"},\"signingScope\":{\"$ref\":\"#/$defs/SigningScope\",\"description\":\"The task families the service offers to let the starter key sign for, as `identifiedAs`, for the session a grant would arm (auth/oob/grant/0.3). Fixed by the service for the surface at `origin`. Absent: the grant delegates no signing.\"}},\"required\":[\"requestId\",\"service\",\"origin\",\"purpose\",\"decisionClosesAt\",\"sessionKey\",\"requester\",\"identifiedAs\"],\"title\":\"Auth — OOB Prove — response payload (step 2)\",\"type\":\"object\"},\"SameNetwork\":{\"description\":\"Whether the starter's request and the approver's prove came from the same egress network, as the service saw them: `true`, `false`, or the string `unknown` when the service cannot tell. The service compares addresses; it never discloses them.\",\"oneOf\":[{\"type\":\"boolean\"},{\"const\":\"unknown\",\"type\":\"string\"}],\"title\":\"SameNetwork\"},\"Service\":{\"additionalProperties\":false,\"description\":\"Who the service says it is.\",\"properties\":{\"did\":{\"description\":\"The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.\",\"maxLength\":2048,\"minLength\":5,\"pattern\":\"^did:\",\"type\":\"string\"},\"name\":{\"description\":\"The name the service calls itself. Supplied by the service: an approver shows the name from its OWN records and flags a difference from this one (VTI-LNK-104); it never shows this value as the community's name on its own authority.\",\"maxLength\":128,\"minLength\":1,\"type\":\"string\"}},\"required\":[\"did\",\"name\"],\"title\":\"Service\",\"type\":\"object\"},\"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.\",\"items\":{\"$ref\":\"#/$defs/TaskFamily\"},\"maxItems\":8,\"minItems\":1,\"title\":\"SigningScope\",\"type\":\"array\",\"uniqueItems\":true},\"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`.\",\"maxLength\":128,\"minLength\":1,\"pattern\":\"^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$\",\"title\":\"TaskFamily\",\"type\":\"string\"}},\"$id\":\"https://trusttasks.org/spec/auth/oob/prove/0.3\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"additionalProperties\":false,\"description\":\"The lock holder proves membership and the number on the starter's screen by carrying a signed auth/oob/identify document, and gets back the service-signed step 2. Issued and signed by the lock key `K_a`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, parentThreadId, proof) are owned by the framework — SPEC §6.3.\",\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"identify\":{\"description\":\"A complete, signed auth/oob/identify/0.1 Trust Task document, issued by the approving DID and signed by its VTA for `authentication`. The service verifies it as a document in its own right — envelope, proof and payload against that specification's schema — over the members exactly as received: its proof covers every member, so it is deliberately an open object here rather than a typed one a binding could narrow.\",\"type\":\"object\"}},\"required\":[\"identify\"],\"title\":\"Auth — OOB Prove — payload\",\"type\":\"object\"}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/auth/oob/prove/0.3#response";
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(
"{\"$defs\":{\"Ext\":{\"additionalProperties\":true,\"description\":\"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"},\"title\":\"Ext\",\"type\":\"object\"},\"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.\",\"maxLength\":64,\"minLength\":48,\"pattern\":\"^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$\",\"title\":\"OobKey\",\"type\":\"string\"},\"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.\",\"maxLength\":2048,\"minLength\":9,\"pattern\":\"^https://[^/?#\\\\s]+$\",\"title\":\"Origin\",\"type\":\"string\"},\"Purpose\":{\"description\":\"What the request is for. A CLOSED list: each purpose has a fixed row in CONVENTIONS.md §3 stating what is revealed at each step, what the grant contains, what redeem returns and the window lengths. Version 0.1 defines `login` only. `stepUp` and `deviceEnrol` are reserved names; adding one is a new version of this component and of every task that references it, never an in-place edit.\",\"enum\":[\"login\"],\"title\":\"Purpose\",\"type\":\"string\"},\"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.\",\"maxLength\":43,\"minLength\":22,\"pattern\":\"^[A-Za-z0-9_-]{22,43}$\",\"title\":\"RequestId\",\"type\":\"string\"},\"Requester\":{\"additionalProperties\":false,\"description\":\"What the service reports about where the request came from. Revealed only in the step 2 response, to the lock holder, after a membership and number proof. Reported by the service, signed by it, and a heuristic: a relaying attacker controls what is observed.\",\"properties\":{\"browser\":{\"description\":\"Browser family of the starter (e.g. `Chrome`), never the full User-Agent; `unknown` when it cannot be told.\",\"maxLength\":64,\"minLength\":1,\"type\":\"string\"},\"createdAt\":{\"description\":\"When the service accepted the starter's auth/oob/request.\",\"format\":\"date-time\",\"type\":\"string\"},\"location\":{\"description\":\"City and country of the starter's connection, from a local lookup with no third-party call, or the literal `unknown`. Never an IP address.\",\"maxLength\":128,\"minLength\":1,\"type\":\"string\"},\"os\":{\"description\":\"Operating system family of the starter (e.g. `macOS`); `unknown` when it cannot be told.\",\"maxLength\":64,\"minLength\":1,\"type\":\"string\"},\"sameNetwork\":{\"$ref\":\"#/$defs/SameNetwork\"}},\"required\":[\"location\",\"browser\",\"os\",\"createdAt\",\"sameNetwork\"],\"title\":\"Requester\",\"type\":\"object\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Step 2 of the disclosure ladder, signed by the service's assertionMethod key: the step 1 members unchanged, plus the starter's key, where the request came from, which DID was identified and, optionally, the task families the starter key would sign for. The SHA-256 of its JCS canonical form, proof included, is the grant's `contextDigest`.\",\"properties\":{\"decisionClosesAt\":{\"description\":\"Unchanged from step 1 (auth/oob/claim/0.2): when the decision window closes, as an RFC 3339 date-time.\",\"format\":\"date-time\",\"type\":\"string\"},\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"identifiedAs\":{\"description\":\"The DID that issued the verified identify document. A grant must come from this DID.\",\"maxLength\":2048,\"minLength\":5,\"pattern\":\"^did:\",\"type\":\"string\"},\"origin\":{\"$ref\":\"#/$defs/Origin\"},\"purpose\":{\"$ref\":\"#/$defs/Purpose\"},\"requestId\":{\"$ref\":\"#/$defs/RequestId\"},\"requester\":{\"$ref\":\"#/$defs/Requester\"},\"service\":{\"$ref\":\"#/$defs/Service\"},\"sessionKey\":{\"$ref\":\"#/$defs/OobKey\",\"description\":\"The starter key `K_b`: the key a grant would let act as the identified DID.\"},\"signingScope\":{\"$ref\":\"#/$defs/SigningScope\",\"description\":\"The task families the service offers to let the starter key sign for, as `identifiedAs`, for the session a grant would arm (auth/oob/grant/0.3). Fixed by the service for the surface at `origin`. Absent: the grant delegates no signing.\"}},\"required\":[\"requestId\",\"service\",\"origin\",\"purpose\",\"decisionClosesAt\",\"sessionKey\",\"requester\",\"identifiedAs\"],\"title\":\"Auth — OOB Prove — response payload (step 2)\",\"type\":\"object\"},\"SameNetwork\":{\"description\":\"Whether the starter's request and the approver's prove came from the same egress network, as the service saw them: `true`, `false`, or the string `unknown` when the service cannot tell. The service compares addresses; it never discloses them.\",\"oneOf\":[{\"type\":\"boolean\"},{\"const\":\"unknown\",\"type\":\"string\"}],\"title\":\"SameNetwork\"},\"Service\":{\"additionalProperties\":false,\"description\":\"Who the service says it is.\",\"properties\":{\"did\":{\"description\":\"The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.\",\"maxLength\":2048,\"minLength\":5,\"pattern\":\"^did:\",\"type\":\"string\"},\"name\":{\"description\":\"The name the service calls itself. Supplied by the service: an approver shows the name from its OWN records and flags a difference from this one (VTI-LNK-104); it never shows this value as the community's name on its own authority.\",\"maxLength\":128,\"minLength\":1,\"type\":\"string\"}},\"required\":[\"did\",\"name\"],\"title\":\"Service\",\"type\":\"object\"},\"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.\",\"items\":{\"$ref\":\"#/$defs/TaskFamily\"},\"maxItems\":8,\"minItems\":1,\"title\":\"SigningScope\",\"type\":\"array\",\"uniqueItems\":true},\"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`.\",\"maxLength\":128,\"minLength\":1,\"pattern\":\"^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$\",\"title\":\"TaskFamily\",\"type\":\"string\"}},\"$ref\":\"#/$defs/Response\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\"}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
/// The earlier `MAJOR.MINOR` of this slug that this version declares it
/// extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
/// `None`. Only the direct declaration; walk a chain with
/// [`crate::extension::extends_for`].
pub const EXTENDS: Option<&str> = None;
/// 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] = &[
error_codes::NUMBER_MISMATCH,
error_codes::NOT_CLAIMANT,
error_codes::REQUEST_EXPIRED,
error_codes::NOT_AUTHORIZED,
error_codes::RATE_LIMITED,
];
/// One constant per extended error code this specification declares
/// (SPEC §7.3 item 9), named for its local part.
///
/// Emit these rather than a string literal: the code is read from the
/// specification, so it cannot name a code the specification never
/// declared.
pub mod error_codes {
/// `auth/oob/prove:numberMismatch`
///
/// The typed number does not match. The request is declined.
///
/// Declared `retryable: false`.
pub const NUMBER_MISMATCH: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob/prove:numberMismatch",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `auth/oob:notClaimant`
///
/// The prove is not signed by the request's lock key.
///
/// Declared `retryable: false`.
pub const NOT_CLAIMANT: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob:notClaimant",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `auth/oob:requestExpired`
///
/// The decision window has passed, or the request has otherwise ended.
///
/// Declared `retryable: false`.
pub const REQUEST_EXPIRED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob:requestExpired",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `auth/oob:notAuthorized`
///
/// The carried identify failed verification, does not match the request or the lock, or its issuer is not an active member. Deliberately generic. The request is declined.
///
/// Declared `retryable: false`.
pub const NOT_AUTHORIZED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob:notAuthorized",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `auth/oob:rateLimited`
///
/// The approver's network has hit the service's prove limit. `details.retryAfter` MAY give seconds until a retry.
///
/// Declared `retryable: true`.
/// Declares a `detailsSchema` for the error's `details` member.
pub const RATE_LIMITED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob:rateLimited",
retryable: true,
details_schema: ::core::option::Option::Some(
"{\"additionalProperties\":false,\"properties\":{\"retryAfter\":{\"minimum\":0,\"type\":\"integer\"}},\"type\":\"object\"}",
),
};
}