From: "flichtenheld (Code Review)" Date: Fri, 12 Jan 2024 14:14:07 +0000 References: Reply-To: frank@...2641..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net Message-ID: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="Cra83WZlAvI="; 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: plaisthos Cc: openvpn-devel --Cra83WZlAvI= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: plaisthos. Hello plaisthos, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/498?usp=3Demail to review the following change. 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 --- 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/1 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: 1 Gerrit-Owner: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-MessageType: newchange --Cra83WZlAvI= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: plaisthos.

flichtenheld would like plaisthos to review this change.

Vi= ew Change

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: I7a754d0b4a76a9227bf922f65= 176cd9ec4d7670c
Signed-off-by: Frank Lichtenheld <frank@...2641...>= ;
---
M doc/man-sections/proxy-options.rst
1 file changed, 32 inse= rtions(+), 3 deletions(-)

git pull ssh://gerrit.openvpn.net:29418=
/openvpn refs/changes/98/498/1
diff --git a/doc/man-sections/proxy-=
options.rst b/doc/man-sections/proxy-options.rst
index 9cf3= 11f..ad49c60 100644
--- a/doc/man-sections/proxy-options.rs= t
+++ b/doc/man-sections/proxy-options.rst
= @@ -4,7 +4,7 @@
is required, a file name to an ``authfil= e`` file containing a username
and password on 2 lines c= an be given, or :code:`stdin` to prompt from
console. It= s 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 ``au= th-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 fi= le
http-proxy proxy.example.net 3128 authfile.txt

+ # basic authentica= tion, ask user for credentials
http-proxy proxy.examp= le.net 3128 stdin
- = http-proxy proxy.example.net 3128 auto basic
- http-proxy proxy.example.net 3128 auto-nct ntl= m2
+ # NTLM authe= ntication, load credentials from file
+ http-proxy proxy.example.net 3128 authfile.txt ntlm2=
+ # determine wh= ich authentication is required, ask user for credentials
+ http-proxy proxy.example.net 3128= auto
+ # determi= ne which authentication is required, but reject basic
+ http-proxy proxy.example.net 3128 au= to-nct
+ # determ= ine which authentication is required, but set credentials
+ http-proxy proxy.example.net 312= 8 auto
+ http-pro= xy-user-pass authfile.txt
+ # basic authentication, specify credentials inline
+ http-proxy proxy.example.net= 3128 "" basic
+ <http-proxy-user-pass>
+ username
+ password
+ </http-proxy-user-pass>

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``. I= f specified
+ as an = inline option (see `INLINE FILE SUPPORT`_), it will be interpreted as

+ username/password separ= ated by a newline. When specified on the command line
+ it is interpreted as a filename same as= the third argument to ``--http-proxy``.
+
+ Example::
+

+ <http-proxy-user-p= ass>
+ username=
+ password=
+ </http-proxy-user-p= ass>
+
<= span> --http-proxy-option args
Set extended HTTP proxy o= ptions. Requires an option ``type`` as argument
and an o= ptional ``parameter`` to the type. Repeat to set multiple
=

To view, visit change 498. To unsubscribe, or for help writi= ng mail filters, visit setti= ngs.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I7a754d0b4a76a9227bf922f6517= 6cd9ec4d7670c
Gerrit-Change-Number: 498
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <frank@...2723...= .>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-MessageType: newchange
--Cra83WZlAvI=--