@openvtc/trust-tasks 0.25.2 → 0.26.1

package/src/vtc/oid4vp/identities/list/0.1/payload.ts

@@ -0,0 +1,706 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/oid4vp/identities/list/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * An administrator reads the OpenID4VP verifier identities the community holds — the identities it presents to wallets that speak OpenID4VP and no Trust Task protocol — and, for each, whether it can open a presentation session now and what stands in the way. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCOpenID4VPVerifierIdentitiesListPayload {
+  ext?: Ext;
+}
+export interface VTCOpenID4VPVerifierIdentitiesListResponsePayload {
+  /**
+   * Every verifier identity the community holds, by `id`. Empty when it holds none.
+   */
+  identities: Identity[];
+  /**
+   * The identity the community is configured to use when a session names no client identifier prefix; null when none is configured, and the first usable identity is used.
+   */
+  defaultIdentity?: string | null;
+  /**
+   * What is wrong with the community's verifier as a whole, rather than with one identity. Empty when nothing is.
+   */
+  problems: Problem[];
+  ext?: Ext;
+}
+/**
+ * One verifier identity, described by what is public about it. The signing key's private half, and where a remote custodian keeps it, are never returned.
+ */
+export interface Identity {
+  /**
+   * The administrator's name for the identity.
+   */
+  id: string;
+  /**
+   * The wallet ecosystem it is known to: `swiyu` (a DID registered in the swiyu Base Registry) or `eudi` (an X.509 access certificate).
+   */
+  kind: "swiyu" | "eudi";
+  /**
+   * The OpenID4VP client identifier wallets see, prefix included. Null while an `eudi` identity has no certificate.
+   */
+  clientId?: string | null;
+  /**
+   * The identity's DID, for a `swiyu` identity.
+   */
+  did?: string | null;
+  /**
+   * The verification method that signs request objects, for an identity known by a DID.
+   */
+  keyId?: string | null;
+  /**
+   * Where the signing key is: `cached` by the community, kept by its `agent` (which signs every request object), or `invalid` when the record names neither or both.
+   */
+  custody: "cached" | "agent" | "invalid";
+  /**
+   * Whether a session could be opened on this identity now: true exactly when no `error` problem applies to it, and none other than `defaultIdentityNotInstalled` applies to the community's verifier as a whole.
+   */
+  usable: boolean;
+  /**
+   * Whether a session that names no client identifier prefix uses this identity.
+   */
+  isDefault: boolean;
+  certificate?: Certificate;
+  /**
+   * What every request object carries in `verifier_info`, in the order it carries them. Empty when it carries none.
+   */
+  attestations: Attestation[];
+  /**
+   * What is wrong with this identity. Empty when nothing is.
+   */
+  problems: Problem[];
+  installedAt: string;
+}
+/**
+ * The access certificate, for an `eudi` identity that has one.
+ */
+export interface Certificate {
+  /**
+   * The leaf's subject distinguished name, as RFC 4514 renders it.
+   */
+  subject?: string;
+  /**
+   * The leaf's issuer distinguished name, as RFC 4514 renders it.
+   */
+  issuer?: string;
+  notBefore: string;
+  notAfter: string;
+  /**
+   * Certificates in the chain, leaf included.
+   */
+  chainLength: number;
+}
+/**
+ * One attestation about the verifier that every request object carries in `verifier_info`.
+ */
+export interface Attestation {
+  /**
+   * Which attestation it is, as tabled in the specification.
+   */
+  kind: "identityTrustStatement" | "protectedVerificationAuthorization" | "registrationCertificate" | "other";
+  /**
+   * When it expires, if it says; null when it carries no expiry the maintainer reads.
+   */
+  expiresAt?: string | null;
+}
+/**
+ * One thing that stops, or will soon stop, a verifier identity or the community's verifier as a whole from serving wallets.
+ */
+export interface Problem {
+  /**
+   * What is wrong, as tabled in the specification.
+   */
+  code:
+    | "keyCustodyInvalid"
+    | "signerNotLoaded"
+    | "agentLinkMissing"
+    | "certificateMissing"
+    | "certificateNotYetValid"
+    | "certificateExpired"
+    | "certificateExpiresSoon"
+    | "identityStatementMissing"
+    | "statementExpired"
+    | "statementExpiresSoon"
+    | "defaultIdentityNotInstalled"
+    | "noPublicUrl";
+  /**
+   * `error`: sessions are refused, or wallets will refuse what the community sends, until it is fixed. `warning`: it works now and will not for long.
+   */
+  severity: "error" | "warning";
+  /**
+   * Maintainer-authored prose for the administrator — what to run to fix it. Never parsed.
+   */
+  detail?: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/oid4vp/identities/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCOpenID4VPVerifierIdentitiesListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/oid4vp/identities/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCOpenID4VPVerifierIdentitiesListResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vtc/oid4vp/identities/list/0.1",
+  "title": "VTC OpenID4VP Verifier Identities List — payload",
+  "description": "An administrator reads the OpenID4VP verifier identities the community holds — the identities it presents to wallets that speak OpenID4VP and no Trust Task protocol — and, for each, whether it can open a presentation session now and what stands in the way. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Problem": {
+      "title": "Problem",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One thing that stops, or will soon stop, a verifier identity or the community's verifier as a whole from serving wallets.",
+      "required": [
+        "code",
+        "severity"
+      ],
+      "properties": {
+        "code": {
+          "type": "string",
+          "enum": [
+            "keyCustodyInvalid",
+            "signerNotLoaded",
+            "agentLinkMissing",
+            "certificateMissing",
+            "certificateNotYetValid",
+            "certificateExpired",
+            "certificateExpiresSoon",
+            "identityStatementMissing",
+            "statementExpired",
+            "statementExpiresSoon",
+            "defaultIdentityNotInstalled",
+            "noPublicUrl"
+          ],
+          "description": "What is wrong, as tabled in the specification."
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning"
+          ],
+          "description": "`error`: sessions are refused, or wallets will refuse what the community sends, until it is fixed. `warning`: it works now and will not for long."
+        },
+        "detail": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Maintainer-authored prose for the administrator — what to run to fix it. Never parsed."
+        }
+      }
+    },
+    "Certificate": {
+      "title": "Certificate",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "An X.509-identified verifier's access certificate: the leaf of the chain it sends wallets as `x5c`.",
+      "required": [
+        "notBefore",
+        "notAfter",
+        "chainLength"
+      ],
+      "properties": {
+        "subject": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "The leaf's subject distinguished name, as RFC 4514 renders it."
+        },
+        "issuer": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "The leaf's issuer distinguished name, as RFC 4514 renders it."
+        },
+        "notBefore": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "notAfter": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "chainLength": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Certificates in the chain, leaf included."
+        }
+      }
+    },
+    "Attestation": {
+      "title": "Attestation",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One attestation about the verifier that every request object carries in `verifier_info`.",
+      "required": [
+        "kind"
+      ],
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "identityTrustStatement",
+            "protectedVerificationAuthorization",
+            "registrationCertificate",
+            "other"
+          ],
+          "description": "Which attestation it is, as tabled in the specification."
+        },
+        "expiresAt": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time",
+          "description": "When it expires, if it says; null when it carries no expiry the maintainer reads."
+        }
+      }
+    },
+    "Identity": {
+      "title": "Identity",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One verifier identity, described by what is public about it. The signing key's private half, and where a remote custodian keeps it, are never returned.",
+      "required": [
+        "id",
+        "kind",
+        "custody",
+        "usable",
+        "isDefault",
+        "attestations",
+        "problems",
+        "installedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The administrator's name for the identity."
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "swiyu",
+            "eudi"
+          ],
+          "description": "The wallet ecosystem it is known to: `swiyu` (a DID registered in the swiyu Base Registry) or `eudi` (an X.509 access certificate)."
+        },
+        "clientId": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The OpenID4VP client identifier wallets see, prefix included. Null while an `eudi` identity has no certificate."
+        },
+        "did": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The identity's DID, for a `swiyu` identity."
+        },
+        "keyId": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The verification method that signs request objects, for an identity known by a DID."
+        },
+        "custody": {
+          "type": "string",
+          "enum": [
+            "cached",
+            "agent",
+            "invalid"
+          ],
+          "description": "Where the signing key is: `cached` by the community, kept by its `agent` (which signs every request object), or `invalid` when the record names neither or both."
+        },
+        "usable": {
+          "type": "boolean",
+          "description": "Whether a session could be opened on this identity now: true exactly when no `error` problem applies to it, and none other than `defaultIdentityNotInstalled` applies to the community's verifier as a whole."
+        },
+        "isDefault": {
+          "type": "boolean",
+          "description": "Whether a session that names no client identifier prefix uses this identity."
+        },
+        "certificate": {
+          "$ref": "#/$defs/Certificate",
+          "description": "The access certificate, for an `eudi` identity that has one."
+        },
+        "attestations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Attestation"
+          },
+          "description": "What every request object carries in `verifier_info`, in the order it carries them. Empty when it carries none."
+        },
+        "problems": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Problem"
+          },
+          "description": "What is wrong with this identity. Empty when nothing is."
+        },
+        "installedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC OpenID4VP Verifier Identities List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identities",
+        "problems"
+      ],
+      "properties": {
+        "identities": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Identity"
+          },
+          "description": "Every verifier identity the community holds, by `id`. Empty when it holds none."
+        },
+        "defaultIdentity": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The identity the community is configured to use when a session names no client identifier prefix; null when none is configured, and the first usable identity is used."
+        },
+        "problems": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Problem"
+          },
+          "description": "What is wrong with the community's verifier as a whole, rather than with one identity. Empty when nothing is."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Problem": {
+      "title": "Problem",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One thing that stops, or will soon stop, a verifier identity or the community's verifier as a whole from serving wallets.",
+      "required": [
+        "code",
+        "severity"
+      ],
+      "properties": {
+        "code": {
+          "type": "string",
+          "enum": [
+            "keyCustodyInvalid",
+            "signerNotLoaded",
+            "agentLinkMissing",
+            "certificateMissing",
+            "certificateNotYetValid",
+            "certificateExpired",
+            "certificateExpiresSoon",
+            "identityStatementMissing",
+            "statementExpired",
+            "statementExpiresSoon",
+            "defaultIdentityNotInstalled",
+            "noPublicUrl"
+          ],
+          "description": "What is wrong, as tabled in the specification."
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning"
+          ],
+          "description": "`error`: sessions are refused, or wallets will refuse what the community sends, until it is fixed. `warning`: it works now and will not for long."
+        },
+        "detail": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Maintainer-authored prose for the administrator — what to run to fix it. Never parsed."
+        }
+      }
+    },
+    "Certificate": {
+      "title": "Certificate",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "An X.509-identified verifier's access certificate: the leaf of the chain it sends wallets as `x5c`.",
+      "required": [
+        "notBefore",
+        "notAfter",
+        "chainLength"
+      ],
+      "properties": {
+        "subject": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "The leaf's subject distinguished name, as RFC 4514 renders it."
+        },
+        "issuer": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "The leaf's issuer distinguished name, as RFC 4514 renders it."
+        },
+        "notBefore": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "notAfter": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "chainLength": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Certificates in the chain, leaf included."
+        }
+      }
+    },
+    "Attestation": {
+      "title": "Attestation",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One attestation about the verifier that every request object carries in `verifier_info`.",
+      "required": [
+        "kind"
+      ],
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "identityTrustStatement",
+            "protectedVerificationAuthorization",
+            "registrationCertificate",
+            "other"
+          ],
+          "description": "Which attestation it is, as tabled in the specification."
+        },
+        "expiresAt": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "format": "date-time",
+          "description": "When it expires, if it says; null when it carries no expiry the maintainer reads."
+        }
+      }
+    },
+    "Identity": {
+      "title": "Identity",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "One verifier identity, described by what is public about it. The signing key's private half, and where a remote custodian keeps it, are never returned.",
+      "required": [
+        "id",
+        "kind",
+        "custody",
+        "usable",
+        "isDefault",
+        "attestations",
+        "problems",
+        "installedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The administrator's name for the identity."
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "swiyu",
+            "eudi"
+          ],
+          "description": "The wallet ecosystem it is known to: `swiyu` (a DID registered in the swiyu Base Registry) or `eudi` (an X.509 access certificate)."
+        },
+        "clientId": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The OpenID4VP client identifier wallets see, prefix included. Null while an `eudi` identity has no certificate."
+        },
+        "did": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The identity's DID, for a `swiyu` identity."
+        },
+        "keyId": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The verification method that signs request objects, for an identity known by a DID."
+        },
+        "custody": {
+          "type": "string",
+          "enum": [
+            "cached",
+            "agent",
+            "invalid"
+          ],
+          "description": "Where the signing key is: `cached` by the community, kept by its `agent` (which signs every request object), or `invalid` when the record names neither or both."
+        },
+        "usable": {
+          "type": "boolean",
+          "description": "Whether a session could be opened on this identity now: true exactly when no `error` problem applies to it, and none other than `defaultIdentityNotInstalled` applies to the community's verifier as a whole."
+        },
+        "isDefault": {
+          "type": "boolean",
+          "description": "Whether a session that names no client identifier prefix uses this identity."
+        },
+        "certificate": {
+          "$ref": "#/$defs/Certificate",
+          "description": "The access certificate, for an `eudi` identity that has one."
+        },
+        "attestations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Attestation"
+          },
+          "description": "What every request object carries in `verifier_info`, in the order it carries them. Empty when it carries none."
+        },
+        "problems": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Problem"
+          },
+          "description": "What is wrong with this identity. Empty when nothing is."
+        },
+        "installedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC OpenID4VP Verifier Identities List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identities",
+        "problems"
+      ],
+      "properties": {
+        "identities": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Identity"
+          },
+          "description": "Every verifier identity the community holds, by `id`. Empty when it holds none."
+        },
+        "defaultIdentity": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The identity the community is configured to use when a session names no client identifier prefix; null when none is configured, and the first usable identity is used."
+        },
+        "problems": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Problem"
+          },
+          "description": "What is wrong with the community's verifier as a whole, rather than with one identity. Empty when nothing is."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "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-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;