doc/man-sections/proxy-options.rst

   1 --http-proxy args
   2   Connect to remote host through an HTTP proxy.  This requires at least an
   3   address ``server`` and ``port`` argument.  If HTTP Proxy-Authenticate
   4   is required, a file name to an ``authfile`` file containing a username
   5   and password on 2 lines can be given, or :code:`stdin` to prompt from
   6   console. Its content can also be specified in the config file with the
   7   ``--http-proxy-user-pass`` option. (See section on inline files)
   8
   9   The last optional argument is an ``auth-method`` which should be one
  10   of :code:`none`, :code:`basic`, or :code:`ntlm2`.
  11
  12   HTTP Digest authentication is supported as well, but only via the
  13   :code:`auto` or :code:`auto-nct` flags (below).  This must replace
  14   the ``authfile`` argument.
  15
  16   The :code:`auto` flag causes OpenVPN to automatically determine the
  17   ``auth-method`` and query stdin or the management interface for
  18   username/password credentials, if required. This flag exists on OpenVPN
  19   2.1 or higher.
  20
  21   The ``auto-nct`` flag (no clear-text auth) instructs OpenVPN to
  22   automatically determine the authentication method, but to reject weak
  23   authentication protocols such as HTTP Basic Authentication.
  24
  25   Examples:
  26   ::
  27
  28      http-proxy proxy.example.net 3128
  29      http-proxy proxy.example.net 3128 authfile.txt
  30      http-proxy proxy.example.net 3128 stdin
  31      http-proxy proxy.example.net 3128 auto basic
  32      http-proxy proxy.example.net 3128 auto-nct ntlm2
  33
  34   Note that support for NTLMv1 proxies was removed with OpenVPN 2.7.
  35
  36 --http-proxy-option args
  37   Set extended HTTP proxy options. Requires an option ``type`` as argument
  38   and an optional ``parameter`` to the type.  Repeat to set multiple
  39   options.
  40
  41   :code:`VERSION` ``version``
  42       Set HTTP version number to ``version`` (default :code:`1.0`).
  43
  44   :code:`AGENT` ``user-agent``
  45       Set HTTP "User-Agent" string to ``user-agent``.
  46
  47   :code:`CUSTOM-HEADER` ``name`` ``content``
  48       Adds the custom Header with ``name`` as name and ``content`` as
  49       the content of the custom HTTP header.
  50
  51   Examples:
  52   ::
  53
  54      http-proxy-option VERSION 1.1
  55      http-proxy-option AGENT OpenVPN/2.4
  56      http-proxy-option X-Proxy-Flag some-flags
  57
  58 --socks-proxy args
  59   Connect to remote host through a Socks5 proxy.  A required ``server``
  60   argument is needed.  Optionally a ``port`` (default :code:`1080`) and
  61   ``authfile`` can be given.  The ``authfile`` is a file containing a
  62   username and password on 2 lines, or :code:`stdin` can be used to
  63   prompt from console.