Skip to content

Commit c04a194

Browse files
committed
docs(add): complete ref content page
1 parent 4ae26c1 commit c04a194

File tree

2 files changed

+80
-64
lines changed

2 files changed

+80
-64
lines changed

pages/key-manager/concepts.mdx

Lines changed: 10 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,14 @@ title: Key Manager - Concepts
33
description: Explore essential cryptographic concepts, including symmetric and asymmetric encryption, data encryption keys (DEKs), key encryption keys (KEKs), and Scaleway Key Manager's robust features for secure key management and encryption operations.
44
tags: key-manager key encryption-key
55
dates:
6-
validation: 2025-09-03
6+
validation: 2025-10-23
77
---
88

99
## Asymmetric encryption
1010

1111
Asymmetric encryption is a fundamental type of cryptographic method used to secure data with a pair of keys: a **public key** and a **private key**.
1212

13-
The public key is used for encryption and can be shared openly, while the private key is used for decryption and must be kept secret. This design eliminates the need to share a single key securely, which is a challenge in symmetric encryption.
14-
15-
Asymmetric encryption is particularly well-suited for secure communication and authentication, such as encrypting emails or verifying digital signatures. However, it is slower than symmetric encryption. Algorithms like RSA and ECC are common examples of asymmetric encryption.
16-
17-
As of now, Key Manager supports the following asymmetric encryption algorithms:
18-
19-
- RSA-OAEP-2048-SHA256: RSA encryption with 2048-bit key and OAEP padding using SHA-256.
20-
- RSA-OAEP-3072-SHA256: RSA encryption with 3072-bit key and OAEP padding using SHA-256. (recommended)
21-
- RSA-OAEP-4096-SHA256: RSA encryption with 4096-bit key and OAEP padding using SHA-256.
13+
Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/#asymmetric-encryption) documentation page for more information.
2214

2315
## Ciphertext
2416

@@ -61,51 +53,29 @@ The only way to decrypt an encrypted payload is by using the `Decrypt` [endpoint
6153

6254
## Encryption
6355

64-
A cryptographic operation used to encrypt data using the latest version of the Key Manager key. The [encryption algorithm](#encryption-algorithm) used is the one defined when setting the [key usage](#key-usage).
56+
Encryption is a cryptographic operation used to encrypt data using the latest version of the Key Manager key. The [encryption algorithm](#encryption-algorithm) used is the one defined when setting the [key usage](#key-usage).
6557

6658
The input data is arbitrary, but this endpoint should only be used to encrypt **data encryption keys**, not actual [payloads](#payload).
6759

6860
[Find out how to encrypt and decrypt payloads using The Scaleway Tink provider](/key-manager/api-cli/manage-keys-with-tink)
6961

7062
## Encryption algorithm
7163

72-
An encryption algorithm is the specific procedure used to perform encryption and decryption.
73-
74-
It defines the exact steps to transform plaintext into ciphertext and vice versa using a key.
75-
76-
As of now, Key Manager supports the following **symmetric** encryption algorithm:
77-
78-
- AES (Advanced Encryption Standard): A widely used symmetric encryption algorithm.
79-
80-
It also supports the following **asymmetric** encryption algorithms:
64+
An encryption algorithm is the specific procedure used to perform encryption and decryption. It defines the exact steps to transform plaintext into ciphertext and vice versa using a key.
8165

82-
- RSA-OAEP-2048-SHA256: RSA encryption with 2048-bit key and OAEP padding using SHA-256.
83-
- RSA-OAEP-3072-SHA256: RSA encryption with 3072-bit key and OAEP padding using SHA-256. (recommended)
84-
- RSA-OAEP-4096-SHA256: RSA encryption with 4096-bit key and OAEP padding using SHA-256.
85-
86-
Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/) documentation page for more information.
66+
Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/#encryption-algorithm) documentation page for more information.
8767

8868
## Encryption method
8969

9070
An encryption method is a broader approach used to convert readable data ([plaintext](#plaintext)) into an unreadable format ([ciphertext](#ciphertext)) which may involve one or more [encryption algorithms](#encryption-algorithm).
9171

92-
There are three types of encryption methods:
93-
94-
- [Symmetric encryption](#symmetric-encryption)
95-
- [Asymmetric encryption](#asymmetric-encryption)
96-
- Hybrid encryption: An encryption method that combines both symmetric and asymmetric methods
97-
98-
Key Manager supports symmetric and asymmetric encryption. Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/) documentation page for more information.
72+
Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/#encryption-method) documentation page for more information.
9973

10074
## Encryption scheme
10175

10276
An encryption scheme is a structured approach to encryption that specifies the encryption algorithm, key size, and mode of operation for block ciphers.
10377

104-
For example, in the `AES-256-GCM` encryption scheme:
105-
106-
- `AES` refers to the Advanced Encryption Standard (AES) encryption algorithm
107-
- `256` refers to the key length in bits
108-
- `GCM` or Galois/Counter Mode, is the mode of operation for block ciphers. GCM encrypts your plaintext data using AES, and authenticates it using a unique "tag". This means that if anyone tampers with your data, you will know because the tag will not match anymore.
78+
Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/#encryption-scheme) documentation page for more information.
10979

11080
## Key encryption key (KEK)
11181

@@ -167,16 +137,7 @@ Signature is a cryptographic technique used to ensure the authenticity and integ
167137

168138
Signatures are widely used in scenarios like document signing, secure communication, and identity verification. They offer assurance that the data originated from a trusted source and has not been tampered with.
169139

170-
As of now, Key Manager supports the following asymmetric signing algorithms:
171-
172-
- EC-P256-SHA256: ECDSA signing with the P-256 curve and SHA-256. (recommended)
173-
- EC-P384-SHA256: ECDSA signing with the P-384 curve and SHA-384.
174-
- RSA-PSS-2048-SHA256: RSA-PSS signing with 2048-bit key and SHA-256.
175-
- RSA-PSS-3072-SHA256: RSA-PSS signing with 3072-bit key and SHA-256.
176-
- RSA-PSS-4096-SHA256: RSA-PSS signing with 4096-bit key and SHA-256.
177-
- RSA-PKCS1-2048-SHA256: RSA PKCS#1 v1.5 signing with 2048-bit key and SHA-256.
178-
- RSA-PKCS1-3072-SHA256: RSA PKCS#1 v1.5 signing with 3072-bit key and SHA-256.
179-
- RSA-PKCS1-4096-SHA256: RSA PKCS#1 v1.5 signing with 4096-bit key and SHA-256.
140+
Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/#encryption-scheme) documentation page for more information on supported signing algorithms.
180141

181142
## Signature verification
182143

@@ -198,3 +159,5 @@ Symmetric encryption is a fundamental type of cryptographic method where the sam
198159
Because symmetric encryption relies on a single key, it is generally fast and ideal for encrypting large volumes of data. However, its security depends entirely on keeping the key confidential.
199160

200161
Symmetric encryption algorithms like AES are widely used in scenarios where speed and efficiency are critical. As of now, Key Manager only supports the `AES_256_GCM` symmetric encryption algorithm.
162+
163+
Refer to the [Understanding Key Manager cryptography](/key-manager/reference-content/cryptographic-details-key-manager/#symmetric-encryption) documentation page for more information.

pages/key-manager/reference-content/cryptographic-details-key-manager.mdx

Lines changed: 70 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,67 @@ title: Understanding Key Manager cryptography
33
description: This page describes the cryptographic mechanisms used by Scaleway Key Manager, in accordance with ANSSI-PA-079 recommendations.
44
tags: key-manager security
55
dates:
6-
validation: 2025-09-15
6+
validation: 2025-10-23
77
posted: 2025-05-23
88
---
99

1010
## Cryptographic primitives in Scaleway Key Manager
1111

1212
This page provides information on the core cryptographic mechanisms used by Key Manager. It explains how cryptographic keys are generated, managed, and used to encrypt data. Key Manager uses these mechanisms in compliance with the cryptographic guidelines issued by [France's national cybersecurity agency](https://cyber.gouv.fr/), as outlined in the ANSSI-PA-079 recommendations, to ensure the confidentiality and integrity of customer data.
1313

14+
### Encryption algorithm
15+
16+
An encryption algorithm is the specific procedure used to perform encryption and decryption. It defines the exact steps to transform plaintext into ciphertext and vice versa using a key.
17+
18+
As of now, Key Manager supports the following **symmetric** encryption algorithm:
19+
20+
- AES (Advanced Encryption Standard): A widely used symmetric encryption algorithm.
21+
22+
It also supports the following **asymmetric** encryption algorithms:
23+
24+
- RSA-OAEP-2048-SHA256: RSA encryption with 2048-bit key and OAEP padding using SHA-256.
25+
- RSA-OAEP-3072-SHA256: RSA encryption with 3072-bit key and OAEP padding using SHA-256. (recommended)
26+
- RSA-OAEP-4096-SHA256: RSA encryption with 4096-bit key and OAEP padding using SHA-256.
27+
28+
### Encryption method
29+
30+
An encryption method is a broader approach used to convert readable data ([plaintext](/key-manager/concepts/#plaintext)) into an unreadable format ([ciphertext](/key-manager/concepts/#ciphertext)) which may involve one or more [encryption algorithms](#encryption-algorithm).
31+
32+
There are three types of encryption methods:
33+
34+
- Symmetric encryption
35+
- Asymmetric encryption
36+
- Hybrid encryption: An encryption method that combines both symmetric and asymmetric methods
37+
38+
Key Manager supports symmetric and asymmetric encryption.
39+
40+
### Encryption scheme
41+
42+
An encryption scheme is a structured approach to encryption that specifies the encryption algorithm, key size, and mode of operation for block ciphers.
43+
44+
For example, in the `AES-256-GCM` encryption scheme:
45+
46+
- `AES` refers to the Advanced Encryption Standard (AES) encryption algorithm
47+
- `256` refers to the key length in bits
48+
- `GCM` or Galois/Counter Mode, is the mode of operation for block ciphers. GCM encrypts your plaintext data using AES, and authenticates it using a unique "tag". This means that if anyone tampers with your data, you will know because the tag will not match anymore.
49+
50+
### Signature
51+
52+
Signature is a cryptographic technique used to ensure the authenticity and integrity of data. In this process, a digest (hash) of the message is created and then signed using a private key. This signature can later be verified by anyone with access to the corresponding public key.
53+
54+
Signatures are widely used in scenarios like document signing, secure communication, and identity verification. They offer assurance that the data originated from a trusted source and has not been tampered with.
55+
56+
As of now, Key Manager supports the following asymmetric signing algorithms:
57+
58+
- EC-P256-SHA256: ECDSA signing with the P-256 curve and SHA-256. (recommended)
59+
- EC-P384-SHA256: ECDSA signing with the P-384 curve and SHA-384.
60+
- RSA-PSS-2048-SHA256: RSA-PSS signing with 2048-bit key and SHA-256.
61+
- RSA-PSS-3072-SHA256: RSA-PSS signing with 3072-bit key and SHA-256.
62+
- RSA-PSS-4096-SHA256: RSA-PSS signing with 4096-bit key and SHA-256.
63+
- RSA-PKCS1-2048-SHA256: RSA PKCS#1 v1.5 signing with 2048-bit key and SHA-256.
64+
- RSA-PKCS1-3072-SHA256: RSA PKCS#1 v1.5 signing with 3072-bit key and SHA-256.
65+
- RSA-PKCS1-4096-SHA256: RSA PKCS#1 v1.5 signing with 4096-bit key and SHA-256.
66+
1467
### Random number generation
1568

1669
#### Key encryption key (KEK) generation
@@ -37,6 +90,20 @@ Scaleway Key Manager supports Bring Your Own Key (BYOK), allowing customers to i
3790

3891
To protect against direct reuse, imported key material is not used directly. Instead, it is processed using the HKDF algorithm (HMAC-based Key Derivation Function) with SHA-256 as the hash algorithm, incorporating secure random bytes added as a salt value.
3992

93+
### Asymmetric encryption
94+
95+
Asymmetric encryption is a fundamental type of cryptographic method used to secure data with a pair of keys: a **public key** and a **private key**.
96+
97+
The public key is used for encryption and can be shared openly, while the private key is used for decryption and must be kept secret. This design eliminates the need to share a single key securely, which is a challenge in symmetric encryption.
98+
99+
Asymmetric encryption is particularly well-suited for secure communication and authentication, such as encrypting emails or verifying digital signatures. However, it is slower than symmetric encryption. Algorithms like RSA and ECC are common examples of asymmetric encryption.
100+
101+
As of now, Key Manager supports the following asymmetric encryption algorithms:
102+
103+
- RSA-OAEP-2048-SHA256: RSA encryption with 2048-bit key and OAEP padding using SHA-256.
104+
- RSA-OAEP-3072-SHA256: RSA encryption with 3072-bit key and OAEP padding using SHA-256. (recommended)
105+
- RSA-OAEP-4096-SHA256: RSA encryption with 4096-bit key and OAEP padding using SHA-256.
106+
40107
### Symmetric encryption
41108

42109
Scaleway Key Manager uses **AES-256-GCM** (AES with a 256-bit key in Galois/Counter Mode) with authenticated associated data (AEAD) for encrypting and decrypting user payloads.
@@ -48,24 +115,10 @@ To reduce the risk of key overuse, plaintext payloads are limited to a maximum s
48115
</Message>
49116

50117
<Message type="important">
51-
While Key Manager internally uses AES-256-GCM, this does not restrict users to the same algorithm for their data encryption keys (DEKs).
118+
While Key Manager internally uses AES-256-GCM, this does not restrict users to the same algorithm for their data encryption keys (DEKs).
52119
We recommend using cryptographic libraries like Tink, which handle DEK management with robust and reviewed algorithms.
53120
Scaleway provides Tink integrations for Go and Python, which is the preferred integration method.
54121

55122
- [Tink Python integration](https://github.com/scaleway/tink-py-scwkms)
56123
- [Tink Go integration](https://github.com/scaleway/tink-go-scwkms)
57-
</Message>
58-
59-
### Asymmetric encryption
60-
61-
Asymmetric encryption is a fundamental type of cryptographic method used to secure data with a pair of keys: a **public key** and a **private key**.
62-
63-
The public key is used for encryption and can be shared openly, while the private key is used for decryption and must be kept secret. This design eliminates the need to share a single key securely, which is a challenge in symmetric encryption.
64-
65-
Asymmetric encryption is particularly well-suited for secure communication and authentication, such as encrypting emails or verifying digital signatures. However, it is slower than symmetric encryption. Algorithms like RSA and ECC are common examples of asymmetric encryption.
66-
67-
As of now, Key Manager supports the following asymmetric encryption algorithms:
68-
69-
- RSA-OAEP-2048-SHA256: RSA encryption with 2048-bit key and OAEP padding using SHA-256.
70-
- RSA-OAEP-3072-SHA256: RSA encryption with 3072-bit key and OAEP padding using SHA-256. (recommended)
71-
- RSA-OAEP-4096-SHA256: RSA encryption with 4096-bit key and OAEP padding using SHA-256.
124+
</Message>

0 commit comments

Comments
 (0)