@openvtc/trust-tasks 0.14.2 → 0.16.0

package/src/vault/get/0.2/payload.ts

@@ -3,22 +3,8 @@
  * Source: specs/vault/get/0.2/payload.schema.json
  */
 
-/**
- * A single binding target for a vault entry. Tagged union over the discriminator `kind`. A VaultEntry's `targets` array MAY mix any number of these.
- */
-export type SiteTarget = WebOrigin | Did | IosApp | AndroidApp;
-/**
- * Discriminator for the kind of secret this entry holds. The secret material itself is NEVER returned in metadata views; the kind is exposed so consumers can render an appropriate UI affordance and so policy decisions can route by kind.
- */
-export type SecretKind =
-  | "password"
-  | "passkey"
-  | "oauthTokens"
-  | "didSelfIssued"
-  | "didcommPeer"
-  | "bearerToken"
-  | "sshKey"
-  | "custom";
+import type { AndroidApp_VaultV0_2 as AndroidApp, AttachmentRef_VaultV0_1 as AttachmentRef, Did_VaultV0_2 as Did, Ext, IosApp_VaultV0_2 as IosApp, SecretKind_VaultV0_2 as SecretKind, SiteTarget_VaultV0_2 as SiteTarget, VaultEntry_VaultV0_2 as VaultEntry, WebOrigin_VaultV0_2 as WebOrigin } from "../../../_shared/components.js";
+
 
 /**
  * Fetch the metadata view of a single vault entry by id. Returns the same VaultEntry shape vault/list does, but for one specific entry. Secret material is NEVER returned by this task; use vault/release/0.1 to obtain secret bytes.
@@ -30,163 +16,14 @@ export interface VaultGetPayload {
   id: string;
   ext?: Ext;
 }
-/**
- * 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.
- */
-export interface Ext {
-  [k: string]: unknown | undefined;
-}
 export interface VaultGetResponsePayload {
   entry: VaultEntry;
   redactedFields?: string[];
   ext?: Ext;
 }
-export interface VaultEntry {
-  /**
-   * Opaque vault-maintainer-assigned identifier for the entry. ULID/UUID/base32 are common; the wire spec only requires non-empty string equality.
-   */
-  id: string;
-  /**
-   * Identifier of the trust context (persona) the entry belongs to. Opaque string interpreted by the vault maintainer; corresponds to a single ContextRecord on the VTA side.
-   */
-  contextId: string;
-  /**
-   * One or more binding targets — web origins, mobile app identifiers, and/or DIDs — that this credential applies to. A request from any matching target uses this entry. A typical entry for a service that exists as both a website and mobile apps will list a web origin, an iOS bundle id, and an Android package id; passkeys for that service typically list only the origin (because iOS Associated Domains and Android Asset Links bind apps to the domain at the OS level).
-   *
-   * @minItems 1
-   */
-  targets: [SiteTarget, ...SiteTarget[]];
-  /**
-   * Human-readable display name (e.g. "Work GitHub", "Personal bank — checking"). Maintainers MAY enforce a maximum length; the wire spec does not.
-   */
-  label: string;
-  secretKind: SecretKind;
-  /**
-   * User-defined tags for organisation and filtering (e.g. ["family", "finance"]). Maintainers MAY enforce a maximum count; the wire spec does not.
-   */
-  tags?: string[];
-  /**
-   * Non-sensitive notes the user attached to the entry. Visible in metadata view (suitable for support contact, account number, expiry policy memos). SENSITIVE notes belong in the secret payload as a `secureNotes` field — those are only released by vault/release/0.1.
-   */
-  notes?: string;
-  /**
-   * Optional URI of an icon to display in the consumer UI. Maintainers MAY fetch and cache; consumers SHOULD treat as untrusted content and fetch via a sandboxed pipeline.
-   */
-  favicon?: string;
-  /**
-   * Opaque maintainer-defined selector strings fed to the policy engine when this entry is requested (e.g. "recent_uv_required", "network_class=corp", "step_up_push"). Consumers MUST treat selectors as opaque; they exist for policy authoring on the maintainer side.
-   */
-  selectors?: string[];
-  /**
-   * Names of additional fields the user has attached (e.g. ["security-question-1", "account-number"]). The VALUES live in the secret payload and are only delivered by vault/release/0.1. Exposing names in metadata lets the consumer render the right form layout before requesting release.
-   */
-  customFieldNames?: string[];
-  /**
-   * References to encrypted blobs associated with the entry (recovery codes, PEM files, screenshots of authenticator setup). The blobs themselves are fetched via a separate mechanism the maintainer documents; metadata view exposes only the descriptor.
-   */
-  attachments?: AttachmentRef[];
-  /**
-   * Optional time after which the credential is no longer expected to be valid (e.g. an OAuth refresh token's known expiry, a time-limited API token, an enterprise password rotation policy). Maintainers MAY surface this in the consumer UI as a warning.
-   */
-  expiresAt?: string;
-  /**
-   * Set by the maintainer (via HIBP integration or equivalent) when the password material associated with this entry is known to appear in a public breach. Consumers SHOULD surface this prominently. Cleared when the user rotates the password and the new password is not in any known breach.
-   */
-  breachedAt?: string;
-  /**
-   * Set whenever the password component of the secret payload is rotated. Maintainers MUST update this on every secret-material change for entries of kind `password` (or any kind that carries a password component). Used by consumers to surface rotation-overdue warnings.
-   */
-  passwordChangedAt?: string;
-  createdAt: string;
-  /**
-   * VID of the consumer that originally created the entry.
-   */
-  createdBy?: string;
-  updatedAt: string;
-  /**
-   * VID of the consumer that last modified the entry.
-   */
-  updatedBy?: string;
-  /**
-   * Most recent time the entry was used (either released or proxy-login performed). Maintainers MAY return this with reduced precision (e.g. hour-floored) when releasing to a less-trusted consumer.
-   */
-  lastUsedAt?: string;
-  /**
-   * Monotonic version counter incremented on every mutation. Used by consumers for optimistic-concurrency checks on vault/upsert and as the seq baseline for vault/sync.
-   */
-  version: number;
-  /**
-   * Optional cached DID the entry will act AS for DID-shaped flows — mirrors the `did` field of the entry's secret payload when `secretKind` carries one (`didSelfIssued`, `didcommPeer`). Absent for kinds that have no DID concept (`password`, `passkey`, `oauthTokens`, `bearerToken`, `sshKey`, `custom`). MAINTAINER-DERIVED, NOT CONSUMER-SUPPLIED: the maintainer MUST recompute this from the canonical secret at every upsert / secret rotation; a producer-supplied value on `vault/upsert/0.1` MUST be ignored (no error, but no honour). Read-only on the wire, present in metadata views so consumers can drive RP-side flows (e.g. fetch `/auth/challenge` keyed on the principal DID before requesting a proxy-login) without releasing the secret.
-   */
-  principalDid?: string;
-  ext?: Ext1;
-}
-export interface WebOrigin {
-  kind: "webOrigin";
-  /**
-   * Web origin per RFC 6454 (scheme + host + optional port), e.g. "https://github.com". Compared by exact string equality after canonicalisation (lowercase host, default port elided). Consumers wanting subdomain coverage SHOULD add multiple targets, not encode a wildcard.
-   */
-  origin: string;
-}
-export interface Did {
-  kind: "did";
-  /**
-   * DID identifying the relying party (e.g. did:web:rp.example). The vault maintainer is responsible for any DID resolution required to act on this entry.
-   */
-  did: string;
-}
-export interface IosApp {
-  kind: "iosApp";
-  /**
-   * iOS bundle identifier in reverse-DNS form (e.g. "com.github.stwalkerster.codehub"). Compared by exact string equality. Matches when an iOS Companion identifies the requesting app via its bundle id (typically via the OS Credential Manager integration).
-   */
-  bundleId: string;
-  /**
-   * Optional Apple Developer Team identifier (10-character alphanumeric). When supplied, the maintainer SHOULD also verify the team id of the requesting app before matching — defense in depth against bundle-id squatting on jailbroken devices.
-   */
-  teamId?: string;
-}
-export interface AndroidApp {
-  kind: "androidApp";
-  /**
-   * Android package name in reverse-DNS form (e.g. "com.github.android").
-   */
-  packageName: string;
-  /**
-   * SHA-256 fingerprints of the app's signing certificates, in colon-separated hex (the format `apksigner` and the Play Console emit). At least one fingerprint MUST be present. The maintainer matches when ANY of the provided fingerprints matches the requesting app's signature — this supports apps signed by multiple keys (e.g. during certificate rotation via Play App Signing).
-   *
-   * @minItems 1
-   */
-  sha256CertFingerprints: [string, ...string[]];
-}
-export interface AttachmentRef {
-  /**
-   * Opaque maintainer-assigned id for this attachment; used to fetch the blob via a separate mechanism.
-   */
-  id: string;
-  /**
-   * User-supplied filename (e.g. "recovery-codes.txt").
-   */
-  name: string;
-  /**
-   * Size of the encrypted blob in bytes. Maintainers MAY enforce a maximum per attachment and per entry.
-   */
-  sizeBytes: number;
-  /**
-   * Hex-encoded SHA-256 of the encrypted blob bytes (post-encryption). Lets the consumer verify integrity after fetch.
-   */
-  sha256: string;
-  /**
-   * Optional MIME type hint for the consumer UI (e.g. "text/plain", "application/x-pem-file").
-   */
-  contentType?: 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.
- */
-export interface Ext1 {
-  [k: string]: unknown | undefined;
-}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AndroidApp, AttachmentRef, Did, Ext, IosApp, SecretKind, SiteTarget, VaultEntry, WebOrigin };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vault/get/0.2" as const;
@@ -299,7 +136,8 @@ export const PAYLOAD_SCHEMA = {
         "label": {
           "type": "string",
           "minLength": 1,
-          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Maintainers MAY enforce a maximum length; the wire spec does not."
+          "maxLength": 256,
+          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Bounded on the wire at 256 characters; a maintainer MAY enforce a shorter limit."
         },
         "secretKind": {
           "$ref": "#/$defs/SecretKind",
@@ -634,7 +472,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "label": {
           "type": "string",
           "minLength": 1,
-          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Maintainers MAY enforce a maximum length; the wire spec does not."
+          "maxLength": 256,
+          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Bounded on the wire at 256 characters; a maintainer MAY enforce a shorter limit."
         },
         "secretKind": {
           "$ref": "#/$defs/SecretKind",
@@ -906,6 +745,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -919,5 +759,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;

package/src/vault/get/0.3/payload.ts

@@ -3,26 +3,8 @@
  * Source: specs/vault/get/0.3/payload.schema.json
  */
 
-/**
- * A single binding target for a vault entry. Tagged union over the discriminator `kind`. A VaultEntry's `targets` array MAY mix any number of these.
- */
-export type SiteTarget = WebOrigin | Did | IosApp | AndroidApp;
-/**
- * Discriminator for the kind of secret this entry holds. The secret material itself is NEVER returned in metadata views; the kind is exposed so consumers can render an appropriate UI affordance and so policy decisions can route by kind.
- */
-export type SecretKind =
-  | "password"
-  | "passkey"
-  | "oauthTokens"
-  | "didSelfIssued"
-  | "didcommPeer"
-  | "bearerToken"
-  | "sshKey"
-  | "custom";
-/**
- * Digest over the encrypted blob bytes (post-encryption), so the consumer can verify integrity after fetch. Taken over the bytes as stored, not over a canonicalization: the blob is an opaque artifact, not a JSON document.
- */
-export type DigestMultibase = string;
+import type { AndroidApp_VaultV0_2 as AndroidApp, AttachmentRef_VaultV0_3 as AttachmentRef, Did_VaultV0_2 as Did, DigestMultibase, Ext, IosApp_VaultV0_2 as IosApp, SecretKind_VaultV0_2 as SecretKind, SiteTarget_VaultV0_2 as SiteTarget, VaultEntry_VaultV0_3 as VaultEntry, WebOrigin_VaultV0_2 as WebOrigin } from "../../../_shared/components.js";
+
 
 /**
  * Fetch the metadata view of a single vault entry by id. Returns the same VaultEntry shape vault/list does, but for one specific entry. Secret material is NEVER returned by this task; use vault/release/0.1 to obtain secret bytes.
@@ -34,160 +16,14 @@ export interface VaultGetPayload {
   id: string;
   ext?: Ext;
 }
-/**
- * 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.
- */
-export interface Ext {
-  [k: string]: unknown | undefined;
-}
 export interface VaultGetResponsePayload {
   entry: VaultEntry;
   redactedFields?: string[];
   ext?: Ext;
 }
-export interface VaultEntry {
-  /**
-   * Opaque vault-maintainer-assigned identifier for the entry. ULID/UUID/base32 are common; the wire spec only requires non-empty string equality.
-   */
-  id: string;
-  /**
-   * Identifier of the trust context (persona) the entry belongs to. Opaque string interpreted by the vault maintainer; corresponds to a single ContextRecord on the VTA side.
-   */
-  contextId: string;
-  /**
-   * One or more binding targets — web origins, mobile app identifiers, and/or DIDs — that this credential applies to. A request from any matching target uses this entry. A typical entry for a service that exists as both a website and mobile apps will list a web origin, an iOS bundle id, and an Android package id; passkeys for that service typically list only the origin (because iOS Associated Domains and Android Asset Links bind apps to the domain at the OS level).
-   *
-   * @minItems 1
-   */
-  targets: [SiteTarget, ...SiteTarget[]];
-  /**
-   * Human-readable display name (e.g. "Work GitHub", "Personal bank — checking"). Maintainers MAY enforce a maximum length; the wire spec does not.
-   */
-  label: string;
-  secretKind: SecretKind;
-  /**
-   * User-defined tags for organisation and filtering (e.g. ["family", "finance"]). Maintainers MAY enforce a maximum count; the wire spec does not.
-   */
-  tags?: string[];
-  /**
-   * Non-sensitive notes the user attached to the entry. Visible in metadata view (suitable for support contact, account number, expiry policy memos). SENSITIVE notes belong in the secret payload as a `secureNotes` field — those are only released by vault/release/0.1.
-   */
-  notes?: string;
-  /**
-   * Optional URI of an icon to display in the consumer UI. Maintainers MAY fetch and cache; consumers SHOULD treat as untrusted content and fetch via a sandboxed pipeline.
-   */
-  favicon?: string;
-  /**
-   * Opaque maintainer-defined selector strings fed to the policy engine when this entry is requested (e.g. "recent_uv_required", "network_class=corp", "step_up_push"). Consumers MUST treat selectors as opaque; they exist for policy authoring on the maintainer side.
-   */
-  selectors?: string[];
-  /**
-   * Names of additional fields the user has attached (e.g. ["security-question-1", "account-number"]). The VALUES live in the secret payload and are only delivered by vault/release/0.1. Exposing names in metadata lets the consumer render the right form layout before requesting release.
-   */
-  customFieldNames?: string[];
-  /**
-   * References to encrypted blobs associated with the entry (recovery codes, PEM files, screenshots of authenticator setup). The blobs themselves are fetched via a separate mechanism the maintainer documents; metadata view exposes only the descriptor.
-   */
-  attachments?: AttachmentRef[];
-  /**
-   * Optional time after which the credential is no longer expected to be valid (e.g. an OAuth refresh token's known expiry, a time-limited API token, an enterprise password rotation policy). Maintainers MAY surface this in the consumer UI as a warning.
-   */
-  expiresAt?: string;
-  /**
-   * Set by the maintainer (via HIBP integration or equivalent) when the password material associated with this entry is known to appear in a public breach. Consumers SHOULD surface this prominently. Cleared when the user rotates the password and the new password is not in any known breach.
-   */
-  breachedAt?: string;
-  /**
-   * Set whenever the password component of the secret payload is rotated. Maintainers MUST update this on every secret-material change for entries of kind `password` (or any kind that carries a password component). Used by consumers to surface rotation-overdue warnings.
-   */
-  passwordChangedAt?: string;
-  createdAt: string;
-  /**
-   * VID of the consumer that originally created the entry.
-   */
-  createdBy?: string;
-  updatedAt: string;
-  /**
-   * VID of the consumer that last modified the entry.
-   */
-  updatedBy?: string;
-  /**
-   * Most recent time the entry was used (either released or proxy-login performed). Maintainers MAY return this with reduced precision (e.g. hour-floored) when releasing to a less-trusted consumer.
-   */
-  lastUsedAt?: string;
-  /**
-   * Monotonic version counter incremented on every mutation. Used by consumers for optimistic-concurrency checks on vault/upsert and as the seq baseline for vault/sync.
-   */
-  version: number;
-  /**
-   * Optional cached DID the entry will act AS for DID-shaped flows — mirrors the `did` field of the entry's secret payload when `secretKind` carries one (`didSelfIssued`, `didcommPeer`). Absent for kinds that have no DID concept (`password`, `passkey`, `oauthTokens`, `bearerToken`, `sshKey`, `custom`). MAINTAINER-DERIVED, NOT CONSUMER-SUPPLIED: the maintainer MUST recompute this from the canonical secret at every upsert / secret rotation; a producer-supplied value on `vault/upsert/0.1` MUST be ignored (no error, but no honour). Read-only on the wire, present in metadata views so consumers can drive RP-side flows (e.g. fetch `/auth/challenge` keyed on the principal DID before requesting a proxy-login) without releasing the secret.
-   */
-  principalDid?: string;
-  ext?: Ext1;
-}
-export interface WebOrigin {
-  kind: "webOrigin";
-  /**
-   * Web origin per RFC 6454 (scheme + host + optional port), e.g. "https://github.com". Compared by exact string equality after canonicalisation (lowercase host, default port elided). Consumers wanting subdomain coverage SHOULD add multiple targets, not encode a wildcard.
-   */
-  origin: string;
-}
-export interface Did {
-  kind: "did";
-  /**
-   * DID identifying the relying party (e.g. did:web:rp.example). The vault maintainer is responsible for any DID resolution required to act on this entry.
-   */
-  did: string;
-}
-export interface IosApp {
-  kind: "iosApp";
-  /**
-   * iOS bundle identifier in reverse-DNS form (e.g. "com.github.stwalkerster.codehub"). Compared by exact string equality. Matches when an iOS Companion identifies the requesting app via its bundle id (typically via the OS Credential Manager integration).
-   */
-  bundleId: string;
-  /**
-   * Optional Apple Developer Team identifier (10-character alphanumeric). When supplied, the maintainer SHOULD also verify the team id of the requesting app before matching — defense in depth against bundle-id squatting on jailbroken devices.
-   */
-  teamId?: string;
-}
-export interface AndroidApp {
-  kind: "androidApp";
-  /**
-   * Android package name in reverse-DNS form (e.g. "com.github.android").
-   */
-  packageName: string;
-  /**
-   * SHA-256 fingerprints of the app's signing certificates, in colon-separated hex (the format `apksigner` and the Play Console emit). At least one fingerprint MUST be present. The maintainer matches when ANY of the provided fingerprints matches the requesting app's signature — this supports apps signed by multiple keys (e.g. during certificate rotation via Play App Signing).
-   *
-   * @minItems 1
-   */
-  sha256CertFingerprints: [string, ...string[]];
-}
-export interface AttachmentRef {
-  /**
-   * Opaque maintainer-assigned id for this attachment; used to fetch the blob via a separate mechanism.
-   */
-  id: string;
-  /**
-   * User-supplied filename (e.g. "recovery-codes.txt").
-   */
-  name: string;
-  /**
-   * Size of the encrypted blob in bytes. Maintainers MAY enforce a maximum per attachment and per entry.
-   */
-  sizeBytes: number;
-  digestMultibase: DigestMultibase;
-  /**
-   * Optional MIME type hint for the consumer UI (e.g. "text/plain", "application/x-pem-file").
-   */
-  contentType?: 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.
- */
-export interface Ext1 {
-  [k: string]: unknown | undefined;
-}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AndroidApp, AttachmentRef, Did, DigestMultibase, Ext, IosApp, SecretKind, SiteTarget, VaultEntry, WebOrigin };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vault/get/0.3" as const;
@@ -300,7 +136,8 @@ export const PAYLOAD_SCHEMA = {
         "label": {
           "type": "string",
           "minLength": 1,
-          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Maintainers MAY enforce a maximum length; the wire spec does not."
+          "maxLength": 256,
+          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Bounded on the wire at 256 characters; a maintainer MAY enforce a shorter limit."
         },
         "secretKind": {
           "$ref": "#/$defs/SecretKind",
@@ -644,7 +481,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "label": {
           "type": "string",
           "minLength": 1,
-          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Maintainers MAY enforce a maximum length; the wire spec does not."
+          "maxLength": 256,
+          "description": "Human-readable display name (e.g. \"Work GitHub\", \"Personal bank — checking\"). Bounded on the wire at 256 characters; a maintainer MAY enforce a shorter limit."
         },
         "secretKind": {
           "$ref": "#/$defs/SecretKind",
@@ -925,6 +763,7 @@ export const SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
 } as const;
 
@@ -938,5 +777,6 @@ export const RESPONSE_SPEC = {
   isBearer: false,
   isProofRequired: false,
   isRecipientRequired: true,
+  isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
 } as const;