XrdSysDNS.hh

Go to the documentation of this file.

#ifndef __XRDSYSDNS__
#define __XRDSYSDNS__
/******************************************************************************/
/*                                                                            */
/*                          X r d S y s D N S . h h                           */
/*                                                                            */
/* (c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/

/* This class is deprecated and essentially OBSOLETE and no longer mainatined.*/
/*                                                                            */
/* This class only supports IPV4 addresses and contexts. Please use classes   */
/* XrdNetAddr, XrdNetAddrInfo, and XrdNetUtils that provide IP address format */
/* agnostic replacement methods. SysDNS will be removed the next major release*/
#include <sys/types.h>
#ifndef WIN32
#include <sys/socket.h>
#else
#include <Winsock2.h>
#endif

class XrdSysDNS
{
public:

// Note: Most methods allow the reason for failure to be returned via an errtxt
//       argument. The string returned in errtxt is static and must neither be
//       modified not freed.

// getHostAddr() translates an host name or an ascii host ip address to the
//               binary address suitable for use in network system calls. The
//               host name or address must be registered in the DNS for the
//               translation to be successful. Upon success the either the
//               primary address (1st form) or a list of addresses (2nd form)
//               up to maxipa is returned. The return values are:
//                 0 -> Host name could not be translated, the error text
//                      is placed in errtxt, if an address is supplied.
//               > 0 -> The number of addresses returned.
//
static int getHostAddr(const  char     *InetName,
                       struct sockaddr &InetAddr,
                              char    **errtxt=0)
                      {return getHostAddr(InetName, &InetAddr, 1, errtxt);}

static int getHostAddr(const  char     *InetName,
                       struct sockaddr  InetAddr[],
                              int       maxipa=1,
                              char    **errtxt=0);

// getHostID()   returns the ASCII string corresponding to the IP address
//               InetAddr. If a translation is successful, the address
//               of an strdup'd null terminated name is returned (it must be
//               released using free()). Otherwise, an strdup of '0.0.0.0' is
//               returned (which must also be freed).
//
static char *getHostID(struct sockaddr &InetAddr);

// getAddrName() finds addresses and names associated with an host name or
//               an ascii host ip address. The host name or address must be
//               registered in the DNS for the translation to be successful.
//               Upon success a list of addresses and names up to maxipa is
//               returned in the arrays haddr and hname. The arrays must be
//               previously allocated by the caller for at least maxipa
//               'char *'. The returned char arrays are allocated inside and
//               must be freed by the caller. The return values are:
//                 0 -> Host name could not be translated, the error text
//                      is placed in errtxt, if an address is supplied.
//               > 0 -> The number of addresses returned.
//
static int getAddrName(const  char     *InetName,
                              int       maxipa,
                              char    **haddr,
                              char    **hname,
                              char    **errtxt=0);

// getHostName() returns the fully qualified name of a host. If no partial
//               host name is specified (or specifiied as 0), the fully
//               qualified name of this host is returned. The name is returned
//               as an strdup'd string which must be released using free().
//               If errtxt is supplied, it is set to zero.
//               Upon failure, strdup("0.0.0.0") is returned and the error
//               text is placed in errtxt if an address is supplied.
//
static char *getHostName(const char *InetName=0,
                               char **errtxt=0);

// getHostName() returns the primary name of the host associated with the IP
//               address InetAddr. If a translation is successful, the address
//               of an strdup'd null terminated name is returned (it must be
//               released using free()) and errtxt, of supplied, is set to 0.
//               Upon failure, the ascii text version of the address is
//               returned and the error text is placed in errtxt if an 
//               address is supplied.
//
static char *getHostName(struct sockaddr &InetAddr,
                                char    **errtxt=0);

// getHostName() returns the names of the host associated with the IP address
//               InetAddr. The first name is the primary name of the host.
//               Upon success, the address of each null terminated name is
//               placed in InetName[i]. Up to maxipn names are returned. The
//               array must be large enough to hold maxipn entries, Each
//               name is returned as an strdup'd string, which must be 
//               released using free().  Return values are:
//                0 -> No names could be returned; the error text is placed
//                     in errtxt if an address is supplied.
//               >0 -> Number of names returned.
//
static int getHostName(struct sockaddr &InetAddr, 
                              char     *InetName[],
                              int       maxipn,
                              char    **errtxt=0);

// getPort()  returns the port number of the service corresponding to the
//            supplied name and service type (i.e., "tcp" or "udp"). If the port
//            cannot be found, zero is returned and the error text is placed
//            in errtxt if an address is supplied.
//
static int getPort(const char  *servname,
                   const char  *servtype,
                         char **errtxt=0);

// getPort() variant returns the port number associated with the specified
//           file descriptor. If an error occurs, a negative errno is returned,
//           and errtxt is set if supplied.
//
static int getPort(int fd, char **errtxt=0);

// getProtoID() returns the protocol number associated with the protocol name
//              passed as a parameter. No failures can occur since TCP is
//              returned if the protocol cannot be found.
//
static int getProtoID(const char *pname);

// Host2Dest() returns a sockaddr structure suitable for socket operations
//             built from the "host:port" specified in InetName. It returns
//             1 upon success and 0 upon failure with the reason placed in
//             errtxt, if as address is supplied.
//
static int Host2Dest(const char      *InetName,
                     struct sockaddr &DestAddr,
                           char     **errtxt=0);

// Host2IP() converts a host name passed in InetName to an IPV4 address,
//           returned in ipaddr (unless it is zero, in which only a conversion
//           check is performed). 1 is returned upon success, 0 upon failure.
//
static int Host2IP(const char   *InetName,
                   unsigned int *ipaddr=0);

// IPFormat()  converts an IP address/port (V4 or V6) into the standard V6 RFC
//             ASCII representation: "[address]:port".

// Input:      sAddr - Address to convert. This is either sockaddr_in or
//                     sockaddr_in6 cast to struct sockaddr.
//             bP    - points to a buffer large enough to hold the result.
//                     A buffer 64 characters long will always be big enough.
//             bL    - the actual size of the buffer.
//             fP    - When true  (the default) will format sAddr->sin_port
//                     (or sin6_port) as ":port" at the end of the address.
//                     When false the colon and port number is omitted.
//
// Output:     Upon success the length of the formatted address is returned.
//             Upon failure zero is returned and the buffer state is undefined.
//             Failure occurs when the buffer is too small or the address family
//             (sAddr->sa_family) is neither AF_INET nor AF_INET6.
//
static int IPFormat(const struct sockaddr *sAddr, char *bP, int bL, int fP=1);

// IP2String() converts an IPV4 version of the address to ascii dot notation
//             If port > 0 then the results is <ipaddr>:<port>. The return
//             value is the number of characters placed in the buffer.
//
static int IP2String(unsigned int ipaddr, int port, char *buff, int blen);

// IPAddr() returns the IPV4 version of the address in the address argument
//
static unsigned int IPAddr(struct sockaddr *InetAddr);

// isDomain() returns true if the domain portion of the hostname matches
//            the specified domain name.
//
static int isDomain(const char *Hostname, const char *Domname, int Domlen);

// isLoopback() returns true if the address in InetAddr is the loopback address.
//              This test is used to discover IP address spoofing in UDP packets.
//
static int isLoopback(struct sockaddr &InetAddr);

// isMatch() returns true if the HostName matches the host pattern HostPat.
//           Patterns are formed as {[<pfx>][*][<sfx>] | <name>+}
//
static int isMatch(const char *HostNme, char *HostPat);

// Peername() returns the strdupp'd string name (and optionally the address) of 
//            the host associated with the socket passed as the first parameter. 
//            The string must be released using free(). If the host cannot be
//            determined, 0 is returned and the error text is placed in errtxt
//            if an address is supplied.
//
static char *Peername(       int       snum,
                      struct sockaddr *sap=0,
                             char    **errtxt=0);

// setPort() sets the port number InetAddr. If anyaddr is true,, InetAddr is
//           initialized to the network defined "any" IP address.
//
static void setPort(struct sockaddr &InetAddr, int port, int anyaddr=0);

              XrdSysDNS() {}
             ~XrdSysDNS() {}
 
private:
 
static char *LowCase(char *str);
static int   setET(char **errtxt, int rc);
static int   setETni(char **errtxt, int rc);
};
#endif