Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 1 | /* |
| 2 | * include/types/connection.h |
| 3 | * This file describes the connection struct and associated constants. |
| 4 | * |
Willy Tarreau | baf5b9b | 2014-01-23 15:26:18 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
| 21 | |
| 22 | #ifndef _TYPES_CONNECTION_H |
| 23 | #define _TYPES_CONNECTION_H |
| 24 | |
| 25 | #include <stdlib.h> |
| 26 | #include <sys/socket.h> |
| 27 | |
| 28 | #include <common/config.h> |
| 29 | |
Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 30 | #include <types/listener.h> |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 31 | #include <types/obj_type.h> |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 32 | #include <types/port_range.h> |
Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 33 | #include <types/protocol.h> |
| 34 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 35 | /* referenced below */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 36 | struct connection; |
| 37 | struct buffer; |
| 38 | struct pipe; |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 39 | |
Willy Tarreau | baf5b9b | 2014-01-23 15:26:18 +0100 | [diff] [blame] | 40 | /* For each direction, we have a CO_FL_{SOCK,DATA}_<DIR>_ENA flag, which |
| 41 | * indicates if read or write is desired in that direction for the respective |
| 42 | * layers. The current status corresponding to the current layer being used is |
| 43 | * remembered in the CO_FL_CURR_<DIR>_ENA flag. The need to poll (ie receipt of |
| 44 | * EAGAIN) is remembered at the file descriptor level so that even when the |
| 45 | * activity is stopped and restarted, we still remember whether it was needed |
| 46 | * to poll before attempting the I/O. |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 47 | * |
Willy Tarreau | baf5b9b | 2014-01-23 15:26:18 +0100 | [diff] [blame] | 48 | * The CO_FL_CURR_<DIR>_ENA flag is set from the FD status in |
| 49 | * conn_refresh_polling_flags(). The FD state is updated according to these |
| 50 | * flags in conn_cond_update_polling(). |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 51 | */ |
| 52 | |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 53 | /* flags for use in connection->flags */ |
| 54 | enum { |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 55 | CO_FL_NONE = 0x00000000, /* Just for initialization purposes */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 56 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 57 | /* Do not change these values without updating conn_*_poll_changes() ! */ |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 58 | CO_FL_SOCK_RD_ENA = 0x00000001, /* receiving handshakes is allowed */ |
| 59 | CO_FL_DATA_RD_ENA = 0x00000002, /* receiving data is allowed */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 60 | CO_FL_CURR_RD_ENA = 0x00000004, /* receiving is currently allowed */ |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 61 | /* unused : 0x00000008 */ |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 62 | |
| 63 | CO_FL_SOCK_WR_ENA = 0x00000010, /* sending handshakes is desired */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 64 | CO_FL_DATA_WR_ENA = 0x00000020, /* sending data is desired */ |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 65 | CO_FL_CURR_WR_ENA = 0x00000040, /* sending is currently desired */ |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 66 | /* unused : 0x00000080 */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 67 | |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 68 | /* These flags indicate whether the Control and Transport layers are initialized */ |
| 69 | CO_FL_CTRL_READY = 0x00000100, /* FD was registered, fd_delete() needed */ |
| 70 | CO_FL_XPRT_READY = 0x00000200, /* xprt_init() done, xprt_close() needed */ |
| 71 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 72 | /* These flags are used by data layers to indicate they had to stop |
| 73 | * sending data because a buffer was empty (WAIT_DATA) or stop receiving |
| 74 | * data because a buffer was full (WAIT_ROOM). The connection handler |
| 75 | * clears them before first calling the I/O and data callbacks. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 76 | */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 77 | CO_FL_WAIT_DATA = 0x00000400, /* data source is empty */ |
| 78 | CO_FL_WAIT_ROOM = 0x00000800, /* data sink is full */ |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 79 | |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 80 | /* These flags are used to report whether the from/to addresses are set or not */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 81 | CO_FL_ADDR_FROM_SET = 0x00001000, /* addr.from is set */ |
| 82 | CO_FL_ADDR_TO_SET = 0x00002000, /* addr.to is set */ |
| 83 | |
| 84 | /* flags indicating what event type the data layer is interested in */ |
| 85 | CO_FL_INIT_DATA = 0x00004000, /* initialize the data layer before using it */ |
| 86 | CO_FL_WAKE_DATA = 0x00008000, /* wake-up data layer upon activity at the transport layer */ |
Willy Tarreau | 2ba4465 | 2012-08-20 17:30:32 +0200 | [diff] [blame] | 87 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 88 | /* flags used to remember what shutdown have been performed/reported */ |
| 89 | CO_FL_DATA_RD_SH = 0x00010000, /* DATA layer was notified about shutr/read0 */ |
| 90 | CO_FL_DATA_WR_SH = 0x00020000, /* DATA layer asked for shutw */ |
| 91 | CO_FL_SOCK_RD_SH = 0x00040000, /* SOCK layer was notified about shutr/read0 */ |
| 92 | CO_FL_SOCK_WR_SH = 0x00080000, /* SOCK layer asked for shutw */ |
| 93 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 94 | /* flags used to report connection status and errors */ |
| 95 | CO_FL_ERROR = 0x00100000, /* a fatal error was reported */ |
| 96 | CO_FL_CONNECTED = 0x00200000, /* the connection is now established */ |
| 97 | CO_FL_WAIT_L4_CONN = 0x00400000, /* waiting for L4 to be connected */ |
| 98 | CO_FL_WAIT_L6_CONN = 0x00800000, /* waiting for L6 to be connected (eg: SSL) */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 99 | |
Willy Tarreau | 9e272bf | 2012-10-03 21:04:48 +0200 | [diff] [blame] | 100 | /* synthesis of the flags above */ |
| 101 | CO_FL_CONN_STATE = 0x00FF0000, /* all shut/connected flags */ |
| 102 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 103 | /*** All the flags below are used for connection handshakes. Any new |
| 104 | * handshake should be added after this point, and CO_FL_HANDSHAKE |
| 105 | * should be updated. |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 106 | */ |
Willy Tarreau | 57cd3e4 | 2013-10-24 22:01:26 +0200 | [diff] [blame] | 107 | CO_FL_SEND_PROXY = 0x01000000, /* send a valid PROXY protocol header */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 108 | CO_FL_SSL_WAIT_HS = 0x02000000, /* wait for an SSL handshake to complete */ |
Willy Tarreau | 5f1504f | 2012-10-04 23:55:57 +0200 | [diff] [blame] | 109 | CO_FL_ACCEPT_PROXY = 0x04000000, /* receive a valid PROXY protocol header */ |
Willy Tarreau | 57cd3e4 | 2013-10-24 22:01:26 +0200 | [diff] [blame] | 110 | /* unused : 0x08000000 */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 111 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 112 | /* below we have all handshake flags grouped into one */ |
Willy Tarreau | 57cd3e4 | 2013-10-24 22:01:26 +0200 | [diff] [blame] | 113 | CO_FL_HANDSHAKE = CO_FL_SEND_PROXY | CO_FL_SSL_WAIT_HS | CO_FL_ACCEPT_PROXY, |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 114 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 115 | /* when any of these flags is set, polling is defined by socket-layer |
| 116 | * operations, as opposed to data-layer. Transport is explicitly not |
| 117 | * mentionned here to avoid any confusion, since it can be the same |
| 118 | * as DATA or SOCK on some implementations. |
| 119 | */ |
| 120 | CO_FL_POLL_SOCK = CO_FL_HANDSHAKE | CO_FL_WAIT_L4_CONN | CO_FL_WAIT_L6_CONN, |
Willy Tarreau | 1e95491 | 2012-10-12 17:50:05 +0200 | [diff] [blame] | 121 | |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 122 | /* unused : 0x10000000, 0x20000000, 0x40000000 */ |
| 123 | |
Willy Tarreau | 1e95491 | 2012-10-12 17:50:05 +0200 | [diff] [blame] | 124 | /* This last flag indicates that the transport layer is used (for instance |
| 125 | * by logs) and must not be cleared yet. The last call to conn_xprt_close() |
| 126 | * must be done after clearing this flag. |
| 127 | */ |
| 128 | CO_FL_XPRT_TRACKED = 0x80000000, |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 129 | }; |
| 130 | |
Willy Tarreau | 14cba4b | 2012-11-30 17:33:05 +0100 | [diff] [blame] | 131 | |
| 132 | /* possible connection error codes */ |
| 133 | enum { |
| 134 | CO_ER_NONE, /* no error */ |
Willy Tarreau | 45b34e8 | 2014-01-24 16:06:50 +0100 | [diff] [blame] | 135 | |
| 136 | CO_ER_CONF_FDLIM, /* reached process' configured FD limitation */ |
| 137 | CO_ER_PROC_FDLIM, /* reached process' FD limitation */ |
| 138 | CO_ER_SYS_FDLIM, /* reached system's FD limitation */ |
| 139 | CO_ER_SYS_MEMLIM, /* reached system buffers limitation */ |
| 140 | CO_ER_NOPROTO, /* protocol not supported */ |
| 141 | CO_ER_SOCK_ERR, /* other socket error */ |
| 142 | |
| 143 | CO_ER_PORT_RANGE, /* source port range exhausted */ |
| 144 | CO_ER_CANT_BIND, /* can't bind to source address */ |
| 145 | CO_ER_FREE_PORTS, /* no more free ports on the system */ |
| 146 | CO_ER_ADDR_INUSE, /* local address already in use */ |
| 147 | |
Willy Tarreau | 8e3bf69 | 2012-12-03 15:41:18 +0100 | [diff] [blame] | 148 | CO_ER_PRX_EMPTY, /* nothing received in PROXY protocol header */ |
| 149 | CO_ER_PRX_ABORT, /* client abort during PROXY protocol header */ |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 150 | CO_ER_PRX_TIMEOUT, /* timeout while waiting for a PROXY header */ |
Willy Tarreau | 8e3bf69 | 2012-12-03 15:41:18 +0100 | [diff] [blame] | 151 | CO_ER_PRX_TRUNCATED, /* truncated PROXY protocol header */ |
| 152 | CO_ER_PRX_NOT_HDR, /* not a PROXY protocol header */ |
| 153 | CO_ER_PRX_BAD_HDR, /* bad PROXY protocol header */ |
| 154 | CO_ER_PRX_BAD_PROTO, /* unsupported protocol in PROXY header */ |
| 155 | |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 156 | CO_ER_SSL_EMPTY, /* client closed during SSL handshake */ |
| 157 | CO_ER_SSL_ABORT, /* client abort during SSL handshake */ |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 158 | CO_ER_SSL_TIMEOUT, /* timeout during SSL handshake */ |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 159 | CO_ER_SSL_TOO_MANY, /* too many SSL connections */ |
| 160 | CO_ER_SSL_NO_MEM, /* no more memory to allocate an SSL connection */ |
| 161 | CO_ER_SSL_RENEG, /* forbidden client renegociation */ |
| 162 | CO_ER_SSL_CA_FAIL, /* client cert verification failed in the CA chain */ |
| 163 | CO_ER_SSL_CRT_FAIL, /* client cert verification failed on the certificate */ |
| 164 | CO_ER_SSL_HANDSHAKE, /* SSL error during handshake */ |
Willy Tarreau | b396637 | 2014-04-25 18:54:29 +0200 | [diff] [blame] | 165 | CO_ER_SSL_HANDSHAKE_HB, /* SSL error during handshake with heartbeat present */ |
Willy Tarreau | f51c698 | 2014-04-25 20:02:39 +0200 | [diff] [blame] | 166 | CO_ER_SSL_KILLED_HB, /* Stopped a TLSv1 heartbeat attack (CVE-2014-0160) */ |
| 167 | CO_ER_SSL_NO_TARGET, /* unknown target (not client nor server) */ |
Willy Tarreau | 14cba4b | 2012-11-30 17:33:05 +0100 | [diff] [blame] | 168 | }; |
| 169 | |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 170 | /* source address settings for outgoing connections */ |
| 171 | enum { |
| 172 | /* Tproxy exclusive values from 0 to 7 */ |
| 173 | CO_SRC_TPROXY_ADDR = 0x0001, /* bind to this non-local address when connecting */ |
| 174 | CO_SRC_TPROXY_CIP = 0x0002, /* bind to the client's IP address when connecting */ |
| 175 | CO_SRC_TPROXY_CLI = 0x0003, /* bind to the client's IP+port when connecting */ |
| 176 | CO_SRC_TPROXY_DYN = 0x0004, /* bind to a dynamically computed non-local address */ |
| 177 | CO_SRC_TPROXY_MASK = 0x0007, /* bind to a non-local address when connecting */ |
| 178 | |
| 179 | CO_SRC_BIND = 0x0008, /* bind to a specific source address when connecting */ |
| 180 | }; |
| 181 | |
Willy Tarreau | 1049b1f | 2014-02-02 01:51:17 +0100 | [diff] [blame] | 182 | /* flags that can be passed to xprt->snd_buf() */ |
| 183 | enum { |
| 184 | CO_SFL_MSG_MORE = 0x0001, /* More data to come afterwards */ |
Willy Tarreau | 7bed945 | 2014-02-02 02:00:24 +0100 | [diff] [blame] | 185 | CO_SFL_STREAMER = 0x0002, /* Producer is continuously streaming data */ |
Willy Tarreau | 1049b1f | 2014-02-02 01:51:17 +0100 | [diff] [blame] | 186 | }; |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 187 | |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 188 | /* xprt_ops describes transport-layer operations for a connection. They |
| 189 | * generally run over a socket-based control layer, but not always. Some |
| 190 | * of them are used for data transfer with the upper layer (rcv_*, snd_*) |
| 191 | * and the other ones are used to setup and release the transport layer. |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 192 | */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 193 | struct xprt_ops { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 194 | int (*rcv_buf)(struct connection *conn, struct buffer *buf, int count); /* recv callback */ |
| 195 | int (*snd_buf)(struct connection *conn, struct buffer *buf, int flags); /* send callback */ |
| 196 | int (*rcv_pipe)(struct connection *conn, struct pipe *pipe, unsigned int count); /* recv-to-pipe callback */ |
| 197 | int (*snd_pipe)(struct connection *conn, struct pipe *pipe); /* send-to-pipe callback */ |
| 198 | void (*shutr)(struct connection *, int); /* shutr function */ |
| 199 | void (*shutw)(struct connection *, int); /* shutw function */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 200 | void (*close)(struct connection *); /* close the transport layer */ |
| 201 | int (*init)(struct connection *conn); /* initialize the transport layer */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 202 | }; |
| 203 | |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 204 | /* data_cb describes the data layer's recv and send callbacks which are called |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 205 | * when I/O activity was detected after the transport layer is ready. These |
| 206 | * callbacks are supposed to make use of the xprt_ops above to exchange data |
Willy Tarreau | 4aa3683 | 2012-10-02 20:07:22 +0200 | [diff] [blame] | 207 | * from/to buffers and pipes. The <wake> callback is used to report activity |
| 208 | * at the transport layer, which can be a connection opening/close, or any |
Willy Tarreau | f4e114f | 2012-10-03 01:12:30 +0200 | [diff] [blame] | 209 | * data movement. The <init> callback may be called by the connection handler |
| 210 | * at the end of a transport handshake, when it is about to transfer data and |
Willy Tarreau | 2396c1c | 2012-10-03 21:12:16 +0200 | [diff] [blame] | 211 | * the data layer is not ready yet. Both <wake> and <init> may abort a connection |
| 212 | * by returning < 0. |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 213 | */ |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 214 | struct data_cb { |
| 215 | void (*recv)(struct connection *conn); /* data-layer recv callback */ |
| 216 | void (*send)(struct connection *conn); /* data-layer send callback */ |
Willy Tarreau | 2396c1c | 2012-10-03 21:12:16 +0200 | [diff] [blame] | 217 | int (*wake)(struct connection *conn); /* data-layer callback to report activity */ |
Willy Tarreau | f4e114f | 2012-10-03 01:12:30 +0200 | [diff] [blame] | 218 | int (*init)(struct connection *conn); /* data-layer initialization */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 219 | }; |
| 220 | |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 221 | /* a connection source profile defines all the parameters needed to properly |
| 222 | * bind an outgoing connection for a server or proxy. |
| 223 | */ |
| 224 | |
| 225 | struct conn_src { |
| 226 | unsigned int opts; /* CO_SRC_* */ |
| 227 | int iface_len; /* bind interface name length */ |
| 228 | char *iface_name; /* bind interface name or NULL */ |
| 229 | struct port_range *sport_range; /* optional per-server TCP source ports */ |
| 230 | struct sockaddr_storage source_addr; /* the address to which we want to bind for connect() */ |
Pieter Baauw | d551fb5 | 2013-05-08 22:49:23 +0200 | [diff] [blame] | 231 | #if defined(CONFIG_HAP_CTTPROXY) || defined(CONFIG_HAP_TRANSPARENT) |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 232 | struct sockaddr_storage tproxy_addr; /* non-local address we want to bind to for connect() */ |
| 233 | char *bind_hdr_name; /* bind to this header name if defined */ |
| 234 | int bind_hdr_len; /* length of the name of the header above */ |
| 235 | int bind_hdr_occ; /* occurrence number of header above: >0 = from first, <0 = from end, 0=disabled */ |
| 236 | #endif |
| 237 | }; |
| 238 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 239 | /* This structure describes a connection with its methods and data. |
| 240 | * A connection may be performed to proxy or server via a local or remote |
| 241 | * socket, and can also be made to an internal applet. It can support |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 242 | * several transport schemes (raw, ssl, ...). It can support several |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 243 | * connection control schemes, generally a protocol for socket-oriented |
| 244 | * connections, but other methods for applets. |
| 245 | */ |
| 246 | struct connection { |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 247 | enum obj_type obj_type; /* differentiates connection from applet context */ |
Willy Tarreau | ad5281c | 2013-12-06 21:09:57 +0100 | [diff] [blame] | 248 | unsigned char err_code; /* CO_ER_* */ |
| 249 | signed short send_proxy_ofs; /* <0 = offset to (re)send from the end, >0 = send all */ |
Willy Tarreau | b8020ce | 2013-10-24 21:10:08 +0200 | [diff] [blame] | 250 | unsigned int flags; /* CO_FL_* */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 251 | const struct protocol *ctrl; /* operations at the socket layer */ |
Willy Tarreau | 378e041 | 2012-10-13 14:33:58 +0200 | [diff] [blame] | 252 | const struct xprt_ops *xprt; /* operations at the transport layer */ |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 253 | const struct data_cb *data; /* data layer callbacks. Must be set before xprt->init() */ |
Willy Tarreau | 378e041 | 2012-10-13 14:33:58 +0200 | [diff] [blame] | 254 | void *xprt_ctx; /* general purpose pointer, initialized to NULL */ |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 255 | void *owner; /* pointer to upper layer's entity (eg: stream interface) */ |
Willy Tarreau | b8020ce | 2013-10-24 21:10:08 +0200 | [diff] [blame] | 256 | int xprt_st; /* transport layer state, initialized to zero */ |
Willy Tarreau | ad5281c | 2013-12-06 21:09:57 +0100 | [diff] [blame] | 257 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 258 | union { /* definitions which depend on connection type */ |
| 259 | struct { /*** information used by socket-based connections ***/ |
| 260 | int fd; /* file descriptor for a stream driver when known */ |
| 261 | } sock; |
| 262 | } t; |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 263 | enum obj_type *target; /* the target to connect to (server, proxy, applet, ...) */ |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 264 | struct { |
| 265 | struct sockaddr_storage from; /* client address, or address to spoof when connecting to the server */ |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 266 | struct sockaddr_storage to; /* address reached by the client, or address to connect to */ |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 267 | } addr; /* addresses of the remote side, client for producer and server for consumer */ |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 268 | }; |
| 269 | |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 270 | /* proxy protocol v2 definitions */ |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 271 | #define PP2_SIGNATURE "\x0D\x0A\x0D\x0A\x00\x0D\x0A\x51\x55\x49\x54\x0A" |
| 272 | #define PP2_SIGNATURE_LEN 12 |
| 273 | #define PP2_HEADER_LEN 16 |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 274 | |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 275 | /* ver_cmd byte */ |
| 276 | #define PP2_CMD_LOCAL 0x00 |
| 277 | #define PP2_CMD_PROXY 0x01 |
| 278 | #define PP2_CMD_MASK 0x0F |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 279 | |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 280 | #define PP2_VERSION 0x20 |
| 281 | #define PP2_VERSION_MASK 0xF0 |
| 282 | |
| 283 | /* fam byte */ |
| 284 | #define PP2_TRANS_UNSPEC 0x00 |
| 285 | #define PP2_TRANS_STREAM 0x01 |
| 286 | #define PP2_TRANS_DGRAM 0x02 |
| 287 | #define PP2_TRANS_MASK 0x0F |
| 288 | |
| 289 | #define PP2_FAM_UNSPEC 0x00 |
| 290 | #define PP2_FAM_INET 0x10 |
| 291 | #define PP2_FAM_INET6 0x20 |
| 292 | #define PP2_FAM_UNIX 0x30 |
| 293 | #define PP2_FAM_MASK 0xF0 |
| 294 | |
| 295 | #define PP2_ADDR_LEN_UNSPEC (0) |
| 296 | #define PP2_ADDR_LEN_INET (4 + 4 + 2 + 2) |
| 297 | #define PP2_ADDR_LEN_INET6 (16 + 16 + 2 + 2) |
| 298 | #define PP2_ADDR_LEN_UNIX (108 + 108) |
| 299 | |
| 300 | #define PP2_HDR_LEN_UNSPEC (PP2_HEADER_LEN + PP2_ADDR_LEN_UNSPEC) |
| 301 | #define PP2_HDR_LEN_INET (PP2_HEADER_LEN + PP2_ADDR_LEN_INET) |
| 302 | #define PP2_HDR_LEN_INET6 (PP2_HEADER_LEN + PP2_ADDR_LEN_INET6) |
| 303 | #define PP2_HDR_LEN_UNIX (PP2_HEADER_LEN + PP2_ADDR_LEN_UNIX) |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 304 | |
| 305 | struct proxy_hdr_v2 { |
| 306 | uint8_t sig[12]; /* hex 0D 0A 0D 0A 00 0D 0A 51 55 49 54 0A */ |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 307 | uint8_t ver_cmd; /* protocol version and command */ |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 308 | uint8_t fam; /* protocol family and transport */ |
| 309 | uint16_t len; /* number of following bytes part of the header */ |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 310 | union { |
| 311 | struct { /* for TCP/UDP over IPv4, len = 12 */ |
| 312 | uint32_t src_addr; |
| 313 | uint32_t dst_addr; |
| 314 | uint16_t src_port; |
| 315 | uint16_t dst_port; |
| 316 | } ip4; |
| 317 | struct { /* for TCP/UDP over IPv6, len = 36 */ |
| 318 | uint8_t src_addr[16]; |
| 319 | uint8_t dst_addr[16]; |
| 320 | uint16_t src_port; |
| 321 | uint16_t dst_port; |
| 322 | } ip6; |
| 323 | struct { /* for AF_UNIX sockets, len = 216 */ |
| 324 | uint8_t src_addr[108]; |
| 325 | uint8_t dst_addr[108]; |
| 326 | } unx; |
| 327 | } addr; |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 328 | }; |
| 329 | |
| 330 | #define PP2_TYPE_SSL 0x20 |
| 331 | #define PP2_TYPE_SSL_VERSION 0x21 |
| 332 | #define PP2_TYPE_SSL_CN 0x22 |
| 333 | |
| 334 | struct tlv { |
| 335 | uint8_t type; |
| 336 | uint8_t length_hi; |
| 337 | uint8_t length_lo; |
| 338 | uint8_t value[0]; |
| 339 | }__attribute__((packed)); |
| 340 | |
| 341 | struct tlv_ssl { |
| 342 | struct tlv tlv; |
| 343 | uint8_t client; |
| 344 | uint32_t verify; |
| 345 | uint8_t sub_tlv[0]; |
| 346 | }__attribute__((packed)); |
| 347 | |
Dave McCowan | 328fb58 | 2014-07-30 10:39:13 -0400 | [diff] [blame] | 348 | #define PP2_CLIENT_SSL 0x01 |
| 349 | #define PP2_CLIENT_CERT_CONN 0x02 |
| 350 | #define PP2_CLIENT_CERT_SESS 0x04 |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 351 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 352 | #endif /* _TYPES_CONNECTION_H */ |
| 353 | |
| 354 | /* |
| 355 | * Local variables: |
| 356 | * c-indent-level: 8 |
| 357 | * c-basic-offset: 8 |
| 358 | * End: |
| 359 | */ |