@scaleway/sdk-key-manager 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.gen.d.ts +1 -1
- package/dist/v1alpha1/api.gen.cjs +1 -1
- package/dist/v1alpha1/api.gen.d.ts +3 -3
- package/dist/v1alpha1/api.gen.js +1 -1
- package/dist/v1alpha1/index.gen.d.ts +3 -3
- package/dist/v1alpha1/marshalling.gen.d.ts +1 -1
- package/dist/v1alpha1/types.gen.d.ts +5 -3
- package/package.json +4 -4
package/dist/index.gen.d.ts
CHANGED
|
@@ -14,7 +14,7 @@ class API extends sdkClient.API {
|
|
|
14
14
|
regions: ["fr-par", "nl-ams", "pl-waw"]
|
|
15
15
|
});
|
|
16
16
|
/**
|
|
17
|
-
* Create a key. Create a key in a given region specified by the `region` parameter.
|
|
17
|
+
* 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**.
|
|
18
18
|
*
|
|
19
19
|
* @param request - The request {@link CreateKeyRequest}
|
|
20
20
|
* @returns A Promise of Key
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { ApiLocality } from '@scaleway/sdk-client';
|
|
2
1
|
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
3
|
-
import type {
|
|
2
|
+
import type { ApiLocality } from '@scaleway/sdk-client';
|
|
3
|
+
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';
|
|
4
4
|
/**
|
|
5
5
|
* Key Manager API.
|
|
6
6
|
|
|
@@ -13,7 +13,7 @@ export declare class API extends ParentAPI {
|
|
|
13
13
|
*/
|
|
14
14
|
static readonly LOCALITY: ApiLocality;
|
|
15
15
|
/**
|
|
16
|
-
* Create a key. Create a key in a given region specified by the `region` parameter.
|
|
16
|
+
* 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**.
|
|
17
17
|
*
|
|
18
18
|
* @param request - The request {@link CreateKeyRequest}
|
|
19
19
|
* @returns A Promise of Key
|
package/dist/v1alpha1/api.gen.js
CHANGED
|
@@ -12,7 +12,7 @@ class API extends API$1 {
|
|
|
12
12
|
regions: ["fr-par", "nl-ams", "pl-waw"]
|
|
13
13
|
});
|
|
14
14
|
/**
|
|
15
|
-
* Create a key. Create a key in a given region specified by the `region` parameter.
|
|
15
|
+
* 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**.
|
|
16
16
|
*
|
|
17
17
|
* @param request - The request {@link CreateKeyRequest}
|
|
18
18
|
* @returns A Promise of Key
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { API } from './api.gen';
|
|
2
|
-
export * from './marshalling.gen';
|
|
3
|
-
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';
|
|
1
|
+
export { API } from './api.gen.js';
|
|
2
|
+
export * from './marshalling.gen.js';
|
|
3
|
+
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';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DefaultValues } from '@scaleway/sdk-client';
|
|
2
|
-
import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, ImportKeyMaterialRequest, Key, ListAlgorithmsResponse, ListKeysResponse, PublicKey, SignRequest, SignResponse, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen';
|
|
2
|
+
import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, ImportKeyMaterialRequest, Key, ListAlgorithmsResponse, ListKeysResponse, PublicKey, SignRequest, SignResponse, UpdateKeyRequest, VerifyRequest, VerifyResponse } from './types.gen.js';
|
|
3
3
|
export declare const unmarshalKey: (data: unknown) => Key;
|
|
4
4
|
export declare const unmarshalDataKey: (data: unknown) => DataKey;
|
|
5
5
|
export declare const unmarshalDecryptResponse: (data: unknown) => DecryptResponse;
|
|
@@ -26,11 +26,13 @@ export interface KeyUsage {
|
|
|
26
26
|
*/
|
|
27
27
|
symmetricEncryption?: KeyAlgorithmSymmetricEncryption;
|
|
28
28
|
/**
|
|
29
|
+
* See the `Key.Algorithm.AsymmetricEncryption` enum for a description of values.
|
|
29
30
|
*
|
|
30
31
|
* One-of ('usage'): at most one of 'symmetricEncryption', 'asymmetricEncryption', 'asymmetricSigning' could be set.
|
|
31
32
|
*/
|
|
32
33
|
asymmetricEncryption?: KeyAlgorithmAsymmetricEncryption;
|
|
33
34
|
/**
|
|
35
|
+
* See the `Key.Algorithm.AsymmetricSigning` enum for a description of values.
|
|
34
36
|
*
|
|
35
37
|
* One-of ('usage'): at most one of 'symmetricEncryption', 'asymmetricEncryption', 'asymmetricSigning' could be set.
|
|
36
38
|
*/
|
|
@@ -55,7 +57,7 @@ export interface Key {
|
|
|
55
57
|
*/
|
|
56
58
|
name: string;
|
|
57
59
|
/**
|
|
58
|
-
*
|
|
60
|
+
* See the `Key.Usage` enum for a description of possible values.
|
|
59
61
|
*/
|
|
60
62
|
usage?: KeyUsage;
|
|
61
63
|
/**
|
|
@@ -125,7 +127,7 @@ export type CreateKeyRequest = {
|
|
|
125
127
|
*/
|
|
126
128
|
name?: string;
|
|
127
129
|
/**
|
|
128
|
-
* See the `Key.
|
|
130
|
+
* See the `Key.Usage` enum for a description of possible values.
|
|
129
131
|
*/
|
|
130
132
|
usage?: KeyUsage;
|
|
131
133
|
/**
|
|
@@ -501,7 +503,7 @@ export interface VerifyResponse {
|
|
|
501
503
|
*/
|
|
502
504
|
keyId: string;
|
|
503
505
|
/**
|
|
504
|
-
* Returns `true` if the signature is valid for the digest and key, `false` otherwise.
|
|
506
|
+
* Returns `true` if the signature is valid for the digest and key, and `false` otherwise.
|
|
505
507
|
*/
|
|
506
508
|
valid: boolean;
|
|
507
509
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scaleway/sdk-key-manager",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0",
|
|
4
4
|
"description": "Scaleway SDK key-manager",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"files": [
|
|
@@ -30,13 +30,13 @@
|
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
32
|
"@scaleway/random-name": "5.1.2",
|
|
33
|
-
"@scaleway/sdk-std": "1.0
|
|
33
|
+
"@scaleway/sdk-std": "1.2.0"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"@scaleway/sdk-client": "^1.3.
|
|
36
|
+
"@scaleway/sdk-client": "^1.3.3"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@scaleway/sdk-client": "^1.3.
|
|
39
|
+
"@scaleway/sdk-client": "^1.3.3"
|
|
40
40
|
},
|
|
41
41
|
"scripts": {
|
|
42
42
|
"package:check": "pnpm publint",
|