8878fc0603e43a7c591145cba064f0fb0388c5e7
[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 #ifdef HAVE_STRING_H
133 #include <string.h>
134 #else
135 #ifdef HAVE_STRINGS_H
136 #include <strings.h>
137 #endif
138 #endif
139 #include <rx/xdr.h>
140 #include <rx/rx.h>
141 #include <rx/rx_globals.h>
142 #include <lock.h>
143 #include <ubik.h>
144 #include <afs/cellconfig.h>
145 #include <afs/auth.h>
146 #include <afs/keys.h>
147 #include "ptserver.h"
148 #include "error_macros.h"
149 #include "afs/audit.h"
150 #include <afs/afsutil.h>
151 #include <afs/com_err.h>
152
153
154 /* make all of these into a structure if you want */
155 struct prheader cheader;
156 struct ubik_dbase *dbase;
157 struct afsconf_dir *prdir;
158
159 #if defined(SUPERGROUPS)
160 extern afs_int32 depthsg;
161 #endif
162
163 extern int afsconf_ServerAuth();
164 extern int afsconf_CheckAuth();
165
166 int pr_realmNameLen;
167 char *pr_realmName;
168
169 int restricted = 0;
170 int rxMaxMTU = -1;
171 int rxBind = 0;
172
173 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
174 afs_uint32 SHostAddrs[ADDRSPERSITE];
175
176 static struct afsconf_cell info;
177
178 extern int prp_group_default;
179 extern int prp_user_default;
180
181 #include "AFS_component_version_number.c"
182
183 int
184 prp_access_mask(s)
185     char *s;
186 {
187     int r;
188     if (*s >= '0' && *s <= '9') {
189         return strtol(s, NULL, 0);
190     }
191     r = 0;
192     while (*s) switch(*s++)
193     {
194     case 'S':   r |= PRP_STATUS_ANY; break;
195     case 's':   r |= PRP_STATUS_MEM; break;
196     case 'O':   r |= PRP_OWNED_ANY; break;
197     case 'M':   r |= PRP_MEMBER_ANY; break;
198     case 'm':   r |= PRP_MEMBER_MEM; break;
199     case 'A':   r |= PRP_ADD_ANY; break;
200     case 'a':   r |= PRP_ADD_MEM; break;
201     case 'r':   r |= PRP_REMOVE_MEM; break;
202     }
203     return r;
204 }
205
206 /* check whether caller is authorized to manage RX statistics */
207 int
208 pr_rxstat_userok(struct rx_call *call)
209 {
210     return afsconf_SuperUser(prdir, call, NULL);
211 }
212
213 int
214 main(int argc, char **argv)
215 {
216     register afs_int32 code;
217     afs_int32 myHost;
218     register struct hostent *th;
219     char hostname[64];
220     struct rx_service *tservice;
221     struct rx_securityClass *sc[3];
222     extern int RXSTATS_ExecuteRequest();
223     extern int PR_ExecuteRequest();
224 #if 0
225     struct ktc_encryptionKey tkey;
226 #endif
227     int kerberosKeys;           /* set if found some keys */
228     int lwps = 3;
229     char clones[MAXHOSTSPERCELL];
230     afs_uint32 host = htonl(INADDR_ANY);
231
232     const char *pr_dbaseName;
233     char *whoami = "ptserver";
234
235     int a;
236     char arg[100];
237
238 #ifdef  AFS_AIX32_ENV
239     /*
240      * The following signal action for AIX is necessary so that in case of a 
241      * crash (i.e. core is generated) we can include the user's data section 
242      * in the core dump. Unfortunately, by default, only a partial core is
243      * generated which, in many cases, isn't too useful.
244      */
245     struct sigaction nsa;
246
247     sigemptyset(&nsa.sa_mask);
248     nsa.sa_handler = SIG_DFL;
249     nsa.sa_flags = SA_FULLDUMP;
250     sigaction(SIGABRT, &nsa, NULL);
251     sigaction(SIGSEGV, &nsa, NULL);
252 #endif
253     osi_audit_init();
254     osi_audit(PTS_StartEvent, 0, AUD_END);
255
256     /* Initialize dirpaths */
257     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
258 #ifdef AFS_NT40_ENV
259         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
260 #endif
261         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
262                 argv[0]);
263         exit(2);
264     }
265
266     pr_dbaseName = AFSDIR_SERVER_PRDB_FILEPATH;
267
268 #if defined(SUPERGROUPS)
269     /* make sure the structures for database records are the same size */
270     if ((sizeof(struct prentry) != ENTRYSIZE)
271         || (sizeof(struct prentryg) != ENTRYSIZE)) {
272         fprintf(stderr,
273                 "The structures for the database records are different"
274                 " sizes\n" "struct prentry = %d\n" "struct prentryg = %d\n"
275                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
276                 sizeof(struct prentryg), ENTRYSIZE);
277         PT_EXIT(1);
278     }
279 #endif
280
281     for (a = 1; a < argc; a++) {
282         int alen;
283         lcstring(arg, argv[a], sizeof(arg));
284         alen = strlen(arg);
285         if ((strncmp(arg, "-database", alen) == 0)
286             || (strncmp(arg, "-db", alen) == 0)) {
287             pr_dbaseName = argv[++a];   /* specify a database */
288         } else if (strncmp(arg, "-p", alen) == 0) {
289             lwps = atoi(argv[++a]);
290             if (lwps > 16) {    /* maximum of 16 */
291                 printf("Warning: '-p %d' is too big; using %d instead\n",
292                        lwps, 16);
293                 lwps = 16;
294             } else if (lwps < 3) {      /* minimum of 3 */
295                 printf("Warning: '-p %d' is too small; using %d instead\n",
296                        lwps, 3);
297                 lwps = 3;
298             }
299         } else if (strncmp(arg, "-rebuild", alen) == 0) /* rebuildDB++ */
300             ;
301 #if defined(SUPERGROUPS)
302         else if ((strncmp(arg, "-groupdepth", alen) == 0)
303                  || (strncmp(arg, "-depth", alen) == 0)) {
304             depthsg = atoi(argv[++a]);  /* Max search depth for supergroups */
305         }
306 #endif
307         else if (strncmp(arg, "-default_access", alen) == 0) {
308             prp_user_default = prp_access_mask(argv[++a]);
309             prp_group_default = prp_access_mask(argv[++a]);
310         }
311         else if (strncmp(arg, "-restricted", alen) == 0) {
312             restricted = 1;
313         }
314         else if (strncmp(arg, "-rxbind", alen) == 0) {
315             rxBind = 1;
316         }
317         else if (strncmp(arg, "-enable_peer_stats", alen) == 0) {
318             rx_enablePeerRPCStats();
319         } else if (strncmp(arg, "-enable_process_stats", alen) == 0) {
320             rx_enableProcessRPCStats();
321         }
322 #ifndef AFS_NT40_ENV
323         else if (strncmp(arg, "-syslog", alen) == 0) {
324             /* set syslog logging flag */
325             serverLogSyslog = 1;
326         } else if (strncmp(arg, "-syslog=", MIN(8, alen)) == 0) {
327             serverLogSyslog = 1;
328             serverLogSyslogFacility = atoi(arg + 8);
329         }
330 #endif
331         else if (strncmp(arg, "-auditlog", alen) == 0) {
332             int tempfd, flags;
333             FILE *auditout;
334             char oldName[MAXPATHLEN];
335             char *fileName = argv[++a];
336
337 #ifndef AFS_NT40_ENV
338             struct stat statbuf;
339
340             if ((lstat(fileName, &statbuf) == 0) 
341                 && (S_ISFIFO(statbuf.st_mode))) {
342                 flags = O_WRONLY | O_NONBLOCK;
343             } else 
344 #endif
345             {
346                 strcpy(oldName, fileName);
347                 strcat(oldName, ".old");
348                 renamefile(fileName, oldName);
349                 flags = O_WRONLY | O_TRUNC | O_CREAT;
350             }
351             tempfd = open(fileName, flags, 0666);
352             if (tempfd > -1) {
353                 auditout = fdopen(tempfd, "a");
354                 if (auditout) {
355                     osi_audit_file(auditout);
356                     osi_audit(PTS_StartEvent, 0, AUD_END);
357                 } else
358                     printf("Warning: auditlog %s not writable, ignored.\n", fileName);
359             } else
360                 printf("Warning: auditlog %s not writable, ignored.\n", fileName);
361         }
362         else if (!strncmp(arg, "-rxmaxmtu", alen)) {
363             if ((a + 1) >= argc) {
364                 fprintf(stderr, "missing argument for -rxmaxmtu\n");
365                 PT_EXIT(1);
366             }
367             rxMaxMTU = atoi(argv[++a]);
368             if ((rxMaxMTU < RX_MIN_PACKET_SIZE) ||
369                  (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
370                 printf("rxMaxMTU %d% invalid; must be between %d-%d\n",
371                         rxMaxMTU, RX_MIN_PACKET_SIZE,
372                         RX_MAX_PACKET_DATA_SIZE);
373                 PT_EXIT(1);
374             }
375         } 
376         else if (*arg == '-') {
377             /* hack in help flag support */
378
379 #if defined(SUPERGROUPS)
380 #ifndef AFS_NT40_ENV
381             printf("Usage: ptserver [-database <db path>] "
382                    "[-auditlog <log path>] "
383                    "[-syslog[=FACILITY]] "
384                    "[-p <number of processes>] [-rebuild] "
385                    "[-groupdepth <depth>] "
386                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
387                    "[-enable_peer_stats] [-enable_process_stats] "
388                    "[-default_access default_user_access default_group_access] "
389                    "[-help]\n");
390 #else /* AFS_NT40_ENV */
391             printf("Usage: ptserver [-database <db path>] "
392                    "[-auditlog <log path>] "
393                    "[-p <number of processes>] [-rebuild] [-rxbind] "
394                    "[-default_access default_user_access default_group_access] "
395                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
396                    "[-groupdepth <depth>] " "[-help]\n");
397 #endif
398 #else
399 #ifndef AFS_NT40_ENV
400             printf("Usage: ptserver [-database <db path>] "
401                    "[-auditlog <log path>] "
402                    "[-syslog[=FACILITY]] "
403                    "[-p <number of processes>] [-rebuild] "
404                    "[-enable_peer_stats] [-enable_process_stats] "
405                    "[-default_access default_user_access default_group_access] "
406                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
407                    "[-help]\n");
408 #else /* AFS_NT40_ENV */
409             printf("Usage: ptserver [-database <db path>] "
410                    "[-auditlog <log path>] "
411                    "[-default_access default_user_access default_group_access] "
412                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
413                    "[-p <number of processes>] [-rebuild] " "[-help]\n");
414 #endif
415 #endif
416             fflush(stdout);
417
418             PT_EXIT(1);
419         }
420 #if defined(SUPERGROUPS)
421         else {
422             fprintf(stderr, "Unrecognized arg: '%s' ignored!\n", arg);
423         }
424 #endif
425     }
426
427 #ifndef AFS_NT40_ENV
428     serverLogSyslogTag = "ptserver";
429 #endif
430     OpenLog(AFSDIR_SERVER_PTLOG_FILEPATH);      /* set up logging */
431     SetupLogSignals();
432
433     prdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
434     if (!prdir) {
435         fprintf(stderr, "ptserver: can't open configuration directory.\n");
436         PT_EXIT(1);
437     }
438     if (afsconf_GetNoAuthFlag(prdir))
439         printf("ptserver: running unauthenticated\n");
440
441 #ifdef AFS_NT40_ENV
442     /* initialize winsock */
443     if (afs_winsockInit() < 0) {
444         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
445
446         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
447         PT_EXIT(1);
448     }
449 #endif
450     /* get this host */
451     gethostname(hostname, sizeof(hostname));
452     th = gethostbyname(hostname);
453     if (!th) {
454         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
455         PT_EXIT(1);
456     }
457     memcpy(&myHost, th->h_addr, sizeof(afs_int32));
458
459     /* get list of servers */
460     code =
461         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, &clones);
462     if (code) {
463         afs_com_err(whoami, code, "Couldn't get server list");
464         PT_EXIT(2);
465     }
466     pr_realmName = info.name;
467     pr_realmNameLen = strlen(pr_realmName);
468
469 #if 0
470     /* get keys */
471     code = afsconf_GetKey(prdir, 999, &tkey);
472     if (code) {
473         afs_com_err(whoami, code,
474                 "couldn't get bcrypt keys from key file, ignoring.");
475     }
476 #endif
477     {
478         afs_int32 kvno;         /* see if there is a KeyFile here */
479         struct ktc_encryptionKey key;
480         code = afsconf_GetLatestKey(prdir, &kvno, &key);
481         kerberosKeys = (code == 0);
482         if (!kerberosKeys)
483             printf
484                 ("ptserver: can't find any Kerberos keys, code = %d, ignoring\n",
485                  code);
486     }
487     if (kerberosKeys) {
488         /* initialize ubik */
489         ubik_CRXSecurityProc = afsconf_ClientAuth;
490         ubik_CRXSecurityRock = (char *)prdir;
491         ubik_SRXSecurityProc = afsconf_ServerAuth;
492         ubik_SRXSecurityRock = (char *)prdir;
493         ubik_CheckRXSecurityProc = afsconf_CheckAuth;
494         ubik_CheckRXSecurityRock = (char *)prdir;
495     }
496     /* The max needed is when deleting an entry.  A full CoEntry deletion
497      * required removal from 39 entries.  Each of which may refers to the entry
498      * being deleted in one of its CoEntries.  If a CoEntry is freed its
499      * predecessor CoEntry will be modified as well.  Any freed blocks also
500      * modifies the database header.  Counting the entry being deleted and its
501      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
502      * and the header are in separate Ubik buffers then 120 buffers may be
503      * required. */
504     ubik_nBuffers = 120 + /*fudge */ 40;
505
506     if (rxBind) {
507         afs_int32 ccode;
508 #ifndef AFS_NT40_ENV
509         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH || 
510             AFSDIR_SERVER_NETINFO_FILEPATH) {
511             char reason[1024];
512             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
513                                            ADDRSPERSITE, reason,
514                                            AFSDIR_SERVER_NETINFO_FILEPATH,
515                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
516         } else 
517 #endif
518         {
519             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
520         }
521         if (ccode == 1) {
522             host = SHostAddrs[0];
523             rx_InitHost(host, htons(AFSCONF_PROTPORT));
524         }
525     }
526
527     code =
528         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, &clones,
529                               pr_dbaseName, &dbase);
530     if (code) {
531         afs_com_err(whoami, code, "Ubik init failed");
532         PT_EXIT(2);
533     }
534 #if defined(SUPERGROUPS)
535     pt_hook_write();
536 #endif
537
538     sc[0] = rxnull_NewServerSecurityObject();
539     sc[1] = 0;
540     if (kerberosKeys) {
541         sc[2] = rxkad_NewServerSecurityObject(0, prdir, afsconf_GetKey, NULL);
542     } else
543         sc[2] = sc[0];
544
545     /* Disable jumbograms */
546     rx_SetNoJumbo();
547
548     if (rxMaxMTU != -1) {
549         rx_SetMaxMTU(rxMaxMTU);
550     }
551
552     tservice =
553         rx_NewServiceHost(host, 0, PRSRV, "Protection Server", sc, 3,
554                       PR_ExecuteRequest);
555     if (tservice == (struct rx_service *)0) {
556         fprintf(stderr, "ptserver: Could not create new rx service.\n");
557         PT_EXIT(3);
558     }
559     rx_SetMinProcs(tservice, 2);
560     rx_SetMaxProcs(tservice, lwps);
561
562     tservice =
563         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats", sc, 3,
564                       RXSTATS_ExecuteRequest);
565     if (tservice == (struct rx_service *)0) {
566         fprintf(stderr, "ptserver: Could not create new rx service.\n");
567         PT_EXIT(3);
568     }
569     rx_SetMinProcs(tservice, 2);
570     rx_SetMaxProcs(tservice, 4);
571
572     /* allow super users to manage RX statistics */
573     rx_SetRxStatUserOk(pr_rxstat_userok);
574
575     rx_StartServer(1);
576     osi_audit(PTS_FinishEvent, -1, AUD_END);
577     exit(0);
578 }