Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CooperRS committed Nov 9, 2019
1 parent 289e041 commit 2b71b60
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,35 @@ This tool allows for decrypting the encrypted backups/account files created by [

If you find problems with the file format (in particular security related issues), do not hesitate and file an issue.

## Usage

Requires:
## Requirements

- [Python 3.7](https://www.python.org/downloads/)
- [pipenv](https://docs.pipenv.org)
- [pipenv](https://github.com/pypa/pipenv)
- An encrypted OTP Auth backup/account file

## Usage

1. Clone repository

```
git clone https://github.com/CooperRS/decrypt-otpauth-files.git
cd decrypt-otpauth-files
```

2. Install dependencies

```
pipenv install
```

3. Decrypt your OTP Auth file

```
# Decrypt a full backup file
pipenv run python decrypt_otpauth.py decrypt_backup --encrypted-otpauth-backup <path to your OTP Auth backup>
```

```
# Decrypt a single account export
pipenv run python decrypt_otpauth.py decrypt_account --encrypted-otpauth-account <path to your OTP Auth account>
```
Expand Down

0 comments on commit 2b71b60

Please sign in to comment.