From: "cron2 (Code Review)" Date: Thu, 18 Jan 2024 17:49:29 +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="Q63eP7ipc1s="; 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 , plaisthos Cc: openvpn-devel --Q63eP7ipc1s= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable cron2 has uploaded a new patch set (#2) to the change originally created by= flichtenheld. ( http://gerrit.openvpn.net/c/openvpn/+/498?usp=3Demail ) The following approvals got outdated and were removed: Code-Review+2 by cron2 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(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/98/498/2 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: newpatchset --Q63eP7ipc1s= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

cron2 uploaded patch set #2 to the change originally cr= eated by flichtenheld.

View Change

The following approvals got outda= ted and were removed: Code-Review+2 by cron2

proxy-options.rst: Add proper documentation for --ht=
tp-proxy-user-pass

And extend examples section for authenticated HTT= P proxies because
is was misleading.

Change-Id: I7a754d0b4a76a922= 7bf922f65176cd9ec4d7670c
Signed-off-by: Frank Lichtenheld <frank@...1665...= 641...>
Acked-by: Gert Doering <gert@...1296...>
Message-Id:= <20240118164903.22519-1-gert@...1296...>
URL: https://www.mail-ar= chive.com/openvpn-devel@lists.sourceforge.net/msg28083.html
Signed-off-b= y: Gert Doering <gert@...1296...>
---
M doc/man-sections/proxy-= options.rst
1 file changed, 32 insertions(+), 3 deletions(-)

g=
it pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/98/498/2
<= pre style=3D"font-family: monospace,monospace; white-space: pre-wrap;">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-secti= ons/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 prom= pt from
console. Its content can also be specified in th= e config file with the
= - ``--http-proxy-user-pass`` option. (See section on inline files)<= br>+ ``--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`.
<= span>@@ -25,14 +25,43 @@

Examples:
::=

+ = # no authentication
http-proxy proxy.example.net = 3128
+ # basic au= thentication, load credentials from file
http-proxy p= roxy.example.net 3128 authfile.txt
+ # basic authentication, ask user for credentials=
http-proxy proxy.example.net 3128 stdin
- http-proxy proxy.example.net 3128 au= to basic
- http-pro= xy proxy.example.net 3128 auto-nct ntlm2
+ # NTLM authentication, load credentials from file=
+ http-proxy pro= xy.example.net 3128 authfile.txt ntlm2
+ # determine which authentication is required, ask u= ser 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
<= span style=3D"color: hsl(120, 100%, 40%);">+ # basic authentication, sp= ecify credentials inline
+ http-proxy proxy.example.net 3128 "" basic
+ <http-proxy-user-pass>= ;
+ username

+ password
= + </http-proxy-user-pass= >

Note that support for NTLMv1 prox= ies 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: newpatchset
--Q63eP7ipc1s=--