From 988c7921eacee0cf0b519788c143fe428972b0dc Mon Sep 17 00:00:00 2001
From: Stefan Kreutz <mail@skreutz.com>
Date: Sat, 28 May 2022 15:15:39 +0200
Subject: Extract wpa-psk-cli crate

---
 wpa-psk-cli/README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 wpa-psk-cli/README.md

(limited to 'wpa-psk-cli/README.md')

diff --git a/wpa-psk-cli/README.md b/wpa-psk-cli/README.md
new file mode 100644
index 0000000..6c00a4c
--- /dev/null
+++ b/wpa-psk-cli/README.md
@@ -0,0 +1,47 @@
+# wpa-psk-cli
+
+This is a command-line utility to compute the WPA pre-shared key of a Wi-Fi
+SSID and passphrase. See also the corresponding Rust library `wpa-psk`.
+
+## Usage
+
+Hash a typical SSID and passphrase:
+
+    $ wpa-psk home password123
+    0xde811641af2c516ffd35cc6f851b3abf03c7c84fc703cfb580f1c0456943cdc0
+    
+Hash *special* albeit valid credentials:
+
+    $ wpa-psk "123abcABC.,-" "456defDEF *<:D"
+    0x8a366e5bc51cd5d8fbbeffacc5f1af23fac30e3ac93cdcc368fafbbf63a1085c
+    
+Hash *invalid* credentials:
+
+    $ wpa-psk --force bar 2short
+    0xcb5de4e4d23b2ab0bf5b9ba0fe8132c1e2af3bb52298ec801af8ad520cea3437
+
+## Installation
+
+You can install the `wpa-psk` utility using Cargo:
+
+    $ cargo install wpa-psk-cli
+
+## License
+
+This work is distributed under the terms of both, the [MIT License][MIT] and
+the [Apache License, Version 2.0][Apache-2.0].
+
+[MIT]: LICENSE-MIT
+[Apache-2.0]: LICENSE-APACHE-2.0
+
+## Contribution
+
+Contributions are welcome! Please [contact][] me via email.
+
+[contact]: https://www.skreutz.com/contact/
+
+## See also
+
+The popular [wpa_supplicant][] comes with a similar tool, `wpa_passphrase(8)`.
+
+[wpa_supplicant]: https://hostap.epitest.fi/wpa_supplicant/
-- 
cgit v1.2.3