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