| Message ID | 20240220175215.2731491-1-selva.nair@gmail.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [Openvpn-devel,v2] Document that auth-user-pass may be inlined | expand |
Hi, On 20/02/2024 18:52, selva.nair@gmail.com wrote: > From: Selva Nair <selva.nair@gmail.com> > > 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 <a@unstable.cc> > --- > v2: Add '--' prefix when referring to auth-user-pass > and mention related github issue > doc/man-sections/client-options.rst | 11 +++++++++++ > doc/man-sections/inline-files.rst | 2 +- > 2 files changed, 12 insertions(+), 1 deletion(-) > > diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-options.rst > index b92b1a46..b75fe5bd 100644 > --- a/doc/man-sections/client-options.rst > +++ b/doc/man-sections/client-options.rst > @@ -73,6 +73,17 @@ configuration. > If ``up`` is omitted, username/password will be prompted from the > console. > > + This option can also be inlined > + :: > + > + <auth-user-pass> > + username > + [password] > + </auth-user-pass> > + > + where password is optional, and will be prompted from the console if > + missing. > + > The server configuration must specify an ``--auth-user-pass-verify`` > script to verify the username/password provided by the client. > > diff --git a/doc/man-sections/inline-files.rst b/doc/man-sections/inline-files.rst > index f46301e8..4dba73c9 100644 > --- a/doc/man-sections/inline-files.rst > +++ b/doc/man-sections/inline-files.rst > @@ -5,7 +5,7 @@ OpenVPN allows including files in the main configuration for the ``--ca``, > ``--cert``, ``--dh``, ``--extra-certs``, ``--key``, ``--pkcs12``, > ``--crl-verify``, ``--http-proxy-user-pass``, ``--tls-auth``, > ``--auth-gen-token-secret``, ``--peer-fingerprint``, ``--tls-crypt``, > -``--tls-crypt-v2`` and ``--verify-hash`` options. > +``--tls-crypt-v2``, ``--verify-hash`` and ``--auth-user-pass`` options. > > Each inline file started by the line ``<option>`` and ended by the line > ``</option>``
Thanks for that. Documentation improvements are always welcome :-)
Your patch has been applied to the master and releae/2.6 branch (docs).
commit fad2d7017eee366317bb18b34416e7788cbe2372 (master)
commit 2aac80e4b13d442139f62ed2b35756d1cda44c39 (release/2.6)
Author: Selva Nair
Date: Tue Feb 20 12:52:15 2024 -0500
Document that auth-user-pass may be inlined
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>
--
kind regards,
Gert Doering
diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-options.rst index b92b1a46..b75fe5bd 100644 --- a/doc/man-sections/client-options.rst +++ b/doc/man-sections/client-options.rst @@ -73,6 +73,17 @@ configuration. If ``up`` is omitted, username/password will be prompted from the console. + This option can also be inlined + :: + + <auth-user-pass> + username + [password] + </auth-user-pass> + + where password is optional, and will be prompted from the console if + missing. + The server configuration must specify an ``--auth-user-pass-verify`` script to verify the username/password provided by the client. diff --git a/doc/man-sections/inline-files.rst b/doc/man-sections/inline-files.rst index f46301e8..4dba73c9 100644 --- a/doc/man-sections/inline-files.rst +++ b/doc/man-sections/inline-files.rst @@ -5,7 +5,7 @@ OpenVPN allows including files in the main configuration for the ``--ca``, ``--cert``, ``--dh``, ``--extra-certs``, ``--key``, ``--pkcs12``, ``--crl-verify``, ``--http-proxy-user-pass``, ``--tls-auth``, ``--auth-gen-token-secret``, ``--peer-fingerprint``, ``--tls-crypt``, -``--tls-crypt-v2`` and ``--verify-hash`` options. +``--tls-crypt-v2``, ``--verify-hash`` and ``--auth-user-pass`` options. Each inline file started by the line ``<option>`` and ended by the line ``</option>``