d1c4d40b0622f4f5a578a6be002c97f9673d6f91
[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     const char *configDir;
210     const char *logFile;
211     char *whoami = "ptserver";
212
213     int a;
214     char arg[100];
215
216     char *auditFileName = NULL;
217
218 #ifdef  AFS_AIX32_ENV
219     /*
220      * The following signal action for AIX is necessary so that in case of a
221      * crash (i.e. core is generated) we can include the user's data section
222      * in the core dump. Unfortunately, by default, only a partial core is
223      * generated which, in many cases, isn't too useful.
224      */
225     struct sigaction nsa;
226
227     sigemptyset(&nsa.sa_mask);
228     nsa.sa_handler = SIG_DFL;
229     nsa.sa_flags = SA_FULLDUMP;
230     sigaction(SIGABRT, &nsa, NULL);
231     sigaction(SIGSEGV, &nsa, NULL);
232 #endif
233     osi_audit_init();
234     osi_audit(PTS_StartEvent, 0, AUD_END);
235
236     /* Initialize dirpaths */
237     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
238 #ifdef AFS_NT40_ENV
239         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
240 #endif
241         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
242                 argv[0]);
243         exit(2);
244     }
245
246     pr_dbaseName = AFSDIR_SERVER_PRDB_FILEPATH;
247     configDir = AFSDIR_SERVER_ETC_DIRPATH;
248     logFile = AFSDIR_SERVER_PTLOG_FILEPATH;
249
250 #if defined(SUPERGROUPS)
251     /* make sure the structures for database records are the same size */
252     if ((sizeof(struct prentry) != ENTRYSIZE)
253         || (sizeof(struct prentryg) != ENTRYSIZE)) {
254         fprintf(stderr,
255                 "The structures for the database records are different"
256                 " sizes\n" "struct prentry = %" AFS_SIZET_FMT "\n"
257                 "struct prentryg = %" AFS_SIZET_FMT "\n"
258                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
259                 sizeof(struct prentryg), ENTRYSIZE);
260         PT_EXIT(1);
261     }
262 #endif
263
264     for (a = 1; a < argc; a++) {
265         int alen;
266         lcstring(arg, argv[a], sizeof(arg));
267         alen = strlen(arg);
268         if (strcmp(argv[a], "-d") == 0) {
269             if ((a + 1) >= argc) {
270                 fprintf(stderr, "missing argument for -d\n");
271                 return -1;
272             }
273             debuglevel = atoi(argv[++a]);
274             LogLevel = debuglevel;
275         } else if ((strncmp(arg, "-database", alen) == 0)
276             || (strncmp(arg, "-db", alen) == 0)) {
277             pr_dbaseName = argv[++a];   /* specify a database */
278         } else if (strncmp(arg, "-p", alen) == 0) {
279             lwps = atoi(argv[++a]);
280             if (lwps > 16) {    /* maximum of 16 */
281                 printf("Warning: '-p %d' is too big; using %d instead\n",
282                        lwps, 16);
283                 lwps = 16;
284             } else if (lwps < 3) {      /* minimum of 3 */
285                 printf("Warning: '-p %d' is too small; using %d instead\n",
286                        lwps, 3);
287                 lwps = 3;
288             }
289 #if defined(SUPERGROUPS)
290         } else if ((strncmp(arg, "-groupdepth", alen) == 0)
291                  || (strncmp(arg, "-depth", alen) == 0)) {
292             depthsg = atoi(argv[++a]);  /* Max search depth for supergroups */
293 #endif
294         } else if (strncmp(arg, "-default_access", alen) == 0) {
295             prp_user_default = prp_access_mask(argv[++a]);
296             prp_group_default = prp_access_mask(argv[++a]);
297         }
298         else if (strncmp(arg, "-restricted", alen) == 0) {
299             restricted = 1;
300         }
301         else if (strncmp(arg, "-rxbind", alen) == 0) {
302             rxBind = 1;
303         }
304         else if (strncmp(arg, "-allow-dotted-principals", alen) == 0) {
305             rxkadDisableDotCheck = 1;
306         }
307         else if (strncmp(arg, "-enable_peer_stats", alen) == 0) {
308             rx_enablePeerRPCStats();
309         } else if (strncmp(arg, "-enable_process_stats", alen) == 0) {
310             rx_enableProcessRPCStats();
311         }
312 #ifndef AFS_NT40_ENV
313         else if (strncmp(arg, "-syslog", alen) == 0) {
314             /* set syslog logging flag */
315             serverLogSyslog = 1;
316         } else if (strncmp(arg, "-syslog=", MIN(8, alen)) == 0) {
317             serverLogSyslog = 1;
318             serverLogSyslogFacility = atoi(arg + 8);
319         }
320 #endif
321         else if (strncmp(arg, "-auditlog", alen) == 0) {
322             auditFileName = argv[++a];
323
324         } else if (strncmp(arg, "-audit-interface", alen) == 0) {
325             char *interface = argv[++a];
326             if (osi_audit_interface(interface)) {
327                 printf("Invalid audit interface '%s'\n", interface);
328                 PT_EXIT(1);
329             }
330         }
331         else if (!strncmp(arg, "-rxmaxmtu", alen)) {
332             if ((a + 1) >= argc) {
333                 fprintf(stderr, "missing argument for -rxmaxmtu\n");
334                 PT_EXIT(1);
335             }
336             rxMaxMTU = atoi(argv[++a]);
337             if ((rxMaxMTU < RX_MIN_PACKET_SIZE) ||
338                  (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
339                 printf("rxMaxMTU %d invalid; must be between %d-%" AFS_SIZET_FMT "\n",
340                         rxMaxMTU, RX_MIN_PACKET_SIZE,
341                         RX_MAX_PACKET_DATA_SIZE);
342                 PT_EXIT(1);
343             }
344         } else if (!strncmp(arg, "-config", alen)) {
345             if ((a + 1) > argc) {
346                 fprintf(stderr, "missing argument for -config\n");
347                 PT_EXIT(1);
348             }
349             configDir = argv[++a];
350         } else if (!strncmp(arg, "-logfile", alen)) {
351             if ((a + 1) > argc) {
352                 fprintf(stderr, "missing argument for -logfile\n");
353                 PT_EXIT(1);
354             }
355             logFile = argv[++a];
356         }
357         else if (*arg == '-') {
358             /* hack in help flag support */
359             printf("Usage: ptserver [-database <db path>] "
360                    "[-auditlog <log path>] "
361                    "[-audit-interface <file|sysvmq> (default is file)] "
362                    "[-config <config directory path>] "
363                    "[-logfile <log file path>] ");
364 #ifndef AFS_NT40_ENV
365             printf("[-syslog[=FACILITY]] ");
366 #endif
367             printf("[-d <debug level>] "
368                    "[-p <number of processes>] [-rebuild] [-rxbind] ");
369 #if defined(SUPERGROUPS)
370             printf("[-groupdepth <depth>] ");
371 #endif
372             printf("[-restricted] [-rxmaxmtu <bytes>] "
373                    "[-allow-dotted-principals] ");
374 #ifndef AFS_NT40_ENV
375             printf("[-enable_peer_stats] [-enable_process_stats] ");
376 #endif
377             printf("[-default_access default_user_access default_group_access] "
378                    "[-help]\n");
379
380             fflush(stdout);
381
382             PT_EXIT(1);
383         }
384         else {
385             fprintf(stderr, "Unrecognized arg: '%s' ignored!\n", arg);
386         }
387     }
388
389     if (auditFileName) {
390         osi_audit_file(auditFileName);
391         osi_audit(PTS_StartEvent, 0, AUD_END);
392     }
393
394 #ifndef AFS_NT40_ENV
395     serverLogSyslogTag = "ptserver";
396 #endif
397     OpenLog(logFile);   /* set up logging */
398     SetupLogSignals();
399
400     prdir = afsconf_Open(configDir);
401     if (!prdir) {
402         fprintf(stderr, "ptserver: can't open configuration directory.\n");
403         PT_EXIT(1);
404     }
405     if (afsconf_GetNoAuthFlag(prdir))
406         printf("ptserver: running unauthenticated\n");
407
408 #ifdef AFS_NT40_ENV
409     /* initialize winsock */
410     if (afs_winsockInit() < 0) {
411         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
412
413         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
414         PT_EXIT(1);
415     }
416 #endif
417     /* get this host */
418     gethostname(hostname, sizeof(hostname));
419     th = gethostbyname(hostname);
420     if (!th) {
421         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
422         PT_EXIT(1);
423     }
424     memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
425
426     /* get list of servers */
427     code =
428         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, clones);
429     if (code) {
430         afs_com_err(whoami, code, "Couldn't get server list");
431         PT_EXIT(2);
432     }
433     pr_realmName = info.name;
434
435     /* initialize ubik */
436     ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate, prdir);
437     ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
438                                 afsconf_CheckAuth, prdir);
439
440     /* The max needed is when deleting an entry.  A full CoEntry deletion
441      * required removal from 39 entries.  Each of which may refers to the entry
442      * being deleted in one of its CoEntries.  If a CoEntry is freed its
443      * predecessor CoEntry will be modified as well.  Any freed blocks also
444      * modifies the database header.  Counting the entry being deleted and its
445      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
446      * and the header are in separate Ubik buffers then 120 buffers may be
447      * required. */
448     ubik_nBuffers = 120 + /*fudge */ 40;
449
450     if (rxBind) {
451         afs_int32 ccode;
452         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
453             AFSDIR_SERVER_NETINFO_FILEPATH) {
454             char reason[1024];
455             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
456                                            ADDRSPERSITE, reason,
457                                            AFSDIR_SERVER_NETINFO_FILEPATH,
458                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
459         } else
460         {
461             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
462         }
463         if (ccode == 1) {
464             host = SHostAddrs[0];
465             /* the following call is idempotent so if/when it gets called
466              * again by the ubik init stuff, it doesn't really matter
467              * -- klm
468              */
469             rx_InitHost(host, htons(AFSCONF_PROTPORT));
470         }
471     }
472
473     code =
474         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
475                               pr_dbaseName, &dbase);
476     if (code) {
477         afs_com_err(whoami, code, "Ubik init failed");
478         PT_EXIT(2);
479     }
480 #if defined(SUPERGROUPS)
481     pt_hook_write();
482 #endif
483
484     afsconf_BuildServerSecurityObjects(prdir, &securityClasses, &numClasses);
485
486     /* Disable jumbograms */
487     rx_SetNoJumbo();
488
489     if (rxMaxMTU != -1) {
490         rx_SetMaxMTU(rxMaxMTU);
491     }
492
493     tservice =
494         rx_NewServiceHost(host, 0, PRSRV, "Protection Server", securityClasses,
495                           numClasses, PR_ExecuteRequest);
496     if (tservice == (struct rx_service *)0) {
497         fprintf(stderr, "ptserver: Could not create new rx service.\n");
498         PT_EXIT(3);
499     }
500     rx_SetMinProcs(tservice, 2);
501     rx_SetMaxProcs(tservice, lwps);
502     if (rxkadDisableDotCheck) {
503         rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
504                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
505     }
506
507     tservice =
508         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
509                           securityClasses, numClasses, RXSTATS_ExecuteRequest);
510     if (tservice == (struct rx_service *)0) {
511         fprintf(stderr, "ptserver: Could not create new rx service.\n");
512         PT_EXIT(3);
513     }
514     rx_SetMinProcs(tservice, 2);
515     rx_SetMaxProcs(tservice, 4);
516
517     /* allow super users to manage RX statistics */
518     rx_SetRxStatUserOk(pr_rxstat_userok);
519
520     LogCommandLine(argc, argv, "ptserver",
521 #if defined(SUPERGROUPS)
522                    "1.1",
523 #else
524                    "1.0",
525 #endif
526                    "Starting AFS", FSLog);
527
528     rx_StartServer(1);
529     osi_audit(PTS_FinishEvent, -1, AUD_END);
530     exit(0);
531 }