nginx: src/core/ngx_inet.h annotate

annotate src/core/ngx_inet.h @ 6564:19db5a6bc34e

Realip: port support in X-Real-IP and X-Forwarded-For. Now, the module extracts optional port which may accompany an IP address. This custom extension is introduced, among other things, in order to facilitate logging of original client ports. Addresses with ports are expected to be in the RFC 3986 format, that is, with IPv6 addresses in square brackets. E.g., "X-Real-IP: [2001:0db8::1]:12345" sets client port ($remote_port) to 12345.

author	Dmitry Volyntsev <xeioex@nginx.com>
date	Mon, 23 May 2016 18:44:23 +0300
parents	adf25b8d0431
children	b3b7e33083ac

rev	line source
441 da8c5707af39 nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files Igor Sysoev <igor@sysoev.ru> parents: 340 diff changeset	1
da8c5707af39 nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files Igor Sysoev <igor@sysoev.ru> parents: 340 diff changeset	2 /*
444 42d11f017717 nginx-0.1.0-2004-09-29-20:00:49 import; remove years from copyright Igor Sysoev <igor@sysoev.ru> parents: 441 diff changeset	3 * Copyright (C) Igor Sysoev
4412 d620f497c50f Copyright updated. Maxim Konovalov <maxim@nginx.com> parents: 3276 diff changeset	4 * Copyright (C) Nginx, Inc.
441 da8c5707af39 nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files Igor Sysoev <igor@sysoev.ru> parents: 340 diff changeset	5 */
da8c5707af39 nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files Igor Sysoev <igor@sysoev.ru> parents: 340 diff changeset	6
da8c5707af39 nginx-0.1.0-2004-09-28-12:34:51 import; set copyright and remove unused files Igor Sysoev <igor@sysoev.ru> parents: 340 diff changeset	7
26 53cb81681040 nginx-0.0.1-2002-12-15-09:25:09 import Igor Sysoev <igor@sysoev.ru> parents: diff changeset	8 #ifndef _NGX_INET_H_INCLUDED_
53cb81681040 nginx-0.0.1-2002-12-15-09:25:09 import Igor Sysoev <igor@sysoev.ru> parents: diff changeset	9 #define _NGX_INET_H_INCLUDED_
53cb81681040 nginx-0.0.1-2002-12-15-09:25:09 import Igor Sysoev <igor@sysoev.ru> parents: diff changeset	10
53cb81681040 nginx-0.0.1-2002-12-15-09:25:09 import Igor Sysoev <igor@sysoev.ru> parents: diff changeset	11
479 c52408583801 nginx-0.1.14-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 444 diff changeset	12 #include <ngx_config.h>
c52408583801 nginx-0.1.14-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 444 diff changeset	13 #include <ngx_core.h>
c52408583801 nginx-0.1.14-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 444 diff changeset	14
c52408583801 nginx-0.1.14-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 444 diff changeset	15
3230 a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	16 #define NGX_INET_ADDRSTRLEN (sizeof("255.255.255.255") - 1)
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	17 #define NGX_INET6_ADDRSTRLEN \
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	18 (sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255") - 1)
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	19 #define NGX_UNIX_ADDRSTRLEN \
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	20 (sizeof(struct sockaddr_un) - offsetof(struct sockaddr_un, sun_path))
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	21
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	22 #if (NGX_HAVE_UNIX_DOMAIN)
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	23 #define NGX_SOCKADDR_STRLEN (sizeof("unix:") - 1 + NGX_UNIX_ADDRSTRLEN)
6559 adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	24 #elif (NGX_HAVE_INET6)
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	25 #define NGX_SOCKADDR_STRLEN (NGX_INET6_ADDRSTRLEN + sizeof("[]:65535") - 1)
3230 a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	26 #else
6559 adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	27 #define NGX_SOCKADDR_STRLEN (NGX_INET_ADDRSTRLEN + sizeof(":65535") - 1)
3230 a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	28 #endif
a7491af45540 http listen unix domain sockets Igor Sysoev <igor@sysoev.ru> parents: 2856 diff changeset	29
6559 adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	30 /* compatibility */
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	31 #define NGX_SOCKADDRLEN sizeof(ngx_sockaddr_t)
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	32
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	33
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	34 typedef union {
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	35 struct sockaddr sockaddr;
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	36 struct sockaddr_in sockaddr_in;
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	37 #if (NGX_HAVE_INET6)
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	38 struct sockaddr_in6 sockaddr_in6;
adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	39 #endif
2521 119ab57ffaa1 fix NGX_SOCKADDRLEN, introduced in r2513 Igor Sysoev <igor@sysoev.ru> parents: 2512 diff changeset	40 #if (NGX_HAVE_UNIX_DOMAIN)
6559 adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	41 struct sockaddr_un sockaddr_un;
2512 2e91aecb9e57 a prelimiary IPv6 support, HTTP listen Igor Sysoev <igor@sysoev.ru> parents: 2203 diff changeset	42 #endif
6559 adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	43 } ngx_sockaddr_t;
2197 74477ea8074f ) remove zero termination in ngx_inet_ntop() and ngx_sock_ntop() Igor Sysoev <igor@sysoev.ru>* parents: 1671 diff changeset	44
74477ea8074f ) remove zero termination in ngx_inet_ntop() and ngx_sock_ntop() Igor Sysoev <igor@sysoev.ru>* parents: 1671 diff changeset	45
340 0bf903191ceb nginx-0.0.3-2004-05-25-19:28:46 import Igor Sysoev <igor@sysoev.ru> parents: 291 diff changeset	46 typedef struct {
2538 c5bbb6164630 fix the previous commit Igor Sysoev <igor@sysoev.ru> parents: 2537 diff changeset	47 in_addr_t addr;
c5bbb6164630 fix the previous commit Igor Sysoev <igor@sysoev.ru> parents: 2537 diff changeset	48 in_addr_t mask;
c5bbb6164630 fix the previous commit Igor Sysoev <igor@sysoev.ru> parents: 2537 diff changeset	49 } ngx_in_cidr_t;
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	50
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	51
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	52 #if (NGX_HAVE_INET6)
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	53
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	54 typedef struct {
2538 c5bbb6164630 fix the previous commit Igor Sysoev <igor@sysoev.ru> parents: 2537 diff changeset	55 struct in6_addr addr;
c5bbb6164630 fix the previous commit Igor Sysoev <igor@sysoev.ru> parents: 2537 diff changeset	56 struct in6_addr mask;
c5bbb6164630 fix the previous commit Igor Sysoev <igor@sysoev.ru> parents: 2537 diff changeset	57 } ngx_in6_cidr_t;
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	58
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	59 #endif
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	60
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	61
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	62 typedef struct {
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	63 ngx_uint_t family;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	64 union {
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	65 ngx_in_cidr_t in;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	66 #if (NGX_HAVE_INET6)
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	67 ngx_in6_cidr_t in6;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	68 #endif
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	69 } u;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	70 } ngx_cidr_t;
340 0bf903191ceb nginx-0.0.3-2004-05-25-19:28:46 import Igor Sysoev <igor@sysoev.ru> parents: 291 diff changeset	71
0bf903191ceb nginx-0.0.3-2004-05-25-19:28:46 import Igor Sysoev <igor@sysoev.ru> parents: 291 diff changeset	72
804 472cd9768ac2 now the "listen" directives use ngx_parse_url() Igor Sysoev <igor@sysoev.ru> parents: 663 diff changeset	73 typedef struct {
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	74 struct sockaddr *sockaddr;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	75 socklen_t socklen;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	76 ngx_str_t name;
3269 f0d596e84634 rename ngx_peer_addr_t to ngx_addr_t Igor Sysoev <igor@sysoev.ru> parents: 3265 diff changeset	77 } ngx_addr_t;
804 472cd9768ac2 now the "listen" directives use ngx_parse_url() Igor Sysoev <igor@sysoev.ru> parents: 663 diff changeset	78
651 39b7d7b33c91 nginx-0.3.47-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 479 diff changeset	79
884 4d68c486fcb0 upstream choice modules Igor Sysoev <igor@sysoev.ru> parents: 808 diff changeset	80 typedef struct {
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	81 ngx_str_t url;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	82 ngx_str_t host;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	83 ngx_str_t port_text;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	84 ngx_str_t uri;
804 472cd9768ac2 now the "listen" directives use ngx_parse_url() Igor Sysoev <igor@sysoev.ru> parents: 663 diff changeset	85
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	86 in_port_t port;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	87 in_port_t default_port;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	88 int family;
651 39b7d7b33c91 nginx-0.3.47-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 479 diff changeset	89
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	90 unsigned listen:1;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	91 unsigned uri_part:1;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	92 unsigned no_resolve:1;
651 39b7d7b33c91 nginx-0.3.47-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 479 diff changeset	93
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	94 unsigned no_port:1;
a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	95 unsigned wildcard:1;
884 4d68c486fcb0 upstream choice modules Igor Sysoev <igor@sysoev.ru> parents: 808 diff changeset	96
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	97 socklen_t socklen;
6559 adf25b8d0431 Introduced the ngx_sockaddr_t type. Ruslan Ermilov <ru@nginx.com> parents: 6527 diff changeset	98 ngx_sockaddr_t sockaddr;
2512 2e91aecb9e57 a prelimiary IPv6 support, HTTP listen Igor Sysoev <igor@sysoev.ru> parents: 2203 diff changeset	99
3269 f0d596e84634 rename ngx_peer_addr_t to ngx_addr_t Igor Sysoev <igor@sysoev.ru> parents: 3265 diff changeset	100 ngx_addr_t *addrs;
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	101 ngx_uint_t naddrs;
804 472cd9768ac2 now the "listen" directives use ngx_parse_url() Igor Sysoev <igor@sysoev.ru> parents: 663 diff changeset	102
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	103 char *err;
651 39b7d7b33c91 nginx-0.3.47-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 479 diff changeset	104 } ngx_url_t;
39b7d7b33c91 nginx-0.3.47-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 479 diff changeset	105
39b7d7b33c91 nginx-0.3.47-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 479 diff changeset	106
1647 c68477afa410 ngx_inet_addr() Igor Sysoev <igor@sysoev.ru> parents: 1559 diff changeset	107 in_addr_t ngx_inet_addr(u_char *text, size_t len);
3265 0c5c5e876391 ngx_inet6_addr() Igor Sysoev <igor@sysoev.ru> parents: 3264 diff changeset	108 #if (NGX_HAVE_INET6)
0c5c5e876391 ngx_inet6_addr() Igor Sysoev <igor@sysoev.ru> parents: 3264 diff changeset	109 ngx_int_t ngx_inet6_addr(u_char p, size_t len, u_char addr);
3276 beaf94f2f265 make ngx_inet6_ntop() non-static Igor Sysoev <igor@sysoev.ru> parents: 3272 diff changeset	110 size_t ngx_inet6_ntop(u_char p, u_char text, size_t len);
3265 0c5c5e876391 ngx_inet6_addr() Igor Sysoev <igor@sysoev.ru> parents: 3264 diff changeset	111 #endif
5263 05ba5bce31e0 Core: extended ngx_sock_ntop() with socklen parameter. Vladimir Homutov <vl@nginx.com> parents: 4971 diff changeset	112 size_t ngx_sock_ntop(struct sockaddr sa, socklen_t socklen, u_char text,
05ba5bce31e0 Core: extended ngx_sock_ntop() with socklen parameter. Vladimir Homutov <vl@nginx.com> parents: 4971 diff changeset	113 size_t len, ngx_uint_t port);
291 117ccc7c4055 nginx-0.0.3-2004-03-16-16:35:20 import Igor Sysoev <igor@sysoev.ru> parents: 290 diff changeset	114 size_t ngx_inet_ntop(int family, void addr, u_char text, size_t len);
2537 a472d954c534 prepare ngx_ptocidr() for IPv6 Igor Sysoev <igor@sysoev.ru> parents: 2521 diff changeset	115 ngx_int_t ngx_ptocidr(ngx_str_t text, ngx_cidr_t cidr);
3272 98f49b2bcae8 change ngx_parse_addr() interface Igor Sysoev <igor@sysoev.ru> parents: 3270 diff changeset	116 ngx_int_t ngx_parse_addr(ngx_pool_t pool, ngx_addr_t addr, u_char *text,
98f49b2bcae8 change ngx_parse_addr() interface Igor Sysoev <igor@sysoev.ru> parents: 3270 diff changeset	117 size_t len);
6564 19db5a6bc34e Realip: port support in X-Real-IP and X-Forwarded-For. Dmitry Volyntsev <xeioex@nginx.com> parents: 6559 diff changeset	118 ngx_int_t ngx_parse_addr_port(ngx_pool_t pool, ngx_addr_t addr,
19db5a6bc34e Realip: port support in X-Real-IP and X-Forwarded-For. Dmitry Volyntsev <xeioex@nginx.com> parents: 6559 diff changeset	119 u_char *text, size_t len);
1559 fe11e2a3946d use pool instead of ngx_conf_t Igor Sysoev <igor@sysoev.ru> parents: 906 diff changeset	120 ngx_int_t ngx_parse_url(ngx_pool_t pool, ngx_url_t u);
fe11e2a3946d use pool instead of ngx_conf_t Igor Sysoev <igor@sysoev.ru> parents: 906 diff changeset	121 ngx_int_t ngx_inet_resolve_host(ngx_pool_t pool, ngx_url_t u);
5473 d39ef821d03e Core: externalized ngx_cmp_sockaddr(). Ruslan Ermilov <ru@nginx.com> parents: 5263 diff changeset	122 ngx_int_t ngx_cmp_sockaddr(struct sockaddr *sa1, socklen_t slen1,
d39ef821d03e Core: externalized ngx_cmp_sockaddr(). Ruslan Ermilov <ru@nginx.com> parents: 5263 diff changeset	123 struct sockaddr *sa2, socklen_t slen2, ngx_uint_t cmp_port);
884 4d68c486fcb0 upstream choice modules Igor Sysoev <igor@sysoev.ru> parents: 808 diff changeset	124
479 c52408583801 nginx-0.1.14-RELEASE import Igor Sysoev <igor@sysoev.ru> parents: 444 diff changeset	125
26 53cb81681040 nginx-0.0.1-2002-12-15-09:25:09 import Igor Sysoev <igor@sysoev.ru> parents: diff changeset	126 #endif /* _NGX_INET_H_INCLUDED_ */

Mercurial > hg > nginx

annotate src/core/ngx_inet.h @ 6564:19db5a6bc34e