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

package/src/models/ManagedKeyInfo.ts

@@ -0,0 +1,167 @@
+/* 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,111 @@
+/* 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,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.
+ */
+
+
+/**
+ * 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;
+}
+

package/src/models/ProviderCapabilities.ts

@@ -0,0 +1,122 @@
+/* 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,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 { 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'],
+    };
+}
+