Skip to content

Commit 02d721f

Browse files
committed
docs(crypt): add encryption algorithms and kernel config requirements
Document the algorithms used for LUKS2 volumes: - Encryption: aes-xts-plain64 (always required) - Integrity: hmac-sha256 (when integrity=true) Split kernel config requirements into two sections: always-required for encryption, and additional options needed only when integrity=true.
1 parent dff3850 commit 02d721f

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

cryptpilot-crypt/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,32 @@
1212
- **Integrity Protection**: Optional dm-integrity for data authenticity
1313
- **Flexible File Systems**: Support for ext4, xfs, vfat, swap
1414

15+
## Encryption and Integrity
16+
17+
cryptpilot-crypt uses the following algorithms for LUKS2 volumes:
18+
19+
- **Encryption**: `aes-xts-plain64`
20+
- **Integrity** (when enabled): `hmac-sha256`
21+
22+
### Kernel Configuration Requirements
23+
24+
The following kernel config options are always required for encryption:
25+
26+
```
27+
CONFIG_CRYPTO_AES=y
28+
CONFIG_CRYPTO_AES_NI_INTEL=y
29+
CONFIG_CRYPTO_XTS=y
30+
```
31+
32+
When `integrity = true` is enabled, the following additional options are required:
33+
34+
```
35+
CONFIG_DM_INTEGRITY=y
36+
CONFIG_DM_BUFIO=y
37+
CONFIG_CRYPTO_HMAC=y
38+
CONFIG_AS_SHA256_NI=y
39+
```
40+
1541
## Installation
1642

1743
Install from the [latest release](https://github.com/openanolis/cryptpilot/releases):

cryptpilot-crypt/README_zh.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,32 @@
1212
- **完整性保护**:可选的 dm-integrity 数据真实性保护
1313
- **灵活的文件系统**:支持 ext4、xfs、vfat、swap
1414

15+
## 加密与完整性
16+
17+
cryptpilot-crypt 使用以下算法进行 LUKS2 卷加密:
18+
19+
- **加密算法**`aes-xts-plain64`
20+
- **完整性算法**(启用时):`hmac-sha256`
21+
22+
### 内核配置要求
23+
24+
以下内核配置选项始终需要(用于加密功能):
25+
26+
```
27+
CONFIG_CRYPTO_AES=y
28+
CONFIG_CRYPTO_AES_NI_INTEL=y
29+
CONFIG_CRYPTO_XTS=y
30+
```
31+
32+
当启用 `integrity = true` 时,还需要以下额外选项:
33+
34+
```
35+
CONFIG_DM_INTEGRITY=y
36+
CONFIG_DM_BUFIO=y
37+
CONFIG_CRYPTO_HMAC=y
38+
CONFIG_AS_SHA256_NI=y
39+
```
40+
1541
## 安装
1642

1743
[最新发布版本](https://github.com/openanolis/cryptpilot/releases)安装:

0 commit comments

Comments
 (0)