@scaleway/sdk-key-manager 1.2.2 → 1.4.0

package/dist/index.gen.d.ts

@@ -2,4 +2,4 @@
  * This file is automatically generated
  * PLEASE DO NOT EDIT HERE
  */
-export * as KeyManagerv1alpha1 from './v1alpha1/index.gen';
+export * as KeyManagerv1alpha1 from './v1alpha1/index.gen.js';

package/dist/v1alpha1/api.gen.cjs

@@ -14,7 +14,7 @@ class API extends sdkClient.API {
     regions: ["fr-par", "nl-ams", "pl-waw"]
   });
   /**
-   * Create a key. Create a key in a given region specified by the `region` parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
+   * Create a key. Create a key in a given region specified by the `region` parameter. You can use keys to encrypt or decrypt arbitrary payloads, to sign and verify messages or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
    *
    * @param request - The request {@link CreateKeyRequest}
    * @returns A Promise of Key
@@ -205,7 +205,7 @@ class API extends sdkClient.API {
     marshalling_gen.unmarshalDataKey
   );
   /**
-   * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. Only keys with a usage set to `symmetric_encryption` are supported by this method. The maximum payload size that can be encrypted is 64 KB of plaintext.
+   * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. The maximum payload size that can be encrypted is 64 KB of plaintext.
    *
    * @param request - The request {@link EncryptRequest}
    * @returns A Promise of EncryptResponse
@@ -313,5 +313,19 @@ class API extends sdkClient.API {
     },
     marshalling_gen.unmarshalKey
   );
+  /**
+   * List all available algorithms. Lists all cryptographic algorithms supported by the Key Manager service.
+   *
+   * @param request - The request {@link ListAlgorithmsRequest}
+   * @returns A Promise of ListAlgorithmsResponse
+   */
+  listAlgorithms = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/key-manager/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/algorithms`,
+      urlParams: sdkClient.urlParams(["usages", request.usages])
+    },
+    marshalling_gen.unmarshalListAlgorithmsResponse
+  );
 }
 exports.API = API;

package/dist/v1alpha1/api.gen.d.ts

@@ -1,6 +1,6 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality } from '@scaleway/sdk-client';
-import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, ListKeysRequest, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen';
+import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, ListAlgorithmsRequest, ListAlgorithmsResponse, ListKeysRequest, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen.js';
 /**
  * Key Manager API.
 
@@ -13,7 +13,7 @@ export declare class API extends ParentAPI {
      */
     static readonly LOCALITY: ApiLocality;
     /**
-     * Create a key. Create a key in a given region specified by the `region` parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
+     * Create a key. Create a key in a given region specified by the `region` parameter. You can use keys to encrypt or decrypt arbitrary payloads, to sign and verify messages or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
      *
      * @param request - The request {@link CreateKeyRequest}
      * @returns A Promise of Key
@@ -102,7 +102,7 @@ export declare class API extends ParentAPI {
      */
     generateDataKey: (request: Readonly<GenerateDataKeyRequest>) => Promise<DataKey>;
     /**
-     * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. Only keys with a usage set to `symmetric_encryption` are supported by this method. The maximum payload size that can be encrypted is 64 KB of plaintext.
+     * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. The maximum payload size that can be encrypted is 64 KB of plaintext.
      *
      * @param request - The request {@link EncryptRequest}
      * @returns A Promise of EncryptResponse
@@ -149,4 +149,11 @@ export declare class API extends ParentAPI {
      * @returns A Promise of Key
      */
     restoreKey: (request: Readonly<RestoreKeyRequest>) => Promise<Key>;
+    /**
+     * List all available algorithms. Lists all cryptographic algorithms supported by the Key Manager service.
+     *
+     * @param request - The request {@link ListAlgorithmsRequest}
+     * @returns A Promise of ListAlgorithmsResponse
+     */
+    listAlgorithms: (request?: Readonly<ListAlgorithmsRequest>) => Promise<ListAlgorithmsResponse>;
 }

package/dist/v1alpha1/api.gen.js

@@ -1,5 +1,5 @@
 import { API as API$1, toApiLocality, validatePathParam, urlParams, enrichForPagination } from "@scaleway/sdk-client";
-import { marshalCreateKeyRequest, unmarshalKey, unmarshalPublicKey, marshalUpdateKeyRequest, unmarshalListKeysResponse, marshalGenerateDataKeyRequest, unmarshalDataKey, marshalEncryptRequest, unmarshalEncryptResponse, marshalDecryptRequest, unmarshalDecryptResponse, marshalSignRequest, unmarshalSignResponse, marshalVerifyRequest, unmarshalVerifyResponse, marshalImportKeyMaterialRequest } from "./marshalling.gen.js";
+import { marshalCreateKeyRequest, unmarshalKey, unmarshalPublicKey, marshalUpdateKeyRequest, unmarshalListKeysResponse, marshalGenerateDataKeyRequest, unmarshalDataKey, marshalEncryptRequest, unmarshalEncryptResponse, marshalDecryptRequest, unmarshalDecryptResponse, marshalSignRequest, unmarshalSignResponse, marshalVerifyRequest, unmarshalVerifyResponse, marshalImportKeyMaterialRequest, unmarshalListAlgorithmsResponse } from "./marshalling.gen.js";
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
@@ -12,7 +12,7 @@ class API extends API$1 {
     regions: ["fr-par", "nl-ams", "pl-waw"]
   });
   /**
-   * Create a key. Create a key in a given region specified by the `region` parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
+   * Create a key. Create a key in a given region specified by the `region` parameter. You can use keys to encrypt or decrypt arbitrary payloads, to sign and verify messages or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
    *
    * @param request - The request {@link CreateKeyRequest}
    * @returns A Promise of Key
@@ -203,7 +203,7 @@ class API extends API$1 {
     unmarshalDataKey
   );
   /**
-   * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. Only keys with a usage set to `symmetric_encryption` are supported by this method. The maximum payload size that can be encrypted is 64 KB of plaintext.
+   * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. The maximum payload size that can be encrypted is 64 KB of plaintext.
    *
    * @param request - The request {@link EncryptRequest}
    * @returns A Promise of EncryptResponse
@@ -311,6 +311,20 @@ class API extends API$1 {
     },
     unmarshalKey
   );
+  /**
+   * List all available algorithms. Lists all cryptographic algorithms supported by the Key Manager service.
+   *
+   * @param request - The request {@link ListAlgorithmsRequest}
+   * @returns A Promise of ListAlgorithmsResponse
+   */
+  listAlgorithms = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/algorithms`,
+      urlParams: urlParams(["usages", request.usages])
+    },
+    unmarshalListAlgorithmsResponse
+  );
 }
 export {
   API

package/dist/v1alpha1/index.gen.cjs

@@ -15,6 +15,7 @@ exports.unmarshalDataKey = marshalling_gen.unmarshalDataKey;
 exports.unmarshalDecryptResponse = marshalling_gen.unmarshalDecryptResponse;
 exports.unmarshalEncryptResponse = marshalling_gen.unmarshalEncryptResponse;
 exports.unmarshalKey = marshalling_gen.unmarshalKey;
+exports.unmarshalListAlgorithmsResponse = marshalling_gen.unmarshalListAlgorithmsResponse;
 exports.unmarshalListKeysResponse = marshalling_gen.unmarshalListKeysResponse;
 exports.unmarshalPublicKey = marshalling_gen.unmarshalPublicKey;
 exports.unmarshalSignResponse = marshalling_gen.unmarshalSignResponse;

package/dist/v1alpha1/index.gen.d.ts

@@ -1,3 +1,3 @@
-export { API } from './api.gen';
-export * from './marshalling.gen';
-export type { CreateKeyRequest, DataKey, DataKeyAlgorithmSymmetricEncryption, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, KeyAlgorithmAsymmetricEncryption, KeyAlgorithmAsymmetricSigning, KeyAlgorithmSymmetricEncryption, KeyOrigin, KeyRotationPolicy, KeyState, KeyUsage, ListKeysRequest, ListKeysRequestOrderBy, ListKeysRequestUsage, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse, } from './types.gen';
+export { API } from './api.gen.js';
+export * from './marshalling.gen.js';
+export type { CreateKeyRequest, DataKey, DataKeyAlgorithmSymmetricEncryption, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, GetPublicKeyRequest, ImportKeyMaterialRequest, Key, KeyAlgorithmAsymmetricEncryption, KeyAlgorithmAsymmetricSigning, KeyAlgorithmSymmetricEncryption, KeyOrigin, KeyRotationPolicy, KeyState, KeyUsage, ListAlgorithmsRequest, ListAlgorithmsRequestUsage, ListAlgorithmsResponse, ListAlgorithmsResponseAlgorithm, ListKeysRequest, ListKeysRequestOrderBy, ListKeysRequestUsage, ListKeysResponse, ProtectKeyRequest, PublicKey, RestoreKeyRequest, RotateKeyRequest, SignRequest, SignResponse, UnprotectKeyRequest, UpdateKeyRequest, VerifyRequest, VerifyResponse, } from './types.gen.js';

package/dist/v1alpha1/index.gen.js

@@ -1,5 +1,5 @@
 import { API } from "./api.gen.js";
-import { marshalCreateKeyRequest, marshalDecryptRequest, marshalEncryptRequest, marshalGenerateDataKeyRequest, marshalImportKeyMaterialRequest, marshalSignRequest, marshalUpdateKeyRequest, marshalVerifyRequest, unmarshalDataKey, unmarshalDecryptResponse, unmarshalEncryptResponse, unmarshalKey, unmarshalListKeysResponse, unmarshalPublicKey, unmarshalSignResponse, unmarshalVerifyResponse } from "./marshalling.gen.js";
+import { marshalCreateKeyRequest, marshalDecryptRequest, marshalEncryptRequest, marshalGenerateDataKeyRequest, marshalImportKeyMaterialRequest, marshalSignRequest, marshalUpdateKeyRequest, marshalVerifyRequest, unmarshalDataKey, unmarshalDecryptResponse, unmarshalEncryptResponse, unmarshalKey, unmarshalListAlgorithmsResponse, unmarshalListKeysResponse, unmarshalPublicKey, unmarshalSignResponse, unmarshalVerifyResponse } from "./marshalling.gen.js";
 export {
   API,
   marshalCreateKeyRequest,
@@ -14,6 +14,7 @@ export {
   unmarshalDecryptResponse,
   unmarshalEncryptResponse,
   unmarshalKey,
+  unmarshalListAlgorithmsResponse,
   unmarshalListKeysResponse,
   unmarshalPublicKey,
   unmarshalSignResponse,

package/dist/v1alpha1/marshalling.gen.cjs

@@ -87,6 +87,31 @@ const unmarshalEncryptResponse = (data) => {
     keyId: data.key_id
   };
 };
+const unmarshalListAlgorithmsResponseAlgorithm = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListAlgorithmsResponseAlgorithm' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name,
+    recommended: data.recommended,
+    usage: data.usage
+  };
+};
+const unmarshalListAlgorithmsResponse = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListAlgorithmsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    algorithms: sdkClient.unmarshalArrayOfObject(
+      data.algorithms,
+      unmarshalListAlgorithmsResponseAlgorithm
+    )
+  };
+};
 const unmarshalListKeysResponse = (data) => {
   if (!sdkClient.isJSONObject(data)) {
     throw new TypeError(
@@ -192,6 +217,7 @@ exports.unmarshalDataKey = unmarshalDataKey;
 exports.unmarshalDecryptResponse = unmarshalDecryptResponse;
 exports.unmarshalEncryptResponse = unmarshalEncryptResponse;
 exports.unmarshalKey = unmarshalKey;
+exports.unmarshalListAlgorithmsResponse = unmarshalListAlgorithmsResponse;
 exports.unmarshalListKeysResponse = unmarshalListKeysResponse;
 exports.unmarshalPublicKey = unmarshalPublicKey;
 exports.unmarshalSignResponse = unmarshalSignResponse;

package/dist/v1alpha1/marshalling.gen.d.ts

@@ -1,9 +1,10 @@
 import type { DefaultValues } from '@scaleway/sdk-client';
-import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, ImportKeyMaterialRequest, Key, ListKeysResponse, PublicKey, SignRequest, SignResponse, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen';
+import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, ImportKeyMaterialRequest, Key, ListAlgorithmsResponse, ListKeysResponse, PublicKey, SignRequest, SignResponse, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen.js';
 export declare const unmarshalKey: (data: unknown) => Key;
 export declare const unmarshalDataKey: (data: unknown) => DataKey;
 export declare const unmarshalDecryptResponse: (data: unknown) => DecryptResponse;
 export declare const unmarshalEncryptResponse: (data: unknown) => EncryptResponse;
+export declare const unmarshalListAlgorithmsResponse: (data: unknown) => ListAlgorithmsResponse;
 export declare const unmarshalListKeysResponse: (data: unknown) => ListKeysResponse;
 export declare const unmarshalPublicKey: (data: unknown) => PublicKey;
 export declare const unmarshalSignResponse: (data: unknown) => SignResponse;

package/dist/v1alpha1/marshalling.gen.js

@@ -85,6 +85,31 @@ const unmarshalEncryptResponse = (data) => {
     keyId: data.key_id
   };
 };
+const unmarshalListAlgorithmsResponseAlgorithm = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListAlgorithmsResponseAlgorithm' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name,
+    recommended: data.recommended,
+    usage: data.usage
+  };
+};
+const unmarshalListAlgorithmsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListAlgorithmsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    algorithms: unmarshalArrayOfObject(
+      data.algorithms,
+      unmarshalListAlgorithmsResponseAlgorithm
+    )
+  };
+};
 const unmarshalListKeysResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -191,6 +216,7 @@ export {
   unmarshalDecryptResponse,
   unmarshalEncryptResponse,
   unmarshalKey,
+  unmarshalListAlgorithmsResponse,
   unmarshalListKeysResponse,
   unmarshalPublicKey,
   unmarshalSignResponse,

package/dist/v1alpha1/types.gen.d.ts

@@ -4,7 +4,8 @@ export type KeyAlgorithmAsymmetricEncryption = 'unknown_asymmetric_encryption' |
 export type KeyAlgorithmAsymmetricSigning = 'unknown_asymmetric_signing' | 'ec_p256_sha256' | 'ec_p384_sha384' | 'rsa_pss_2048_sha256' | 'rsa_pss_3072_sha256' | 'rsa_pss_4096_sha256' | 'rsa_pkcs1_2048_sha256' | 'rsa_pkcs1_3072_sha256' | 'rsa_pkcs1_4096_sha256';
 export type KeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
 export type KeyOrigin = 'unknown_origin' | 'scaleway_kms' | 'external';
-export type KeyState = 'unknown_state' | 'enabled' | 'disabled' | 'pending_key_material';
+export type KeyState = 'unknown_state' | 'enabled' | 'disabled' | 'pending_key_material' | 'scheduled_for_deletion';
+export type ListAlgorithmsRequestUsage = 'unknown_usage' | 'symmetric_encryption' | 'asymmetric_encryption' | 'asymmetric_signing';
 export type ListKeysRequestOrderBy = 'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc';
 export type ListKeysRequestUsage = 'unknown_usage' | 'symmetric_encryption' | 'asymmetric_encryption' | 'asymmetric_signing';
 export interface KeyRotationPolicy {
@@ -25,16 +26,23 @@ export interface KeyUsage {
      */
     symmetricEncryption?: KeyAlgorithmSymmetricEncryption;
     /**
+     * See the `Key.Algorithm.AsymmetricEncryption` enum for a description of values.
      *
      * One-of ('usage'): at most one of 'symmetricEncryption', 'asymmetricEncryption', 'asymmetricSigning' could be set.
      */
     asymmetricEncryption?: KeyAlgorithmAsymmetricEncryption;
     /**
+     * See the `Key.Algorithm.AsymmetricSigning` enum for a description of values.
      *
      * One-of ('usage'): at most one of 'symmetricEncryption', 'asymmetricEncryption', 'asymmetricSigning' could be set.
      */
     asymmetricSigning?: KeyAlgorithmAsymmetricSigning;
 }
+export interface ListAlgorithmsResponseAlgorithm {
+    usage: string;
+    name: string;
+    recommended: boolean;
+}
 export interface Key {
     /**
      * ID of the key.
@@ -49,7 +57,7 @@ export interface Key {
      */
     name: string;
     /**
-     * Keys with a usage set to `symmetric_encryption` can encrypt and decrypt data using the `AES-256-GCM` key algorithm. Key Manager currently only supports `AES-256-GCM`.
+     * See the `Key.Usage` enum for a description of possible values.
      */
     usage?: KeyUsage;
     /**
@@ -119,7 +127,7 @@ export type CreateKeyRequest = {
      */
     name?: string;
     /**
-     * See the `Key.Algorithm.SymmetricEncryption` enum for a description of values.
+     * See the `Key.Usage` enum for a description of possible values.
      */
     usage?: KeyUsage;
     /**
@@ -322,6 +330,22 @@ export type ImportKeyMaterialRequest = {
      */
     salt?: string;
 };
+export type ListAlgorithmsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Filter by key usage.
+     */
+    usages?: ListAlgorithmsRequestUsage[];
+};
+export interface ListAlgorithmsResponse {
+    /**
+     * Returns a list of algorithms matching the requested criteria.
+     */
+    algorithms: ListAlgorithmsResponseAlgorithm[];
+}
 export type ListKeysRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.
@@ -479,7 +503,7 @@ export interface VerifyResponse {
      */
     keyId: string;
     /**
-     * Returns `true` if the signature is valid for the digest and key, `false` otherwise.
+     * Returns `true` if the signature is valid for the digest and key, and `false` otherwise.
      */
     valid: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-key-manager",
-  "version": "1.2.2",
+  "version": "1.4.0",
   "description": "Scaleway SDK key-manager",
   "license": "Apache-2.0",
   "files": [
@@ -26,17 +26,17 @@
     "directory": "packages_generated/key-manager"
   },
   "engines": {
-    "node": ">=20.19.1"
+    "node": ">=20.19.4"
   },
   "dependencies": {
-    "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.0.5"
+    "@scaleway/random-name": "5.1.2",
+    "@scaleway/sdk-std": "1.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.0"
+    "@scaleway/sdk-client": "^1.3.2"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.0"
+    "@scaleway/sdk-client": "^1.3.2"
   },
   "scripts": {
     "package:check": "pnpm publint",