aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/MANPAGE.md4
-rw-r--r--Documentation/file-format.md12
2 files changed, 13 insertions, 3 deletions
diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md
index c7a1c03..fd8f5db 100644
--- a/Documentation/MANPAGE.md
+++ b/Documentation/MANPAGE.md
@@ -164,6 +164,10 @@ specify `-aessiv`.
Use XChaCha20-Poly1305 file content encryption. This should be much faster
than AES-GCM on CPUs that lack AES acceleration.
+#### -aegis
+Use AEGIS file content encryption. This should be much faster
+than AES-GCM on CPUs with AES acceleration.
+
Run `gocryptfs -speed` to find out if and how much faster.
MOUNT OPTIONS
diff --git a/Documentation/file-format.md b/Documentation/file-format.md
index 7cce72c..ee10524 100644
--- a/Documentation/file-format.md
+++ b/Documentation/file-format.md
@@ -24,7 +24,13 @@ Data block, XChaCha20-Poly1305 (enabled via `-init -xchacha`)
1-4096 bytes encrypted data
16 bytes Poly1305 tag
-Full block overhead (AES-GCM and AES-SIV mode) = 32/4096 = 1/128 = 0.78125 %
+Data block, AEGIS (enabled via `-init -aegis`)
+
+ 16 bytes nonce
+ 1-4096 bytes encrypted data
+ 16 bytes tag
+
+Full block overhead (AEGIS, AES-GCM and AES-SIV mode) = 32/4096 = 1/128 = 0.78125 %
Full block overhead (XChaCha20-Poly1305 mode) = 40/4096 = \~1 %
@@ -36,8 +42,8 @@ Example: 1-byte file, AES-GCM and AES-SIV mode
Total: 51 bytes
-Example: 5000-byte file, , AES-GCM and AES-SIV mode
----------------------------------------------------
+Example: 5000-byte file, AEGIS, AES-GCM and AES-SIV mode
+--------------------------------------------------------
Header 18 bytes
Data block 4128 bytes