src/auth/cellconfig.p.h

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 /*
  11 cellconfig.h:
  12
  13     Interface to the routines used by the FileServer to manipulate the cell/server database
  14     for the Cellular Andrew system, along with an operation to determine the name of the
  15     local cell.  Included are a string variable used to hold the local cell name, definitions for
  16     the database file format and routines for:
  17         1) Acquiring the local cell name.
  18         2) Reading in the cell/server database from disk.
  19         3) Reporting the set of servers associated with a given cell name.
  20         4) Printing out the contents of the cell/server database.
  21         5) Reclaiming the space used by an in-memory database.
  22
  23 Creation date:
  24     17 August 1987
  25
  26 --------------------------------------------------------------------------------------------------------------*/
  27
  28 #ifndef __CELLCONFIG_AFS_INCL_
  29 #define __CELLCONFIG_AFS_INCL_  1
  30
  31 #ifndef IPPROTO_MAX
  32         /* get sockaddr_in */
  33 #ifdef AFS_NT40_ENV
  34 #include <winsock2.h>
  35 #else
  36 #include <sys/types.h>
  37 #include <netinet/in.h>
  38 #endif
  39 #endif
  40
  41 #define MAXCELLCHARS    64
  42 #define MAXHOSTCHARS    64
  43 #define MAXHOSTSPERCELL  8
  44
  45 /*
  46  * Return codes.
  47  */
  48 #define AFSCONF_SUCCESS   0     /* worked */
  49 #if 0
  50 #define AFSCONF_FAILURE   1     /* mysterious failure */
  51 #define AFSCONF_NOTFOUND  2     /* could not find entry */
  52 #define AFSCONF_UNKNOWN   3     /* do not know that information */
  53 #define AFSCONF_NOCELL    4     /* line appears before a cell has been defined */
  54 #define AFSCONF_SYNTAX    5     /* syntax error */
  55 #define AFSCONF_NODB      6     /* a database file is missing */
  56 #define AFSCONF_FULL      7     /* no more entries */
  57 #endif
  58
  59 /*
  60  * Complete server info for one cell.
  61  */
  62 struct afsconf_cell {
  63     char name[MAXCELLCHARS];                    /*Cell name*/
  64     short numServers;                                   /*Num active servers for the cell*/
  65     short flags;                                /* useful flags */
  66     struct sockaddr_in hostAddr[MAXHOSTSPERCELL];       /*IP addresses for cell's servers*/
  67     char hostName[MAXHOSTSPERCELL][MAXHOSTCHARS];       /*Names for cell's servers*/
  68     char *linkedCell;                           /* Linked cell name, if any */
  69     int timeout;                                /* Data timeout, if non-zero */
  70 };
  71
  72 struct afsconf_entry {
  73     struct afsconf_entry *next; /* next guy in afsconf_dir */
  74     struct afsconf_cell cellInfo;       /* info for this cell */
  75 };
  76
  77 struct afsconf_dir {
  78     char *name;     /* pointer to dir prefix */
  79     char *cellName; /* cell name, if any, we're in */
  80     struct afsconf_entry *entries; /* list of cell entries */
  81     struct afsconf_keys *keystr;    /* structure containing keys */
  82     afs_int32 timeRead;             /* time stamp of file last read */
  83 };
  84
  85 extern struct afsconf_dir *afsconf_Open();
  86 extern afs_int32 afsconf_Authenticate();
  87
  88 struct afsconf_servPair {
  89     char *name;
  90     int port;
  91 };
  92
  93
  94 /* some well-known ports and their names; new additions to table in cellconfig.c, too */
  95 #define AFSCONF_FILESERVICE             "afs"
  96 #define AFSCONF_FILEPORT                7000
  97 #define AFSCONF_CALLBACKSERVICE         "afscb"
  98 #define AFSCONF_CALLBACKPORT            7001
  99 #define AFSCONF_PROTSERVICE             "afsprot"
 100 #define AFSCONF_PROTPORT                7002
 101 #define AFSCONF_VLDBSERVICE             "afsvldb"
 102 #define AFSCONF_VLDBPORT                7003
 103 #define AFSCONF_KAUTHSERVICE            "afskauth"
 104 #define AFSCONF_KAUTHPORT               7004
 105 #define AFSCONF_VOLUMESERVICE           "afsvol"
 106 #define AFSCONF_VOLUMEPORT              7005
 107 #define AFSCONF_ERRORSERVICE            "afserror"
 108 #define AFSCONF_ERRORPORT               7006
 109 #define AFSCONF_NANNYSERVICE            "afsnanny"
 110 #define AFSCONF_NANNYPORT               7007
 111 #define AFSCONF_UPDATESERVICE           "afsupdate"
 112 #define AFSCONF_UPDATEPORT              7008
 113 #define AFSCONF_RMTSYSSERVICE           "afsrmtsys"
 114 #define AFSCONF_RMTSYSPORT              7009
 115 #define AFSCONF_RSDBSERVICE             "afsres"
 116 #define AFSCONF_RESPORT                 7010
 117 #define AFSCONF_REMIODBSERVICE          "afsremio"
 118 #define AFSCONF_REMIOPORT               7011
 119
 120 #endif /* __CELLCONFIG_AFS_INCL_ */