Unverified Commit 6baeb6df authored by Lawrence Matthews's avatar Lawrence Matthews Committed by Daniel Stenberg
Browse files

CURLOPT_HAPROXYPROTOCOL: support the HAProxy PROXY protocol 

Add --haproxy-protocol for the command line tool

Closes #2162
parent 9572831b

docs/cmdline-opts/haproxy-protocol.d

0 → 100644
+11 −0
Original line number Diff line number Diff line 
Long: haproxy-protocol

Help: Send HAProxy PROXY protocol header

Protocols: HTTP

Added: 7.60.0

---

Send a HAProxy PROXY protocol header at the beginning of the connection. This

is used by some load balancers and reverse proxies to indicate the client's

true IP address and port.



This option is primarily useful when sending test requests to a service that

expects this header.

docs/libcurl/curl_easy_setopt.3

+2 −0
Original line number Diff line number Diff line
@@ -185,6 +185,8 @@ Socks5 GSSAPI service name. \fICURLOPT_SOCKS5_GSSAPI_SERVICE(3)\fP 
Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP

.IP CURLOPT_PROXY_SERVICE_NAME

Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP

.IP CURLOPT_HAPROXYPROTOCOL

Send an HAProxy PROXY protocol header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP

.IP CURLOPT_SERVICE_NAME

Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP

.IP CURLOPT_INTERFACE

docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3

0 → 100644
+57 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at https://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_HAPROXYPROTOCOL 3 "5 Feb 2018" "libcurl 7.60.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol header

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,

                          long haproxy_protocol);

.SH DESCRIPTION

A long parameter set to 1 tells the library to send an HAProxy PROXY

protocol header at beginning of the connection. The default action is not to

send this header.



This option is primarily useful when sending test requests to a service that

expects this header.



Most applications do not need this option.

.SH DEFAULT

0, do not send HAProxy PROXY protocol header

.SH PROTOCOLS

HTTP

.SH EXAMPLE

.nf

CURL *curl = curl_easy_init();

if(curl) {

  CURLcode ret;

  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");

  curl_easy_setopt(curl, CURLOPT_HAPROXYPROTOCOL, 1L);

  ret = curl_easy_perform(curl);

}

.fi

.SH AVAILABILITY

Along with HTTP. Added in 7.60.0.

.SH RETURN VALUE

Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.

docs/libcurl/opts/Makefile.inc

+1 −0
Original line number Diff line number Diff line
@@ -137,6 +137,7 @@ man_MANS = \ 
  CURLOPT_FTP_USE_PRET.3                        \

  CURLOPT_GSSAPI_DELEGATION.3                   \

  CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3           \

  CURLOPT_HAPROXYPROTOCOL.3                     \

  CURLOPT_HEADER.3                              \

  CURLOPT_HEADERDATA.3                          \

  CURLOPT_HEADERFUNCTION.3                      \

docs/libcurl/symbols-in-versions

+1 −0
Original line number Diff line number Diff line
@@ -404,6 +404,7 @@ CURLOPT_FTP_USE_EPSV 7.9.2 
CURLOPT_FTP_USE_PRET            7.20.0

CURLOPT_GSSAPI_DELEGATION       7.22.0

CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS 7.59.0

CURLOPT_HAPROXYPROTOCOL         7.60.0

CURLOPT_HEADER                  7.1

CURLOPT_HEADERDATA              7.10

CURLOPT_HEADERFUNCTION          7.7.2