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