ubik-serverinit-clones-correction-20081222
[openafs.git] / src / ptserver / ptserver.c
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  *                      A general description of the supergroup changes
12  *                      to ptserver:
13  *
14  *                      In AFS users can be members of groups. When you add
15  *                      a user, u1, to a group, g1, you add the user id for u1
16  *                      to an entries list in g1. This is a list of all the
17  *                      members of g1.
18  *                      You also add the id for g1 to an entries list in u1.
19  *                      This is a list of all the groups this user is a
20  *                      member of.
21  *                      The list has room for 10 entries. If more are required,
22  *                      a continuation record is created.
23  *
24  *                      With UMICH mods, u1 can be a group. When u1 is a group
25  *                      a new field is required to list the groups this group
26  *                      is a member of (since the entries field is used to
27  *                      list it's members). This new field is supergroups and
28  *                      has two entries. If more are required, a continuation
29  *                      record is formed. 
30  *                      There are two additional fields required, nextsg is
31  *                      an address of the next continuation record for this
32  *                      group, and countsg is the count for the number of 
33  *                      groups this group is a member of.
34  *                   
35  *
36  *
37  *      09/18/95 jjm    Add mdw's changes to afs-3.3a Changes:
38  *                      (1) Add the parameter -groupdepth or -depth to
39  *                          define the maximum search depth for supergroups.
40  *                          Define the variable depthsg to be the value of
41  *                          the parameter. The default value is set to 5.
42  *
43  *                      (3) Make sure the sizes of the struct prentry and
44  *                          struct prentryg are equal. If they aren't equal
45  *                          the pt database will be corrupted.
46  *                          The error is reported with an fprintf statement,
47  *                          but this doesn't print when ptserver is started by
48  *                          bos, so all you see is an error message in the
49  *                          /usr/afs/logs/BosLog file. If you start the
50  *                          ptserver without bos the fprintf will print
51  *                          on stdout.
52  *                          The program will terminate with a PT_EXIT(1).
53  *
54  *
55  *                      Transarc does not currently use opcodes past 520, but
56  *                      they *could* decide at any time to use more opcodes.
57  *                      If they did, then one part of our local mods,
58  *                      ListSupergroups, would break.  I've therefore
59  *                      renumbered it to 530, and put logic in to enable the
60  *                      old opcode to work (for now).
61  *
62  *      2/1/98 jjm      Add mdw's changes for bit mapping for supergroups
63  *                      Overview:
64  *                      Before fetching a supergroup, this version of ptserver
65  *                      checks to see if it was marked "found" and "not a
66  *                      member".  If and only if so, it doesn't fetch the group.
67  *                      Since this should be the case with most groups, this
68  *                      should save a significant amount of CPU in redundant
69  *                      fetches of the same group.  After fetching the group,
70  *                      it sets "found", and either sets or clears "not a
71  *                      member", depending on if the group was a member of
72  *                      other groups.  When it writes group entries to the
73  *                      database, it clears the "found" flag.
74  */
75
76 #if defined(SUPERGROUPS)
77 /*
78  *  A general description of the supergroup changes
79  *  to ptserver:
80  *
81  *  In AFS users can be members of groups. When you add a user, u1,
82  *  to a group, g1, you add the user id for u1 to an entries list
83  *  in g1. This is a list of all the members of g1.  You also add
84  *  the id for g1 to an entries list in u1.  This is a list of all
85  *  the groups this user is a member of.  The list has room for 10
86  *  entries. If more are required, a continuation record is created.
87  *
88  *  With UMICH mods, u1 can be a group. When u1 is a group a new
89  *  field is required to list the groups this group is a member of
90  *  (since the entries field is used to list it's members). This
91  *  new field is supergroups and has two entries. If more are
92  *  required, a continuation record is formed.
93  *
94  *  There are two additional fields required, nextsg is an address
95  *  of the next continuation record for this group, and countsg is
96  *  the count for the number of groups this group is a member of.
97  *
98  *  Bit mapping support for supergroups:
99  *
100  *  Before fetching a supergroup, this version of ptserver checks to
101  *  see if it was marked "found" and "not a member".  If and only if
102  *  so, it doesn't fetch the group.  Since this should be the case
103  *  with most groups, this should save a significant amount of CPU in
104  *  redundant fetches of the same group.  After fetching the group, it
105  *  sets "found", and either sets or clears "not a member", depending
106  *  on if the group was a member of other groups.  When it writes
107  *  group entries to the database, it clears the "found" flag.
108  */
109 #endif
110
111 #include <afsconfig.h>
112 #include <afs/param.h>
113
114 RCSID
115     ("$Header$");
116
117 #include <afs/stds.h>
118 #ifdef  AFS_AIX32_ENV
119 #include <signal.h>
120 #endif
121 #include <sys/types.h>
122 #include <stdio.h>
123 #include <fcntl.h>
124 #include <sys/stat.h>
125 #ifdef AFS_NT40_ENV
126 #include <winsock2.h>
127 #include <WINNT/afsevent.h>
128 #else
129 #include <netdb.h>
130 #include <netinet/in.h>
131 #endif
132 #include <string.h>
133 #include <rx/xdr.h>
134 #include <rx/rx.h>
135 #include <rx/rx_globals.h>
136 #include <lock.h>
137 #include <ubik.h>
138 #include <afs/cellconfig.h>
139 #include <afs/auth.h>
140 #include <afs/keys.h>
141 #include "ptserver.h"
142 #include "error_macros.h"
143 #include "afs/audit.h"
144 #include <afs/afsutil.h>
145 #include <afs/com_err.h>
146
147
148 /* make all of these into a structure if you want */
149 struct prheader cheader;
150 struct ubik_dbase *dbase;
151 struct afsconf_dir *prdir;
152
153 #if defined(SUPERGROUPS)
154 extern afs_int32 depthsg;
155 #endif
156
157 extern int afsconf_ServerAuth();
158 extern int afsconf_CheckAuth();
159
160 int pr_realmNameLen;
161 char *pr_realmName;
162
163 int debuglevel = 0;
164 int restricted = 0;
165 int rxMaxMTU = -1;
166 int rxBind = 0;
167 int rxkadDisableDotCheck = 0;
168
169 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
170 afs_uint32 SHostAddrs[ADDRSPERSITE];
171
172 static struct afsconf_cell info;
173
174 extern int prp_group_default;
175 extern int prp_user_default;
176
177 #include "AFS_component_version_number.c"
178
179 int
180 prp_access_mask(s)
181     char *s;
182 {
183     int r;
184     if (*s >= '0' && *s <= '9') {
185         return strtol(s, NULL, 0);
186     }
187     r = 0;
188     while (*s) switch(*s++)
189     {
190     case 'S':   r |= PRP_STATUS_ANY; break;
191     case 's':   r |= PRP_STATUS_MEM; break;
192     case 'O':   r |= PRP_OWNED_ANY; break;
193     case 'M':   r |= PRP_MEMBER_ANY; break;
194     case 'm':   r |= PRP_MEMBER_MEM; break;
195     case 'A':   r |= PRP_ADD_ANY; break;
196     case 'a':   r |= PRP_ADD_MEM; break;
197     case 'r':   r |= PRP_REMOVE_MEM; break;
198     }
199     return r;
200 }
201
202 /* check whether caller is authorized to manage RX statistics */
203 int
204 pr_rxstat_userok(struct rx_call *call)
205 {
206     return afsconf_SuperUser(prdir, call, NULL);
207 }
208
209 int
210 main(int argc, char **argv)
211 {
212     register afs_int32 code;
213     afs_int32 myHost;
214     register struct hostent *th;
215     char hostname[64];
216     struct rx_service *tservice;
217     struct rx_securityClass *sc[3];
218     extern int RXSTATS_ExecuteRequest();
219     extern int PR_ExecuteRequest();
220 #if 0
221     struct ktc_encryptionKey tkey;
222 #endif
223     int kerberosKeys;           /* set if found some keys */
224     int lwps = 3;
225     char clones[MAXHOSTSPERCELL];
226     afs_uint32 host = htonl(INADDR_ANY);
227
228     const char *pr_dbaseName;
229     char *whoami = "ptserver";
230
231     int a;
232     char arg[100];
233
234 #ifdef  AFS_AIX32_ENV
235     /*
236      * The following signal action for AIX is necessary so that in case of a 
237      * crash (i.e. core is generated) we can include the user's data section 
238      * in the core dump. Unfortunately, by default, only a partial core is
239      * generated which, in many cases, isn't too useful.
240      */
241     struct sigaction nsa;
242
243     sigemptyset(&nsa.sa_mask);
244     nsa.sa_handler = SIG_DFL;
245     nsa.sa_flags = SA_FULLDUMP;
246     sigaction(SIGABRT, &nsa, NULL);
247     sigaction(SIGSEGV, &nsa, NULL);
248 #endif
249     osi_audit_init();
250     osi_audit(PTS_StartEvent, 0, AUD_END);
251
252     /* Initialize dirpaths */
253     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
254 #ifdef AFS_NT40_ENV
255         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
256 #endif
257         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
258                 argv[0]);
259         exit(2);
260     }
261
262     pr_dbaseName = AFSDIR_SERVER_PRDB_FILEPATH;
263
264 #if defined(SUPERGROUPS)
265     /* make sure the structures for database records are the same size */
266     if ((sizeof(struct prentry) != ENTRYSIZE)
267         || (sizeof(struct prentryg) != ENTRYSIZE)) {
268         fprintf(stderr,
269                 "The structures for the database records are different"
270                 " sizes\n" "struct prentry = %d\n" "struct prentryg = %d\n"
271                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
272                 sizeof(struct prentryg), ENTRYSIZE);
273         PT_EXIT(1);
274     }
275 #endif
276
277     for (a = 1; a < argc; a++) {
278         int alen;
279         lcstring(arg, argv[a], sizeof(arg));
280         alen = strlen(arg);
281         if ((strncmp(arg, "-database", alen) == 0)
282             || (strncmp(arg, "-db", alen) == 0)) {
283             pr_dbaseName = argv[++a];   /* specify a database */
284         } else if (strcmp(argv[a], "-d") == 0) {
285             if ((a + 1) >= argc) {
286                 fprintf(stderr, "missing argument for -d\n"); 
287                 return -1; 
288             }
289             debuglevel = atoi(argv[++a]);
290             LogLevel = debuglevel;
291         } else if (strncmp(arg, "-p", alen) == 0) {
292             lwps = atoi(argv[++a]);
293             if (lwps > 16) {    /* maximum of 16 */
294                 printf("Warning: '-p %d' is too big; using %d instead\n",
295                        lwps, 16);
296                 lwps = 16;
297             } else if (lwps < 3) {      /* minimum of 3 */
298                 printf("Warning: '-p %d' is too small; using %d instead\n",
299                        lwps, 3);
300                 lwps = 3;
301             }
302         } else if (strncmp(arg, "-rebuild", alen) == 0) /* rebuildDB++ */
303             ;
304 #if defined(SUPERGROUPS)
305         else if ((strncmp(arg, "-groupdepth", alen) == 0)
306                  || (strncmp(arg, "-depth", alen) == 0)) {
307             depthsg = atoi(argv[++a]);  /* Max search depth for supergroups */
308         }
309 #endif
310         else if (strncmp(arg, "-default_access", alen) == 0) {
311             prp_user_default = prp_access_mask(argv[++a]);
312             prp_group_default = prp_access_mask(argv[++a]);
313         }
314         else if (strncmp(arg, "-restricted", alen) == 0) {
315             restricted = 1;
316         }
317         else if (strncmp(arg, "-rxbind", alen) == 0) {
318             rxBind = 1;
319         }
320         else if (strncmp(arg, "-allow-dotted-principals", alen) == 0) {
321             rxkadDisableDotCheck = 1;
322         }
323         else if (strncmp(arg, "-enable_peer_stats", alen) == 0) {
324             rx_enablePeerRPCStats();
325         } else if (strncmp(arg, "-enable_process_stats", alen) == 0) {
326             rx_enableProcessRPCStats();
327         }
328 #ifndef AFS_NT40_ENV
329         else if (strncmp(arg, "-syslog", alen) == 0) {
330             /* set syslog logging flag */
331             serverLogSyslog = 1;
332         } else if (strncmp(arg, "-syslog=", MIN(8, alen)) == 0) {
333             serverLogSyslog = 1;
334             serverLogSyslogFacility = atoi(arg + 8);
335         }
336 #endif
337         else if (strncmp(arg, "-auditlog", alen) == 0) {
338             char *fileName = argv[++a];
339
340             osi_audit_file(fileName);
341             osi_audit(PTS_StartEvent, 0, AUD_END);
342         }
343         else if (!strncmp(arg, "-rxmaxmtu", alen)) {
344             if ((a + 1) >= argc) {
345                 fprintf(stderr, "missing argument for -rxmaxmtu\n");
346                 PT_EXIT(1);
347             }
348             rxMaxMTU = atoi(argv[++a]);
349             if ((rxMaxMTU < RX_MIN_PACKET_SIZE) ||
350                  (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
351                 printf("rxMaxMTU %d invalid; must be between %d-%d\n",
352                         rxMaxMTU, RX_MIN_PACKET_SIZE,
353                         RX_MAX_PACKET_DATA_SIZE);
354                 PT_EXIT(1);
355             }
356         } 
357         else if (*arg == '-') {
358             /* hack in help flag support */
359
360 #if defined(SUPERGROUPS)
361 #ifndef AFS_NT40_ENV
362             printf("Usage: ptserver [-database <db path>] "
363                    "[-auditlog <log path>] "
364                    "[-syslog[=FACILITY]] [-d <debug level>] "
365                    "[-p <number of processes>] [-rebuild] "
366                    "[-groupdepth <depth>] "
367                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
368                    "[-allow-dotted-principals] "
369                    "[-enable_peer_stats] [-enable_process_stats] "
370                    "[-default_access default_user_access default_group_access] "
371                    "[-help]\n");
372 #else /* AFS_NT40_ENV */
373             printf("Usage: ptserver [-database <db path>] "
374                    "[-auditlog <log path>] [-d <debug level>] "
375                    "[-p <number of processes>] [-rebuild] [-rxbind] "
376                    "[-allow-dotted-principals] "
377                    "[-default_access default_user_access default_group_access] "
378                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
379                    "[-groupdepth <depth>] " "[-help]\n");
380 #endif
381 #else
382 #ifndef AFS_NT40_ENV
383             printf("Usage: ptserver [-database <db path>] "
384                    "[-auditlog <log path>] [-d <debug level>] "
385                    "[-syslog[=FACILITY]] "
386                    "[-p <number of processes>] [-rebuild] "
387                    "[-enable_peer_stats] [-enable_process_stats] "
388                    "[-default_access default_user_access default_group_access] "
389                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
390                    "[-allow-dotted-principals] "
391                    "[-help]\n");
392 #else /* AFS_NT40_ENV */
393             printf("Usage: ptserver [-database <db path>] "
394                    "[-auditlog <log path>] [-d <debug level>] "
395                    "[-default_access default_user_access default_group_access] "
396                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
397                    "[-allow-dotted-principals] "
398                    "[-p <number of processes>] [-rebuild] " "[-help]\n");
399 #endif
400 #endif
401             fflush(stdout);
402
403             PT_EXIT(1);
404         }
405 #if defined(SUPERGROUPS)
406         else {
407             fprintf(stderr, "Unrecognized arg: '%s' ignored!\n", arg);
408         }
409 #endif
410     }
411
412 #ifndef AFS_NT40_ENV
413     serverLogSyslogTag = "ptserver";
414 #endif
415     OpenLog(AFSDIR_SERVER_PTLOG_FILEPATH);      /* set up logging */
416     SetupLogSignals();
417
418     prdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
419     if (!prdir) {
420         fprintf(stderr, "ptserver: can't open configuration directory.\n");
421         PT_EXIT(1);
422     }
423     if (afsconf_GetNoAuthFlag(prdir))
424         printf("ptserver: running unauthenticated\n");
425
426 #ifdef AFS_NT40_ENV
427     /* initialize winsock */
428     if (afs_winsockInit() < 0) {
429         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
430
431         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
432         PT_EXIT(1);
433     }
434 #endif
435     /* get this host */
436     gethostname(hostname, sizeof(hostname));
437     th = gethostbyname(hostname);
438     if (!th) {
439         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
440         PT_EXIT(1);
441     }
442     memcpy(&myHost, th->h_addr, sizeof(afs_int32));
443
444     /* get list of servers */
445     code =
446         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, &clones);
447     if (code) {
448         afs_com_err(whoami, code, "Couldn't get server list");
449         PT_EXIT(2);
450     }
451     pr_realmName = info.name;
452     pr_realmNameLen = strlen(pr_realmName);
453
454 #if 0
455     /* get keys */
456     code = afsconf_GetKey(prdir, 999, &tkey);
457     if (code) {
458         afs_com_err(whoami, code,
459                 "couldn't get bcrypt keys from key file, ignoring.");
460     }
461 #endif
462     {
463         afs_int32 kvno;         /* see if there is a KeyFile here */
464         struct ktc_encryptionKey key;
465         code = afsconf_GetLatestKey(prdir, &kvno, &key);
466         kerberosKeys = (code == 0);
467         if (!kerberosKeys)
468             printf
469                 ("ptserver: can't find any Kerberos keys, code = %d, ignoring\n",
470                  code);
471     }
472     if (kerberosKeys) {
473         /* initialize ubik */
474         ubik_CRXSecurityProc = afsconf_ClientAuth;
475         ubik_CRXSecurityRock = (char *)prdir;
476         ubik_SRXSecurityProc = afsconf_ServerAuth;
477         ubik_SRXSecurityRock = (char *)prdir;
478         ubik_CheckRXSecurityProc = afsconf_CheckAuth;
479         ubik_CheckRXSecurityRock = (char *)prdir;
480     }
481     /* The max needed is when deleting an entry.  A full CoEntry deletion
482      * required removal from 39 entries.  Each of which may refers to the entry
483      * being deleted in one of its CoEntries.  If a CoEntry is freed its
484      * predecessor CoEntry will be modified as well.  Any freed blocks also
485      * modifies the database header.  Counting the entry being deleted and its
486      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
487      * and the header are in separate Ubik buffers then 120 buffers may be
488      * required. */
489     ubik_nBuffers = 120 + /*fudge */ 40;
490
491     if (rxBind) {
492         afs_int32 ccode;
493         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH || 
494             AFSDIR_SERVER_NETINFO_FILEPATH) {
495             char reason[1024];
496             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
497                                            ADDRSPERSITE, reason,
498                                            AFSDIR_SERVER_NETINFO_FILEPATH,
499                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
500         } else 
501         {
502             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
503         }
504         if (ccode == 1) {
505             host = SHostAddrs[0];
506             /* the following call is idempotent so if/when it gets called
507              * again by the ubik init stuff, it doesn't really matter
508              * -- klm
509              */
510             rx_InitHost(host, htons(AFSCONF_PROTPORT));
511         }
512     }
513
514     code =
515         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
516                               pr_dbaseName, &dbase);
517     if (code) {
518         afs_com_err(whoami, code, "Ubik init failed");
519         PT_EXIT(2);
520     }
521 #if defined(SUPERGROUPS)
522     pt_hook_write();
523 #endif
524
525     sc[0] = rxnull_NewServerSecurityObject();
526     sc[1] = 0;
527     if (kerberosKeys) {
528         sc[2] = rxkad_NewServerSecurityObject(0, prdir, afsconf_GetKey, NULL);
529     } else
530         sc[2] = sc[0];
531
532     /* Disable jumbograms */
533     rx_SetNoJumbo();
534
535     if (rxMaxMTU != -1) {
536         rx_SetMaxMTU(rxMaxMTU);
537     }
538
539     tservice =
540         rx_NewServiceHost(host, 0, PRSRV, "Protection Server", sc, 3,
541                       PR_ExecuteRequest);
542     if (tservice == (struct rx_service *)0) {
543         fprintf(stderr, "ptserver: Could not create new rx service.\n");
544         PT_EXIT(3);
545     }
546     rx_SetMinProcs(tservice, 2);
547     rx_SetMaxProcs(tservice, lwps);
548     if (rxkadDisableDotCheck) {
549         rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
550                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
551     }
552
553     tservice =
554         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats", sc, 3,
555                       RXSTATS_ExecuteRequest);
556     if (tservice == (struct rx_service *)0) {
557         fprintf(stderr, "ptserver: Could not create new rx service.\n");
558         PT_EXIT(3);
559     }
560     rx_SetMinProcs(tservice, 2);
561     rx_SetMaxProcs(tservice, 4);
562
563     /* allow super users to manage RX statistics */
564     rx_SetRxStatUserOk(pr_rxstat_userok);
565
566     rx_StartServer(1);
567     osi_audit(PTS_FinishEvent, -1, AUD_END);
568     exit(0);
569 }