@@ -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
+ <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``. If specified
+ 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-proxy``.
+
+ 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
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=email to review the following change. Change subject: proxy-options.rst: Add proper documentation for --http-proxy-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 <frank@lichtenheld.com> --- 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