Skip to content

Commit 43eb4e9

Browse files
committed
README updates
1 parent 14cb9df commit 43eb4e9

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

.github/workflows/ci-workflow.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,4 @@ jobs:
1515
- name: Build crate
1616
run: cargo build --verbose
1717
- name: Test crate
18-
run: cargo test --verbose
19-
18+
run: cargo test --verbose

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
[![Build Status](https://app.travis-ci.com/rust-keylock/rust-keylock-lib.svg?branch=master)](https://app.travis-ci.com/rust-keylock/rust-keylock-lib)
1+
[![rust-keylock CI](https://github.com/rust-keylock/rust-keylock-lib/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/rust-keylock/rust-keylock-lib/actions/workflows/ci-workflow.yml)
22
[![crates.io](https://img.shields.io/crates/v/rust_keylock.svg)](https://crates.io/crates/rust_keylock)
3-
[![codecov](https://codecov.io/gh/rust-keylock/rust-keylock-lib/branch/master/graph/badge.svg)](https://codecov.io/gh/rust-keylock/rust-keylock-lib)
43

5-
[![snapcraft](https://img.shields.io/f-droid/v/org.astonbitecode.rustkeylock.svg)](https://f-droid.org/en/packages/org.astonbitecode.rustkeylock/)
4+
[![f-droid](https://img.shields.io/f-droid/v/org.astonbitecode.rustkeylock.svg)](https://f-droid.org/en/packages/org.astonbitecode.rustkeylock/)
65
[![rust-keylock-ui](https://snapcraft.io//rust-keylock-ui/badge.svg)](https://snapcraft.io/rust-keylock-ui)
76

87

@@ -26,11 +25,11 @@ The project has not yet received any formal / official security reviews. Use it
2625

2726
### Security
2827

29-
* The data is locked with a user-defined master password, using _bcrypt_ password hashing
30-
* Encryption using _AES_ with _CTR_ mode
28+
* The data is encrypted using a user-defined master password, with _bcrypt_ password hashing
29+
* Encryption using _AES 256_ in _CTR_ mode
3130
* Data integrity checks with SHA3 (Keccak)
3231
* During runtime, the passwords are kept encrypted in memory
33-
* During runtime, the encryption keys are stored in safe, non-swappable memory
32+
* During runtime, encryption keys are stored in safe, non-swappable memory
3433
* Upon saving, the encryption keys change, even if the user master password remains the same. This results to different encrypted products, even if the data that is being encrypted is the same.
3534
* Passphrases generation using [Diceware](https://theworld.com/~reinhold/diceware.html).
3635
* Passwords health check against [pwned passwords list](https://www.troyhunt.com/ive-just-launched-pwned-passwords-version-2/), leveraging the [k-anonimity API](https://blog.cloudflare.com/validating-leaked-passwords-with-k-anonymity/).

0 commit comments

Comments
 (0)