1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* Copyright 2004 The WebRTC Project Authors. All rights reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef RTC_BASE_SOCKET_ADDRESS_H_
#define RTC_BASE_SOCKET_ADDRESS_H_
#include <string>
#include "absl/strings/string_view.h"
#ifdef WEBRTC_UNIT_TEST
#include <ostream> // no-presubmit-check TODO(webrtc:8982)
#endif // WEBRTC_UNIT_TEST
#include "rtc_base/ip_address.h"
#include "rtc_base/system/rtc_export.h"
#undef SetPort
struct sockaddr_in;
struct sockaddr_storage;
namespace rtc {
// Records an IP address and port.
class RTC_EXPORT SocketAddress {
public:
// Creates a nil address.
SocketAddress();
// Creates the address with the given host and port. Host may be a
// literal IP string or a hostname to be resolved later.
// DCHECKs that port is in valid range (0 to 2^16-1).
SocketAddress(absl::string_view hostname, int port);
// Creates the address with the given IP and port.
// IP is given as an integer in host byte order. V4 only, to be deprecated.
// DCHECKs that port is in valid range (0 to 2^16-1).
SocketAddress(uint32_t ip_as_host_order_integer, int port);
// Creates the address with the given IP and port.
// DCHECKs that port is in valid range (0 to 2^16-1).
SocketAddress(const IPAddress& ip, int port);
// Creates a copy of the given address.
SocketAddress(const SocketAddress& addr);
// Resets to the nil address.
void Clear();
// Determines if this is a nil address (empty hostname, any IP, null port)
bool IsNil() const;
// Returns true if ip and port are set.
bool IsComplete() const;
// Replaces our address with the given one.
SocketAddress& operator=(const SocketAddress& addr);
// Changes the IP of this address to the given one, and clears the hostname
// IP is given as an integer in host byte order. V4 only, to be deprecated..
void SetIP(uint32_t ip_as_host_order_integer);
// Changes the IP of this address to the given one, and clears the hostname.
void SetIP(const IPAddress& ip);
// Changes the hostname of this address to the given one.
// Does not resolve the address; use Resolve to do so.
void SetIP(absl::string_view hostname);
// Sets the IP address while retaining the hostname. Useful for bypassing
// DNS for a pre-resolved IP.
// IP is given as an integer in host byte order. V4 only, to be deprecated.
void SetResolvedIP(uint32_t ip_as_host_order_integer);
// Sets the IP address while retaining the hostname. Useful for bypassing
// DNS for a pre-resolved IP.
void SetResolvedIP(const IPAddress& ip);
// Changes the port of this address to the given one.
// DCHECKs that port is in valid range (0 to 2^16-1).
void SetPort(int port);
// Returns the hostname.
const std::string& hostname() const { return hostname_; }
// Returns the IP address as a host byte order integer.
// Returns 0 for non-v4 addresses.
uint32_t ip() const;
const IPAddress& ipaddr() const;
int family() const { return ip_.family(); }
// Returns the port part of this address.
uint16_t port() const;
// Returns the scope ID associated with this address. Scope IDs are a
// necessary addition to IPv6 link-local addresses, with different network
// interfaces having different scope-ids for their link-local addresses.
// IPv4 address do not have scope_ids and sockaddr_in structures do not have
// a field for them.
int scope_id() const { return scope_id_; }
void SetScopeID(int id) { scope_id_ = id; }
// Returns the 'host' portion of the address (hostname or IP) in a form
// suitable for use in a URI. If both IP and hostname are present, hostname
// is preferred. IPv6 addresses are enclosed in square brackets ('[' and ']').
std::string HostAsURIString() const;
// Same as HostAsURIString but anonymizes IP addresses by hiding the last
// part.
std::string HostAsSensitiveURIString() const;
// Returns the port as a string.
std::string PortAsString() const;
// Returns hostname:port or [hostname]:port.
std::string ToString() const;
// Same as ToString but anonymizes it by hiding the last part.
std::string ToSensitiveString() const;
// Returns sensitive description of address in a form which both includes
// resolved and unresolved addresses based on their availability.
std::string ToSensitiveNameAndAddressString() const;
// Parses hostname:port and [hostname]:port.
bool FromString(absl::string_view str);
#ifdef WEBRTC_UNIT_TEST
inline std::ostream& operator<<( // no-presubmit-check TODO(webrtc:8982)
std::ostream& os) { // no-presubmit-check TODO(webrtc:8982)
return os << HostAsURIString() << ":" << port();
}
#endif // WEBRTC_UNIT_TEST
// Determines whether this represents a missing / any IP address.
// That is, 0.0.0.0 or ::.
// Hostname and/or port may be set.
bool IsAnyIP() const;
// Determines whether the IP address refers to a loopback address.
// For v4 addresses this means the address is in the range 127.0.0.0/8.
// For v6 addresses this means the address is ::1.
bool IsLoopbackIP() const;
// Determines whether the IP address is in one of the private ranges:
// For v4: 127.0.0.0/8 10.0.0.0/8 192.168.0.0/16 172.16.0.0/12.
// For v6: FE80::/16 and ::1.
bool IsPrivateIP() const;
// Determines whether the hostname has been resolved to an IP.
bool IsUnresolvedIP() const;
// Determines whether this address is identical to the given one.
bool operator==(const SocketAddress& addr) const;
inline bool operator!=(const SocketAddress& addr) const {
return !this->operator==(addr);
}
// Compares based on IP and then port.
bool operator<(const SocketAddress& addr) const;
// Determines whether this address has the same IP as the one given.
bool EqualIPs(const SocketAddress& addr) const;
// Determines whether this address has the same port as the one given.
bool EqualPorts(const SocketAddress& addr) const;
// Hashes this address into a small number.
size_t Hash() const;
// Write this address to a sockaddr_in.
// If IPv6, will zero out the sockaddr_in and sets family to AF_UNSPEC.
void ToSockAddr(sockaddr_in* saddr) const;
// Read this address from a sockaddr_in.
bool FromSockAddr(const sockaddr_in& saddr);
// Read and write the address to/from a sockaddr_storage.
// Dual stack version always sets family to AF_INET6, and maps v4 addresses.
// The other version doesn't map, and outputs an AF_INET address for
// v4 or mapped addresses, and AF_INET6 addresses for others.
// Returns the size of the sockaddr_in or sockaddr_in6 structure that is
// written to the sockaddr_storage, or zero on failure.
size_t ToDualStackSockAddrStorage(sockaddr_storage* saddr) const;
size_t ToSockAddrStorage(sockaddr_storage* saddr) const;
private:
std::string hostname_;
IPAddress ip_;
uint16_t port_;
int scope_id_;
bool literal_; // Indicates that 'hostname_' contains a literal IP string.
};
RTC_EXPORT bool SocketAddressFromSockAddrStorage(const sockaddr_storage& saddr,
SocketAddress* out);
SocketAddress EmptySocketAddressWithFamily(int family);
} // namespace rtc
#endif // RTC_BASE_SOCKET_ADDRESS_H_
|
