Skip to content

Commit c3e9dd4

Browse files
authored
docs(key_manager): add documentation (#4997)
1 parent 3dc3991 commit c3e9dd4

File tree

5 files changed

+15
-13
lines changed

5 files changed

+15
-13
lines changed

cmd/scw/testdata/test-all-usage-keymanager-key-create-usage.golden

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
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**.
3+
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**.
44

55
USAGE:
66
scw keymanager key create [arg=value ...]
77

88
ARGS:
99
[project-id] Project ID to use. If none is passed the default project ID will be used
1010
[name] (Optional) Name of the key
11-
[usage.symmetric-encryption] Algorithm used to encrypt and decrypt arbitrary payloads. (unknown_symmetric_encryption | aes_256_gcm)
12-
[usage.asymmetric-encryption] (unknown_asymmetric_encryption | rsa_oaep_2048_sha256 | rsa_oaep_3072_sha256 | rsa_oaep_4096_sha256)
13-
[usage.asymmetric-signing] (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)
11+
[usage.symmetric-encryption] Encrypt and decrypt arbitrary payloads using a symmetric encryption algorithm. (unknown_symmetric_encryption | aes_256_gcm)
12+
[usage.asymmetric-encryption] Encrypt and decrypt arbitrary payloads using an asymmetric encryption algorithm. (unknown_asymmetric_encryption | rsa_oaep_2048_sha256 | rsa_oaep_3072_sha256 | rsa_oaep_4096_sha256)
13+
[usage.asymmetric-signing] Sign and verify arbitrary messages using an asymmetric signing algorithm. (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)
1414
[description] (Optional) Description of the key
1515
[tags.{index}] (Optional) List of the key's tags
1616
[rotation-policy.rotation-period] Rotation period

docs/commands/keymanager.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Keys are logical containers which store cryptographic keys.
2727

2828
### Create a key
2929

30-
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**.
30+
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**.
3131

3232
**Usage:**
3333

@@ -42,9 +42,9 @@ scw keymanager key create [arg=value ...]
4242
|------|---|-------------|
4343
| project-id | | Project ID to use. If none is passed the default project ID will be used |
4444
| name | | (Optional) Name of the key |
45-
| usage.symmetric-encryption | One of: `unknown_symmetric_encryption`, `aes_256_gcm` | Algorithm used to encrypt and decrypt arbitrary payloads. |
46-
| usage.asymmetric-encryption | One of: `unknown_asymmetric_encryption`, `rsa_oaep_2048_sha256`, `rsa_oaep_3072_sha256`, `rsa_oaep_4096_sha256` | |
47-
| usage.asymmetric-signing | One of: `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` | |
45+
| usage.symmetric-encryption | One of: `unknown_symmetric_encryption`, `aes_256_gcm` | Encrypt and decrypt arbitrary payloads using a symmetric encryption algorithm. |
46+
| usage.asymmetric-encryption | One of: `unknown_asymmetric_encryption`, `rsa_oaep_2048_sha256`, `rsa_oaep_3072_sha256`, `rsa_oaep_4096_sha256` | Encrypt and decrypt arbitrary payloads using an asymmetric encryption algorithm. |
47+
| usage.asymmetric-signing | One of: `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` | Sign and verify arbitrary messages using an asymmetric signing algorithm. |
4848
| description | | (Optional) Description of the key |
4949
| tags.{index} | | (Optional) List of the key's tags |
5050
| rotation-policy.rotation-period | | Rotation period |

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ require (
2323
github.com/mattn/go-isatty v0.0.20
2424
github.com/moby/buildkit v0.24.0
2525
github.com/opencontainers/go-digest v1.0.0
26-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.34.0.20250909122954-71c9aae6a7e3
26+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.34.0.20250911091431-3c6786e253d0
2727
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
2828
github.com/spf13/cobra v1.10.1
2929
github.com/spf13/pflag v1.0.10

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -460,8 +460,8 @@ github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7
460460
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
461461
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
462462
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
463-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.34.0.20250909122954-71c9aae6a7e3 h1:bUgIIouQdnYoZ95+pB/WYEZh20P/So2sUZ44NaWEIBU=
464-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.34.0.20250909122954-71c9aae6a7e3/go.mod h1:2Cfo14o/ZO3hZg9GjbyD/BHKbyri3K5BiEHq4fBcUHY=
463+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.34.0.20250911091431-3c6786e253d0 h1:EOCbW0MnUjNKndDwoWiGwXix7no3Fe74sVDiXp8wMag=
464+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.34.0.20250911091431-3c6786e253d0/go.mod h1:47B1d/YXmSAxlJxUJxClzHR6b3T4M1WyCvwENPQNBWc=
465465
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
466466
github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
467467
github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=

internal/namespaces/key_manager/v1alpha1/key_manager_cli.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func keymanagerKey() *core.Command {
5959
func keymanagerKeyCreate() *core.Command {
6060
return &core.Command{
6161
Short: `Create a key`,
62-
Long: `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**.`,
62+
Long: `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**.`,
6363
Namespace: "keymanager",
6464
Resource: "key",
6565
Verb: "create",
@@ -76,7 +76,7 @@ func keymanagerKeyCreate() *core.Command {
7676
},
7777
{
7878
Name: "usage.symmetric-encryption",
79-
Short: `Algorithm used to encrypt and decrypt arbitrary payloads.`,
79+
Short: `Encrypt and decrypt arbitrary payloads using a symmetric encryption algorithm.`,
8080
Required: false,
8181
Deprecated: false,
8282
Positional: false,
@@ -87,6 +87,7 @@ func keymanagerKeyCreate() *core.Command {
8787
},
8888
{
8989
Name: "usage.asymmetric-encryption",
90+
Short: `Encrypt and decrypt arbitrary payloads using an asymmetric encryption algorithm.`,
9091
Required: false,
9192
Deprecated: false,
9293
Positional: false,
@@ -99,6 +100,7 @@ func keymanagerKeyCreate() *core.Command {
99100
},
100101
{
101102
Name: "usage.asymmetric-signing",
103+
Short: `Sign and verify arbitrary messages using an asymmetric signing algorithm.`,
102104
Required: false,
103105
Deprecated: false,
104106
Positional: false,

0 commit comments

Comments
 (0)