xrootd
XrdNetAddrInfo.hh
Go to the documentation of this file.
1 #ifndef __XRDNETADDRINFO_HH__
2 #define __XRDNETADDRINFO_HH__
3 /******************************************************************************/
4 /* */
5 /* X r d N e t A d d r I n f o . h h */
6 /* */
7 /* (c) 2013 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
33 #include <inttypes.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include <netinet/in.h>
37 #include <sys/socket.h>
38 #include <sys/un.h>
39 
40 #include "XrdNet/XrdNetSockAddr.hh"
41 #include "XrdSys/XrdSysPlatform.hh"
42 
43 //------------------------------------------------------------------------------
48 //------------------------------------------------------------------------------
49 
50 struct addrinfo;
51 class XrdNetCache;
52 
54 {
55 public:
56 
57 //------------------------------------------------------------------------------
63 //------------------------------------------------------------------------------
64 
65 const char *Dialect() {return protName;}
66 
67 //------------------------------------------------------------------------------
72 //------------------------------------------------------------------------------
73 
74 int Family() const {return static_cast<int>(IP.Addr.sa_family);}
75 
76 //------------------------------------------------------------------------------
97 //------------------------------------------------------------------------------
98 
99 enum fmtUse {fmtAuto=0,
103 
104 static const int noPort = 0x0000001;
105 static const int noPortRaw = 0x0000002;
106 static const int old6Map4 = 0x0000004;
107 static const int prefipv4 = 0x0000008;
108 
109 int Format(char *bAddr, int bLen, fmtUse fmtType=fmtAuto, int fmtOpts=0);
110 
111 //------------------------------------------------------------------------------
117 //------------------------------------------------------------------------------
118 
119 bool isLoopback();
120 
121 //------------------------------------------------------------------------------
131 //------------------------------------------------------------------------------
132 
133 static bool isHostName(const char *name);
134 
135 //------------------------------------------------------------------------------
142 //------------------------------------------------------------------------------
143 
144 enum IPType {IPv4 = AF_INET, IPv6 = AF_INET6, IPuX = AF_UNIX};
145 
146 bool isIPType(IPType ipType) const {return IP.Addr.sa_family == ipType;}
147 
148 //------------------------------------------------------------------------------
153 //------------------------------------------------------------------------------
154 
155 bool isMapped() const {return IP.Addr.sa_family == AF_INET6
156  && IN6_IS_ADDR_V4MAPPED(&IP.v6.sin6_addr);
157  }
158 
159 //------------------------------------------------------------------------------
164 //------------------------------------------------------------------------------
165 
166 bool isPrivate();
167 
168 //------------------------------------------------------------------------------
173 //------------------------------------------------------------------------------
174 
176 
177 //------------------------------------------------------------------------------
182 //------------------------------------------------------------------------------
183 
184 bool isUsingTLS();
185 
186 //------------------------------------------------------------------------------
192 //------------------------------------------------------------------------------
193 
194 struct LocInfo
195  {unsigned char Country[2];
196  unsigned char Region;
197  unsigned char Locale;
198  char TimeZone;
199  char Flags;
200  short Speed;
201  int Latitude;
203 
204  LocInfo() : Region(0), Locale(0), TimeZone(-128), Flags(0),
205  Speed(0), Latitude(0), Longtitude(0) {*Country = 0;}
206 
207  };
208 
209 const struct
210 LocInfo *Location() {return (addrLoc.Country[0] ? &addrLoc : 0);}
211 
212 //------------------------------------------------------------------------------
224 //------------------------------------------------------------------------------
225 
226 const char *Name(const char *eName=0, const char **eText=0);
227 
228 //------------------------------------------------------------------------------
234 //------------------------------------------------------------------------------
235 
236 const
237 XrdNetSockAddr *NetAddr() {return (sockAddr == (void *)&IP ? &IP : 0);}
238 
239 //------------------------------------------------------------------------------
244 //------------------------------------------------------------------------------
245 
246 int Port();
247 
248 //------------------------------------------------------------------------------
253 //------------------------------------------------------------------------------
254 
255 int Protocol() {return static_cast<int>(protType);}
256 
257 //------------------------------------------------------------------------------
266 //-----------------------------------------------------------------------------sav-
267 
268 int Same(const XrdNetAddrInfo *ipAddr, bool plusPort=false);
269 
270 //------------------------------------------------------------------------------
275 //------------------------------------------------------------------------------
276 
277 const
278 sockaddr *SockAddr() {return sockAddr;}
279 
280 //------------------------------------------------------------------------------
285 //------------------------------------------------------------------------------
286 
287 SOCKLEN_t SockSize() {return static_cast<SOCKLEN_t>(addrSize);}
288 
289 //------------------------------------------------------------------------------
293 //------------------------------------------------------------------------------
294 
295 int SockFD() {return (sockNum ? sockNum : -1);}
296 
297 //------------------------------------------------------------------------------
299 //------------------------------------------------------------------------------
300 
302  {if (&rhs != this)
303  {memmove(&IP, &rhs.IP, sizeof(IP));
304  addrSize = rhs.addrSize; sockNum = rhs.sockNum;
305  protType = rhs.protType;
306  protFlgs = rhs.protFlgs;
307  protName = rhs.protName;
308  if (hostName) free(hostName);
309  hostName = (rhs.hostName ? strdup(rhs.hostName):0);
310  addrLoc = rhs.addrLoc;
311  if (rhs.sockAddr != &rhs.IP.Addr)
312  {if (!unixPipe || sockAddr == &IP.Addr)
313  unixPipe = new sockaddr_un;
314  memcpy(unixPipe, rhs.unixPipe, sizeof(sockaddr_un));
315  } else sockAddr = &IP.Addr;
316  }
317  return *this;
318  }
319 
320 //------------------------------------------------------------------------------
322 //------------------------------------------------------------------------------
323 
325  {hostName = 0;
326  unixPipe = 0;
327  *this = oP;
328  }
329 
330 //------------------------------------------------------------------------------
332 //------------------------------------------------------------------------------
333 
335  protFlgs(0), sockNum(0), protName(0)
336  {IP.Addr.sa_family = 0;
337  sockAddr = &IP.Addr;
338  }
339 
340  XrdNetAddrInfo(const XrdNetAddrInfo *addr) : hostName(0) {*this = *addr;}
341 
342 //------------------------------------------------------------------------------
344 //------------------------------------------------------------------------------
345 
347  if (sockAddr != &IP.Addr) delete unixPipe;
348  }
349 
350 protected:
351  char *LowCase(char *str);
352  int QFill(char *bAddr, int bLen);
353  int Resolve();
354 
356 
358 union {struct sockaddr *sockAddr;
359  struct sockaddr_un *unixPipe;
360  };
361 char *hostName;
363 unsigned short addrSize;
364 unsigned char protType;
365 unsigned char protFlgs;
367 const char *protName;
368 
369 // Flag settings in protFlgs
370 //
371 static const char isTLS = 0x01;
372 };
373 #endif
XrdNetAddrInfo::IPv6
@ IPv6
Definition: XrdNetAddrInfo.hh:144
XrdNetAddrInfo::IPType
IPType
Definition: XrdNetAddrInfo.hh:144
XrdNetAddrInfo::SockAddr
const sockaddr * SockAddr()
Definition: XrdNetAddrInfo.hh:278
XrdNetAddrInfo::Resolve
int Resolve()
XrdNetAddrInfo::isHostName
static bool isHostName(const char *name)
XrdNetAddrInfo::IPv4
@ IPv4
Definition: XrdNetAddrInfo.hh:144
XrdNetAddrInfo::Same
int Same(const XrdNetAddrInfo *ipAddr, bool plusPort=false)
XrdNetCache
Definition: XrdNetCache.hh:42
XrdNetAddrInfo::LocInfo
Definition: XrdNetAddrInfo.hh:195
XrdNetAddrInfo::XrdNetAddrInfo
XrdNetAddrInfo(const XrdNetAddrInfo *addr)
Definition: XrdNetAddrInfo.hh:340
XrdNetAddrInfo::SockSize
SOCKLEN_t SockSize()
Definition: XrdNetAddrInfo.hh:287
XrdNetAddrInfo::isUsingTLS
bool isUsingTLS()
XrdNetAddrInfo::LocInfo::Region
unsigned char Region
Region (may combine adjacent countries)
Definition: XrdNetAddrInfo.hh:196
XrdNetAddrInfo::LocInfo::Latitude
int Latitude
Degrees +/- xx.xxxxxx (not supported)
Definition: XrdNetAddrInfo.hh:201
XrdNetAddrInfo::Location
const struct LocInfo * Location()
Definition: XrdNetAddrInfo.hh:210
XrdNetSockAddr::Addr
struct sockaddr Addr
Definition: XrdNetSockAddr.hh:45
XrdNetAddrInfo::hostName
char * hostName
Definition: XrdNetAddrInfo.hh:361
XrdNetAddrInfo::isIPType
bool isIPType(IPType ipType) const
Definition: XrdNetAddrInfo.hh:146
XrdNetAddrInfo::isLoopback
bool isLoopback()
XrdNetAddrInfo::LocInfo::Speed
short Speed
I/F speed (Gb*1024/100)(not supported)
Definition: XrdNetAddrInfo.hh:200
XrdNetAddrInfo
Definition: XrdNetAddrInfo.hh:54
XrdNetAddrInfo::isRegistered
bool isRegistered()
XrdNetAddrInfo::fmtName
@ fmtName
Hostname if it is resolvable o/w use fmtAddr.
Definition: XrdNetAddrInfo.hh:100
XrdNetAddrInfo::dnsCache
static XrdNetCache * dnsCache
Definition: XrdNetAddrInfo.hh:355
XrdNetAddrInfo::LocInfo::LocInfo
LocInfo()
Definition: XrdNetAddrInfo.hh:204
XrdNetAddrInfo::fmtAddr
@ fmtAddr
Address using suitable ipv4 or ipv6 format.
Definition: XrdNetAddrInfo.hh:101
XrdNetAddrInfo::XrdNetAddrInfo
XrdNetAddrInfo()
Constructor.
Definition: XrdNetAddrInfo.hh:334
XrdNetAddrInfo::Port
int Port()
XrdNetAddrInfo::~XrdNetAddrInfo
~XrdNetAddrInfo()
Destructor.
Definition: XrdNetAddrInfo.hh:346
XrdNetAddrInfo::Protocol
int Protocol()
Definition: XrdNetAddrInfo.hh:255
XrdNetAddrInfo::Format
int Format(char *bAddr, int bLen, fmtUse fmtType=fmtAuto, int fmtOpts=0)
XrdNetAddrInfo::LocInfo::Flags
char Flags
Flags.
Definition: XrdNetAddrInfo.hh:199
XrdNetAddrInfo::operator=
XrdNetAddrInfo & operator=(XrdNetAddrInfo const &rhs)
Assignment operator.
Definition: XrdNetAddrInfo.hh:301
XrdNetAddrInfo::SockFD
int SockFD()
Definition: XrdNetAddrInfo.hh:295
XrdNetAddrInfo::Family
int Family() const
Definition: XrdNetAddrInfo.hh:74
XrdNetAddrInfo::Dialect
const char * Dialect()
Definition: XrdNetAddrInfo.hh:65
XrdNetAddrInfo::isPrivate
bool isPrivate()
XrdNetAddrInfo::IP
XrdNetSockAddr IP
Definition: XrdNetAddrInfo.hh:357
XrdNetAddrInfo::prefipv4
static const int prefipv4
Use if mapped IPV4 actual format.
Definition: XrdNetAddrInfo.hh:107
XrdNetAddrInfo::sockNum
int sockNum
Definition: XrdNetAddrInfo.hh:366
XrdNetAddrInfo::noPort
static const int noPort
Do not add port number.
Definition: XrdNetAddrInfo.hh:104
XrdNetAddrInfo::LocInfo::Longtitude
int Longtitude
Degrees +/- xx.xxxxxx (not supported)
Definition: XrdNetAddrInfo.hh:202
XrdSysPlatform.hh
XrdNetAddrInfo::protFlgs
unsigned char protFlgs
Definition: XrdNetAddrInfo.hh:365
XrdNetSockAddr.hh
XrdNetAddrInfo::sockAddr
struct sockaddr * sockAddr
Definition: XrdNetAddrInfo.hh:358
XrdNetAddrInfo::XrdNetAddrInfo
XrdNetAddrInfo(XrdNetAddrInfo const &oP)
Copy constructor.
Definition: XrdNetAddrInfo.hh:324
XrdNetSockAddr
Definition: XrdNetSockAddr.hh:43
XrdNetAddrInfo::protName
const char * protName
Definition: XrdNetAddrInfo.hh:367
XrdNetAddrInfo::fmtUse
fmtUse
Definition: XrdNetAddrInfo.hh:99
XrdNetAddrInfo::addrLoc
LocInfo addrLoc
Definition: XrdNetAddrInfo.hh:362
XrdNetAddrInfo::isMapped
bool isMapped() const
Definition: XrdNetAddrInfo.hh:155
XrdNetAddrInfo::LocInfo::TimeZone
char TimeZone
+/- hours from GMT (-128 if not set)
Definition: XrdNetAddrInfo.hh:198
XrdNetAddrInfo::noPortRaw
static const int noPortRaw
Use raw address format (no port)
Definition: XrdNetAddrInfo.hh:105
XrdNetAddrInfo::QFill
int QFill(char *bAddr, int bLen)
XrdNetAddrInfo::old6Map4
static const int old6Map4
Use deprecated IPV6 mapped format.
Definition: XrdNetAddrInfo.hh:106
XrdNetAddrInfo::fmtAuto
@ fmtAuto
Hostname if already resolved o/w use fmtAddr.
Definition: XrdNetAddrInfo.hh:99
XrdNetAddrInfo::LowCase
char * LowCase(char *str)
XrdNetSockAddr::v6
struct sockaddr_in6 v6
Definition: XrdNetSockAddr.hh:43
XrdNetAddrInfo::unixPipe
struct sockaddr_un * unixPipe
Definition: XrdNetAddrInfo.hh:359
XrdNetAddrInfo::LocInfo::Country
unsigned char Country[2]
Two letter TLD country code.
Definition: XrdNetAddrInfo.hh:195
SOCKLEN_t
#define SOCKLEN_t
Definition: XrdSysPlatform.hh:255
XrdNetAddrInfo::protType
unsigned char protType
Definition: XrdNetAddrInfo.hh:364
XrdNetAddrInfo::isTLS
static const char isTLS
Location using TLS.
Definition: XrdNetAddrInfo.hh:371
XrdNetAddrInfo::Name
const char * Name(const char *eName=0, const char **eText=0)
XrdNetAddrInfo::fmtAdv6
@ fmtAdv6
Definition: XrdNetAddrInfo.hh:102
XrdNetAddrInfo::IPuX
@ IPuX
Definition: XrdNetAddrInfo.hh:144
XrdNetAddrInfo::LocInfo::Locale
unsigned char Locale
Locale (may combine adjacent regions)
Definition: XrdNetAddrInfo.hh:197
XrdNetAddrInfo::addrSize
unsigned short addrSize
Definition: XrdNetAddrInfo.hh:363
XrdNetAddrInfo::NetAddr
const XrdNetSockAddr * NetAddr()
Definition: XrdNetAddrInfo.hh:237