Add the CellServDB pathname to the afsconf_dir
[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 #include <rx/rx_opaque.h>
41 #include <opr/queue.h>
42
43 #define MAXCELLCHARS    64
44 #define MAXHOSTCHARS    64
45 #define MAXHOSTSPERCELL  8
46
47 /*
48  * Return codes.
49  */
50 #define AFSCONF_SUCCESS   0     /* worked */
51
52 /*
53  * Complete server info for one cell.
54  */
55 struct afsconf_cell {
56     char name[MAXCELLCHARS];    /*Cell name */
57     short numServers;           /*Num active servers for the cell */
58     short flags;                /* useful flags */
59     struct sockaddr_in hostAddr[MAXHOSTSPERCELL];       /*IP addresses for cell's servers */
60     char hostName[MAXHOSTSPERCELL][MAXHOSTCHARS];       /*Names for cell's servers */
61     char *linkedCell;           /* Linked cell name, if any */
62     int timeout;                /* Data timeout, if non-zero */
63 };
64
65 #define AFSCONF_CELL_FLAG_DNS_QUERIED   1
66
67 struct afsconf_cellalias {
68     char aliasName[MAXCELLCHARS];
69     char realName[MAXCELLCHARS];
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_aliasentry {
78     struct afsconf_aliasentry *next;
79     struct afsconf_cellalias aliasInfo;
80 };
81
82 /*!
83  * A set of bit flags to control the selection of a security object
84  */
85 #define AFSCONF_SECOPTS_NOAUTH        0x1
86 #define AFSCONF_SECOPTS_LOCALAUTH     0x2
87 #define AFSCONF_SECOPTS_ALWAYSENCRYPT 0x4
88 #define AFSCONF_SECOPTS_FALLBACK_NULL 0x8
89 typedef afs_uint32 afsconf_secflags;
90
91 struct afsconf_dir {
92     char *name;                 /* pointer to dir prefix */
93     char *cellName;             /* cell name, if any, we're in */
94     char *cellservDB;           /* pathname of the CellServDB file */
95     struct afsconf_entry *entries;      /* list of cell entries */
96     struct opr_queue keyList;           /* list of keys */
97     afs_int32 timeRead;         /* time stamp of file last read */
98     afs_int32 timeCheck;        /* time of last check for update */
99     struct afsconf_aliasentry *alias_entries;   /* cell aliases */
100     afsconf_secflags securityFlags;
101     struct afsconf_realms *local_realms;        /* local realms */
102     struct afsconf_realms *exclusions;          /* excluded principals */
103 };
104
105 extern afs_int32 afsconf_FindService(const char *aname);
106 extern const char *afsconf_FindIANAName(const char *aname);
107 extern struct afsconf_dir *afsconf_Open(const char *adir);
108 extern int afsconf_CellApply(struct afsconf_dir *adir,
109                              int (*aproc) (struct afsconf_cell * cell,
110                                            void *arock,
111                                            struct afsconf_dir * dir),
112                              void *arock);
113 extern int afsconf_CellAliasApply(struct afsconf_dir *adir,
114                                   int (*aproc) (struct afsconf_cellalias *
115                                                 alias, void *arock,
116                                                 struct afsconf_dir * dir),
117                                   void *arock);
118 extern int afsconf_GetExtendedCellInfo(struct afsconf_dir *adir,
119                                        char *acellName, char *aservice,
120                                        struct afsconf_cell *acellInfo,
121                                        char clones[]);
122 extern int afsconf_GetAfsdbInfo(char *acellName, char *aservice,
123                                 struct afsconf_cell *acellInfo);
124 extern int afsconf_GetCellInfo(struct afsconf_dir *adir, char *acellName,
125                                char *aservice,
126                                struct afsconf_cell *acellInfo);
127 extern int afsconf_GetLocalCell(struct afsconf_dir *adir,
128                                 char *aname, afs_int32 alen);
129 extern int afsconf_Close(struct afsconf_dir *adir);
130 extern int afsconf_UpToDate(void *rock);
131
132 struct afsconf_keys;
133 extern int afsconf_GetKeys(struct afsconf_dir *adir,
134                            struct afsconf_keys *astr);
135
136 struct ktc_encryptionKey;
137 extern afs_int32 afsconf_GetLatestKey(struct afsconf_dir *adir,
138                                       afs_int32 * avno,
139                                       struct ktc_encryptionKey *akey);
140 extern int afsconf_GetKey(void *rock, int avno,
141                           struct ktc_encryptionKey *akey);
142 extern int afsconf_AddKey(struct afsconf_dir *adir, afs_int32 akvno,
143                           char akey[8], afs_int32 overwrite);
144 extern int afsconf_DeleteKey(struct afsconf_dir *adir, afs_int32 akvno);
145
146 struct afsconf_typedKey;
147 struct afsconf_typedKeyList {
148     int nkeys;
149     struct afsconf_typedKey **keys;
150 };
151
152 typedef enum {
153     afsconf_rxkad = 0,
154     afsconf_rxgk  =1,
155     afsconf_rxkad_krb5  =2
156 } afsconf_keyType;
157
158 extern struct afsconf_typedKey *
159         afsconf_typedKey_get(struct afsconf_typedKey *);
160 extern void afsconf_typedKey_put(struct afsconf_typedKey **);
161 extern struct afsconf_typedKey *
162         afsconf_typedKey_new(afsconf_keyType type, int kvno,
163                              int subType, struct rx_opaque *key);
164 extern void afsconf_typedKey_free(struct afsconf_typedKey **);
165
166 extern void afsconf_typedKey_values(struct afsconf_typedKey *key,
167                                   afsconf_keyType *type,
168                                   int *kvno,
169                                   int *minorType,
170                                   struct rx_opaque **keyMaterial);
171
172 extern int afsconf_GetAllKeys(struct afsconf_dir *,
173                               struct afsconf_typedKeyList **);
174 extern int afsconf_GetKeysByType(struct afsconf_dir *dir,
175                                  afsconf_keyType type, int kvno,
176                                  struct afsconf_typedKeyList **);
177 extern int afsconf_GetKeyByTypes(struct afsconf_dir *dir,
178                                  afsconf_keyType type, int kvno, int subType,
179                                  struct afsconf_typedKey **);
180 extern int afsconf_GetLatestKeysByType(struct afsconf_dir *dir,
181                                        afsconf_keyType type,
182                                        struct afsconf_typedKeyList **);
183 extern int afsconf_GetLatestKeyByTypes(struct afsconf_dir *dir,
184                                        afsconf_keyType type, int subType,
185                                        struct afsconf_typedKey **);
186 extern void afsconf_PutTypedKeyList(struct afsconf_typedKeyList **keys);
187 extern int afsconf_AddTypedKey(struct afsconf_dir *dir,
188                                struct afsconf_typedKey *key,
189                                int overwrite);
190 extern int afsconf_DeleteKeyByType(struct afsconf_dir *dir,
191                                    afsconf_keyType type, int kvno);
192 extern int afsconf_DeleteKeyBySubType(struct afsconf_dir *dir,
193                                       afsconf_keyType type, int kvno,
194                                       int subType);
195
196 /* authcon.c */
197 struct rx_securityClass;
198 extern afs_int32 afsconf_ServerAuth(void *arock,
199                                     struct rx_securityClass **,
200                                     afs_int32 *);
201 extern afs_int32 afsconf_ClientAuth(void *arock,
202                                     struct rx_securityClass **astr,
203                                     afs_int32 * aindex);
204 extern afs_int32 afsconf_ClientAuthSecure(void *arock,
205                                           struct rx_securityClass **astr,
206                                           afs_int32 * aindex);
207
208
209 extern afs_int32 afsconf_ClientAuthToken(struct afsconf_cell *info,
210                                          afsconf_secflags flags,
211                                          struct rx_securityClass **sc,
212                                          afs_int32 *scIndex,
213                                          time_t *expires);
214
215
216 extern afs_int32 afsconf_PickClientSecObj(struct afsconf_dir *dir,
217                                           afsconf_secflags flags,
218                                           struct afsconf_cell *info,
219                                           char *cellName,
220                                           struct rx_securityClass **sc,
221                                           afs_int32 *scIndex,
222                                           time_t *expires);
223
224 extern void afsconf_SetSecurityFlags(struct afsconf_dir *dir,
225                                      afsconf_secflags flags);
226
227 extern void afsconf_BuildServerSecurityObjects(void *,
228                                                struct rx_securityClass ***,
229                                                afs_int32 *);
230
231 /* writeconfig.c */
232 int afsconf_SetExtendedCellInfo(struct afsconf_dir *adir, const char *apath,
233                                 struct afsconf_cell *acellInfo, char clones[]);
234 int afsconf_SetCellInfo(struct afsconf_dir *adir, const char *apath,
235                         struct afsconf_cell *acellInfo);
236
237
238 /* userok.c */
239
240 struct rx_call;
241 struct rx_identity;
242 extern int afsconf_CheckAuth(void *arock, struct rx_call *acall);
243 extern int afsconf_GetNoAuthFlag(struct afsconf_dir *adir);
244 extern void afsconf_SetNoAuthFlag(struct afsconf_dir *adir, int aflag);
245 extern int afsconf_DeleteUser(struct afsconf_dir *adir, char *auser);
246 extern int afsconf_DeleteIdentity(struct afsconf_dir *, struct rx_identity *);
247 extern int afsconf_GetNthUser(struct afsconf_dir *adir, afs_int32 an,
248                               char *abuffer, afs_int32 abufferLen);
249 extern int afsconf_GetNthIdentity(struct afsconf_dir *, int,
250                                   struct rx_identity **);
251 extern int afsconf_AddUser(struct afsconf_dir *adir, char *aname);
252 extern int afsconf_AddIdentity(struct afsconf_dir *adir, struct rx_identity *);
253 extern int afsconf_SuperUser(struct afsconf_dir *adir, struct rx_call *acall,
254                              char *namep);
255 extern int afsconf_SuperIdentity(struct afsconf_dir *, struct rx_call *,
256                                  struct rx_identity **);
257 extern int afsconf_IsSuperIdentity(struct afsconf_dir *, struct rx_identity *);
258 extern int afsconf_CheckRestrictedQuery(struct afsconf_dir *adir,
259                                         struct rx_call *acall,
260                                         int needed_level);
261
262 /*
263  * Level constants for the -restricted_query option used by vlserver
264  * and volser.  Once we have vlserver and volserver to ptserver
265  * connection, we can add more access levels, like AUTHUSER or
266  * AUTHANDFOREIGNUSER.
267  */
268 #define RESTRICTED_QUERY_ANYUSER  0
269 #define RESTRICTED_QUERY_ADMIN    1
270
271 /* realms.c */
272 extern int afsconf_SetLocalRealm(const char *realm);
273 extern int afsconf_IsLocalRealmMatch(struct afsconf_dir *dir, afs_int32 * local,
274                                 const char *name, const char *instance,
275                                 const char *cell);
276
277 /* netrestrict.c */
278
279 extern int afsconf_ParseNetRestrictFile(afs_uint32 outAddrs[],
280                                         afs_uint32 * mask, afs_uint32 * mtu,
281                                         afs_uint32 maxAddrs, afs_uint32 * nAddrs,
282                                         char reason[], const char *fileName);
283
284 extern int afsconf_ParseNetFiles(afs_uint32 addrbuf[], afs_uint32 maskbuf[],
285                                  afs_uint32 mtubuf[], afs_uint32 max,
286                                  char reason[], const char *niFileName,
287                                  const char *nrFileName);
288
289 /* some well-known ports and their names; new additions to table in cellconfig.c, too */
290 #define AFSCONF_FILESERVICE             "afs"
291 #define AFSCONF_FILEPORT                7000
292 #define AFSCONF_CALLBACKSERVICE         "afscb"
293 #define AFSCONF_CALLBACKPORT            7001
294 #define AFSCONF_PROTSERVICE             "afsprot"
295 #define AFSCONF_PROTPORT                7002
296 #define AFSCONF_VLDBSERVICE             "afsvldb"
297 #define AFSCONF_VLDBPORT                7003
298 #define AFSCONF_KAUTHSERVICE            "afskauth"
299 #define AFSCONF_KAUTHPORT               7004
300 #define AFSCONF_VOLUMESERVICE           "afsvol"
301 #define AFSCONF_VOLUMEPORT              7005
302 #define AFSCONF_ERRORSERVICE            "afserror"
303 #define AFSCONF_ERRORPORT               7006
304 #define AFSCONF_NANNYSERVICE            "afsnanny"
305 #define AFSCONF_NANNYPORT               7007
306 #define AFSCONF_UPDATESERVICE           "afsupdate"
307 #define AFSCONF_UPDATEPORT              7008
308 #define AFSCONF_RMTSYSSERVICE           "afsrmtsys"
309 #define AFSCONF_RMTSYSPORT              7009
310 #define AFSCONF_RSDBSERVICE             "afsres"
311 #define AFSCONF_RESPORT                 7010
312 #define AFSCONF_REMIODBSERVICE          "afsremio"
313 #define AFSCONF_REMIOPORT               7011
314
315 #endif /* __CELLCONFIG_AFS_INCL_ */