From: "cron2 (Code Review)" Date: Thu, 18 Jan 2024 17:49:30 +0000 In-Reply-To: References: Reply-To: gert@...1296..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="ZKOtkm4vW3E="; charset=UTF-8 Subject: [Openvpn-devel] [S] Change in openvpn[master]: proxy-options.rst: Add proper documentation for --http-proxy-user-pass List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: flichtenheld Cc: plaisthos , openvpn-devel --ZKOtkm4vW3E= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/49= 8?usp=3Demail ) Change subject: proxy-options.rst: Add proper documentation for --http-prox= y-user-pass ...................................................................... proxy-options.rst: Add proper documentation for --http-proxy-user-pass And extend examples section for authenticated HTTP proxies because is was misleading. Change-Id: I7a754d0b4a76a9227bf922f65176cd9ec4d7670c Signed-off-by: Frank Lichtenheld Acked-by: Gert Doering Message-Id: <20240118164903.22519-1-gert@...1296...> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28= 083.html Signed-off-by: Gert Doering --- M doc/man-sections/proxy-options.rst 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/doc/man-sections/proxy-options.rst b/doc/man-sections/proxy-op= tions.rst index 9cf311f..ad49c60 100644 --- a/doc/man-sections/proxy-options.rst +++ b/doc/man-sections/proxy-options.rst @@ -4,7 +4,7 @@ is required, a file name to an ``authfile`` file containing a username and password on 2 lines can be given, or :code:`stdin` to prompt from console. Its content can also be specified in the config file with the - ``--http-proxy-user-pass`` option. (See section on inline files) + ``--http-proxy-user-pass`` option (See `INLINE FILE SUPPORT`_). The last optional argument is an ``auth-method`` which should be one of :code:`none`, :code:`basic`, or :code:`ntlm2`. @@ -25,14 +25,43 @@ Examples: :: + # no authentication http-proxy proxy.example.net 3128 + # basic authentication, load credentials from file http-proxy proxy.example.net 3128 authfile.txt + # basic authentication, ask user for credentials http-proxy proxy.example.net 3128 stdin - http-proxy proxy.example.net 3128 auto basic - http-proxy proxy.example.net 3128 auto-nct ntlm2 + # NTLM authentication, load credentials from file + http-proxy proxy.example.net 3128 authfile.txt ntlm2 + # determine which authentication is required, ask user for credentials + http-proxy proxy.example.net 3128 auto + # determine which authentication is required, but reject basic + http-proxy proxy.example.net 3128 auto-nct + # determine which authentication is required, but set credentials + http-proxy proxy.example.net 3128 auto + http-proxy-user-pass authfile.txt + # basic authentication, specify credentials inline + http-proxy proxy.example.net 3128 "" basic + + username + password + Note that support for NTLMv1 proxies was removed with OpenVPN 2.7. +--http-proxy-user-pass userpass + Overwrite the username/password information for ``--http-proxy``. If spe= cified + as an inline option (see `INLINE FILE SUPPORT`_), it will be interpreted= as + username/password separated by a newline. When specified on the command = line + it is interpreted as a filename same as the third argument to ``--http-p= roxy``. + + Example:: + + + username + password + + --http-proxy-option args Set extended HTTP proxy options. Requires an option ``type`` as argument and an optional ``parameter`` to the type. Repeat to set multiple -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/498?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I7a754d0b4a76a9227bf922f65176cd9ec4d7670c Gerrit-Change-Number: 498 Gerrit-PatchSet: 2 Gerrit-Owner: flichtenheld Gerrit-Reviewer: cron2 Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-MessageType: merged --ZKOtkm4vW3E= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

cron2 submitted this change.

View Change

proxy-options.rst: Add proper documentation fo=
r --http-proxy-user-pass

And extend examples section for authenticat= ed HTTP proxies because
is was misleading.

Change-Id: I7a754d0b4a= 76a9227bf922f65176cd9ec4d7670c
Signed-off-by: Frank Lichtenheld <fran= k@...2641...>
Acked-by: Gert Doering <gert@...1296...>
Messa= ge-Id: <20240118164903.22519-1-gert@...1296...>
URL: https://www.m= ail-archive.com/openvpn-devel@lists.sourceforge.net/msg28083.html
Signed= -off-by: Gert Doering <gert@...1296...>
---
M doc/man-sections/= proxy-options.rst
1 file changed, 32 insertions(+), 3 deletions(-)
diff --git a/doc/man-sections/proxy-options.rst b/doc/man-sections/proxy=
-options.rst
index 9cf311f..ad49c60 100644
= --- a/doc/man-sections/proxy-options.rst
+++ b/doc/man-sect= ions/proxy-options.rst
@@ -4,7 +4,7 @@
i= s required, a file name to an ``authfile`` file containing a username
and password on 2 lines can be given, or :code:`stdin` to pro= mpt from
console. Its content can also be specified in t= he config file with the
- ``--http-proxy-user-pass`` option. (See section on inline files)=
+ ``--http-proxy-user-pass= `` option (See `INLINE FILE SUPPORT`_).

= The last optional argument is an ``auth-method`` which should be one
of :code:`none`, :code:`basic`, or :code:`ntlm2`.
= @@ -25,14 +25,43 @@
Examples:
:= :

+= # no authentication
http-proxy proxy.example.net= 3128
+ # basic a= uthentication, load credentials from file
http-proxy = proxy.example.net 3128 authfile.txt
+ # basic authentication, ask user for credentials
http-proxy proxy.example.net 3128 stdin
- http-proxy proxy.example.net 3128 a= uto basic
- http-pr= oxy proxy.example.net 3128 auto-nct ntlm2
+ # NTLM authentication, load credentials from fil= e
+ http-proxy pr= oxy.example.net 3128 authfile.txt ntlm2
+ # determine which authentication is required, ask = user for credentials
= + http-proxy proxy.example.net 3128 auto
+ # determine which authentication is required,= but reject basic
+ = http-proxy proxy.example.net 3128 auto-nct
+ # determine which authentication is required= , but set credentials
+ http-proxy proxy.example.net 3128 auto
+ http-proxy-user-pass authfile.txt
= + # basic authentication, s= pecify credentials inline
+ http-proxy proxy.example.net 3128 "" basic
<= span style=3D"color: hsl(120, 100%, 40%);">+ <http-proxy-user-pass&g= t;

+ username

+ password+ </http-proxy-user-pas= s>

Note that support for NTLMv1 pro= xies was removed with OpenVPN 2.7.

+--http-proxy-user-pass userpass+ Overwrite the username/pass= word information for ``--http-proxy``. If specified
+ as an inline option (see `INLINE FILE S= UPPORT`_), it will be interpreted as
+ username/password separated by a newline. When specified= on the command line
= + it is interpreted as a filename same as the third argument to ``--http-p= roxy``.
+
<= span style=3D"color: hsl(120, 100%, 40%);">+ Example::
+
+ <http-proxy-user-pass>
+ username
+ password
+ </http-proxy-user-pass>
+
--http-proxy-option args
Set extended HTTP proxy options. Requires an option ``type= `` as argument
and an optional ``parameter`` to the type= . Repeat to set multiple

To view, visi= t change = 498. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I7a754d0b4a76a9227bf922f6517= 6cd9ec4d7670c
Gerrit-Change-Number: 498
Gerrit-PatchSet: 2
Gerrit-Owner: flichtenheld <frank@...2723...= .>
Gerrit-Reviewer: cron2 <gert@...1296...>=
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-MessageType: merged
--ZKOtkm4vW3E=--