cellconfig-gethostbyname-20090618
[openafs.git] / 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 #define AFSCONF_CELL_FLAG_DNS_QUERIED   1
73
74 struct afsconf_cellalias {
75     char aliasName[MAXCELLCHARS];
76     char realName[MAXCELLCHARS];
77 };
78
79 struct afsconf_entry {
80     struct afsconf_entry *next; /* next guy in afsconf_dir */
81     struct afsconf_cell cellInfo;       /* info for this cell */
82 };
83
84 struct afsconf_aliasentry {
85     struct afsconf_aliasentry *next;
86     struct afsconf_cellalias aliasInfo;
87 };
88
89 struct afsconf_dir {
90     char *name;                 /* pointer to dir prefix */
91     char *cellName;             /* cell name, if any, we're in */
92     struct afsconf_entry *entries;      /* list of cell entries */
93     struct afsconf_keys *keystr;        /* structure containing keys */
94     afs_int32 timeRead;         /* time stamp of file last read */
95     struct afsconf_aliasentry *alias_entries;   /* cell aliases */
96 };
97
98 struct afsconf_servPair {
99     char *name;
100     int port;
101 };
102
103 extern struct afsconf_dir *afsconf_Open(register const char *adir);
104 extern int afsconf_CellApply(struct afsconf_dir *adir,
105                              int (*aproc) (struct afsconf_cell * cell,
106                                            void *arock,
107                                            struct afsconf_dir * dir),
108                              void *arock);
109 extern int afsconf_CellAliasApply(struct afsconf_dir *adir,
110                                   int (*aproc) (struct afsconf_cellalias *
111                                                 alias, void *arock,
112                                                 struct afsconf_dir * dir),
113                                   void *arock);
114 extern int afsconf_GetExtendedCellInfo(struct afsconf_dir *adir,
115                                        char *acellName, char *aservice,
116                                        struct afsconf_cell *acellInfo,
117                                        char clones[]);
118 extern int afsconf_GetAfsdbInfo(char *acellName, char *aservice,
119                                 struct afsconf_cell *acellInfo);
120 extern int afsconf_GetCellInfo(struct afsconf_dir *adir, char *acellName,
121                                char *aservice,
122                                struct afsconf_cell *acellInfo);
123 extern int afsconf_GetLocalCell(register struct afsconf_dir *adir,
124                                 char *aname, afs_int32 alen);
125 extern int afsconf_Close(struct afsconf_dir *adir);
126 extern int afsconf_IntGetKeys(struct afsconf_dir *adir);
127 extern int afsconf_GetKeys(struct afsconf_dir *adir,
128                            struct afsconf_keys *astr);
129 struct ktc_encryptionKey;
130 extern afs_int32 afsconf_GetLatestKey(struct afsconf_dir *adir,
131                                       afs_int32 * avno, 
132                                       struct ktc_encryptionKey *akey);
133 extern int afsconf_GetKey(void *rock, int avno,
134                           struct ktc_encryptionKey *akey);
135 extern int afsconf_AddKey(struct afsconf_dir *adir, afs_int32 akvno,
136                           char akey[8], afs_int32 overwrite);
137 extern int afsconf_DeleteKey(struct afsconf_dir *adir, afs_int32 akvno);
138
139 /* authcon.c */
140 struct rx_securityClass;
141 extern afs_int32 afsconf_ServerAuth(void *arock, 
142                                     struct rx_securityClass **,
143                                     afs_int32 *);
144 extern afs_int32 afsconf_ClientAuth(void *arock,
145                                     struct rx_securityClass **astr,
146                                     afs_int32 * aindex);
147 extern afs_int32 afsconf_ClientAuthSecure(void *arock,
148                                           struct rx_securityClass **astr,
149                                           afs_int32 * aindex);
150
151 /* writeconfig.c */
152 int afsconf_SetExtendedCellInfo(struct afsconf_dir *adir, const char *apath, 
153                                 struct afsconf_cell *acellInfo, char clones[]);
154 int afsconf_SetCellInfo(struct afsconf_dir *adir, const char *apath, 
155                         struct afsconf_cell *acellInfo);
156
157
158 /* userok.c */
159
160 struct rx_call;
161 extern int afsconf_CheckAuth(void *arock, struct rx_call *acall);
162 extern int afsconf_GetNoAuthFlag(struct afsconf_dir *adir);
163 extern void afsconf_SetNoAuthFlag(struct afsconf_dir *adir, int aflag);
164 extern int afsconf_DeleteUser(struct afsconf_dir *adir, register char *auser);
165 extern int afsconf_GetNthUser(struct afsconf_dir *adir, afs_int32 an, 
166                               char *abuffer, afs_int32 abufferLen);
167 extern int afsconf_AddUser(struct afsconf_dir *adir, char *aname);
168 extern int afsconf_SuperUser(struct afsconf_dir *adir, struct rx_call *acall,
169                              char *namep);
170
171 /* some well-known ports and their names; new additions to table in cellconfig.c, too */
172 #define AFSCONF_FILESERVICE             "afs"
173 #define AFSCONF_FILEPORT                7000
174 #define AFSCONF_CALLBACKSERVICE         "afscb"
175 #define AFSCONF_CALLBACKPORT            7001
176 #define AFSCONF_PROTSERVICE             "afsprot"
177 #define AFSCONF_PROTPORT                7002
178 #define AFSCONF_VLDBSERVICE             "afsvldb"
179 #define AFSCONF_VLDBPORT                7003
180 #define AFSCONF_KAUTHSERVICE            "afskauth"
181 #define AFSCONF_KAUTHPORT               7004
182 #define AFSCONF_VOLUMESERVICE           "afsvol"
183 #define AFSCONF_VOLUMEPORT              7005
184 #define AFSCONF_ERRORSERVICE            "afserror"
185 #define AFSCONF_ERRORPORT               7006
186 #define AFSCONF_NANNYSERVICE            "afsnanny"
187 #define AFSCONF_NANNYPORT               7007
188 #define AFSCONF_UPDATESERVICE           "afsupdate"
189 #define AFSCONF_UPDATEPORT              7008
190 #define AFSCONF_RMTSYSSERVICE           "afsrmtsys"
191 #define AFSCONF_RMTSYSPORT              7009
192 #define AFSCONF_RSDBSERVICE             "afsres"
193 #define AFSCONF_RESPORT                 7010
194 #define AFSCONF_REMIODBSERVICE          "afsremio"
195 #define AFSCONF_REMIOPORT               7011
196
197 #endif /* __CELLCONFIG_AFS_INCL_ */