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