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

package/src/models/Jwk.ts

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

package/src/models/JwkKeyType.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.
+ */
+
+
+/**
+ * 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,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.
+ */
+
+
+/**
+ * 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,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.
+ */
+
+
+/**
+ * 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,164 @@
+/* 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,59 @@
+/* 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;
+}
+