Browse code

Document that auth-user-pass may be inlined

Commits 7d48d31b, 39619b7f added support for inlining username
and, optionally, password.
Add a description of its usage in the man page.

Github: resolves OpenVPN/openvpn#370

Change-Id: I7a1765661f7676eeba8016024080fd1026220ced
Signed-off-by: Selva Nair <selva.nair@gmail.com>
Acked-by: Antonio Quartulli <antonio@openvpn.net>
Message-Id: <20240220175215.2731491-1-selva.nair@gmail.com>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28284.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>

Selva Nair authored on 2024/02/21 02:52:15
Showing 2 changed files
... ...
@@ -73,6 +73,17 @@ configuration.
73 73
   If ``up`` is omitted, username/password will be prompted from the
74 74
   console.
75 75
 
76
+  This option can also be inlined
77
+  ::
78
+
79
+    <auth-user-pass>
80
+    username
81
+    [password]
82
+    </auth-user-pass>
83
+
84
+  where password is optional, and will be prompted from the console if
85
+  missing.
86
+
76 87
   The server configuration must specify an ``--auth-user-pass-verify``
77 88
   script to verify the username/password provided by the client.
78 89
 
... ...
@@ -5,7 +5,7 @@ OpenVPN allows including files in the main configuration for the ``--ca``,
5 5
 ``--cert``, ``--dh``, ``--extra-certs``, ``--key``, ``--pkcs12``,
6 6
 ``--crl-verify``, ``--http-proxy-user-pass``, ``--tls-auth``,
7 7
 ``--auth-gen-token-secret``, ``--peer-fingerprint``, ``--tls-crypt``,
8
-``--tls-crypt-v2`` and ``--verify-hash`` options.
8
+``--tls-crypt-v2``, ``--verify-hash`` and ``--auth-user-pass`` options.
9 9
 
10 10
 Each inline file started by the line ``<option>`` and ended by the line
11 11
 ``</option>``