kopia lustrzana https://github.com/robinmoisson/staticrypt
typo readme
rodzic
8e75419a2d
commit
2126a97977
10
README.md
10
README.md
|
@ -12,7 +12,7 @@ StatiCrypt generates a static, password protected page that can be decrypted in-
|
|||
|
||||
**Disclaimer** TL;DR: if you have extra sensitive banking data you should probably use something else :)
|
||||
|
||||
StatiCrypt basically encrypts your page and puts everything with a user-friendly way to use a password in the new file.
|
||||
StatiCrypt basically encrypts your page and puts everything with a user-friendly way to use a password in the new file.
|
||||
|
||||
AES-256 is state of the art but brute-force/dictionary attacks would be trivial to do at a really fast pace: **use a long, unusual passphrase**.
|
||||
|
||||
|
@ -23,7 +23,7 @@ The concept is simple and should work ok but I am not a cryptographer, feel free
|
|||
Staticrypt is available through npm as a CLI, install with `npm install -g staticrypt` and use as follow:
|
||||
|
||||
Usage: staticrypt <filename> <passphrase> [options]
|
||||
|
||||
|
||||
Options:
|
||||
--help Show help [boolean]
|
||||
--version Show version number [boolean]
|
||||
|
@ -36,14 +36,14 @@ Staticrypt is available through npm as a CLI, install with `npm install -g stati
|
|||
-i, --instructions Special instructions to display to the user.
|
||||
[string] [default: null]
|
||||
-f, --file-template Path to custom HTML template with password prompt.
|
||||
[string] [default: "[...]/cli/password_template.html"]
|
||||
[string] [default: "[...]/cli/password_template.html"]
|
||||
|
||||
|
||||
|
||||
Example usages:
|
||||
|
||||
- `staticrypt test.html mysecretpassword` -> creates a `test_encrypted.html` file
|
||||
- `find . -type f -name "*.html" -exec staticrypt {} mypassword \;` -> create encrypted files for all HTML files in your directory
|
||||
|
||||
You can use a custom template for the password prompt - just copy `cli/password_template.html` and modify it to suit your presentation style and point to your template file with the `-f` flag. Be careful to not break the encrypting javascript part, the variables replace by staticrypt are between curly brackets: `{instructions}`.
|
||||
You can use a custom template for the password prompt - just copy `cli/password_template.html` and modify it to suit your presentation style and point to your template file with the `-f` flag. Be careful to not break the encrypting javascript part, the variables replaced by staticrypt are between curly brackets: `{instructions}`.
|
||||
|
||||
Thanks [Aaron Coplan](https://github.com/AaronCoplan) for bringing the CLI to life !
|
||||
|
|
|
@ -10,11 +10,11 @@ Obviously, pick a lengthy passphrase !
|
|||
|
||||
StatiCrypt generates a static, password protected page that can be decrypted in-browser: just send or upload the generated page to a place serving static content (github pages, for example) and you're done: the javascript will prompt users for password, decrypt the page and load your HTML.
|
||||
|
||||
StatiCrypt basically encrypts your page and puts everything with a user-friendly way to use a password in the new file.
|
||||
StatiCrypt basically encrypts your page and puts everything with a user-friendly way to use a password in the new file.
|
||||
|
||||
AES-256 is state of the art but brute-force/dictionary attacks would be trivial to do at a really fast pace: **use a long, unusual passphrase!**
|
||||
|
||||
The concept is simple and should work ok but I am not a cryptographer, if you have extra sensitive banking data you might want to use something else :)
|
||||
The concept is simple and should work ok but I am not a cryptographer, if you have extra sensitive banking data you might want to use something else :)
|
||||
|
||||
Feel free to contribute or report any thought to the [GitHub project](https://robinmoisson.github.io/staticrypt) !
|
||||
|
||||
|
@ -23,7 +23,7 @@ Feel free to contribute or report any thought to the [GitHub project](https://ro
|
|||
Staticrypt is available through npm as a CLI, install with `npm install -g staticrypt` and use as follow:
|
||||
|
||||
Usage: staticrypt <filename> <passphrase> [options]
|
||||
|
||||
|
||||
Options:
|
||||
--help Show help [boolean]
|
||||
--version Show version number [boolean]
|
||||
|
@ -36,11 +36,11 @@ Staticrypt is available through npm as a CLI, install with `npm install -g stati
|
|||
-i, --instructions Special instructions to display to the user.
|
||||
[string] [default: null]
|
||||
-f, --file-template Path to custom HTML template with password prompt.
|
||||
[string] [default: "[...]/cli/password_template.html"]
|
||||
|
||||
[string] [default: "[...]/cli/password_template.html"]
|
||||
|
||||
Example usages:
|
||||
|
||||
- `staticrypt test.html mypassword` -> creates a `test_encrypted.html` file
|
||||
- `find . -type f -name "*.html" -exec staticrypt {} mypassword \;` -> create encrypted files for all HTML files in your directory (recursively)
|
||||
|
||||
You can use a custom template for the password prompt - just copy `cli/password_template.html` and modify it to suit your presentation style and point to your template file with the `-f` flag. Be careful to not break the encrypting javascript part, the variables replace by staticrypt are between curly brackets: `{instructions}`.
|
||||
You can use a custom template for the password prompt - just copy `cli/password_template.html` and modify it to suit your presentation style and point to your template file with the `-f` flag. Be careful to not break the encrypting javascript part, the variables replaced by staticrypt are between curly brackets: `{instructions}`.
|
||||
|
|
Ładowanie…
Reference in New Issue