ptserver: Use libcmd for command line parsing
[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/cmd.h>
128 #include <afs/cellconfig.h>
129 #include <afs/auth.h>
130 #include <afs/keys.h>
131 #include <afs/afsutil.h>
132 #include <afs/audit.h>
133 #include <afs/com_err.h>
134
135 #include "ptserver.h"
136 #include "ptprototypes.h"
137 #include "error_macros.h"
138
139 /* make all of these into a structure if you want */
140 struct prheader cheader;
141 struct ubik_dbase *dbase;
142 struct afsconf_dir *prdir;
143
144 #if defined(SUPERGROUPS)
145 extern afs_int32 depthsg;
146 #endif
147
148 char *pr_realmName;
149
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 enum optionsList {
195     OPT_database,
196     OPT_access,
197     OPT_groupdepth,
198     OPT_restricted,
199     OPT_auditlog,
200     OPT_auditiface,
201     OPT_config,
202     OPT_debug,
203     OPT_logfile,
204     OPT_threads,
205     OPT_syslog,
206     OPT_peer,
207     OPT_process,
208     OPT_rxbind,
209     OPT_rxmaxmtu,
210     OPT_dotted
211 };
212
213 int
214 main(int argc, char **argv)
215 {
216     afs_int32 code;
217     afs_uint32 myHost;
218     struct hostent *th;
219     char hostname[64];
220     struct rx_service *tservice;
221     struct rx_securityClass **securityClasses;
222     afs_int32 numClasses;
223     int lwps = 3;
224     char clones[MAXHOSTSPERCELL];
225     afs_uint32 host = htonl(INADDR_ANY);
226     struct cmd_syndesc *opts;
227     struct cmd_item *list;
228
229     char *pr_dbaseName;
230     char *configDir;
231     char *logFile;
232     char *whoami = "ptserver";
233
234     char *auditFileName = NULL;
235     char *interface = NULL;
236
237 #ifdef  AFS_AIX32_ENV
238     /*
239      * The following signal action for AIX is necessary so that in case of a
240      * crash (i.e. core is generated) we can include the user's data section
241      * in the core dump. Unfortunately, by default, only a partial core is
242      * generated which, in many cases, isn't too useful.
243      */
244     struct sigaction nsa;
245
246     sigemptyset(&nsa.sa_mask);
247     nsa.sa_handler = SIG_DFL;
248     nsa.sa_flags = SA_FULLDUMP;
249     sigaction(SIGABRT, &nsa, NULL);
250     sigaction(SIGSEGV, &nsa, NULL);
251 #endif
252     osi_audit_init();
253     osi_audit(PTS_StartEvent, 0, AUD_END);
254
255     /* Initialize dirpaths */
256     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
257 #ifdef AFS_NT40_ENV
258         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
259 #endif
260         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
261                 argv[0]);
262         exit(2);
263     }
264
265     pr_dbaseName = strdup(AFSDIR_SERVER_PRDB_FILEPATH);
266     configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
267     logFile = strdup(AFSDIR_SERVER_PTLOG_FILEPATH);
268
269 #if defined(SUPERGROUPS)
270     /* make sure the structures for database records are the same size */
271     if ((sizeof(struct prentry) != ENTRYSIZE)
272         || (sizeof(struct prentryg) != ENTRYSIZE)) {
273         fprintf(stderr,
274                 "The structures for the database records are different"
275                 " sizes\n" "struct prentry = %" AFS_SIZET_FMT "\n"
276                 "struct prentryg = %" AFS_SIZET_FMT "\n"
277                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
278                 sizeof(struct prentryg), ENTRYSIZE);
279         PT_EXIT(1);
280     }
281 #endif
282
283     cmd_DisableAbbreviations();
284     cmd_DisablePositionalCommands();
285     opts = cmd_CreateSyntax(NULL, NULL, NULL, NULL);
286
287 /* ptserver specific options */
288     cmd_AddParmAtOffset(opts, OPT_database, "-database", CMD_SINGLE,
289                         CMD_OPTIONAL, "database file");
290     cmd_AddParmAlias(opts, OPT_database, "db");
291
292     cmd_AddParmAtOffset(opts, OPT_access, "-default_access", CMD_SINGLE,
293                         CMD_OPTIONAL, "default access flags for new entries");
294 #if defined(SUPERGROUPS)
295     cmd_AddParmAtOffset(opts, OPT_groupdepth, "-groupdepth", CMD_SINGLE,
296                         CMD_OPTIONAL, "max search depth for supergroups");
297     cmd_AddParmAlias(opts, OPT_groupdepth, "depth");
298 #endif
299     cmd_AddParmAtOffset(opts, OPT_restricted, "-restricted", CMD_FLAG,
300                         CMD_OPTIONAL, "enable restricted mode");
301
302     /* general server options */
303     cmd_AddParmAtOffset(opts, OPT_auditlog, "-auditlog", CMD_SINGLE,
304                         CMD_OPTIONAL, "location of audit log");
305     cmd_AddParmAtOffset(opts, OPT_auditiface, "-audit-interface", CMD_SINGLE,
306                         CMD_OPTIONAL, "interface to use for audit logging");
307     cmd_AddParmAtOffset(opts, OPT_config, "-config", CMD_SINGLE,
308                         CMD_OPTIONAL, "configuration location");
309     cmd_AddParmAtOffset(opts, OPT_debug, "-d", CMD_SINGLE,
310                         CMD_OPTIONAL, "debug level");
311     cmd_AddParmAtOffset(opts, OPT_logfile, "-logfile", CMD_SINGLE,
312                         CMD_OPTIONAL, "location of logfile");
313     cmd_AddParmAtOffset(opts, OPT_threads, "-p", CMD_SINGLE,
314                         CMD_OPTIONAL, "number of threads");
315 #if !defined(AFS_NT40_ENV)
316     cmd_AddParmAtOffset(opts, OPT_syslog, "-syslog", CMD_SINGLE_OR_FLAG, 
317                         CMD_OPTIONAL, "log to syslog");
318 #endif
319
320     /* rx options */
321     cmd_AddParmAtOffset(opts, OPT_peer, "-enable_peer_stats", CMD_FLAG,
322                         CMD_OPTIONAL, "enable RX transport statistics");
323     cmd_AddParmAtOffset(opts, OPT_process, "-enable_process_stats", CMD_FLAG,
324                         CMD_OPTIONAL, "enable RX RPC statistics");
325     cmd_AddParmAtOffset(opts, OPT_rxbind, "-rxbind", CMD_FLAG,
326                         CMD_OPTIONAL, "bind only to the primary interface");
327     cmd_AddParmAtOffset(opts, OPT_rxmaxmtu, "-rxmaxmtu", CMD_SINGLE,
328                         CMD_OPTIONAL, "maximum MTU for RX");
329
330     /* rxkad options */
331     cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals",
332                         CMD_FLAG, CMD_OPTIONAL,
333                         "permit Kerberos 5 principals with dots");
334
335     code = cmd_Parse(argc, argv, &opts);
336     if (code)
337         PT_EXIT(1);
338
339     if (cmd_OptionAsList(opts, OPT_access, &list) == 0) {
340         prp_user_default = prp_access_mask(list->data);
341         if (list->next == NULL || list->next->data == NULL) {
342             fprintf(stderr, "Missing second argument for -default_access\n");
343             PT_EXIT(1);
344         }
345         prp_group_default = prp_access_mask(list->next->data);
346     }
347
348 #if defined(SUPERGROUPS)
349     cmd_OptionAsInt(opts, OPT_groupdepth, &depthsg);
350 #endif
351
352     cmd_OptionAsFlag(opts, OPT_restricted, &restricted);
353
354     /* general server options */
355     cmd_OptionAsString(opts, OPT_auditlog, &auditFileName);
356
357     if (cmd_OptionAsString(opts, OPT_auditiface, &interface) == 0) {
358         if (osi_audit_interface(interface)) {
359             printf("Invalid audit interface '%s'\n", interface);
360             PT_EXIT(1);
361         }
362         free(interface);
363     }
364
365     cmd_OptionAsString(opts, OPT_config, &configDir);
366     cmd_OptionAsInt(opts, OPT_debug, &LogLevel);
367     cmd_OptionAsString(opts, OPT_database, &pr_dbaseName);
368     cmd_OptionAsString(opts, OPT_logfile, &logFile);
369
370     if (cmd_OptionAsInt(opts, OPT_threads, &lwps) == 0) {
371         if (lwps > 16) {        /* maximum of 16 */
372             printf("Warning: '-p %d' is too big; using %d instead\n",
373                    lwps, 16);
374             lwps = 16;
375         } else if (lwps < 3) {  /* minimum of 3 */
376             printf("Warning: '-p %d' is too small; using %d instead\n",
377                    lwps, 3);
378             lwps = 3;
379         }
380     }
381
382 #ifndef AFS_NT40_ENV
383     if (cmd_OptionPresent(opts, OPT_syslog)) {
384         serverLogSyslog = 1;
385         cmd_OptionAsInt(opts, OPT_syslog, &serverLogSyslogFacility);
386     }
387 #endif
388
389     /* rx options */
390     if (cmd_OptionPresent(opts, OPT_peer))
391         rx_enablePeerRPCStats();
392
393     if (cmd_OptionPresent(opts, OPT_process))
394         rx_enableProcessRPCStats();
395
396     cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
397
398     if (cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU) == 0) {
399         if ((rxMaxMTU < RX_MIN_PACKET_SIZE) ||
400             (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
401             printf("rxMaxMTU %d invalid; must be between %d-%" AFS_SIZET_FMT "\n",
402                    rxMaxMTU, RX_MIN_PACKET_SIZE,
403                    RX_MAX_PACKET_DATA_SIZE);
404             PT_EXIT(1);
405         }
406     }
407
408     /* rxkad options */
409     cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
410
411     cmd_FreeOptions(&opts);
412
413     if (auditFileName) {
414         osi_audit_file(auditFileName);
415         osi_audit(PTS_StartEvent, 0, AUD_END);
416     }
417
418 #ifndef AFS_NT40_ENV
419     serverLogSyslogTag = "ptserver";
420 #endif
421     OpenLog(logFile);   /* set up logging */
422     SetupLogSignals();
423
424     prdir = afsconf_Open(configDir);
425     if (!prdir) {
426         fprintf(stderr, "ptserver: can't open configuration directory.\n");
427         PT_EXIT(1);
428     }
429     if (afsconf_GetNoAuthFlag(prdir))
430         printf("ptserver: running unauthenticated\n");
431
432 #ifdef AFS_NT40_ENV
433     /* initialize winsock */
434     if (afs_winsockInit() < 0) {
435         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
436
437         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
438         PT_EXIT(1);
439     }
440 #endif
441     /* get this host */
442     gethostname(hostname, sizeof(hostname));
443     th = gethostbyname(hostname);
444     if (!th) {
445         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
446         PT_EXIT(1);
447     }
448     memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
449
450     /* get list of servers */
451     code =
452         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, clones);
453     if (code) {
454         afs_com_err(whoami, code, "Couldn't get server list");
455         PT_EXIT(2);
456     }
457     pr_realmName = info.name;
458
459     /* initialize ubik */
460     ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate, prdir);
461     ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
462                                 afsconf_CheckAuth, prdir);
463
464     /* The max needed is when deleting an entry.  A full CoEntry deletion
465      * required removal from 39 entries.  Each of which may refers to the entry
466      * being deleted in one of its CoEntries.  If a CoEntry is freed its
467      * predecessor CoEntry will be modified as well.  Any freed blocks also
468      * modifies the database header.  Counting the entry being deleted and its
469      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
470      * and the header are in separate Ubik buffers then 120 buffers may be
471      * required. */
472     ubik_nBuffers = 120 + /*fudge */ 40;
473
474     if (rxBind) {
475         afs_int32 ccode;
476         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
477             AFSDIR_SERVER_NETINFO_FILEPATH) {
478             char reason[1024];
479             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
480                                            ADDRSPERSITE, reason,
481                                            AFSDIR_SERVER_NETINFO_FILEPATH,
482                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
483         } else
484         {
485             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
486         }
487         if (ccode == 1) {
488             host = SHostAddrs[0];
489             /* the following call is idempotent so if/when it gets called
490              * again by the ubik init stuff, it doesn't really matter
491              * -- klm
492              */
493             rx_InitHost(host, htons(AFSCONF_PROTPORT));
494         }
495     }
496
497     code =
498         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
499                               pr_dbaseName, &dbase);
500     if (code) {
501         afs_com_err(whoami, code, "Ubik init failed");
502         PT_EXIT(2);
503     }
504 #if defined(SUPERGROUPS)
505     pt_hook_write();
506 #endif
507
508     afsconf_BuildServerSecurityObjects(prdir, &securityClasses, &numClasses);
509
510     /* Disable jumbograms */
511     rx_SetNoJumbo();
512
513     if (rxMaxMTU != -1) {
514         rx_SetMaxMTU(rxMaxMTU);
515     }
516
517     tservice =
518         rx_NewServiceHost(host, 0, PRSRV, "Protection Server", securityClasses,
519                           numClasses, PR_ExecuteRequest);
520     if (tservice == (struct rx_service *)0) {
521         fprintf(stderr, "ptserver: Could not create new rx service.\n");
522         PT_EXIT(3);
523     }
524     rx_SetMinProcs(tservice, 2);
525     rx_SetMaxProcs(tservice, lwps);
526     if (rxkadDisableDotCheck) {
527         rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
528                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
529     }
530
531     tservice =
532         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
533                           securityClasses, numClasses, RXSTATS_ExecuteRequest);
534     if (tservice == (struct rx_service *)0) {
535         fprintf(stderr, "ptserver: Could not create new rx service.\n");
536         PT_EXIT(3);
537     }
538     rx_SetMinProcs(tservice, 2);
539     rx_SetMaxProcs(tservice, 4);
540
541     /* allow super users to manage RX statistics */
542     rx_SetRxStatUserOk(pr_rxstat_userok);
543
544     LogCommandLine(argc, argv, "ptserver",
545 #if defined(SUPERGROUPS)
546                    "1.1",
547 #else
548                    "1.0",
549 #endif
550                    "Starting AFS", FSLog);
551
552     rx_StartServer(1);
553     osi_audit(PTS_FinishEvent, -1, AUD_END);
554     exit(0);
555 }