[Openvpn-devel] Document that auth-user-pass may be inlined

Message ID 20240219192822.2477258-1-selva.nair@gmail.com
State Superseded
Headers show
Series [Openvpn-devel] Document that auth-user-pass may be inlined | expand

Commit Message

Selva Nair Feb. 19, 2024, 7:28 p.m. UTC
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.

Change-Id: I7a1765661f7676eeba8016024080fd1026220ced
Signed-off-by: Selva Nair <selva.nair@gmail.com>
---
Does this have to go through gerrit?

 doc/man-sections/client-options.rst | 11 +++++++++++
 doc/man-sections/inline-files.rst   |  2 +-
 2 files changed, 12 insertions(+), 1 deletion(-)

Comments

Antonio Quartulli Feb. 19, 2024, 9:59 p.m. UTC | #1
Hi,

On 19/02/2024 20:28, 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.
> 
> Change-Id: I7a1765661f7676eeba8016024080fd1026220ced
> Signed-off-by: Selva Nair <selva.nair@gmail.com>

Acked-by: Antonio Quartulli <a@unstable.cc>

> ---
> Does this have to go through gerrit?
> 
>   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..ad02c855 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>``
Gert Doering Feb. 20, 2024, 4:22 p.m. UTC | #2
Hi,

On Mon, Feb 19, 2024 at 02:28:22PM -0500, selva.nair@gmail.com wrote:
> Does this have to go through gerrit?

As of today, there's two ways to inject patches / patch sets for
"openvpn main" - the openvpn-devel@ list, "as always", and gerrit.

Gerrit is nice for larger and more complex patchsets, because review
can happen in pieces (= you can review the first half today, comment
on the web, it will remember which parts you have seen already, and
do the rest tomorrow), and also gerrit can do stuff like "so what
changed from v4 to v5?" meta-diffs.

For smaller patches "single file, trivially correct", openvpn-devel@ is
less work for me :-)

So - what is "better" depends.

gert
Frank Lichtenheld Feb. 20, 2024, 5:04 p.m. UTC | #3
On Mon, Feb 19, 2024 at 02:28:22PM -0500, 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.

Please reference Github #370 which is the same topic.

> Change-Id: I7a1765661f7676eeba8016024080fd1026220ced
> Signed-off-by: Selva Nair <selva.nair@gmail.com>
> ---
> Does this have to go through gerrit?
> 
>  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..ad02c855 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.

--auth-user-pass for consistency.

Regards,

Patch

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..ad02c855 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>``