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

package/src/models/GenerateKey.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 { KeyOperations } from './KeyOperations'
+import { KeyOperationsFromJSON, KeyOperationsToJSON } from './KeyOperations'
+import type { SignatureAlgorithm } from './SignatureAlgorithm'
+import { SignatureAlgorithmFromJSON, SignatureAlgorithmToJSON } from './SignatureAlgorithm'
+import type { JwkUse } from './JwkUse'
+import { JwkUseFromJSON, JwkUseToJSON } from './JwkUse'
+
+/**
+ * Parameters for key generation.
+ * @export
+ * @interface GenerateKey
+ */
+export interface GenerateKey {
+  /**
+   * Alias for the generated key.
+   * @type {string}
+   * @memberof GenerateKey
+   */
+  alias?: string
+  /**
+   *
+   * @type {JwkUse}
+   * @memberof GenerateKey
+   */
+  use?: JwkUse
+  /**
+   *
+   * @type {Array<KeyOperations>}
+   * @memberof GenerateKey
+   */
+  keyOperations?: Array<KeyOperations>
+  /**
+   *
+   * @type {SignatureAlgorithm}
+   * @memberof GenerateKey
+   */
+  alg?: SignatureAlgorithm
+}
+
+/**
+ * Check if a given object implements the GenerateKey interface.
+ */
+export function instanceOfGenerateKey(value: object): value is GenerateKey {
+  return true
+}
+
+export function GenerateKeyFromJSON(json: any): GenerateKey {
+  return GenerateKeyFromJSONTyped(json, false)
+}
+
+export function GenerateKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateKey {
+  if (json == null) {
+    return json
+  }
+  return {
+    alias: json['alias'] == null ? undefined : json['alias'],
+    use: json['use'] == null ? undefined : JwkUseFromJSON(json['use']),
+    keyOperations: json['keyOperations'] == null ? undefined : (json['keyOperations'] as Array<any>).map(KeyOperationsFromJSON),
+    alg: json['alg'] == null ? undefined : SignatureAlgorithmFromJSON(json['alg']),
+  }
+}
+
+export function GenerateKeyToJSON(json: any): GenerateKey {
+  return GenerateKeyToJSONTyped(json, false)
+}
+
+export function GenerateKeyToJSONTyped(value?: GenerateKey | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    alias: value['alias'],
+    use: JwkUseToJSON(value['use']),
+    keyOperations: value['keyOperations'] == null ? undefined : (value['keyOperations'] as Array<any>).map(KeyOperationsToJSON),
+    alg: SignatureAlgorithmToJSON(value['alg']),
+  }
+}

package/src/models/GenerateKeyGlobal.ts

@@ -0,0 +1,100 @@
+/* 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 { KeyOperations } from './KeyOperations'
+import { KeyOperationsFromJSON, KeyOperationsToJSON } from './KeyOperations'
+import type { SignatureAlgorithm } from './SignatureAlgorithm'
+import { SignatureAlgorithmFromJSON, SignatureAlgorithmToJSON } from './SignatureAlgorithm'
+import type { JwkUse } from './JwkUse'
+import { JwkUseFromJSON, JwkUseToJSON } from './JwkUse'
+
+/**
+ * Parameters for global key generation with optional provider specification.
+ * @export
+ * @interface GenerateKeyGlobal
+ */
+export interface GenerateKeyGlobal {
+  /**
+   * Alias for the generated key.
+   * @type {string}
+   * @memberof GenerateKeyGlobal
+   */
+  alias?: string
+  /**
+   *
+   * @type {JwkUse}
+   * @memberof GenerateKeyGlobal
+   */
+  use?: JwkUse
+  /**
+   *
+   * @type {Array<KeyOperations>}
+   * @memberof GenerateKeyGlobal
+   */
+  keyOperations?: Array<KeyOperations>
+  /**
+   *
+   * @type {SignatureAlgorithm}
+   * @memberof GenerateKeyGlobal
+   */
+  alg?: SignatureAlgorithm
+  /**
+   * Optional provider ID. If not specified, the default provider will be used.
+   * @type {string}
+   * @memberof GenerateKeyGlobal
+   */
+  providerId?: string
+}
+
+/**
+ * Check if a given object implements the GenerateKeyGlobal interface.
+ */
+export function instanceOfGenerateKeyGlobal(value: object): value is GenerateKeyGlobal {
+  return true
+}
+
+export function GenerateKeyGlobalFromJSON(json: any): GenerateKeyGlobal {
+  return GenerateKeyGlobalFromJSONTyped(json, false)
+}
+
+export function GenerateKeyGlobalFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateKeyGlobal {
+  if (json == null) {
+    return json
+  }
+  return {
+    alias: json['alias'] == null ? undefined : json['alias'],
+    use: json['use'] == null ? undefined : JwkUseFromJSON(json['use']),
+    keyOperations: json['keyOperations'] == null ? undefined : (json['keyOperations'] as Array<any>).map(KeyOperationsFromJSON),
+    alg: json['alg'] == null ? undefined : SignatureAlgorithmFromJSON(json['alg']),
+    providerId: json['providerId'] == null ? undefined : json['providerId'],
+  }
+}
+
+export function GenerateKeyGlobalToJSON(json: any): GenerateKeyGlobal {
+  return GenerateKeyGlobalToJSONTyped(json, false)
+}
+
+export function GenerateKeyGlobalToJSONTyped(value?: GenerateKeyGlobal | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    alias: value['alias'],
+    use: JwkUseToJSON(value['use']),
+    keyOperations: value['keyOperations'] == null ? undefined : (value['keyOperations'] as Array<any>).map(KeyOperationsToJSON),
+    alg: SignatureAlgorithmToJSON(value['alg']),
+    providerId: value['providerId'],
+  }
+}

package/src/models/GenerateKeyResponse.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 { ManagedKeyPair } from './ManagedKeyPair'
+import { ManagedKeyPairFromJSON, ManagedKeyPairToJSON } from './ManagedKeyPair'
+
+/**
+ * Response body containing a generated key pair.
+ * @export
+ * @interface GenerateKeyResponse
+ */
+export interface GenerateKeyResponse {
+  /**
+   *
+   * @type {ManagedKeyPair}
+   * @memberof GenerateKeyResponse
+   */
+  keyPair: ManagedKeyPair
+}
+
+/**
+ * Check if a given object implements the GenerateKeyResponse interface.
+ */
+export function instanceOfGenerateKeyResponse(value: object): value is GenerateKeyResponse {
+  if (!('keyPair' in value) || value['keyPair'] === undefined) return false
+  return true
+}
+
+export function GenerateKeyResponseFromJSON(json: any): GenerateKeyResponse {
+  return GenerateKeyResponseFromJSONTyped(json, false)
+}
+
+export function GenerateKeyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateKeyResponse {
+  if (json == null) {
+    return json
+  }
+  return {
+    keyPair: ManagedKeyPairFromJSON(json['keyPair']),
+  }
+}
+
+export function GenerateKeyResponseToJSON(json: any): GenerateKeyResponse {
+  return GenerateKeyResponseToJSONTyped(json, false)
+}
+
+export function GenerateKeyResponseToJSONTyped(value?: GenerateKeyResponse | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    keyPair: ManagedKeyPairToJSON(value['keyPair']),
+  }
+}

package/src/models/GetKeyResponse.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 a managed key.
+ * @export
+ * @interface GetKeyResponse
+ */
+export interface GetKeyResponse {
+  /**
+   *
+   * @type {ManagedKeyInfo}
+   * @memberof GetKeyResponse
+   */
+  keyInfo: ManagedKeyInfo
+}
+
+/**
+ * Check if a given object implements the GetKeyResponse interface.
+ */
+export function instanceOfGetKeyResponse(value: object): value is GetKeyResponse {
+  if (!('keyInfo' in value) || value['keyInfo'] === undefined) return false
+  return true
+}
+
+export function GetKeyResponseFromJSON(json: any): GetKeyResponse {
+  return GetKeyResponseFromJSONTyped(json, false)
+}
+
+export function GetKeyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetKeyResponse {
+  if (json == null) {
+    return json
+  }
+  return {
+    keyInfo: ManagedKeyInfoFromJSON(json['keyInfo']),
+  }
+}
+
+export function GetKeyResponseToJSON(json: any): GetKeyResponse {
+  return GetKeyResponseToJSONTyped(json, false)
+}
+
+export function GetKeyResponseToJSONTyped(value?: GetKeyResponse | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    keyInfo: ManagedKeyInfoToJSON(value['keyInfo']),
+  }
+}

package/src/models/IdentifierMethod.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+/**
+ * Method used to identify cryptographic keys.
+ * @export
+ */
+export const IdentifierMethod = {
+  Jwk: 'JWK',
+  Kid: 'KID',
+  CoseKey: 'COSE_KEY',
+  X5C: 'X5C',
+  Did: 'DID',
+} as const
+export type IdentifierMethod = (typeof IdentifierMethod)[keyof typeof IdentifierMethod]
+
+export function instanceOfIdentifierMethod(value: any): boolean {
+  for (const key in IdentifierMethod) {
+    if (Object.prototype.hasOwnProperty.call(IdentifierMethod, key)) {
+      if (IdentifierMethod[key as keyof typeof IdentifierMethod] === value) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+export function IdentifierMethodFromJSON(json: any): IdentifierMethod {
+  return IdentifierMethodFromJSONTyped(json, false)
+}
+
+export function IdentifierMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): IdentifierMethod {
+  return json as IdentifierMethod
+}
+
+export function IdentifierMethodToJSON(value?: IdentifierMethod | null): any {
+  return value as any
+}
+
+export function IdentifierMethodToJSONTyped(value: any, ignoreDiscriminator: boolean): IdentifierMethod {
+  return value as IdentifierMethod
+}

package/src/models/JoseKeyPair.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 { Jwk } from './Jwk'
+import { JwkFromJSON, JwkToJSON } from './Jwk'
+
+/**
+ * Data class representing a cryptographic key pair used with JOSE (JSON Object Signing and Encryption).
+ * @export
+ * @interface JoseKeyPair
+ */
+export interface JoseKeyPair {
+  /**
+   *
+   * @type {Jwk}
+   * @memberof JoseKeyPair
+   */
+  privateJwk?: Jwk
+  /**
+   *
+   * @type {Jwk}
+   * @memberof JoseKeyPair
+   */
+  publicJwk: Jwk
+}
+
+/**
+ * Check if a given object implements the JoseKeyPair interface.
+ */
+export function instanceOfJoseKeyPair(value: object): value is JoseKeyPair {
+  if (!('publicJwk' in value) || value['publicJwk'] === undefined) return false
+  return true
+}
+
+export function JoseKeyPairFromJSON(json: any): JoseKeyPair {
+  return JoseKeyPairFromJSONTyped(json, false)
+}
+
+export function JoseKeyPairFromJSONTyped(json: any, ignoreDiscriminator: boolean): JoseKeyPair {
+  if (json == null) {
+    return json
+  }
+  return {
+    privateJwk: json['privateJwk'] == null ? undefined : JwkFromJSON(json['privateJwk']),
+    publicJwk: JwkFromJSON(json['publicJwk']),
+  }
+}
+
+export function JoseKeyPairToJSON(json: any): JoseKeyPair {
+  return JoseKeyPairToJSONTyped(json, false)
+}
+
+export function JoseKeyPairToJSONTyped(value?: JoseKeyPair | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    privateJwk: JwkToJSON(value['privateJwk']),
+    publicJwk: JwkToJSON(value['publicJwk']),
+  }
+}

package/src/models/Jwk.ts

@@ -0,0 +1,231 @@
+/* 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 { Curve } from './Curve'
+import { CurveFromJSON, CurveToJSON } from './Curve'
+import type { KeyOperations } from './KeyOperations'
+import { KeyOperationsFromJSON, KeyOperationsToJSON } from './KeyOperations'
+import type { JwkUse } from './JwkUse'
+import { JwkUseFromJSON, JwkUseToJSON } from './JwkUse'
+import type { JwkKeyType } from './JwkKeyType'
+import { JwkKeyTypeFromJSON, JwkKeyTypeToJSON } from './JwkKeyType'
+
+/**
+ * Represents a JSON Web Key (JWK) as defined by the JSON Web Key specification.
+ * @export
+ * @interface Jwk
+ */
+export interface Jwk {
+  /**
+   *
+   * @type {JwkKeyType}
+   * @memberof Jwk
+   */
+  kty: JwkKeyType
+  /**
+   * Key identifier used to uniquely identify the key.
+   * @type {string}
+   * @memberof Jwk
+   */
+  kid?: string
+  /**
+   * The algorithm intended for use with the key (JWA algorithm name).
+   * @type {string}
+   * @memberof Jwk
+   */
+  alg?: string
+  /**
+   *
+   * @type {JwkUse}
+   * @memberof Jwk
+   */
+  use?: JwkUse
+  /**
+   * The allowed cryptographic operations for the key.
+   * @type {Array<KeyOperations>}
+   * @memberof Jwk
+   */
+  keyOps?: Array<KeyOperations>
+  /**
+   *
+   * @type {Curve}
+   * @memberof Jwk
+   */
+  crv?: Curve
+  /**
+   * The x coordinate for elliptic curve keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  x?: string
+  /**
+   * The y coordinate for elliptic curve keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  y?: string
+  /**
+   * The private key parameter (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  d?: string
+  /**
+   * The modulus value for RSA keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  n?: string
+  /**
+   * The public exponent for RSA keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  e?: string
+  /**
+   * The first prime factor for RSA private keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  p?: string
+  /**
+   * The second prime factor for RSA private keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  q?: string
+  /**
+   * The first factor CRT exponent for RSA private keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  dp?: string
+  /**
+   * The second factor CRT exponent for RSA private keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  dq?: string
+  /**
+   * The first CRT coefficient for RSA private keys (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  qi?: string
+  /**
+   * The symmetric key value (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  k?: string
+  /**
+   * X.509 certificate chain as base64-encoded DER certificates.
+   * @type {Array<string>}
+   * @memberof Jwk
+   */
+  x5c?: Array<string>
+  /**
+   * X.509 certificate SHA-1 thumbprint (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  x5t?: string
+  /**
+   * URL pointing to X.509 certificate or certificate chain.
+   * @type {string}
+   * @memberof Jwk
+   */
+  x5u?: string
+  /**
+   * X.509 certificate SHA-256 thumbprint (base64url-encoded).
+   * @type {string}
+   * @memberof Jwk
+   */
+  x5tS256?: string
+}
+
+/**
+ * Check if a given object implements the Jwk interface.
+ */
+export function instanceOfJwk(value: object): value is Jwk {
+  if (!('kty' in value) || value['kty'] === undefined) return false
+  return true
+}
+
+export function JwkFromJSON(json: any): Jwk {
+  return JwkFromJSONTyped(json, false)
+}
+
+export function JwkFromJSONTyped(json: any, ignoreDiscriminator: boolean): Jwk {
+  if (json == null) {
+    return json
+  }
+  return {
+    kty: JwkKeyTypeFromJSON(json['kty']),
+    kid: json['kid'] == null ? undefined : json['kid'],
+    alg: json['alg'] == null ? undefined : json['alg'],
+    use: json['use'] == null ? undefined : JwkUseFromJSON(json['use']),
+    keyOps: json['key_ops'] == null ? undefined : (json['key_ops'] as Array<any>).map(KeyOperationsFromJSON),
+    crv: json['crv'] == null ? undefined : CurveFromJSON(json['crv']),
+    x: json['x'] == null ? undefined : json['x'],
+    y: json['y'] == null ? undefined : json['y'],
+    d: json['d'] == null ? undefined : json['d'],
+    n: json['n'] == null ? undefined : json['n'],
+    e: json['e'] == null ? undefined : json['e'],
+    p: json['p'] == null ? undefined : json['p'],
+    q: json['q'] == null ? undefined : json['q'],
+    dp: json['dp'] == null ? undefined : json['dp'],
+    dq: json['dq'] == null ? undefined : json['dq'],
+    qi: json['qi'] == null ? undefined : json['qi'],
+    k: json['k'] == null ? undefined : json['k'],
+    x5c: json['x5c'] == null ? undefined : json['x5c'],
+    x5t: json['x5t'] == null ? undefined : json['x5t'],
+    x5u: json['x5u'] == null ? undefined : json['x5u'],
+    x5tS256: json['x5t#S256'] == null ? undefined : json['x5t#S256'],
+  }
+}
+
+export function JwkToJSON(json: any): Jwk {
+  return JwkToJSONTyped(json, false)
+}
+
+export function JwkToJSONTyped(value?: Jwk | null, ignoreDiscriminator: boolean = false): any {
+  if (value == null) {
+    return value
+  }
+
+  return {
+    kty: JwkKeyTypeToJSON(value['kty']),
+    kid: value['kid'],
+    alg: value['alg'],
+    use: JwkUseToJSON(value['use']),
+    key_ops: value['keyOps'] == null ? undefined : (value['keyOps'] as Array<any>).map(KeyOperationsToJSON),
+    crv: CurveToJSON(value['crv']),
+    x: value['x'],
+    y: value['y'],
+    d: value['d'],
+    n: value['n'],
+    e: value['e'],
+    p: value['p'],
+    q: value['q'],
+    dp: value['dp'],
+    dq: value['dq'],
+    qi: value['qi'],
+    k: value['k'],
+    x5c: value['x5c'],
+    x5t: value['x5t'],
+    x5u: value['x5u'],
+    'x5t#S256': value['x5tS256'],
+  }
+}