Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
shobrook committed May 2, 2020
2 parents ca009ef + bb557f3 commit 40dd55e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 20 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<br />
</h1>

> Encryption -- so simple your mom can do it.
> Because encryption shouldn't be so hard.
`deadbolt` removes all of the complication of encrypting and decrypting files. Select a file you'd like to encrypt, enter a password and... that's it. Decrypting the file is as easy as entering the password.

Expand All @@ -13,31 +13,18 @@

## Installation

There are three ways to install `deadbolt`.
There are two recommended ways to install `deadbolt`.

### Homebrew (Recommended)

If you're on `macOS`, `Linux` or `Windows` (with `WSL`), this is the recommended installation method. The `Homebrew` formula will install the latest version for your OS.
### Homebrew (Recommended for `macOS`)

```bash
$ brew install alichtman/taps/deadbolt
$ brew cask install deadbolt
```

### GitHub Releases
### GitHub Releases (Recommended for `Linux` and `Windows`)

Download the latest release from the [deadbolt GitHub Releases](https://github.com/alichtman/deadbolt/releases) page.


### git

```bash
$ git clone https://github.com/alichtman/deadbolt.git
$ cd deadbolt
$ npm run preelectron-pack && npm run dist
# macOS installation
$ mv dist/mac/Deadbolt.app /Applications/Deadbolt.app
```

## FAQ

### Showing Extensions on `macOS`
Expand Down Expand Up @@ -68,4 +55,4 @@ org.alichtman.deadbolt

## Technical Details

`deadbolt` uses `crypto.js` from the `node.js` standard library for all cryptographic operations. `AES-256-GCM` is the default encryption algorithm used. The derived key for the cipher is created using `pbkdf2Sync`, taking in a 64B randomly generated salt and the user generated password, with 10,000 iterations, a 32B key length and `SHA512` digest. The authenticity of the data is verified with the authentication tag provided by using `GCM`.
`deadbolt` uses `AES-256-GCM` as the encryption algorithms from `crypto.js` in the `node.js` standard library. The derived key for the cipher is created using 10,000 iterations of `pbkdf2Sync`, taking in a 64B randomly generated salt, the user generated password, a 32B key length and `SHA512` digest. The authenticity of the data is verified with the authentication tag provided by using `GCM`.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "deadbolt",
"version": "0.0.0",
"version": "0.1.0",
"description": "An open source encryption app that even your mom can use.",
"license": "MIT",
"author": "Aaron Lichtman <aaronlichtman@gmail.com>",
Expand Down

0 comments on commit 40dd55e

Please sign in to comment.