//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vtc/join-requests/wallet-session/status`. 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())
}
}
}
///What a verified wallet presentation established. Never claim values.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Evidence",
/// "description": "What a verified wallet presentation established. Never claim values.",
/// "type": "object",
/// "required": [
/// "credentials",
/// "holder",
/// "satisfied"
/// ],
/// "properties": {
/// "credentials": {
/// "description": "The credentials presented, one entry each.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/PresentedCredential"
/// },
/// "maxItems": 32,
/// "minItems": 1
/// },
/// "heldUntil": {
/// "description": "When evidence not yet recorded on a join request is discarded if the applicant has not submitted under the session's criterion. Absent when the evidence is recorded on a request.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "holder": {
/// "description": "The identifier of the key that held the presented credentials — for an SD-JWT VC, the `did:key` of its `cnf` key. Recorded beside the applicant DID, never as it.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 1
/// },
/// "satisfied": {
/// "description": "Whether the presentation satisfies the criterion's DCQL query. Satisfying the query is not admission: the community still decides the join under the criterion's `admission`.",
/// "type": "boolean"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Evidence {
///The credentials presented, one entry each.
pub credentials: ::std::vec::Vec<PresentedCredential>,
///When evidence not yet recorded on a join request is discarded if the applicant has not submitted under the session's criterion. Absent when the evidence is recorded on a request.
#[serde(
rename = "heldUntil",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub held_until: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
///The identifier of the key that held the presented credentials — for an SD-JWT VC, the `did:key` of its `cnf` key. Recorded beside the applicant DID, never as it.
pub holder: EvidenceHolder,
///Whether the presentation satisfies the criterion's DCQL query. Satisfying the query is not admission: the community still decides the join under the criterion's `admission`.
pub satisfied: bool,
}
impl Evidence {
pub fn builder() -> builder::Evidence {
Default::default()
}
}
///The identifier of the key that held the presented credentials — for an SD-JWT VC, the `did:key` of its `cnf` key. Recorded beside the applicant DID, never as it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The identifier of the key that held the presented credentials — for an SD-JWT VC, the `did:key` of its `cnf` key. Recorded beside the applicant DID, never as it.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct EvidenceHolder(::std::string::String);
impl ::std::ops::Deref for EvidenceHolder {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<EvidenceHolder> for ::std::string::String {
fn from(value: EvidenceHolder) -> Self {
value.0
}
}
impl ::std::str::FromStr for EvidenceHolder {
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() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for EvidenceHolder {
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 EvidenceHolder {
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 EvidenceHolder {
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 EvidenceHolder {
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())
})
}
}
///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())
})
}
}
///An applicant reads the state of a wallet presentation session they opened with vtc/join-requests/wallet-session/start, and, once a wallet has answered, what the presentation established. The applicant is the document proof's signer. The outer document members are owned by the framework — SPEC §6.3.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/vtc/join-requests/wallet-session/status/0.1",
/// "title": "Payload",
/// "description": "An applicant reads the state of a wallet presentation session they opened with vtc/join-requests/wallet-session/start, and, once a wallet has answered, what the presentation established. The applicant is the document proof's signer. The outer document members are owned by the framework — SPEC §6.3.",
/// "type": "object",
/// "required": [
/// "sessionId"
/// ],
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "sessionId": {
/// "description": "The session to read, as vtc/join-requests/wallet-session/start returned it.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 16
/// }
/// },
/// "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 session to read, as vtc/join-requests/wallet-session/start returned it.
#[serde(rename = "sessionId")]
pub session_id: PayloadSessionId,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///The session to read, as vtc/join-requests/wallet-session/start returned it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The session to read, as vtc/join-requests/wallet-session/start returned it.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 16
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadSessionId(::std::string::String);
impl ::std::ops::Deref for PayloadSessionId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadSessionId> for ::std::string::String {
fn from(value: PayloadSessionId) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadSessionId {
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() < 16usize {
return Err("shorter than 16 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadSessionId {
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 PayloadSessionId {
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 PayloadSessionId {
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 PayloadSessionId {
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())
})
}
}
///One credential the wallet presented, described without any of its claim values.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "PresentedCredential",
/// "description": "One credential the wallet presented, described without any of its claim values.",
/// "type": "object",
/// "required": [
/// "credentialQueryId",
/// "format",
/// "issuer"
/// ],
/// "properties": {
/// "credentialQueryId": {
/// "description": "The `id` of the DCQL credential query this credential was presented for — the key it arrived under in the OpenID4VP `vp_token`.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
/// },
/// "format": {
/// "description": "The credential format identifier, as OpenID4VP names it (`dc+sd-jwt`, `mso_mdoc`). Carried verbatim.",
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1
/// },
/// "issuer": {
/// "description": "The identifier of the credential's issuer as the community verified it — a DID, or for an issuer identified by an X.509 certificate, the certificate subject or hash the community's policy names it by.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 1
/// },
/// "vct": {
/// "description": "The SD-JWT VC credential type (`vct`). Present for SD-JWT VC credentials.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 1
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct PresentedCredential {
///The `id` of the DCQL credential query this credential was presented for — the key it arrived under in the OpenID4VP `vp_token`.
#[serde(rename = "credentialQueryId")]
pub credential_query_id: PresentedCredentialCredentialQueryId,
///The credential format identifier, as OpenID4VP names it (`dc+sd-jwt`, `mso_mdoc`). Carried verbatim.
pub format: PresentedCredentialFormat,
///The identifier of the credential's issuer as the community verified it — a DID, or for an issuer identified by an X.509 certificate, the certificate subject or hash the community's policy names it by.
pub issuer: PresentedCredentialIssuer,
///The SD-JWT VC credential type (`vct`). Present for SD-JWT VC credentials.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub vct: ::std::option::Option<PresentedCredentialVct>,
}
impl PresentedCredential {
pub fn builder() -> builder::PresentedCredential {
Default::default()
}
}
///The `id` of the DCQL credential query this credential was presented for — the key it arrived under in the OpenID4VP `vp_token`.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The `id` of the DCQL credential query this credential was presented for — the key it arrived under in the OpenID4VP `vp_token`.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PresentedCredentialCredentialQueryId(::std::string::String);
impl ::std::ops::Deref for PresentedCredentialCredentialQueryId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PresentedCredentialCredentialQueryId> for ::std::string::String {
fn from(value: PresentedCredentialCredentialQueryId) -> Self {
value.0
}
}
impl ::std::str::FromStr for PresentedCredentialCredentialQueryId {
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 PresentedCredentialCredentialQueryId {
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 PresentedCredentialCredentialQueryId {
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 PresentedCredentialCredentialQueryId {
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 PresentedCredentialCredentialQueryId {
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 credential format identifier, as OpenID4VP names it (`dc+sd-jwt`, `mso_mdoc`). Carried verbatim.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The credential format identifier, as OpenID4VP names it (`dc+sd-jwt`, `mso_mdoc`). Carried verbatim.",
/// "type": "string",
/// "maxLength": 64,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PresentedCredentialFormat(::std::string::String);
impl ::std::ops::Deref for PresentedCredentialFormat {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PresentedCredentialFormat> for ::std::string::String {
fn from(value: PresentedCredentialFormat) -> Self {
value.0
}
}
impl ::std::str::FromStr for PresentedCredentialFormat {
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 PresentedCredentialFormat {
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 PresentedCredentialFormat {
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 PresentedCredentialFormat {
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 PresentedCredentialFormat {
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 identifier of the credential's issuer as the community verified it — a DID, or for an issuer identified by an X.509 certificate, the certificate subject or hash the community's policy names it by.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The identifier of the credential's issuer as the community verified it — a DID, or for an issuer identified by an X.509 certificate, the certificate subject or hash the community's policy names it by.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PresentedCredentialIssuer(::std::string::String);
impl ::std::ops::Deref for PresentedCredentialIssuer {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PresentedCredentialIssuer> for ::std::string::String {
fn from(value: PresentedCredentialIssuer) -> Self {
value.0
}
}
impl ::std::str::FromStr for PresentedCredentialIssuer {
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() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PresentedCredentialIssuer {
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 PresentedCredentialIssuer {
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 PresentedCredentialIssuer {
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 PresentedCredentialIssuer {
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 SD-JWT VC credential type (`vct`). Present for SD-JWT VC credentials.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The SD-JWT VC credential type (`vct`). Present for SD-JWT VC credentials.",
/// "type": "string",
/// "maxLength": 2048,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PresentedCredentialVct(::std::string::String);
impl ::std::ops::Deref for PresentedCredentialVct {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PresentedCredentialVct> for ::std::string::String {
fn from(value: PresentedCredentialVct) -> Self {
value.0
}
}
impl ::std::str::FromStr for PresentedCredentialVct {
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() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PresentedCredentialVct {
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 PresentedCredentialVct {
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 PresentedCredentialVct {
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 PresentedCredentialVct {
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())
})
}
}
///`Response`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "type": "object",
/// "required": [
/// "expiresAt",
/// "sessionId",
/// "state"
/// ],
/// "properties": {
/// "evidence": {
/// "description": "Present only when `state` is `presented`.",
/// "$ref": "#/definitions/Evidence"
/// },
/// "expiresAt": {
/// "description": "When the session closes, or closed, if unanswered.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "reason": {
/// "description": "Why the session ended `refused`. `presentationInvalid`: the response or a presentation failed verification — decryption, `state`, signature, key binding, nonce or audience. `queryNotSatisfied`: the presentations verified but do not satisfy the query. `issuerNotTrusted`: a credential's issuer is not one the criterion accepts. `statusNotValid`: a credential's status is revoked or suspended, or could not be read. `walletDeclined`: the wallet answered with an OpenID4VP error, such as `access_denied`. Present only when `state` is `refused`.",
/// "type": "string",
/// "enum": [
/// "presentationInvalid",
/// "queryNotSatisfied",
/// "issuerNotTrusted",
/// "statusNotValid",
/// "walletDeclined"
/// ]
/// },
/// "requestId": {
/// "description": "The join request the session's evidence is recorded on. Present when the session was bound to one, or its evidence has since been attached to one by a submission.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
/// },
/// "sessionId": {
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 16
/// },
/// "state": {
/// "description": "`awaitingWallet`: no wallet has fetched the request object. `requestRetrieved`: a wallet has fetched it and not yet answered. `presented`: a wallet answered and the presentation verified; see `evidence`. `refused`: a wallet answered and the community did not accept the answer, or the wallet declined; see `reason`. `expired`: the session closed unanswered.",
/// "type": "string",
/// "enum": [
/// "awaitingWallet",
/// "requestRetrieved",
/// "presented",
/// "refused",
/// "expired"
/// ]
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
///Present only when `state` is `presented`.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub evidence: ::std::option::Option<Evidence>,
///When the session closes, or closed, if unanswered.
#[serde(rename = "expiresAt")]
pub expires_at: ::chrono::DateTime<::chrono::offset::Utc>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Why the session ended `refused`. `presentationInvalid`: the response or a presentation failed verification — decryption, `state`, signature, key binding, nonce or audience. `queryNotSatisfied`: the presentations verified but do not satisfy the query. `issuerNotTrusted`: a credential's issuer is not one the criterion accepts. `statusNotValid`: a credential's status is revoked or suspended, or could not be read. `walletDeclined`: the wallet answered with an OpenID4VP error, such as `access_denied`. Present only when `state` is `refused`.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub reason: ::std::option::Option<ResponseReason>,
///The join request the session's evidence is recorded on. Present when the session was bound to one, or its evidence has since been attached to one by a submission.
#[serde(
rename = "requestId",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub request_id: ::std::option::Option<ResponseRequestId>,
#[serde(rename = "sessionId")]
pub session_id: ResponseSessionId,
///`awaitingWallet`: no wallet has fetched the request object. `requestRetrieved`: a wallet has fetched it and not yet answered. `presented`: a wallet answered and the presentation verified; see `evidence`. `refused`: a wallet answered and the community did not accept the answer, or the wallet declined; see `reason`. `expired`: the session closed unanswered.
pub state: ResponseState,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///Why the session ended `refused`. `presentationInvalid`: the response or a presentation failed verification — decryption, `state`, signature, key binding, nonce or audience. `queryNotSatisfied`: the presentations verified but do not satisfy the query. `issuerNotTrusted`: a credential's issuer is not one the criterion accepts. `statusNotValid`: a credential's status is revoked or suspended, or could not be read. `walletDeclined`: the wallet answered with an OpenID4VP error, such as `access_denied`. Present only when `state` is `refused`.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Why the session ended `refused`. `presentationInvalid`: the response or a presentation failed verification — decryption, `state`, signature, key binding, nonce or audience. `queryNotSatisfied`: the presentations verified but do not satisfy the query. `issuerNotTrusted`: a credential's issuer is not one the criterion accepts. `statusNotValid`: a credential's status is revoked or suspended, or could not be read. `walletDeclined`: the wallet answered with an OpenID4VP error, such as `access_denied`. Present only when `state` is `refused`.",
/// "type": "string",
/// "enum": [
/// "presentationInvalid",
/// "queryNotSatisfied",
/// "issuerNotTrusted",
/// "statusNotValid",
/// "walletDeclined"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum ResponseReason {
#[serde(rename = "presentationInvalid")]
PresentationInvalid,
#[serde(rename = "queryNotSatisfied")]
QueryNotSatisfied,
#[serde(rename = "issuerNotTrusted")]
IssuerNotTrusted,
#[serde(rename = "statusNotValid")]
StatusNotValid,
#[serde(rename = "walletDeclined")]
WalletDeclined,
}
impl ::std::fmt::Display for ResponseReason {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::PresentationInvalid => f.write_str("presentationInvalid"),
Self::QueryNotSatisfied => f.write_str("queryNotSatisfied"),
Self::IssuerNotTrusted => f.write_str("issuerNotTrusted"),
Self::StatusNotValid => f.write_str("statusNotValid"),
Self::WalletDeclined => f.write_str("walletDeclined"),
}
}
}
impl ::std::str::FromStr for ResponseReason {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"presentationInvalid" => Ok(Self::PresentationInvalid),
"queryNotSatisfied" => Ok(Self::QueryNotSatisfied),
"issuerNotTrusted" => Ok(Self::IssuerNotTrusted),
"statusNotValid" => Ok(Self::StatusNotValid),
"walletDeclined" => Ok(Self::WalletDeclined),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for ResponseReason {
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 ResponseReason {
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 ResponseReason {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///The join request the session's evidence is recorded on. Present when the session was bound to one, or its evidence has since been attached to one by a submission.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The join request the session's evidence is recorded on. Present when the session was bound to one, or its evidence has since been attached to one by a submission.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseRequestId(::std::string::String);
impl ::std::ops::Deref for ResponseRequestId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseRequestId> for ::std::string::String {
fn from(value: ResponseRequestId) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseRequestId {
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 ResponseRequestId {
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 ResponseRequestId {
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 ResponseRequestId {
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 ResponseRequestId {
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())
})
}
}
///`ResponseSessionId`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 16
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseSessionId(::std::string::String);
impl ::std::ops::Deref for ResponseSessionId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseSessionId> for ::std::string::String {
fn from(value: ResponseSessionId) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseSessionId {
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() < 16usize {
return Err("shorter than 16 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseSessionId {
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 ResponseSessionId {
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 ResponseSessionId {
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 ResponseSessionId {
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())
})
}
}
///`awaitingWallet`: no wallet has fetched the request object. `requestRetrieved`: a wallet has fetched it and not yet answered. `presented`: a wallet answered and the presentation verified; see `evidence`. `refused`: a wallet answered and the community did not accept the answer, or the wallet declined; see `reason`. `expired`: the session closed unanswered.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "`awaitingWallet`: no wallet has fetched the request object. `requestRetrieved`: a wallet has fetched it and not yet answered. `presented`: a wallet answered and the presentation verified; see `evidence`. `refused`: a wallet answered and the community did not accept the answer, or the wallet declined; see `reason`. `expired`: the session closed unanswered.",
/// "type": "string",
/// "enum": [
/// "awaitingWallet",
/// "requestRetrieved",
/// "presented",
/// "refused",
/// "expired"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum ResponseState {
#[serde(rename = "awaitingWallet")]
AwaitingWallet,
#[serde(rename = "requestRetrieved")]
RequestRetrieved,
#[serde(rename = "presented")]
Presented,
#[serde(rename = "refused")]
Refused,
#[serde(rename = "expired")]
Expired,
}
impl ::std::fmt::Display for ResponseState {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::AwaitingWallet => f.write_str("awaitingWallet"),
Self::RequestRetrieved => f.write_str("requestRetrieved"),
Self::Presented => f.write_str("presented"),
Self::Refused => f.write_str("refused"),
Self::Expired => f.write_str("expired"),
}
}
}
impl ::std::str::FromStr for ResponseState {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"awaitingWallet" => Ok(Self::AwaitingWallet),
"requestRetrieved" => Ok(Self::RequestRetrieved),
"presented" => Ok(Self::Presented),
"refused" => Ok(Self::Refused),
"expired" => Ok(Self::Expired),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for ResponseState {
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 ResponseState {
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 ResponseState {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct Evidence {
credentials: ::std::result::Result<
::std::vec::Vec<super::PresentedCredential>,
::std::string::String,
>,
held_until: ::std::result::Result<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
::std::string::String,
>,
holder: ::std::result::Result<super::EvidenceHolder, ::std::string::String>,
satisfied: ::std::result::Result<bool, ::std::string::String>,
}
impl ::std::default::Default for Evidence {
fn default() -> Self {
Self {
credentials: Err("no value supplied for credentials".to_string()),
held_until: Ok(Default::default()),
holder: Err("no value supplied for holder".to_string()),
satisfied: Err("no value supplied for satisfied".to_string()),
}
}
}
impl Evidence {
pub fn credentials<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::PresentedCredential>>,
T::Error: ::std::fmt::Display,
{
self.credentials = value
.try_into()
.map_err(|e| format!("error converting supplied value for credentials: {e}"));
self
}
pub fn held_until<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
>,
T::Error: ::std::fmt::Display,
{
self.held_until = value
.try_into()
.map_err(|e| format!("error converting supplied value for held_until: {e}"));
self
}
pub fn holder<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::EvidenceHolder>,
T::Error: ::std::fmt::Display,
{
self.holder = value
.try_into()
.map_err(|e| format!("error converting supplied value for holder: {e}"));
self
}
pub fn satisfied<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.satisfied = value
.try_into()
.map_err(|e| format!("error converting supplied value for satisfied: {e}"));
self
}
}
impl ::std::convert::TryFrom<Evidence> for super::Evidence {
type Error = super::error::ConversionError;
fn try_from(value: Evidence) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
credentials: value.credentials?,
held_until: value.held_until?,
holder: value.holder?,
satisfied: value.satisfied?,
})
}
}
impl ::std::convert::From<super::Evidence> for Evidence {
fn from(value: super::Evidence) -> Self {
Self {
credentials: Ok(value.credentials),
held_until: Ok(value.held_until),
holder: Ok(value.holder),
satisfied: Ok(value.satisfied),
}
}
}
#[derive(Clone, Debug)]
pub struct Payload {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
session_id: ::std::result::Result<super::PayloadSessionId, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
session_id: Err("no value supplied for session_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 session_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PayloadSessionId>,
T::Error: ::std::fmt::Display,
{
self.session_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for session_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?,
session_id: value.session_id?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
ext: Ok(value.ext),
session_id: Ok(value.session_id),
}
}
}
#[derive(Clone, Debug)]
pub struct PresentedCredential {
credential_query_id: ::std::result::Result<
super::PresentedCredentialCredentialQueryId,
::std::string::String,
>,
format: ::std::result::Result<super::PresentedCredentialFormat, ::std::string::String>,
issuer: ::std::result::Result<super::PresentedCredentialIssuer, ::std::string::String>,
vct: ::std::result::Result<
::std::option::Option<super::PresentedCredentialVct>,
::std::string::String,
>,
}
impl ::std::default::Default for PresentedCredential {
fn default() -> Self {
Self {
credential_query_id: Err("no value supplied for credential_query_id".to_string()),
format: Err("no value supplied for format".to_string()),
issuer: Err("no value supplied for issuer".to_string()),
vct: Ok(Default::default()),
}
}
}
impl PresentedCredential {
pub fn credential_query_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PresentedCredentialCredentialQueryId>,
T::Error: ::std::fmt::Display,
{
self.credential_query_id = value.try_into().map_err(|e| {
format!("error converting supplied value for credential_query_id: {e}")
});
self
}
pub fn format<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PresentedCredentialFormat>,
T::Error: ::std::fmt::Display,
{
self.format = value
.try_into()
.map_err(|e| format!("error converting supplied value for format: {e}"));
self
}
pub fn issuer<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PresentedCredentialIssuer>,
T::Error: ::std::fmt::Display,
{
self.issuer = value
.try_into()
.map_err(|e| format!("error converting supplied value for issuer: {e}"));
self
}
pub fn vct<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PresentedCredentialVct>>,
T::Error: ::std::fmt::Display,
{
self.vct = value
.try_into()
.map_err(|e| format!("error converting supplied value for vct: {e}"));
self
}
}
impl ::std::convert::TryFrom<PresentedCredential> for super::PresentedCredential {
type Error = super::error::ConversionError;
fn try_from(
value: PresentedCredential,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
credential_query_id: value.credential_query_id?,
format: value.format?,
issuer: value.issuer?,
vct: value.vct?,
})
}
}
impl ::std::convert::From<super::PresentedCredential> for PresentedCredential {
fn from(value: super::PresentedCredential) -> Self {
Self {
credential_query_id: Ok(value.credential_query_id),
format: Ok(value.format),
issuer: Ok(value.issuer),
vct: Ok(value.vct),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
evidence:
::std::result::Result<::std::option::Option<super::Evidence>, ::std::string::String>,
expires_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
reason: ::std::result::Result<
::std::option::Option<super::ResponseReason>,
::std::string::String,
>,
request_id: ::std::result::Result<
::std::option::Option<super::ResponseRequestId>,
::std::string::String,
>,
session_id: ::std::result::Result<super::ResponseSessionId, ::std::string::String>,
state: ::std::result::Result<super::ResponseState, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
evidence: Ok(Default::default()),
expires_at: Err("no value supplied for expires_at".to_string()),
ext: Ok(Default::default()),
reason: Ok(Default::default()),
request_id: Ok(Default::default()),
session_id: Err("no value supplied for session_id".to_string()),
state: Err("no value supplied for state".to_string()),
}
}
}
impl Response {
pub fn evidence<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Evidence>>,
T::Error: ::std::fmt::Display,
{
self.evidence = value
.try_into()
.map_err(|e| format!("error converting supplied value for evidence: {e}"));
self
}
pub fn expires_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.expires_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for expires_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 reason<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::ResponseReason>>,
T::Error: ::std::fmt::Display,
{
self.reason = value
.try_into()
.map_err(|e| format!("error converting supplied value for reason: {e}"));
self
}
pub fn request_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::ResponseRequestId>>,
T::Error: ::std::fmt::Display,
{
self.request_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for request_id: {e}"));
self
}
pub fn session_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseSessionId>,
T::Error: ::std::fmt::Display,
{
self.session_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for session_id: {e}"));
self
}
pub fn state<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseState>,
T::Error: ::std::fmt::Display,
{
self.state = value
.try_into()
.map_err(|e| format!("error converting supplied value for state: {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 {
evidence: value.evidence?,
expires_at: value.expires_at?,
ext: value.ext?,
reason: value.reason?,
request_id: value.request_id?,
session_id: value.session_id?,
state: value.state?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
evidence: Ok(value.evidence),
expires_at: Ok(value.expires_at),
ext: Ok(value.ext),
reason: Ok(value.reason),
request_id: Ok(value.request_id),
session_id: Ok(value.session_id),
state: Ok(value.state),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/vtc/join-requests/wallet-session/status/0.1";
const IS_PROOF_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"Evidence\": {\n \"additionalProperties\": false,\n \"description\": \"What a verified wallet presentation established. Never claim values.\",\n \"properties\": {\n \"credentials\": {\n \"description\": \"The credentials presented, one entry each.\",\n \"items\": {\n \"$ref\": \"#/$defs/PresentedCredential\"\n },\n \"maxItems\": 32,\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"heldUntil\": {\n \"description\": \"When evidence not yet recorded on a join request is discarded if the applicant has not submitted under the session's criterion. Absent when the evidence is recorded on a request.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"holder\": {\n \"description\": \"The identifier of the key that held the presented credentials — for an SD-JWT VC, the `did:key` of its `cnf` key. Recorded beside the applicant DID, never as it.\",\n \"maxLength\": 2048,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"satisfied\": {\n \"description\": \"Whether the presentation satisfies the criterion's DCQL query. Satisfying the query is not admission: the community still decides the join under the criterion's `admission`.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"satisfied\",\n \"holder\",\n \"credentials\"\n ],\n \"title\": \"Evidence\",\n \"type\": \"object\"\n },\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 \"PresentedCredential\": {\n \"additionalProperties\": false,\n \"description\": \"One credential the wallet presented, described without any of its claim values.\",\n \"properties\": {\n \"credentialQueryId\": {\n \"description\": \"The `id` of the DCQL credential query this credential was presented for — the key it arrived under in the OpenID4VP `vp_token`.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"format\": {\n \"description\": \"The credential format identifier, as OpenID4VP names it (`dc+sd-jwt`, `mso_mdoc`). Carried verbatim.\",\n \"maxLength\": 64,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"issuer\": {\n \"description\": \"The identifier of the credential's issuer as the community verified it — a DID, or for an issuer identified by an X.509 certificate, the certificate subject or hash the community's policy names it by.\",\n \"maxLength\": 2048,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"vct\": {\n \"description\": \"The SD-JWT VC credential type (`vct`). Present for SD-JWT VC credentials.\",\n \"maxLength\": 2048,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"credentialQueryId\",\n \"format\",\n \"issuer\"\n ],\n \"title\": \"PresentedCredential\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"properties\": {\n \"evidence\": {\n \"$ref\": \"#/$defs/Evidence\",\n \"description\": \"Present only when `state` is `presented`.\"\n },\n \"expiresAt\": {\n \"description\": \"When the session closes, or closed, if unanswered.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"reason\": {\n \"description\": \"Why the session ended `refused`. `presentationInvalid`: the response or a presentation failed verification — decryption, `state`, signature, key binding, nonce or audience. `queryNotSatisfied`: the presentations verified but do not satisfy the query. `issuerNotTrusted`: a credential's issuer is not one the criterion accepts. `statusNotValid`: a credential's status is revoked or suspended, or could not be read. `walletDeclined`: the wallet answered with an OpenID4VP error, such as `access_denied`. Present only when `state` is `refused`.\",\n \"enum\": [\n \"presentationInvalid\",\n \"queryNotSatisfied\",\n \"issuerNotTrusted\",\n \"statusNotValid\",\n \"walletDeclined\"\n ],\n \"type\": \"string\"\n },\n \"requestId\": {\n \"description\": \"The join request the session's evidence is recorded on. Present when the session was bound to one, or its evidence has since been attached to one by a submission.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"sessionId\": {\n \"maxLength\": 128,\n \"minLength\": 16,\n \"type\": \"string\"\n },\n \"state\": {\n \"description\": \"`awaitingWallet`: no wallet has fetched the request object. `requestRetrieved`: a wallet has fetched it and not yet answered. `presented`: a wallet answered and the presentation verified; see `evidence`. `refused`: a wallet answered and the community did not accept the answer, or the wallet declined; see `reason`. `expired`: the session closed unanswered.\",\n \"enum\": [\n \"awaitingWallet\",\n \"requestRetrieved\",\n \"presented\",\n \"refused\",\n \"expired\"\n ],\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"sessionId\",\n \"state\",\n \"expiresAt\"\n ],\n \"title\": \"VTC Join-Requests Wallet Session Status — response payload\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/vtc/join-requests/wallet-session/status/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"An applicant reads the state of a wallet presentation session they opened with vtc/join-requests/wallet-session/start, and, once a wallet has answered, what the presentation established. The applicant is the document proof's signer. The outer document members are owned by the framework — SPEC §6.3.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"sessionId\": {\n \"description\": \"The session to read, as vtc/join-requests/wallet-session/start returned it.\",\n \"maxLength\": 128,\n \"minLength\": 16,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"sessionId\"\n ],\n \"title\": \"VTC Join-Requests Wallet Session Status — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/vtc/join-requests/wallet-session/status/0.1#response";
const IS_PROOF_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"Evidence\": {\n \"additionalProperties\": false,\n \"description\": \"What a verified wallet presentation established. Never claim values.\",\n \"properties\": {\n \"credentials\": {\n \"description\": \"The credentials presented, one entry each.\",\n \"items\": {\n \"$ref\": \"#/$defs/PresentedCredential\"\n },\n \"maxItems\": 32,\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"heldUntil\": {\n \"description\": \"When evidence not yet recorded on a join request is discarded if the applicant has not submitted under the session's criterion. Absent when the evidence is recorded on a request.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"holder\": {\n \"description\": \"The identifier of the key that held the presented credentials — for an SD-JWT VC, the `did:key` of its `cnf` key. Recorded beside the applicant DID, never as it.\",\n \"maxLength\": 2048,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"satisfied\": {\n \"description\": \"Whether the presentation satisfies the criterion's DCQL query. Satisfying the query is not admission: the community still decides the join under the criterion's `admission`.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"satisfied\",\n \"holder\",\n \"credentials\"\n ],\n \"title\": \"Evidence\",\n \"type\": \"object\"\n },\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 \"PresentedCredential\": {\n \"additionalProperties\": false,\n \"description\": \"One credential the wallet presented, described without any of its claim values.\",\n \"properties\": {\n \"credentialQueryId\": {\n \"description\": \"The `id` of the DCQL credential query this credential was presented for — the key it arrived under in the OpenID4VP `vp_token`.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"format\": {\n \"description\": \"The credential format identifier, as OpenID4VP names it (`dc+sd-jwt`, `mso_mdoc`). Carried verbatim.\",\n \"maxLength\": 64,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"issuer\": {\n \"description\": \"The identifier of the credential's issuer as the community verified it — a DID, or for an issuer identified by an X.509 certificate, the certificate subject or hash the community's policy names it by.\",\n \"maxLength\": 2048,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"vct\": {\n \"description\": \"The SD-JWT VC credential type (`vct`). Present for SD-JWT VC credentials.\",\n \"maxLength\": 2048,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"credentialQueryId\",\n \"format\",\n \"issuer\"\n ],\n \"title\": \"PresentedCredential\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"properties\": {\n \"evidence\": {\n \"$ref\": \"#/$defs/Evidence\",\n \"description\": \"Present only when `state` is `presented`.\"\n },\n \"expiresAt\": {\n \"description\": \"When the session closes, or closed, if unanswered.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"reason\": {\n \"description\": \"Why the session ended `refused`. `presentationInvalid`: the response or a presentation failed verification — decryption, `state`, signature, key binding, nonce or audience. `queryNotSatisfied`: the presentations verified but do not satisfy the query. `issuerNotTrusted`: a credential's issuer is not one the criterion accepts. `statusNotValid`: a credential's status is revoked or suspended, or could not be read. `walletDeclined`: the wallet answered with an OpenID4VP error, such as `access_denied`. Present only when `state` is `refused`.\",\n \"enum\": [\n \"presentationInvalid\",\n \"queryNotSatisfied\",\n \"issuerNotTrusted\",\n \"statusNotValid\",\n \"walletDeclined\"\n ],\n \"type\": \"string\"\n },\n \"requestId\": {\n \"description\": \"The join request the session's evidence is recorded on. Present when the session was bound to one, or its evidence has since been attached to one by a submission.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"sessionId\": {\n \"maxLength\": 128,\n \"minLength\": 16,\n \"type\": \"string\"\n },\n \"state\": {\n \"description\": \"`awaitingWallet`: no wallet has fetched the request object. `requestRetrieved`: a wallet has fetched it and not yet answered. `presented`: a wallet answered and the presentation verified; see `evidence`. `refused`: a wallet answered and the community did not accept the answer, or the wallet declined; see `reason`. `expired`: the session closed unanswered.\",\n \"enum\": [\n \"awaitingWallet\",\n \"requestRetrieved\",\n \"presented\",\n \"refused\",\n \"expired\"\n ],\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"sessionId\",\n \"state\",\n \"expiresAt\"\n ],\n \"title\": \"VTC Join-Requests Wallet Session Status — response payload\",\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::NOT_FOUND];
/// 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 {
/// `vtc/join-requests/wallet-session/status:notFound`
///
/// No session with the supplied `sessionId` exists, or it was not opened by the proof signer. The same code for both.
///
/// Declared `retryable: false`.
pub const NOT_FOUND: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vtc/join-requests/wallet-session/status:notFound",
retryable: false,
details_schema: ::core::option::Option::None,
};
}