Skip to content

Commit 419cee4

Browse files
author
replydev
committed
Update README.md
1 parent bb77400 commit 419cee4

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 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.3
14+
cotp v0.1.4
1515
written by @replydev
1616

1717
Password:
@@ -25,6 +25,8 @@ This program relies on only one database file, encrypted with [XChaCha20Poly1305
2525
### Import/Export
2626
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)).
2727
By typing `cotp -ex` you can export your database in unencrypted json format.
28+
### Compatibility
29+
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.
2830
### Cross Plaform
2931
Thanks to the glorious [Rust Language](https://www.rust-lang.org/) cotp is easily **compilable** in every platform supported by rust itself.
3032
As now i personally tested program functionalities in these systems:
@@ -76,44 +78,48 @@ You can build cotp using these commands:
7678
If you are familiar with the command line interface using cotp will not be a problem.
7779
Please note that cotp requires at least an 8 chars length password.
7880
If you type `cotp -h` you get some instruction on how to use cotp utilities.
79-
For example, the version 0.1.1 prints out this help screen:
81+
For example, the version 0.1.4 prints out this help screen:
8082
```
81-
cotp v0.1.3
83+
cotp v0.1.4
8284
written by @replydev
8385
8486
USAGE:
8587
cotp [SUBCOMMAND]
8688
8789
ARGUMENTS:
88-
-a,--add [ISSUER] [LABEL] | Add a new OTP code
89-
-e,--edit [ID] [ISSUER] [LABEL] | Edit an OTP code
90-
-r,--remove [ID] | Remove an OTP code
91-
-i,--import [APPNAME] [PATH] | Import a backup from a given application
92-
-ex,--export | Export the entire database in a plaintext json format
93-
-j,--json | Print results in json format
94-
-s,--single | Print OTP codes in single mode
95-
-h,--help | Print this help
90+
-a,--add [ISSUER] [LABEL] [ALGORITHM] [DIGITS] | Add a new OTP code
91+
-e,--edit [ID] [ISSUER] [LABEL] [ALGORITHM] [DIGITS] | Edit an OTP code
92+
-r,--remove [ID] | Remove an OTP code
93+
-i,--import [APPNAME] [PATH] | Import a backup from a given application
94+
-ex,--export | Export the entire database in a plaintext json format
95+
-j,--json | Print results in json format
96+
-s,--single | Print OTP codes in single mode
97+
-h,--help | Print this help
9698
```
9799
Note that in the `--edit` command if you type . instead of argument you are specifying not to modify that specific argument.
98100
### Example:
99101
#### Before:
100-
|index|issuer|label|
101-
|--|--|--|
102-
| 3 | Email_Provider | [email protected] |
102+
|index|issuer|label|algorithm|digits|
103+
|--|--|--|--|--|
104+
| 3 | Email_Provider | [email protected] | SHA1 | 6 |
103105
#### Command:
104106

105-
cotp -e 3 . cotp
107+
cotp -e 3 . [email protected] . 8
106108

107109
#### After:
108-
|index|issuer|label|
109-
|--|--|--|
110-
| 3 | Email_Provider | **cotp** |
110+
|index|issuer|label|algorithm|digits|
111+
|--|--|--|--|--|
112+
| 3 | Email_Provider | **[email protected]** | SHA1 | **8** |
111113

112114
## Planned features
113115

114116
- [x] Reduce binary size and improve compilation speed by removing useless dependencies.
115117
- [x] Use Argon2id for key derivation
116118
- [x] CLI Dashboard
119+
- [x] Support for:
120+
- [x] SHA256
121+
- [x] SHA512
122+
- [x] Custom digit value
117123
- [ ] Backup compatibility with:
118124
- [x] Aegis
119125
- [x] andOTP

0 commit comments

Comments
 (0)