summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimeon Simeonov2020-03-27 10:51:18 +0100
committerSimeon Simeonov2020-03-27 10:51:18 +0100
commita4c050e34ce462f477bc3671e272e244e2792e00 (patch)
tree753d6d49f2b102fede910baad025d0b899c0575a
parentda8fde8579bf90a01c7fec6fd011585fa245b71b (diff)
Update the General and Overview sections of README.md
-rw-r--r--README.md57
1 files changed, 51 insertions, 6 deletions
diff --git a/README.md b/README.md
index 7201b88..fef620a 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,54 @@ It requires no additional libraries.
8 8
9## General 9## General
10 10
11TODO 11The main reason for writing this library was the need to login into my
12FreeBSD servers using the [opiepasswd]
13(https://www.freebsd.org/cgi/man.cgi?query=opiepasswd&sektion=1&manpath=freebsd-release-ports)
14as described in [FreeBSD Handbook]
15(https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/one-time-passwords.html).
16
17I decided to license the library under the
18[Simplified BSD License / 2-clause BSD license](LICENSE) and not under the
19(L)GPL-3 as I usually do.
20
21I hope that somebody will find it useful.
22
23
24## Overview of RFC-2289
25
26RFC-2289 describes a one-time password authentication system (OTP):
27
28"The system provides authentication for system access (login) and other
29applications requiring authentication that is secure against passive attacks
30based on replaying captured reusable passwords. OTP evolved from the S/KEY
31(S/KEY is a trademark of Bellcore) One-Time Password System that was released
32by Bellcore."
33
34"One form of attack on networked computing systems is eavesdropping on
35network connections to obtain authentication information such as the
36login IDs and passwords of legitimate users. Once this information is
37captured, it can be used at a later time to gain access to the
38system. One-time password systems are designed to counter this type
39of attack, called a 'replay attack'."
40
41The authentication system described in RFC-2289 "uses a secret
42pass-phrase to generate a sequence of one-time (single use)
43passwords. With this system, the user's secret pass-phrase never
44needs to cross the network at any time such as during authentication
45or during pass-phrase changes. Thus, it is not vulnerable to replay
46attacks. Added security is provided by the property that no secret
47information need be stored on any system, including the server being
48protected."
49
50"There are two entities in the operation of the OTP one-time password
51system. The **generator** must produce the appropriate one-time password
52from the user's secret pass-phrase and from information provided in
53the **challenge** from the **server**. The server must send a challenge that
54includes the appropriate generation parameters to the generator, must
55verify the one-time password received, must store the last valid
56one-time password it received, and must store the corresponding one-
57time password sequence number. The server must also facilitate the
58changing of the user's secret pass-phrase in a secure manner."
12 59
13 60
14## Examples 61## Examples
@@ -18,15 +65,13 @@ TODO
18 65
19## Author 66## Author
20 67
21Simeon Simeonov - sgs AT pichove D0T org - sgs @ Freenode 68Simeon Simeonov - sgs @ Freenode
22 69
23 70
24## [License][license] 71## [License](LICENSE)
25 72
26Copyright (c) 2020, Simeon Simeonov 73Copyright (c) 2020, Simeon Simeonov
27All rights reserved. 74All rights reserved.
28 75
29[licensed][license] under the BSD 2-clause. 76[licensed](LICENSE) under the BSD 2-clause.
30SPDX-License-Identifier: BSD-2-Clause-FreeBSD 77SPDX-License-Identifier: BSD-2-Clause-FreeBSD
31
32[license]: LICENSE