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