@sphereon/ssi-sdk.kms-rest-client 0.34.1-feature.IDK.11.294

package/src/models/ProviderCapabilities.ts

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyType } from './KeyType'
+import { KeyTypeFromJSON, KeyTypeToJSON } from './KeyType'
+import type { DigestAlg } from './DigestAlg'
+import { DigestAlgFromJSON, DigestAlgToJSON } from './DigestAlg'
+import type { Curve } from './Curve'
+import { CurveFromJSON, CurveToJSON } from './Curve'
+import type { KeyOperations } from './KeyOperations'
+import { KeyOperationsFromJSON, KeyOperationsToJSON } from './KeyOperations'
+import type { SignatureAlgorithm } from './SignatureAlgorithm'
+import { SignatureAlgorithmFromJSON, SignatureAlgorithmToJSON } from './SignatureAlgorithm'
+
+/**
+ * Comprehensive information about a provider's cryptographic capabilities.
+ * @export
+ * @interface ProviderCapabilities
+ */
+export interface ProviderCapabilities {
+  /**
+   * List of key types supported by this provider.
+   * @type {Array<KeyType>}
+   * @memberof ProviderCapabilities
+   */
+  keyTypes?: Array<KeyType>
+  /**
+   * List of signature algorithms supported by this provider.
+   * @type {Array<SignatureAlgorithm>}
+   * @memberof ProviderCapabilities
+   */
+  signatureAlgorithms?: Array<SignatureAlgorithm>
+  /**
+   * List of digest algorithms supported by this provider.
+   * @type {Array<DigestAlg>}
+   * @memberof ProviderCapabilities
+   */
+  digests?: Array<DigestAlg>
+  /**
+   * List of elliptic curves supported by this provider.
+   * @type {Array<Curve>}
+   * @memberof ProviderCapabilities
+   */
+  curves?: Array<Curve>
+  /**
+   * List of key operations supported by this provider.
+   * @type {Array<KeyOperations>}
+   * @memberof ProviderCapabilities
+   */
+  keyOperations?: Array<KeyOperations>
+}
+
+/**
+ * Check if a given object implements the ProviderCapabilities interface.
+ */
+export function instanceOfProviderCapabilities(value: object): value is ProviderCapabilities {
+  return true
+}
+
+export function ProviderCapabilitiesFromJSON(json: any): ProviderCapabilities {
+  return ProviderCapabilitiesFromJSONTyped(json, false)
+}
+
+export function ProviderCapabilitiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderCapabilities {
+  if (json == null) {
+    return json
+  }
+  return {
+    keyTypes: json['keyTypes'] == null ? undefined : (json['keyTypes'] as Array<any>).map(KeyTypeFromJSON),
+    signatureAlgorithms:
+      json['signatureAlgorithms'] == null ? undefined : (json['signatureAlgorithms'] as Array<any>).map(SignatureAlgorithmFromJSON),
+    digests: json['digests'] == null ? undefined : (json['digests'] as Array<any>).map(DigestAlgFromJSON),
+    curves: json['curves'] == null ? undefined : (json['curves'] as Array<any>).map(CurveFromJSON),
+    keyOperations: json['keyOperations'] == null ? undefined : (json['keyOperations'] as Array<any>).map(KeyOperationsFromJSON),
+  }
+}
+
+export function ProviderCapabilitiesToJSON(json: any): ProviderCapabilities {
+  return ProviderCapabilitiesToJSONTyped(json, false)
+}
+
+export function ProviderCapabilitiesToJSONTyped(value?: ProviderCapabilities | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    keyTypes: value['keyTypes'] == null ? undefined : (value['keyTypes'] as Array<any>).map(KeyTypeToJSON),
+    signatureAlgorithms:
+      value['signatureAlgorithms'] == null ? undefined : (value['signatureAlgorithms'] as Array<any>).map(SignatureAlgorithmToJSON),
+    digests: value['digests'] == null ? undefined : (value['digests'] as Array<any>).map(DigestAlgToJSON),
+    curves: value['curves'] == null ? undefined : (value['curves'] as Array<any>).map(CurveToJSON),
+    keyOperations: value['keyOperations'] == null ? undefined : (value['keyOperations'] as Array<any>).map(KeyOperationsToJSON),
+  }
+}

package/src/models/ResolvePublicKey.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyInfo } from './KeyInfo'
+import { KeyInfoFromJSON, KeyInfoToJSON } from './KeyInfo'
+import type { IdentifierMethod } from './IdentifierMethod'
+import { IdentifierMethodFromJSON, IdentifierMethodToJSON } from './IdentifierMethod'
+
+/**
+ * Request body for resolving a public key.
+ * @export
+ * @interface ResolvePublicKey
+ */
+export interface ResolvePublicKey {
+  /**
+   *
+   * @type {KeyInfo}
+   * @memberof ResolvePublicKey
+   */
+  keyInfo: KeyInfo
+  /**
+   *
+   * @type {IdentifierMethod}
+   * @memberof ResolvePublicKey
+   */
+  identifierMethod?: IdentifierMethod
+  /**
+   * Optional array of trusted certificates (base64-encoded) that may be used in the resolution process.
+   * @type {Array<string>}
+   * @memberof ResolvePublicKey
+   */
+  trustedCerts?: Array<string>
+  /**
+   * Optional boolean indicating whether the X.509 certificate chain should be verified.
+   * @type {boolean}
+   * @memberof ResolvePublicKey
+   */
+  verifyX509CertificateChain?: boolean
+}
+
+/**
+ * Check if a given object implements the ResolvePublicKey interface.
+ */
+export function instanceOfResolvePublicKey(value: object): value is ResolvePublicKey {
+  if (!('keyInfo' in value) || value['keyInfo'] === undefined) return false
+  return true
+}
+
+export function ResolvePublicKeyFromJSON(json: any): ResolvePublicKey {
+  return ResolvePublicKeyFromJSONTyped(json, false)
+}
+
+export function ResolvePublicKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResolvePublicKey {
+  if (json == null) {
+    return json
+  }
+  return {
+    keyInfo: KeyInfoFromJSON(json['keyInfo']),
+    identifierMethod: json['identifierMethod'] == null ? undefined : IdentifierMethodFromJSON(json['identifierMethod']),
+    trustedCerts: json['trustedCerts'] == null ? undefined : json['trustedCerts'],
+    verifyX509CertificateChain: json['verifyX509CertificateChain'] == null ? undefined : json['verifyX509CertificateChain'],
+  }
+}
+
+export function ResolvePublicKeyToJSON(json: any): ResolvePublicKey {
+  return ResolvePublicKeyToJSONTyped(json, false)
+}
+
+export function ResolvePublicKeyToJSONTyped(value?: ResolvePublicKey | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    keyInfo: KeyInfoToJSON(value['keyInfo']),
+    identifierMethod: IdentifierMethodToJSON(value['identifierMethod']),
+    trustedCerts: value['trustedCerts'],
+    verifyX509CertificateChain: value['verifyX509CertificateChain'],
+  }
+}

package/src/models/ResolvedKeyInfo.ts

@@ -0,0 +1,145 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyType } from './KeyType'
+import { KeyTypeFromJSON, KeyTypeToJSON } from './KeyType'
+import type { KeyVisibility } from './KeyVisibility'
+import { KeyVisibilityFromJSON, KeyVisibilityToJSON } from './KeyVisibility'
+import type { SignatureAlgorithm } from './SignatureAlgorithm'
+import { SignatureAlgorithmFromJSON, SignatureAlgorithmToJSON } from './SignatureAlgorithm'
+import type { KeyEncoding } from './KeyEncoding'
+import { KeyEncodingFromJSON, KeyEncodingToJSON } from './KeyEncoding'
+import type { Jwk } from './Jwk'
+import { JwkFromJSON, JwkToJSON } from './Jwk'
+
+/**
+ * Represents a resolved cryptographic key information where the key is guaranteed to be present and resolved, providing concrete access to the key.
+ * @export
+ * @interface ResolvedKeyInfo
+ */
+export interface ResolvedKeyInfo {
+  /**
+   * Unique identifier for the cryptographic key. Can be null if the key identifier is not provided.
+   * @type {string}
+   * @memberof ResolvedKeyInfo
+   */
+  kid?: string
+  /**
+   *
+   * @type {Jwk}
+   * @memberof ResolvedKeyInfo
+   */
+  key: Jwk
+  /**
+   *
+   * @type {SignatureAlgorithm}
+   * @memberof ResolvedKeyInfo
+   */
+  signatureAlgorithm?: SignatureAlgorithm
+  /**
+   *
+   * @type {KeyVisibility}
+   * @memberof ResolvedKeyInfo
+   */
+  keyVisibility?: KeyVisibility
+  /**
+   * X.509 certificate chain associated with the key.
+   * @type {Array<string>}
+   * @memberof ResolvedKeyInfo
+   */
+  x5c?: Array<string>
+  /**
+   * A reference or alias to the key in the Key Management Service (KMS).
+   * @type {string}
+   * @memberof ResolvedKeyInfo
+   */
+  alias?: string
+  /**
+   * The Key Management System (KMS) identifier associated with the key.
+   * @type {string}
+   * @memberof ResolvedKeyInfo
+   */
+  providerId?: string
+  /**
+   *
+   * @type {KeyType}
+   * @memberof ResolvedKeyInfo
+   */
+  keyType?: KeyType
+  /**
+   *
+   * @type {KeyEncoding}
+   * @memberof ResolvedKeyInfo
+   */
+  keyEncoding?: KeyEncoding
+  /**
+   * Additional configuration options as key-value pairs.
+   * @type {{ [key: string]: string; }}
+   * @memberof ResolvedKeyInfo
+   */
+  opts?: { [key: string]: string }
+}
+
+/**
+ * Check if a given object implements the ResolvedKeyInfo interface.
+ */
+export function instanceOfResolvedKeyInfo(value: object): value is ResolvedKeyInfo {
+  if (!('key' in value) || value['key'] === undefined) return false
+  return true
+}
+
+export function ResolvedKeyInfoFromJSON(json: any): ResolvedKeyInfo {
+  return ResolvedKeyInfoFromJSONTyped(json, false)
+}
+
+export function ResolvedKeyInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResolvedKeyInfo {
+  if (json == null) {
+    return json
+  }
+  return {
+    kid: json['kid'] == null ? undefined : json['kid'],
+    key: JwkFromJSON(json['key']),
+    signatureAlgorithm: json['signatureAlgorithm'] == null ? undefined : SignatureAlgorithmFromJSON(json['signatureAlgorithm']),
+    keyVisibility: json['keyVisibility'] == null ? undefined : KeyVisibilityFromJSON(json['keyVisibility']),
+    x5c: json['x5c'] == null ? undefined : json['x5c'],
+    alias: json['alias'] == null ? undefined : json['alias'],
+    providerId: json['providerId'] == null ? undefined : json['providerId'],
+    keyType: json['keyType'] == null ? undefined : KeyTypeFromJSON(json['keyType']),
+    keyEncoding: json['keyEncoding'] == null ? undefined : KeyEncodingFromJSON(json['keyEncoding']),
+    opts: json['opts'] == null ? undefined : json['opts'],
+  }
+}
+
+export function ResolvedKeyInfoToJSON(json: any): ResolvedKeyInfo {
+  return ResolvedKeyInfoToJSONTyped(json, false)
+}
+
+export function ResolvedKeyInfoToJSONTyped(value?: ResolvedKeyInfo | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    kid: value['kid'],
+    key: JwkToJSON(value['key']),
+    signatureAlgorithm: SignatureAlgorithmToJSON(value['signatureAlgorithm']),
+    keyVisibility: KeyVisibilityToJSON(value['keyVisibility']),
+    x5c: value['x5c'],
+    alias: value['alias'],
+    providerId: value['providerId'],
+    keyType: KeyTypeToJSON(value['keyType']),
+    keyEncoding: KeyEncodingToJSON(value['keyEncoding']),
+    opts: value['opts'],
+  }
+}

package/src/models/Resolver.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyType } from './KeyType'
+import { KeyTypeFromJSON, KeyTypeToJSON } from './KeyType'
+import type { IdentifierMethod } from './IdentifierMethod'
+import { IdentifierMethodFromJSON, IdentifierMethodToJSON } from './IdentifierMethod'
+
+/**
+ * Represents a key resolver configuration.
+ * @export
+ * @interface Resolver
+ */
+export interface Resolver {
+  /**
+   * Unique identifier for the resolver.
+   * @type {string}
+   * @memberof Resolver
+   */
+  resolverId: string
+  /**
+   * List of identifier methods supported by this resolver.
+   * @type {Array<IdentifierMethod>}
+   * @memberof Resolver
+   */
+  supportedIdentifierMethods?: Array<IdentifierMethod>
+  /**
+   * List of key types supported by this resolver.
+   * @type {Array<KeyType>}
+   * @memberof Resolver
+   */
+  supportedKeyTypes?: Array<KeyType>
+}
+
+/**
+ * Check if a given object implements the Resolver interface.
+ */
+export function instanceOfResolver(value: object): value is Resolver {
+  if (!('resolverId' in value) || value['resolverId'] === undefined) return false
+  return true
+}
+
+export function ResolverFromJSON(json: any): Resolver {
+  return ResolverFromJSONTyped(json, false)
+}
+
+export function ResolverFromJSONTyped(json: any, ignoreDiscriminator: boolean): Resolver {
+  if (json == null) {
+    return json
+  }
+  return {
+    resolverId: json['resolverId'],
+    supportedIdentifierMethods:
+      json['supportedIdentifierMethods'] == null ? undefined : (json['supportedIdentifierMethods'] as Array<any>).map(IdentifierMethodFromJSON),
+    supportedKeyTypes: json['supportedKeyTypes'] == null ? undefined : (json['supportedKeyTypes'] as Array<any>).map(KeyTypeFromJSON),
+  }
+}
+
+export function ResolverToJSON(json: any): Resolver {
+  return ResolverToJSONTyped(json, false)
+}
+
+export function ResolverToJSONTyped(value?: Resolver | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    resolverId: value['resolverId'],
+    supportedIdentifierMethods:
+      value['supportedIdentifierMethods'] == null ? undefined : (value['supportedIdentifierMethods'] as Array<any>).map(IdentifierMethodToJSON),
+    supportedKeyTypes: value['supportedKeyTypes'] == null ? undefined : (value['supportedKeyTypes'] as Array<any>).map(KeyTypeToJSON),
+  }
+}

package/src/models/SignInput.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The input data and metadata required for creating a signature.
+ * @export
+ * @interface SignInput
+ */
+export interface SignInput {
+  /**
+   * The data to be signed, encoded as a base64 string.
+   * @type {string}
+   * @memberof SignInput
+   */
+  data: string
+  /**
+   * The signing mode to be used.
+   * @type {string}
+   * @memberof SignInput
+   */
+  mode?: SignInputModeEnum
+  /**
+   * Additional metadata to be included in the signature.
+   * @type {{ [key: string]: any; }}
+   * @memberof SignInput
+   */
+  metadata?: { [key: string]: any }
+}
+
+/**
+ * @export
+ */
+export const SignInputModeEnum = {
+  Detached: 'DETACHED',
+  Attached: 'ATTACHED',
+} as const
+export type SignInputModeEnum = (typeof SignInputModeEnum)[keyof typeof SignInputModeEnum]
+
+/**
+ * Check if a given object implements the SignInput interface.
+ */
+export function instanceOfSignInput(value: object): value is SignInput {
+  if (!('data' in value) || value['data'] === undefined) return false
+  return true
+}
+
+export function SignInputFromJSON(json: any): SignInput {
+  return SignInputFromJSONTyped(json, false)
+}
+
+export function SignInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignInput {
+  if (json == null) {
+    return json
+  }
+  return {
+    data: json['data'],
+    mode: json['mode'] == null ? undefined : json['mode'],
+    metadata: json['metadata'] == null ? undefined : json['metadata'],
+  }
+}
+
+export function SignInputToJSON(json: any): SignInput {
+  return SignInputToJSONTyped(json, false)
+}
+
+export function SignInputToJSONTyped(value?: SignInput | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    data: value['data'],
+    mode: value['mode'],
+    metadata: value['metadata'],
+  }
+}

package/src/models/SignOutput.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { Signature } from './Signature'
+import { SignatureFromJSON, SignatureToJSON } from './Signature'
+
+/**
+ * The output of a signature creation operation.
+ * @export
+ * @interface SignOutput
+ */
+export interface SignOutput {
+  /**
+   *
+   * @type {Signature}
+   * @memberof SignOutput
+   */
+  signature: Signature
+  /**
+   * Additional metadata included in the signature output.
+   * @type {{ [key: string]: any; }}
+   * @memberof SignOutput
+   */
+  metadata?: { [key: string]: any }
+}
+
+/**
+ * Check if a given object implements the SignOutput interface.
+ */
+export function instanceOfSignOutput(value: object): value is SignOutput {
+  if (!('signature' in value) || value['signature'] === undefined) return false
+  return true
+}
+
+export function SignOutputFromJSON(json: any): SignOutput {
+  return SignOutputFromJSONTyped(json, false)
+}
+
+export function SignOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignOutput {
+  if (json == null) {
+    return json
+  }
+  return {
+    signature: SignatureFromJSON(json['signature']),
+    metadata: json['metadata'] == null ? undefined : json['metadata'],
+  }
+}
+
+export function SignOutputToJSON(json: any): SignOutput {
+  return SignOutputToJSONTyped(json, false)
+}
+
+export function SignOutputToJSONTyped(value?: SignOutput | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    signature: SignatureToJSON(value['signature']),
+    metadata: value['metadata'],
+  }
+}

package/src/models/Signature.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyInfo } from './KeyInfo'
+import { KeyInfoFromJSON, KeyInfoToJSON } from './KeyInfo'
+import type { SignatureAlgorithm } from './SignatureAlgorithm'
+import { SignatureAlgorithmFromJSON, SignatureAlgorithmToJSON } from './SignatureAlgorithm'
+
+/**
+ * A cryptographic signature including the signature value and related information.
+ * @export
+ * @interface Signature
+ */
+export interface Signature {
+  /**
+   * The signature value, encoded as a base64 string.
+   * @type {string}
+   * @memberof Signature
+   */
+  value: string
+  /**
+   *
+   * @type {SignatureAlgorithm}
+   * @memberof Signature
+   */
+  algorithm: SignatureAlgorithm
+  /**
+   *
+   * @type {KeyInfo}
+   * @memberof Signature
+   */
+  keyInfo?: KeyInfo
+  /**
+   * Additional metadata included in the signature.
+   * @type {{ [key: string]: any; }}
+   * @memberof Signature
+   */
+  metadata?: { [key: string]: any }
+}
+
+/**
+ * Check if a given object implements the Signature interface.
+ */
+export function instanceOfSignature(value: object): value is Signature {
+  if (!('value' in value) || value['value'] === undefined) return false
+  if (!('algorithm' in value) || value['algorithm'] === undefined) return false
+  return true
+}
+
+export function SignatureFromJSON(json: any): Signature {
+  return SignatureFromJSONTyped(json, false)
+}
+
+export function SignatureFromJSONTyped(json: any, ignoreDiscriminator: boolean): Signature {
+  if (json == null) {
+    return json
+  }
+  return {
+    value: json['value'],
+    algorithm: SignatureAlgorithmFromJSON(json['algorithm']),
+    keyInfo: json['keyInfo'] == null ? undefined : KeyInfoFromJSON(json['keyInfo']),
+    metadata: json['metadata'] == null ? undefined : json['metadata'],
+  }
+}
+
+export function SignatureToJSON(json: any): Signature {
+  return SignatureToJSONTyped(json, false)
+}
+
+export function SignatureToJSONTyped(value?: Signature | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    value: value['value'],
+    algorithm: SignatureAlgorithmToJSON(value['algorithm']),
+    keyInfo: KeyInfoToJSON(value['keyInfo']),
+    metadata: value['metadata'],
+  }
+}