//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `auth/oob/claim`. Version: `0.1`.
#[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.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ext",
/// "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.",
/// "type": "object",
/// "minProperties": 1,
/// "additionalProperties": true,
/// "propertyNames": {
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
/// }
///}
/// ```
/// </details>
#[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`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
///}
/// ```
/// </details>
#[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 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())
})
}
}
///An approver claims a pending out-of-band request, locking it to a throwaway Ed25519 key (`K_a`) generated for this one exchange. The document is the first request of a trigger-link exchange (VTI-LNK-054): issued and signed by `K_a`, addressed to the service, and carrying the request's handle both here and as the envelope's `parentThreadId`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, parentThreadId, proof) are owned by the framework — SPEC §6.3.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/auth/oob/claim/0.1",
/// "title": "Payload",
/// "description": "An approver claims a pending out-of-band request, locking it to a throwaway Ed25519 key (`K_a`) generated for this one exchange. The document is the first request of a trigger-link exchange (VTI-LNK-054): issued and signed by `K_a`, addressed to the service, and carrying the request's handle both here and as the envelope's `parentThreadId`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, parentThreadId, proof) are owned by the framework — SPEC §6.3.",
/// "type": "object",
/// "required": [
/// "requestId"
/// ],
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "requestId": {
/// "description": "The handle read from the trigger link's `_id`. MUST equal the document's `parentThreadId`.",
/// "$ref": "#/definitions/RequestId"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[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>,
///The handle read from the trigger link's `_id`. MUST equal the document's `parentThreadId`.
#[serde(rename = "requestId")]
pub request_id: RequestId,
}
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.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "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.",
/// "type": "string",
/// "enum": [
/// "login"
/// ]
///}
/// ```
/// </details>
#[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.
///
/// <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())
})
}
}
///Step 1 of the disclosure ladder, signed by the service's assertionMethod key: who the service is, where the request will be used and for what, and when the decision window closes. It MUST contain nothing about the starter.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "Step 1 of the disclosure ladder, signed by the service's assertionMethod key: who the service is, where the request will be used and for what, and when the decision window closes. It MUST contain nothing about the starter.",
/// "type": "object",
/// "required": [
/// "decisionDeadline",
/// "origin",
/// "purpose",
/// "requestId",
/// "service"
/// ],
/// "properties": {
/// "decisionDeadline": {
/// "description": "When the decision window, started by the claim, closes, as integer UTC epoch seconds. Prove, respond and redeem must all complete before it. At most 180 s after the claim; 120 s RECOMMENDED.",
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "origin": {
/// "$ref": "#/definitions/Origin"
/// },
/// "purpose": {
/// "$ref": "#/definitions/Purpose"
/// },
/// "requestId": {
/// "$ref": "#/definitions/RequestId"
/// },
/// "service": {
/// "$ref": "#/definitions/Service"
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
///When the decision window, started by the claim, closes, as integer UTC epoch seconds. Prove, respond and redeem must all complete before it. At most 180 s after the claim; 120 s RECOMMENDED.
#[serde(rename = "decisionDeadline")]
pub decision_deadline: u64,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
pub origin: Origin,
pub purpose: Purpose,
#[serde(rename = "requestId")]
pub request_id: RequestId,
pub service: Service,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///Who the service says it is.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Service",
/// "description": "Who the service says it is.",
/// "type": "object",
/// "required": [
/// "did",
/// "name"
/// ],
/// "properties": {
/// "did": {
/// "description": "The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 5,
/// "pattern": "^did:"
/// },
/// "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.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[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.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 5,
/// "pattern": "^did:"
///}
/// ```
/// </details>
#[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.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "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.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
///}
/// ```
/// </details>
#[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())
})
}
}
/// 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>,
request_id: ::std::result::Result<super::RequestId, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
request_id: Err("no value supplied for request_id".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 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
}
}
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?,
request_id: value.request_id?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
ext: Ok(value.ext),
request_id: Ok(value.request_id),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
decision_deadline: ::std::result::Result<u64, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::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>,
service: ::std::result::Result<super::Service, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
decision_deadline: Err("no value supplied for decision_deadline".to_string()),
ext: Ok(Default::default()),
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()),
service: Err("no value supplied for service".to_string()),
}
}
}
impl Response {
pub fn decision_deadline<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<u64>,
T::Error: ::std::fmt::Display,
{
self.decision_deadline = value
.try_into()
.map_err(|e| format!("error converting supplied value for decision_deadline: {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 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 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
}
}
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_deadline: value.decision_deadline?,
ext: value.ext?,
origin: value.origin?,
purpose: value.purpose?,
request_id: value.request_id?,
service: value.service?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
decision_deadline: Ok(value.decision_deadline),
ext: Ok(value.ext),
origin: Ok(value.origin),
purpose: Ok(value.purpose),
request_id: Ok(value.request_id),
service: Ok(value.service),
}
}
}
#[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/claim/0.1";
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 \"Ext\": {\n \"additionalProperties\": true,\n \"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.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\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 \"Purpose\": {\n \"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.\",\n \"enum\": [\n \"login\"\n ],\n \"title\": \"Purpose\",\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 \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Step 1 of the disclosure ladder, signed by the service's assertionMethod key: who the service is, where the request will be used and for what, and when the decision window closes. It MUST contain nothing about the starter.\",\n \"properties\": {\n \"decisionDeadline\": {\n \"description\": \"When the decision window, started by the claim, closes, as integer UTC epoch seconds. Prove, respond and redeem must all complete before it. At most 180 s after the claim; 120 s RECOMMENDED.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"origin\": {\n \"$ref\": \"#/$defs/Origin\"\n },\n \"purpose\": {\n \"$ref\": \"#/$defs/Purpose\"\n },\n \"requestId\": {\n \"$ref\": \"#/$defs/RequestId\"\n },\n \"service\": {\n \"$ref\": \"#/$defs/Service\"\n }\n },\n \"required\": [\n \"requestId\",\n \"service\",\n \"origin\",\n \"purpose\",\n \"decisionDeadline\"\n ],\n \"title\": \"Auth — OOB Claim — response payload (step 1)\",\n \"type\": \"object\"\n },\n \"Service\": {\n \"additionalProperties\": false,\n \"description\": \"Who the service says it is.\",\n \"properties\": {\n \"did\": {\n \"description\": \"The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.\",\n \"maxLength\": 2048,\n \"minLength\": 5,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"name\": {\n \"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.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"did\",\n \"name\"\n ],\n \"title\": \"Service\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/auth/oob/claim/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"An approver claims a pending out-of-band request, locking it to a throwaway Ed25519 key (`K_a`) generated for this one exchange. The document is the first request of a trigger-link exchange (VTI-LNK-054): issued and signed by `K_a`, addressed to the service, and carrying the request's handle both here and as the envelope's `parentThreadId`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, parentThreadId, proof) are owned by the framework — SPEC §6.3.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"requestId\": {\n \"$ref\": \"#/$defs/RequestId\",\n \"description\": \"The handle read from the trigger link's `_id`. MUST equal the document's `parentThreadId`.\"\n }\n },\n \"required\": [\n \"requestId\"\n ],\n \"title\": \"Auth — OOB Claim — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/auth/oob/claim/0.1#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(
"{\n \"$defs\": {\n \"Ext\": {\n \"additionalProperties\": true,\n \"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.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\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 \"Purpose\": {\n \"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.\",\n \"enum\": [\n \"login\"\n ],\n \"title\": \"Purpose\",\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 \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Step 1 of the disclosure ladder, signed by the service's assertionMethod key: who the service is, where the request will be used and for what, and when the decision window closes. It MUST contain nothing about the starter.\",\n \"properties\": {\n \"decisionDeadline\": {\n \"description\": \"When the decision window, started by the claim, closes, as integer UTC epoch seconds. Prove, respond and redeem must all complete before it. At most 180 s after the claim; 120 s RECOMMENDED.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"origin\": {\n \"$ref\": \"#/$defs/Origin\"\n },\n \"purpose\": {\n \"$ref\": \"#/$defs/Purpose\"\n },\n \"requestId\": {\n \"$ref\": \"#/$defs/RequestId\"\n },\n \"service\": {\n \"$ref\": \"#/$defs/Service\"\n }\n },\n \"required\": [\n \"requestId\",\n \"service\",\n \"origin\",\n \"purpose\",\n \"decisionDeadline\"\n ],\n \"title\": \"Auth — OOB Claim — response payload (step 1)\",\n \"type\": \"object\"\n },\n \"Service\": {\n \"additionalProperties\": false,\n \"description\": \"Who the service says it is.\",\n \"properties\": {\n \"did\": {\n \"description\": \"The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link.\",\n \"maxLength\": 2048,\n \"minLength\": 5,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"name\": {\n \"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.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"did\",\n \"name\"\n ],\n \"title\": \"Service\",\n \"type\": \"object\"\n }\n },\n \"$ref\": \"#/$defs/Response\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\"\n}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
/// 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::ALREADY_CLAIMED,
error_codes::REQUEST_NOT_FOUND,
error_codes::REQUEST_EXPIRED,
error_codes::KEY_UNSUPPORTED,
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/claim:alreadyClaimed`
///
/// The request has already been claimed by another key. Carries no details, so a second scanner learns nothing about the first.
///
/// Declared `retryable: false`.
pub const ALREADY_CLAIMED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob/claim:alreadyClaimed",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `auth/oob:requestNotFound`
///
/// No request has this `requestId`.
///
/// Declared `retryable: false`.
pub const REQUEST_NOT_FOUND: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob:requestNotFound",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `auth/oob:requestExpired`
///
/// The request's claim 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:keyUnsupported`
///
/// The document's issuer is not an Ed25519 `did:key`.
///
/// Declared `retryable: false`.
pub const KEY_UNSUPPORTED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "auth/oob:keyUnsupported",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `auth/oob:rateLimited`
///
/// The approver's network has hit the service's claim 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\"}",
),
};
}