Skip to content

Commit

Permalink
doc: update the disclaimer.
Browse files Browse the repository at this point in the history
  • Loading branch information
aegistudio committed Jan 23, 2023
1 parent 0d21abf commit eda24ad
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Enigma: a simple encrypted filesystem

***(WARN: This project has not been validated or verified for
security. In fact, current implementation is prone to chosen
ciphertext attack. It is strongly not recommended to use this
in production.)***

![build](https://github.com/aegistudio/enigma/actions/workflows/build.yml/badge.svg)
![release](https://img.shields.io/github/release/aegistudio/enigma)
![update](https://img.shields.io/github/release-date/aegistudio/enigma.svg?color=blue&label=update)
Expand Down Expand Up @@ -40,10 +45,6 @@ secrets.

## Methods of Encryption

***(WARN: the method of encryption is undergoing restatement and
reassessment. The author is working on it so that the project will
have security audit as soon as possible.)***

Both the file names and data will be encrypted by an [AES-256](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard)
key in [CTR mode](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#CTR),
which takes trillions of years for the attackers to crack, owing to
Expand Down

0 comments on commit eda24ad

Please sign in to comment.