Skip to content

Commit d4e8534

Browse files
author
replydev
committed
Update README.md
1 parent eb39270 commit d4e8534

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ I believe that security is of paramount importance, especially in this digital w
1111
cotp is written with simplicity in mind, the interface is quite minimalist and intuitive as command line apps should be.
1212
This is an example:
1313

14-
cotp v0.1.4
14+
cotp v0.1.5
1515
written by @replydev
1616

1717
Password:
@@ -23,7 +23,13 @@ This is an example:
2323
### Encryption
2424
This program relies on only one database file, encrypted with [XChaCha20Poly1305](https://doc.libsodium.org/advanced/stream_ciphers/xchacha20) authenticated encryption and [Argon2id](https://en.wikipedia.org/wiki/Argon2) for key derivation.
2525
### Import/Export
26-
You can import backups made by [Aegis](https://github.com/beemdevelopment/Aegis) and [andOTP](https://github.com/andOTP/andOTP) Authenticators, but backup compatibility is growing (check [planned features](#planned-features)).
26+
You can import backups (or [converted databases](#converted-databases)) from:
27+
- [Aegis](https://github.com/beemdevelopment/Aegis)
28+
- [andOTP](https://github.com/andOTP/andOTP)
29+
- [Authy](https://authy.com/)
30+
- [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2)
31+
32+
Backup compatibility is growing (check [planned features](#planned-features)).
2733
By typing `cotp -ex` you can export your database in unencrypted json format.
2834
### Compatibility
2935
cotp can generate two-factor authentication coded using HMAC-SHA1, HMAC-SHA256 and HMAC-SHA512, with any digits, to provide a good compatibility to most two-factor authentication systems.
@@ -78,9 +84,9 @@ You can build cotp using these commands:
7884
If you are familiar with the command line interface using cotp will not be a problem.
7985
Please note that cotp requires at least an 8 chars length password.
8086
If you type `cotp -h` you get some instruction on how to use cotp utilities.
81-
For example, the version 0.1.4 prints out this help screen:
87+
For example, the version 0.1.5 prints out this help screen:
8288
```
83-
cotp v0.1.4
89+
cotp v0.1.5
8490
written by @replydev
8591
8692
USAGE:
@@ -112,6 +118,19 @@ Note that in the `--edit` command if you type . instead of argument you are spec
112118
|--|--|--|--|--|
113119
| 3 | Email_Provider | **[email protected]** | SHA1 | **8** |
114120

121+
## Database conversion
122+
To import Authy or Google Authenticator databases you need first of all to obtain the respective files in your phone in the paths:
123+
- **Authy**: `/data/data/com.authy.authy/shared_prefs/com.authy.storage.tokens.authenticator.xml`
124+
- **Google Authenticator**: `/data/data/com.google.android.apps.authenticator2/databases/databases`
125+
126+
After that run the correct python script located in the converters/ folder in this source code:
127+
128+
`python authy.py path/to/database.xml converted.json`
129+
130+
It will convert the database in a json format readable by cotp.
131+
132+
To finish import the database: `cotp -i authy path/to/database.json`
133+
115134
## Planned features
116135

117136
- [x] Reduce binary size and improve compilation speed by removing useless dependencies.
@@ -124,8 +143,8 @@ Note that in the `--edit` command if you type . instead of argument you are spec
124143
- [ ] Backup compatibility with:
125144
- [x] Aegis
126145
- [x] andOTP
127-
- [ ] Authy
128-
- [ ] Google Authenticator
146+
- [x] Authy
147+
- [x] Google Authenticator
129148
- [ ] FreeOTP
130149
- [ ] Graphical User Interface
131150

0 commit comments

Comments
 (0)