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

package/src/models/JwkKeyType.ts

@@ -0,0 +1,52 @@
+/* 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.
+ */
+
+/**
+ * JSON Web Key (JWK) key type parameter identifying the cryptographic algorithm family.
+ * @export
+ */
+export const JwkKeyType = {
+  Ec: 'EC',
+  Rsa: 'RSA',
+  Okp: 'OKP',
+  Oct: 'oct',
+} as const
+export type JwkKeyType = (typeof JwkKeyType)[keyof typeof JwkKeyType]
+
+export function instanceOfJwkKeyType(value: any): boolean {
+  for (const key in JwkKeyType) {
+    if (Object.prototype.hasOwnProperty.call(JwkKeyType, key)) {
+      if (JwkKeyType[key as keyof typeof JwkKeyType] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function JwkKeyTypeFromJSON(json: any): JwkKeyType {
+  return JwkKeyTypeFromJSONTyped(json, false)
+}
+
+export function JwkKeyTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): JwkKeyType {
+  return json as JwkKeyType
+}
+
+export function JwkKeyTypeToJSON(value?: JwkKeyType | null): any {
+  return value as any
+}
+
+export function JwkKeyTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): JwkKeyType {
+  return value as JwkKeyType
+}

package/src/models/JwkUse.ts

@@ -0,0 +1,50 @@
+/* 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.
+ */
+
+/**
+ * Intended use of the key (signing or encryption).
+ * @export
+ */
+export const JwkUse = {
+  Sig: 'sig',
+  Enc: 'enc',
+} as const
+export type JwkUse = (typeof JwkUse)[keyof typeof JwkUse]
+
+export function instanceOfJwkUse(value: any): boolean {
+  for (const key in JwkUse) {
+    if (Object.prototype.hasOwnProperty.call(JwkUse, key)) {
+      if (JwkUse[key as keyof typeof JwkUse] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function JwkUseFromJSON(json: any): JwkUse {
+  return JwkUseFromJSONTyped(json, false)
+}
+
+export function JwkUseFromJSONTyped(json: any, ignoreDiscriminator: boolean): JwkUse {
+  return json as JwkUse
+}
+
+export function JwkUseToJSON(value?: JwkUse | null): any {
+  return value as any
+}
+
+export function JwkUseToJSONTyped(value: any, ignoreDiscriminator: boolean): JwkUse {
+  return value as JwkUse
+}

package/src/models/KeyEncoding.ts

@@ -0,0 +1,50 @@
+/* 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 encoding format of the cryptographic key.
+ * @export
+ */
+export const KeyEncoding = {
+  Cose: 'COSE',
+  Jose: 'JOSE',
+} as const
+export type KeyEncoding = (typeof KeyEncoding)[keyof typeof KeyEncoding]
+
+export function instanceOfKeyEncoding(value: any): boolean {
+  for (const key in KeyEncoding) {
+    if (Object.prototype.hasOwnProperty.call(KeyEncoding, key)) {
+      if (KeyEncoding[key as keyof typeof KeyEncoding] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function KeyEncodingFromJSON(json: any): KeyEncoding {
+  return KeyEncodingFromJSONTyped(json, false)
+}
+
+export function KeyEncodingFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyEncoding {
+  return json as KeyEncoding
+}
+
+export function KeyEncodingToJSON(value?: KeyEncoding | null): any {
+  return value as any
+}
+
+export function KeyEncodingToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyEncoding {
+  return value as KeyEncoding
+}

package/src/models/KeyInfo.ts

@@ -0,0 +1,144 @@
+/* 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'
+
+/**
+ * Information about a cryptographic key, providing metadata and configuration details necessary for cryptographic operations.
+ * @export
+ * @interface KeyInfo
+ */
+export interface KeyInfo {
+  /**
+   * Unique identifier for the cryptographic key. Can be null if the key identifier is not provided.
+   * @type {string}
+   * @memberof KeyInfo
+   */
+  kid?: string
+  /**
+   *
+   * @type {Jwk}
+   * @memberof KeyInfo
+   */
+  key?: Jwk
+  /**
+   *
+   * @type {SignatureAlgorithm}
+   * @memberof KeyInfo
+   */
+  signatureAlgorithm?: SignatureAlgorithm
+  /**
+   *
+   * @type {KeyVisibility}
+   * @memberof KeyInfo
+   */
+  keyVisibility?: KeyVisibility
+  /**
+   * X.509 certificate chain associated with the key.
+   * @type {Array<string>}
+   * @memberof KeyInfo
+   */
+  x5c?: Array<string>
+  /**
+   * A reference or alias to the key in the Key Management Service (KMS).
+   * @type {string}
+   * @memberof KeyInfo
+   */
+  alias?: string
+  /**
+   * The Key Management System (KMS) identifier associated with the key.
+   * @type {string}
+   * @memberof KeyInfo
+   */
+  providerId?: string
+  /**
+   *
+   * @type {KeyType}
+   * @memberof KeyInfo
+   */
+  keyType?: KeyType
+  /**
+   *
+   * @type {KeyEncoding}
+   * @memberof KeyInfo
+   */
+  keyEncoding?: KeyEncoding
+  /**
+   * Additional configuration options as key-value pairs.
+   * @type {{ [key: string]: string; }}
+   * @memberof KeyInfo
+   */
+  opts?: { [key: string]: string }
+}
+
+/**
+ * Check if a given object implements the KeyInfo interface.
+ */
+export function instanceOfKeyInfo(value: object): value is KeyInfo {
+  return true
+}
+
+export function KeyInfoFromJSON(json: any): KeyInfo {
+  return KeyInfoFromJSONTyped(json, false)
+}
+
+export function KeyInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyInfo {
+  if (json == null) {
+    return json
+  }
+  return {
+    kid: json['kid'] == null ? undefined : json['kid'],
+    key: json['key'] == null ? undefined : 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 KeyInfoToJSON(json: any): KeyInfo {
+  return KeyInfoToJSONTyped(json, false)
+}
+
+export function KeyInfoToJSONTyped(value?: KeyInfo | 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/KeyOperations.ts

@@ -0,0 +1,56 @@
+/* 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.
+ */
+
+/**
+ * Specific operations the key is intended for.
+ * @export
+ */
+export const KeyOperations = {
+  Sign: 'sign',
+  Verify: 'verify',
+  Encrypt: 'encrypt',
+  Decrypt: 'decrypt',
+  WrapKey: 'wrapKey',
+  UnwrapKey: 'unwrapKey',
+  DeriveKey: 'deriveKey',
+  DeriveBits: 'deriveBits',
+} as const
+export type KeyOperations = (typeof KeyOperations)[keyof typeof KeyOperations]
+
+export function instanceOfKeyOperations(value: any): boolean {
+  for (const key in KeyOperations) {
+    if (Object.prototype.hasOwnProperty.call(KeyOperations, key)) {
+      if (KeyOperations[key as keyof typeof KeyOperations] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function KeyOperationsFromJSON(json: any): KeyOperations {
+  return KeyOperationsFromJSONTyped(json, false)
+}
+
+export function KeyOperationsFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyOperations {
+  return json as KeyOperations
+}
+
+export function KeyOperationsToJSON(value?: KeyOperations | null): any {
+  return value as any
+}
+
+export function KeyOperationsToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyOperations {
+  return value as KeyOperations
+}

package/src/models/KeyProvider.ts

@@ -0,0 +1,74 @@
+/* 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 { KeyProviderType } from './KeyProviderType'
+import { KeyProviderTypeFromJSON, KeyProviderTypeToJSON } from './KeyProviderType'
+
+/**
+ * Response body containing the details of a Key Provider instance.
+ * @export
+ * @interface KeyProvider
+ */
+export interface KeyProvider {
+  /**
+   * The unique identifier assigned to the Key Provider instance upon creation.
+   * @type {string}
+   * @memberof KeyProvider
+   */
+  providerId: string
+  /**
+   *
+   * @type {KeyProviderType}
+   * @memberof KeyProvider
+   */
+  type: KeyProviderType
+}
+
+/**
+ * Check if a given object implements the KeyProvider interface.
+ */
+export function instanceOfKeyProvider(value: object): value is KeyProvider {
+  if (!('providerId' in value) || value['providerId'] === undefined) return false
+  if (!('type' in value) || value['type'] === undefined) return false
+  return true
+}
+
+export function KeyProviderFromJSON(json: any): KeyProvider {
+  return KeyProviderFromJSONTyped(json, false)
+}
+
+export function KeyProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyProvider {
+  if (json == null) {
+    return json
+  }
+  return {
+    providerId: json['providerId'],
+    type: KeyProviderTypeFromJSON(json['type']),
+  }
+}
+
+export function KeyProviderToJSON(json: any): KeyProvider {
+  return KeyProviderToJSONTyped(json, false)
+}
+
+export function KeyProviderToJSONTyped(value?: KeyProvider | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    providerId: value['providerId'],
+    type: KeyProviderTypeToJSON(value['type']),
+  }
+}

package/src/models/KeyProviderResponse.ts

@@ -0,0 +1,74 @@
+/* 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 { KeyProviderType } from './KeyProviderType'
+import { KeyProviderTypeFromJSON, KeyProviderTypeToJSON } from './KeyProviderType'
+
+/**
+ * Response body containing the details of a Key Provider instance.
+ * @export
+ * @interface KeyProviderResponse
+ */
+export interface KeyProviderResponse {
+  /**
+   * The unique identifier assigned to the Key Provider instance upon creation.
+   * @type {string}
+   * @memberof KeyProviderResponse
+   */
+  providerId: string
+  /**
+   *
+   * @type {KeyProviderType}
+   * @memberof KeyProviderResponse
+   */
+  type: KeyProviderType
+}
+
+/**
+ * Check if a given object implements the KeyProviderResponse interface.
+ */
+export function instanceOfKeyProviderResponse(value: object): value is KeyProviderResponse {
+  if (!('providerId' in value) || value['providerId'] === undefined) return false
+  if (!('type' in value) || value['type'] === undefined) return false
+  return true
+}
+
+export function KeyProviderResponseFromJSON(json: any): KeyProviderResponse {
+  return KeyProviderResponseFromJSONTyped(json, false)
+}
+
+export function KeyProviderResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyProviderResponse {
+  if (json == null) {
+    return json
+  }
+  return {
+    providerId: json['providerId'],
+    type: KeyProviderTypeFromJSON(json['type']),
+  }
+}
+
+export function KeyProviderResponseToJSON(json: any): KeyProviderResponse {
+  return KeyProviderResponseToJSONTyped(json, false)
+}
+
+export function KeyProviderResponseToJSONTyped(value?: KeyProviderResponse | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    providerId: value['providerId'],
+    type: KeyProviderTypeToJSON(value['type']),
+  }
+}

package/src/models/KeyProviderType.ts

@@ -0,0 +1,51 @@
+/* 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 type of Key Provider. Determines the required configuration settings. - AZURE_KEYVAULT: Microsoft Azure Key Vault or Managed HSM. - AWS_KMS: Amazon Web Services Key Management Service.
+ * @export
+ */
+export const KeyProviderType = {
+  Software: 'SOFTWARE',
+  AzureKeyvault: 'AZURE_KEYVAULT',
+  AwsKms: 'AWS_KMS',
+} as const
+export type KeyProviderType = (typeof KeyProviderType)[keyof typeof KeyProviderType]
+
+export function instanceOfKeyProviderType(value: any): boolean {
+  for (const key in KeyProviderType) {
+    if (Object.prototype.hasOwnProperty.call(KeyProviderType, key)) {
+      if (KeyProviderType[key as keyof typeof KeyProviderType] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function KeyProviderTypeFromJSON(json: any): KeyProviderType {
+  return KeyProviderTypeFromJSONTyped(json, false)
+}
+
+export function KeyProviderTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyProviderType {
+  return json as KeyProviderType
+}
+
+export function KeyProviderTypeToJSON(value?: KeyProviderType | null): any {
+  return value as any
+}
+
+export function KeyProviderTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyProviderType {
+  return value as KeyProviderType
+}

package/src/models/KeyResolver.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 instance with detailed configuration.
+ * @export
+ * @interface KeyResolver
+ */
+export interface KeyResolver {
+  /**
+   * Unique identifier for the resolver.
+   * @type {string}
+   * @memberof KeyResolver
+   */
+  resolverId: string
+  /**
+   * List of identifier methods supported by this resolver.
+   * @type {Array<IdentifierMethod>}
+   * @memberof KeyResolver
+   */
+  supportedIdentifierMethods?: Array<IdentifierMethod>
+  /**
+   * List of key types supported by this resolver.
+   * @type {Array<KeyType>}
+   * @memberof KeyResolver
+   */
+  supportedKeyTypes?: Array<KeyType>
+}
+
+/**
+ * Check if a given object implements the KeyResolver interface.
+ */
+export function instanceOfKeyResolver(value: object): value is KeyResolver {
+  if (!('resolverId' in value) || value['resolverId'] === undefined) return false
+  return true
+}
+
+export function KeyResolverFromJSON(json: any): KeyResolver {
+  return KeyResolverFromJSONTyped(json, false)
+}
+
+export function KeyResolverFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyResolver {
+  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 KeyResolverToJSON(json: any): KeyResolver {
+  return KeyResolverToJSONTyped(json, false)
+}
+
+export function KeyResolverToJSONTyped(value?: KeyResolver | 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/KeyType.ts

@@ -0,0 +1,51 @@
+/* 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.
+ */
+
+/**
+ * Cryptographic key type identifier.
+ * @export
+ */
+export const KeyType = {
+  Okp: 'OKP',
+  Ec: 'EC',
+  Rsa: 'RSA',
+} as const
+export type KeyType = (typeof KeyType)[keyof typeof KeyType]
+
+export function instanceOfKeyType(value: any): boolean {
+  for (const key in KeyType) {
+    if (Object.prototype.hasOwnProperty.call(KeyType, key)) {
+      if (KeyType[key as keyof typeof KeyType] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function KeyTypeFromJSON(json: any): KeyType {
+  return KeyTypeFromJSONTyped(json, false)
+}
+
+export function KeyTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyType {
+  return json as KeyType
+}
+
+export function KeyTypeToJSON(value?: KeyType | null): any {
+  return value as any
+}
+
+export function KeyTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyType {
+  return value as KeyType
+}