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

package/src/models/KeyVisibility.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.
+ */
+
+/**
+ * Indicates the visibility status of a cryptographic key.
+ * @export
+ */
+export const KeyVisibility = {
+  Public: 'PUBLIC',
+  Private: 'PRIVATE',
+} as const
+export type KeyVisibility = (typeof KeyVisibility)[keyof typeof KeyVisibility]
+
+export function instanceOfKeyVisibility(value: any): boolean {
+  for (const key in KeyVisibility) {
+    if (Object.prototype.hasOwnProperty.call(KeyVisibility, key)) {
+      if (KeyVisibility[key as keyof typeof KeyVisibility] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function KeyVisibilityFromJSON(json: any): KeyVisibility {
+  return KeyVisibilityFromJSONTyped(json, false)
+}
+
+export function KeyVisibilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyVisibility {
+  return json as KeyVisibility
+}
+
+export function KeyVisibilityToJSON(value?: KeyVisibility | null): any {
+  return value as any
+}
+
+export function KeyVisibilityToJSONTyped(value: any, ignoreDiscriminator: boolean): KeyVisibility {
+  return value as KeyVisibility
+}

package/src/models/ListKeyProvidersResponse.ts

@@ -0,0 +1,65 @@
+/* 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 { KeyProvider } from './KeyProvider'
+import { KeyProviderFromJSON, KeyProviderToJSON } from './KeyProvider'
+
+/**
+ * Response body containing the details of a Key Provider instance.
+ * @export
+ * @interface ListKeyProvidersResponse
+ */
+export interface ListKeyProvidersResponse {
+  /**
+   *
+   * @type {Array<KeyProvider>}
+   * @memberof ListKeyProvidersResponse
+   */
+  providers: Array<KeyProvider>
+}
+
+/**
+ * Check if a given object implements the ListKeyProvidersResponse interface.
+ */
+export function instanceOfListKeyProvidersResponse(value: object): value is ListKeyProvidersResponse {
+  if (!('providers' in value) || value['providers'] === undefined) return false
+  return true
+}
+
+export function ListKeyProvidersResponseFromJSON(json: any): ListKeyProvidersResponse {
+  return ListKeyProvidersResponseFromJSONTyped(json, false)
+}
+
+export function ListKeyProvidersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListKeyProvidersResponse {
+  if (json == null) {
+    return json
+  }
+  return {
+    providers: (json['providers'] as Array<any>).map(KeyProviderFromJSON),
+  }
+}
+
+export function ListKeyProvidersResponseToJSON(json: any): ListKeyProvidersResponse {
+  return ListKeyProvidersResponseToJSONTyped(json, false)
+}
+
+export function ListKeyProvidersResponseToJSONTyped(value?: ListKeyProvidersResponse | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    providers: (value['providers'] as Array<any>).map(KeyProviderToJSON),
+  }
+}

package/src/models/ListKeysResponse.ts

@@ -0,0 +1,65 @@
+/* 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 { ManagedKeyInfo } from './ManagedKeyInfo'
+import { ManagedKeyInfoFromJSON, ManagedKeyInfoToJSON } from './ManagedKeyInfo'
+
+/**
+ * Response body containing all the managed keys.
+ * @export
+ * @interface ListKeysResponse
+ */
+export interface ListKeysResponse {
+  /**
+   *
+   * @type {Array<ManagedKeyInfo>}
+   * @memberof ListKeysResponse
+   */
+  keyInfos: Array<ManagedKeyInfo>
+}
+
+/**
+ * Check if a given object implements the ListKeysResponse interface.
+ */
+export function instanceOfListKeysResponse(value: object): value is ListKeysResponse {
+  if (!('keyInfos' in value) || value['keyInfos'] === undefined) return false
+  return true
+}
+
+export function ListKeysResponseFromJSON(json: any): ListKeysResponse {
+  return ListKeysResponseFromJSONTyped(json, false)
+}
+
+export function ListKeysResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListKeysResponse {
+  if (json == null) {
+    return json
+  }
+  return {
+    keyInfos: (json['keyInfos'] as Array<any>).map(ManagedKeyInfoFromJSON),
+  }
+}
+
+export function ListKeysResponseToJSON(json: any): ListKeysResponse {
+  return ListKeysResponseToJSONTyped(json, false)
+}
+
+export function ListKeysResponseToJSONTyped(value?: ListKeysResponse | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    keyInfos: (value['keyInfos'] as Array<any>).map(ManagedKeyInfoToJSON),
+  }
+}

package/src/models/ListResolversResponse.ts

@@ -0,0 +1,65 @@
+/* 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 { Resolver } from './Resolver'
+import { ResolverFromJSON, ResolverToJSON } from './Resolver'
+
+/**
+ * Response body containing all the resolvers.
+ * @export
+ * @interface ListResolversResponse
+ */
+export interface ListResolversResponse {
+  /**
+   *
+   * @type {Array<Resolver>}
+   * @memberof ListResolversResponse
+   */
+  resolvers: Array<Resolver>
+}
+
+/**
+ * Check if a given object implements the ListResolversResponse interface.
+ */
+export function instanceOfListResolversResponse(value: object): value is ListResolversResponse {
+  if (!('resolvers' in value) || value['resolvers'] === undefined) return false
+  return true
+}
+
+export function ListResolversResponseFromJSON(json: any): ListResolversResponse {
+  return ListResolversResponseFromJSONTyped(json, false)
+}
+
+export function ListResolversResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListResolversResponse {
+  if (json == null) {
+    return json
+  }
+  return {
+    resolvers: (json['resolvers'] as Array<any>).map(ResolverFromJSON),
+  }
+}
+
+export function ListResolversResponseToJSON(json: any): ListResolversResponse {
+  return ListResolversResponseToJSONTyped(json, false)
+}
+
+export function ListResolversResponseToJSONTyped(value?: ListResolversResponse | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    resolvers: (value['resolvers'] as Array<any>).map(ResolverToJSON),
+  }
+}

package/src/models/LookupMode.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.
+ */
+
+/**
+ * Determines how configuration values are looked up. - VALUE: The actual configuration values are provided directly. - CONFIG_SERVICE: Configuration values are looked up from a configuration service using keys. - SECRET_SERVICE: Configuration values are looked up from a secret service using keys.
+ * @export
+ */
+export const LookupMode = {
+  Value: 'VALUE',
+  ConfigService: 'CONFIG_SERVICE',
+  SecretService: 'SECRET_SERVICE',
+} as const
+export type LookupMode = (typeof LookupMode)[keyof typeof LookupMode]
+
+export function instanceOfLookupMode(value: any): boolean {
+  for (const key in LookupMode) {
+    if (Object.prototype.hasOwnProperty.call(LookupMode, key)) {
+      if (LookupMode[key as keyof typeof LookupMode] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function LookupModeFromJSON(json: any): LookupMode {
+  return LookupModeFromJSONTyped(json, false)
+}
+
+export function LookupModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): LookupMode {
+  return json as LookupMode
+}
+
+export function LookupModeToJSON(value?: LookupMode | null): any {
+  return value as any
+}
+
+export function LookupModeToJSONTyped(value: any, ignoreDiscriminator: boolean): LookupMode {
+  return value as LookupMode
+}

package/src/models/ManagedKeyInfo.ts

@@ -0,0 +1,147 @@
+/* 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 managed cryptographic key information that is guaranteed to be present and resolved, part of a KMS providing concrete access to the key.
+ * @export
+ * @interface ManagedKeyInfo
+ */
+export interface ManagedKeyInfo {
+  /**
+   * Unique identifier for the cryptographic key. Can be null if the key identifier is not provided.
+   * @type {string}
+   * @memberof ManagedKeyInfo
+   */
+  kid?: string
+  /**
+   *
+   * @type {Jwk}
+   * @memberof ManagedKeyInfo
+   */
+  key: Jwk
+  /**
+   *
+   * @type {SignatureAlgorithm}
+   * @memberof ManagedKeyInfo
+   */
+  signatureAlgorithm?: SignatureAlgorithm
+  /**
+   *
+   * @type {KeyVisibility}
+   * @memberof ManagedKeyInfo
+   */
+  keyVisibility?: KeyVisibility
+  /**
+   * X.509 certificate chain associated with the key.
+   * @type {Array<string>}
+   * @memberof ManagedKeyInfo
+   */
+  x5c?: Array<string>
+  /**
+   * A reference or alias to the key in the Key Management Service (KMS).
+   * @type {string}
+   * @memberof ManagedKeyInfo
+   */
+  alias: string
+  /**
+   * The Key Management System (KMS) identifier associated with the key.
+   * @type {string}
+   * @memberof ManagedKeyInfo
+   */
+  providerId: string
+  /**
+   *
+   * @type {KeyType}
+   * @memberof ManagedKeyInfo
+   */
+  keyType?: KeyType
+  /**
+   *
+   * @type {KeyEncoding}
+   * @memberof ManagedKeyInfo
+   */
+  keyEncoding?: KeyEncoding
+  /**
+   * Additional configuration options as key-value pairs.
+   * @type {{ [key: string]: string; }}
+   * @memberof ManagedKeyInfo
+   */
+  opts?: { [key: string]: string }
+}
+
+/**
+ * Check if a given object implements the ManagedKeyInfo interface.
+ */
+export function instanceOfManagedKeyInfo(value: object): value is ManagedKeyInfo {
+  if (!('key' in value) || value['key'] === undefined) return false
+  if (!('alias' in value) || value['alias'] === undefined) return false
+  if (!('providerId' in value) || value['providerId'] === undefined) return false
+  return true
+}
+
+export function ManagedKeyInfoFromJSON(json: any): ManagedKeyInfo {
+  return ManagedKeyInfoFromJSONTyped(json, false)
+}
+
+export function ManagedKeyInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ManagedKeyInfo {
+  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'],
+    providerId: 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 ManagedKeyInfoToJSON(json: any): ManagedKeyInfo {
+  return ManagedKeyInfoToJSONTyped(json, false)
+}
+
+export function ManagedKeyInfoToJSONTyped(value?: ManagedKeyInfo | 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/ManagedKeyPair.ts

@@ -0,0 +1,102 @@
+/* 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 { JoseKeyPair } from './JoseKeyPair'
+import { JoseKeyPairFromJSON, JoseKeyPairToJSON } from './JoseKeyPair'
+import type { CoseKeyPair } from './CoseKeyPair'
+import { CoseKeyPairFromJSON, CoseKeyPairToJSON } from './CoseKeyPair'
+
+/**
+ * Represents a key pair used by a crypto provider, encapsulating both JOSE and COSE key pairs.
+ * @export
+ * @interface ManagedKeyPair
+ */
+export interface ManagedKeyPair {
+  /**
+   * Key identifier, may be null.
+   * @type {string}
+   * @memberof ManagedKeyPair
+   */
+  kid?: string
+  /**
+   * Key Management System identifier.
+   * @type {string}
+   * @memberof ManagedKeyPair
+   */
+  providerId: string
+  /**
+   * Reference to the key in the KMS.
+   * @type {string}
+   * @memberof ManagedKeyPair
+   */
+  alias: string
+  /**
+   *
+   * @type {CoseKeyPair}
+   * @memberof ManagedKeyPair
+   */
+  cose: CoseKeyPair
+  /**
+   *
+   * @type {JoseKeyPair}
+   * @memberof ManagedKeyPair
+   */
+  jose: JoseKeyPair
+}
+
+/**
+ * Check if a given object implements the ManagedKeyPair interface.
+ */
+export function instanceOfManagedKeyPair(value: object): value is ManagedKeyPair {
+  if (!('providerId' in value) || value['providerId'] === undefined) return false
+  if (!('alias' in value) || value['alias'] === undefined) return false
+  if (!('cose' in value) || value['cose'] === undefined) return false
+  if (!('jose' in value) || value['jose'] === undefined) return false
+  return true
+}
+
+export function ManagedKeyPairFromJSON(json: any): ManagedKeyPair {
+  return ManagedKeyPairFromJSONTyped(json, false)
+}
+
+export function ManagedKeyPairFromJSONTyped(json: any, ignoreDiscriminator: boolean): ManagedKeyPair {
+  if (json == null) {
+    return json
+  }
+  return {
+    kid: json['kid'] == null ? undefined : json['kid'],
+    providerId: json['providerId'],
+    alias: json['alias'],
+    cose: CoseKeyPairFromJSON(json['cose']),
+    jose: JoseKeyPairFromJSON(json['jose']),
+  }
+}
+
+export function ManagedKeyPairToJSON(json: any): ManagedKeyPair {
+  return ManagedKeyPairToJSONTyped(json, false)
+}
+
+export function ManagedKeyPairToJSONTyped(value?: ManagedKeyPair | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    kid: value['kid'],
+    providerId: value['providerId'],
+    alias: value['alias'],
+    cose: CoseKeyPairToJSON(value['cose']),
+    jose: JoseKeyPairToJSON(value['jose']),
+  }
+}

package/src/models/MaskGenFunction.ts

@@ -0,0 +1,49 @@
+/* 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.
+ */
+
+/**
+ * Mask generation function algorithm.
+ * @export
+ */
+export const MaskGenFunction = {
+  Mgf1: 'MGF1',
+} as const
+export type MaskGenFunction = (typeof MaskGenFunction)[keyof typeof MaskGenFunction]
+
+export function instanceOfMaskGenFunction(value: any): boolean {
+  for (const key in MaskGenFunction) {
+    if (Object.prototype.hasOwnProperty.call(MaskGenFunction, key)) {
+      if (MaskGenFunction[key as keyof typeof MaskGenFunction] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function MaskGenFunctionFromJSON(json: any): MaskGenFunction {
+  return MaskGenFunctionFromJSONTyped(json, false)
+}
+
+export function MaskGenFunctionFromJSONTyped(json: any, ignoreDiscriminator: boolean): MaskGenFunction {
+  return json as MaskGenFunction
+}
+
+export function MaskGenFunctionToJSON(value?: MaskGenFunction | null): any {
+  return value as any
+}
+
+export function MaskGenFunctionToJSONTyped(value: any, ignoreDiscriminator: boolean): MaskGenFunction {
+  return value as MaskGenFunction
+}