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

package/src/models/CoseKey.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 { CoseKeyType } from './CoseKeyType';
+import {
+    CoseKeyTypeFromJSON,
+    CoseKeyTypeToJSON,
+} from './CoseKeyType';
+
+/**
+ * Represents a COSE (CBOR Object Signing and Encryption) key in JSON format.
+ * @export
+ * @interface CoseKey
+ */
+export interface CoseKey {
+    /**
+     *
+     * @type {CoseKeyType}
+     * @memberof CoseKey
+     */
+    kty: CoseKeyType;
+    /**
+     * Key identifier (base64url-encoded byte string).
+     * @type {string}
+     * @memberof CoseKey
+     */
+    kid?: string;
+    /**
+     * The COSE algorithm identifier (e.g., -7=ES256, -35=ES384, -36=ES512, -8=EdDSA).
+     * @type {number}
+     * @memberof CoseKey
+     */
+    alg?: number;
+    /**
+     * The allowed COSE key operations (1=sign, 2=verify, 3=encrypt, 4=decrypt, etc.).
+     * @type {Array<number>}
+     * @memberof CoseKey
+     */
+    keyOps?: Array<number>;
+    /**
+     * Base initialization vector (base64url-encoded).
+     * @type {string}
+     * @memberof CoseKey
+     */
+    baseIV?: string;
+    /**
+     * The COSE curve identifier (1=P-256, 2=P-384, 3=P-521, 8=secp256k1, 6=Ed25519, etc.).
+     * @type {number}
+     * @memberof CoseKey
+     */
+    crv?: number;
+    /**
+     * The x coordinate (base64url-encoded byte string).
+     * @type {string}
+     * @memberof CoseKey
+     */
+    x?: string;
+    /**
+     * The y coordinate (base64url-encoded byte string).
+     * @type {string}
+     * @memberof CoseKey
+     */
+    y?: string;
+    /**
+     * The private key parameter (base64url-encoded byte string).
+     * @type {string}
+     * @memberof CoseKey
+     */
+    d?: string;
+    /**
+     * X.509 certificate chain as base64-encoded certificates.
+     * @type {Array<string>}
+     * @memberof CoseKey
+     */
+    x5chain?: Array<string>;
+}
+
+
+
+/**
+ * Check if a given object implements the CoseKey interface.
+ */
+export function instanceOfCoseKey(value: object): value is CoseKey {
+    if (!('kty' in value) || value['kty'] === undefined) return false;
+    return true;
+}
+
+export function CoseKeyFromJSON(json: any): CoseKey {
+    return CoseKeyFromJSONTyped(json, false);
+}
+
+export function CoseKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CoseKey {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'kty': CoseKeyTypeFromJSON(json['kty']),
+        'kid': json['kid'] == null ? undefined : json['kid'],
+        'alg': json['alg'] == null ? undefined : json['alg'],
+        'keyOps': json['key_ops'] == null ? undefined : json['key_ops'],
+        'baseIV': json['baseIV'] == null ? undefined : json['baseIV'],
+        'crv': json['crv'] == null ? undefined : json['crv'],
+        'x': json['x'] == null ? undefined : json['x'],
+        'y': json['y'] == null ? undefined : json['y'],
+        'd': json['d'] == null ? undefined : json['d'],
+        'x5chain': json['x5chain'] == null ? undefined : json['x5chain'],
+    };
+}
+
+export function CoseKeyToJSON(json: any): CoseKey {
+    return CoseKeyToJSONTyped(json, false);
+}
+
+export function CoseKeyToJSONTyped(value?: CoseKey | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'kty': CoseKeyTypeToJSON(value['kty']),
+        'kid': value['kid'],
+        'alg': value['alg'],
+        'key_ops': value['keyOps'],
+        'baseIV': value['baseIV'],
+        'crv': value['crv'],
+        'x': value['x'],
+        'y': value['y'],
+        'd': value['d'],
+        'x5chain': value['x5chain'],
+    };
+}
+

package/src/models/CoseKeyPair.ts

@@ -0,0 +1,79 @@
+/* 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 { CoseKey } from './CoseKey';
+import {
+    CoseKeyFromJSON,
+    CoseKeyToJSON,
+} from './CoseKey';
+
+/**
+ * Represents a cryptographic key pair for COSE (CBOR Object Signing and Encryption) operations.
+ * @export
+ * @interface CoseKeyPair
+ */
+export interface CoseKeyPair {
+    /**
+     *
+     * @type {CoseKey}
+     * @memberof CoseKeyPair
+     */
+    privateCoseKey?: CoseKey;
+    /**
+     *
+     * @type {CoseKey}
+     * @memberof CoseKeyPair
+     */
+    publicCoseKey: CoseKey;
+}
+
+/**
+ * Check if a given object implements the CoseKeyPair interface.
+ */
+export function instanceOfCoseKeyPair(value: object): value is CoseKeyPair {
+    if (!('publicCoseKey' in value) || value['publicCoseKey'] === undefined) return false;
+    return true;
+}
+
+export function CoseKeyPairFromJSON(json: any): CoseKeyPair {
+    return CoseKeyPairFromJSONTyped(json, false);
+}
+
+export function CoseKeyPairFromJSONTyped(json: any, ignoreDiscriminator: boolean): CoseKeyPair {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'privateCoseKey': json['privateCoseKey'] == null ? undefined : CoseKeyFromJSON(json['privateCoseKey']),
+        'publicCoseKey': CoseKeyFromJSON(json['publicCoseKey']),
+    };
+}
+
+export function CoseKeyPairToJSON(json: any): CoseKeyPair {
+    return CoseKeyPairToJSONTyped(json, false);
+}
+
+export function CoseKeyPairToJSONTyped(value?: CoseKeyPair | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'privateCoseKey': CoseKeyToJSON(value['privateCoseKey']),
+        'publicCoseKey': CoseKeyToJSON(value['publicCoseKey']),
+    };
+}
+

package/src/models/CoseKeyType.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * COSE key type parameter. 1=OKP (Octet Key Pair), 2=EC2 (Elliptic Curve), 3=RSA, 4=Symmetric.
+ * @export
+ */
+export const CoseKeyType = {
+    NUMBER_1: 1,
+    NUMBER_2: 2,
+    NUMBER_3: 3,
+    NUMBER_4: 4
+} as const;
+export type CoseKeyType = typeof CoseKeyType[keyof typeof CoseKeyType];
+
+
+export function instanceOfCoseKeyType(value: any): boolean {
+    for (const key in CoseKeyType) {
+        if (Object.prototype.hasOwnProperty.call(CoseKeyType, key)) {
+            if (CoseKeyType[key as keyof typeof CoseKeyType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CoseKeyTypeFromJSON(json: any): CoseKeyType {
+    return CoseKeyTypeFromJSONTyped(json, false);
+}
+
+export function CoseKeyTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CoseKeyType {
+    return json as CoseKeyType;
+}
+
+export function CoseKeyTypeToJSON(value?: CoseKeyType | null): any {
+    return value as any;
+}
+
+export function CoseKeyTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): CoseKeyType {
+    return value as CoseKeyType;
+}
+

package/src/models/CreateKeyProvider.ts

@@ -0,0 +1,115 @@
+/* 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 { AwsKmsSetting } from './AwsKmsSetting';
+import {
+    AwsKmsSettingFromJSON,
+    AwsKmsSettingToJSON,
+} from './AwsKmsSetting';
+import type { AzureKeyVaultSetting } from './AzureKeyVaultSetting';
+import {
+    AzureKeyVaultSettingFromJSON,
+    AzureKeyVaultSettingToJSON,
+} from './AzureKeyVaultSetting';
+import type { KeyProviderType } from './KeyProviderType';
+import {
+    KeyProviderTypeFromJSON,
+    KeyProviderTypeToJSON,
+} from './KeyProviderType';
+
+/**
+ * Request body for creating a new Key Provider instance.
+ * @export
+ * @interface CreateKeyProvider
+ */
+export interface CreateKeyProvider {
+    /**
+     *
+     * @type {KeyProviderType}
+     * @memberof CreateKeyProvider
+     */
+    type: KeyProviderType;
+    /**
+     *
+     * @type {AzureKeyVaultSetting}
+     * @memberof CreateKeyProvider
+     */
+    azureKeyvaultSettings?: AzureKeyVaultSetting;
+    /**
+     *
+     * @type {AwsKmsSetting}
+     * @memberof CreateKeyProvider
+     */
+    awsKmsSettings?: AwsKmsSetting;
+    /**
+     * Whether to enable caching for keys retrieved from this provider.
+     * @type {boolean}
+     * @memberof CreateKeyProvider
+     */
+    cacheEnabled?: boolean;
+    /**
+     * Time-to-live for cached keys in seconds (if cacheEnabled is true).
+     * @type {number}
+     * @memberof CreateKeyProvider
+     */
+    cacheTTLInSeconds?: number;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateKeyProvider interface.
+ */
+export function instanceOfCreateKeyProvider(value: object): value is CreateKeyProvider {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function CreateKeyProviderFromJSON(json: any): CreateKeyProvider {
+    return CreateKeyProviderFromJSONTyped(json, false);
+}
+
+export function CreateKeyProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateKeyProvider {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'type': KeyProviderTypeFromJSON(json['type']),
+        'azureKeyvaultSettings': json['azureKeyvaultSettings'] == null ? undefined : AzureKeyVaultSettingFromJSON(json['azureKeyvaultSettings']),
+        'awsKmsSettings': json['awsKmsSettings'] == null ? undefined : AwsKmsSettingFromJSON(json['awsKmsSettings']),
+        'cacheEnabled': json['cacheEnabled'] == null ? undefined : json['cacheEnabled'],
+        'cacheTTLInSeconds': json['cacheTTLInSeconds'] == null ? undefined : json['cacheTTLInSeconds'],
+    };
+}
+
+export function CreateKeyProviderToJSON(json: any): CreateKeyProvider {
+    return CreateKeyProviderToJSONTyped(json, false);
+}
+
+export function CreateKeyProviderToJSONTyped(value?: CreateKeyProvider | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'type': KeyProviderTypeToJSON(value['type']),
+        'azureKeyvaultSettings': AzureKeyVaultSettingToJSON(value['azureKeyvaultSettings']),
+        'awsKmsSettings': AwsKmsSettingToJSON(value['awsKmsSettings']),
+        'cacheEnabled': value['cacheEnabled'],
+        'cacheTTLInSeconds': value['cacheTTLInSeconds'],
+    };
+}
+

package/src/models/CreateRawSignature.ts

@@ -0,0 +1,80 @@
+/* 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';
+
+/**
+ * Request body for creating a raw signature.
+ * @export
+ * @interface CreateRawSignature
+ */
+export interface CreateRawSignature {
+    /**
+     *
+     * @type {KeyInfo}
+     * @memberof CreateRawSignature
+     */
+    keyInfo: KeyInfo;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateRawSignature
+     */
+    input: string;
+}
+
+/**
+ * Check if a given object implements the CreateRawSignature interface.
+ */
+export function instanceOfCreateRawSignature(value: object): value is CreateRawSignature {
+    if (!('keyInfo' in value) || value['keyInfo'] === undefined) return false;
+    if (!('input' in value) || value['input'] === undefined) return false;
+    return true;
+}
+
+export function CreateRawSignatureFromJSON(json: any): CreateRawSignature {
+    return CreateRawSignatureFromJSONTyped(json, false);
+}
+
+export function CreateRawSignatureFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRawSignature {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'keyInfo': KeyInfoFromJSON(json['keyInfo']),
+        'input': json['input'],
+    };
+}
+
+export function CreateRawSignatureToJSON(json: any): CreateRawSignature {
+    return CreateRawSignatureToJSONTyped(json, false);
+}
+
+export function CreateRawSignatureToJSONTyped(value?: CreateRawSignature | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'keyInfo': KeyInfoToJSON(value['keyInfo']),
+        'input': value['input'],
+    };
+}
+

package/src/models/CreateRawSignatureResponse.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.
+ */
+
+/**
+ * Response body containing the created signature.
+ * @export
+ * @interface CreateRawSignatureResponse
+ */
+export interface CreateRawSignatureResponse {
+    /**
+     * The created signature encoded as a base64 string.
+     * @type {string}
+     * @memberof CreateRawSignatureResponse
+     */
+    signature: string;
+}
+
+/**
+ * Check if a given object implements the CreateRawSignatureResponse interface.
+ */
+export function instanceOfCreateRawSignatureResponse(value: object): value is CreateRawSignatureResponse {
+    if (!('signature' in value) || value['signature'] === undefined) return false;
+    return true;
+}
+
+export function CreateRawSignatureResponseFromJSON(json: any): CreateRawSignatureResponse {
+    return CreateRawSignatureResponseFromJSONTyped(json, false);
+}
+
+export function CreateRawSignatureResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRawSignatureResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'signature': json['signature'],
+    };
+}
+
+export function CreateRawSignatureResponseToJSON(json: any): CreateRawSignatureResponse {
+    return CreateRawSignatureResponseToJSONTyped(json, false);
+}
+
+export function CreateRawSignatureResponseToJSONTyped(value?: CreateRawSignatureResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'signature': value['signature'],
+    };
+}
+

package/src/models/CreateSimpleSignature.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 { KeyInfo } from './KeyInfo';
+import {
+    KeyInfoFromJSON,
+    KeyInfoToJSON,
+} from './KeyInfo';
+import type { SignInput } from './SignInput';
+import {
+    SignInputFromJSON,
+    SignInputToJSON,
+} from './SignInput';
+import type { SignatureAlgorithm } from './SignatureAlgorithm';
+import {
+    SignatureAlgorithmFromJSON,
+    SignatureAlgorithmToJSON,
+} from './SignatureAlgorithm';
+
+/**
+ * Request body for creating a digital signature.
+ * @export
+ * @interface CreateSimpleSignature
+ */
+export interface CreateSimpleSignature {
+    /**
+     *
+     * @type {SignInput}
+     * @memberof CreateSimpleSignature
+     */
+    signInput: SignInput;
+    /**
+     *
+     * @type {KeyInfo}
+     * @memberof CreateSimpleSignature
+     */
+    keyInfo: KeyInfo;
+    /**
+     *
+     * @type {SignatureAlgorithm}
+     * @memberof CreateSimpleSignature
+     */
+    signatureAlgorithm?: SignatureAlgorithm;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateSimpleSignature interface.
+ */
+export function instanceOfCreateSimpleSignature(value: object): value is CreateSimpleSignature {
+    if (!('signInput' in value) || value['signInput'] === undefined) return false;
+    if (!('keyInfo' in value) || value['keyInfo'] === undefined) return false;
+    return true;
+}
+
+export function CreateSimpleSignatureFromJSON(json: any): CreateSimpleSignature {
+    return CreateSimpleSignatureFromJSONTyped(json, false);
+}
+
+export function CreateSimpleSignatureFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSimpleSignature {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'signInput': SignInputFromJSON(json['signInput']),
+        'keyInfo': KeyInfoFromJSON(json['keyInfo']),
+        'signatureAlgorithm': json['signatureAlgorithm'] == null ? undefined : SignatureAlgorithmFromJSON(json['signatureAlgorithm']),
+    };
+}
+
+export function CreateSimpleSignatureToJSON(json: any): CreateSimpleSignature {
+    return CreateSimpleSignatureToJSONTyped(json, false);
+}
+
+export function CreateSimpleSignatureToJSONTyped(value?: CreateSimpleSignature | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'signInput': SignInputToJSON(value['signInput']),
+        'keyInfo': KeyInfoToJSON(value['keyInfo']),
+        'signatureAlgorithm': SignatureAlgorithmToJSON(value['signatureAlgorithm']),
+    };
+}
+

package/src/models/CryptoAlg.ts

@@ -0,0 +1,55 @@
+/* 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 algorithm type.
+ * @export
+ */
+export const CryptoAlg = {
+    Ed25519: 'ED25519',
+    Ecdsa: 'ECDSA',
+    Hmac: 'HMAC',
+    Rsa: 'RSA'
+} as const;
+export type CryptoAlg = typeof CryptoAlg[keyof typeof CryptoAlg];
+
+
+export function instanceOfCryptoAlg(value: any): boolean {
+    for (const key in CryptoAlg) {
+        if (Object.prototype.hasOwnProperty.call(CryptoAlg, key)) {
+            if (CryptoAlg[key as keyof typeof CryptoAlg] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CryptoAlgFromJSON(json: any): CryptoAlg {
+    return CryptoAlgFromJSONTyped(json, false);
+}
+
+export function CryptoAlgFromJSONTyped(json: any, ignoreDiscriminator: boolean): CryptoAlg {
+    return json as CryptoAlg;
+}
+
+export function CryptoAlgToJSON(value?: CryptoAlg | null): any {
+    return value as any;
+}
+
+export function CryptoAlgToJSONTyped(value: any, ignoreDiscriminator: boolean): CryptoAlg {
+    return value as CryptoAlg;
+}
+