diff options
| author | Graham Perrin | 2023-01-08 05:53:15 +0000 |
|---|---|---|
| committer | GitHub | 2023-01-08 05:53:15 +0000 |
| commit | 3ee92ff6d2ff7ad67818787db15cbc73bab05b78 (patch) | |
| tree | 4a6bcf00fc55900470add149b48097ce553255d6 | |
| parent | b8fa40b48feb8709d27b1c50f1ea6be2ce081692 (diff) | |
README: pkg, and URLs
Primarily: add one of the pkg methods from <https://www.freshports.org/security/py-pyotp2289>.
Whilst here: update the URL for the One-time Passwords section of the FreeBSD Handbook, and refine the URL for the manual page.
| -rw-r--r-- | README.md | 15 |
1 files changed, 8 insertions, 7 deletions
| @@ -5,12 +5,11 @@ RFC-2289. | |||
| 5 | 5 | ||
| 6 | It requires no additional libraries. | 6 | It requires no additional libraries. |
| 7 | 7 | ||
| 8 | |||
| 9 | ## General | 8 | ## General |
| 10 | 9 | ||
| 11 | The main reason for writing this library was the need to login into my | 10 | The main reason for writing this library was the need to login into my |
| 12 | FreeBSD servers using the [opiepasswd](https://www.freebsd.org/cgi/man.cgi?query=opiepasswd&sektion=1&manpath=freebsd-release-ports) | 11 | FreeBSD servers using [opiepasswd(1)](https://www.freebsd.org/cgi/man.cgi?query=opiepasswd&sektion=1&manpath=FreeBSD) |
| 13 | as described in [FreeBSD Handbook](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/one-time-passwords.html). | 12 | as [described in the FreeBSD Handbook](https://docs.freebsd.org/en/books/handbook/security/#one-time-passwords). |
| 14 | 13 | ||
| 15 | I decided to license the library under the | 14 | I decided to license the library under the |
| 16 | [Simplified BSD License / 2-clause BSD license](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE) and not under the | 15 | [Simplified BSD License / 2-clause BSD license](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE) and not under the |
| @@ -18,7 +17,6 @@ I decided to license the library under the | |||
| 18 | 17 | ||
| 19 | I hope that somebody will find it useful. | 18 | I hope that somebody will find it useful. |
| 20 | 19 | ||
| 21 | |||
| 22 | ## Installation | 20 | ## Installation |
| 23 | 21 | ||
| 24 | ### pip (pypi) | 22 | ### pip (pypi) |
| @@ -27,17 +25,21 @@ I hope that somebody will find it useful. | |||
| 27 | pip install pyotp2289 | 25 | pip install pyotp2289 |
| 28 | ``` | 26 | ``` |
| 29 | 27 | ||
| 30 | |||
| 31 | ### FreeBSD | 28 | ### FreeBSD |
| 32 | 29 | ||
| 33 | *pyotp2289* is included in the official ports-tree. | 30 | *pyotp2289* is included in the official ports-tree. |
| 34 | 31 | ||
| 35 | ```bash | 32 | ```bash |
| 33 | pkg install security/py-pyotp2289 | ||
| 34 | ``` | ||
| 35 | |||
| 36 | – or: | ||
| 37 | |||
| 38 | ```bash | ||
| 36 | cd /usr/ports/security/py-pyotp2289 | 39 | cd /usr/ports/security/py-pyotp2289 |
| 37 | make install clean | 40 | make install clean |
| 38 | ``` | 41 | ``` |
| 39 | 42 | ||
| 40 | |||
| 41 | ### Gentoo | 43 | ### Gentoo |
| 42 | 44 | ||
| 43 | ```bash | 45 | ```bash |
| @@ -50,7 +52,6 @@ I hope that somebody will find it useful. | |||
| 50 | emerge dev-python/pyotp2289 | 52 | emerge dev-python/pyotp2289 |
| 51 | ``` | 53 | ``` |
| 52 | 54 | ||
| 53 | |||
| 54 | ## Overview of RFC-2289 | 55 | ## Overview of RFC-2289 |
| 55 | 56 | ||
| 56 | RFC-2289 describes a one-time password authentication system (OTP): | 57 | RFC-2289 describes a one-time password authentication system (OTP): |
