2 * Copyright 2000, International Business Machines Corporation and others.
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
11 * A general description of the supergroup changes
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
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
21 * The list has room for 10 entries. If more are required,
22 * a continuation record is created.
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
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.
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.
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
52 * The program will terminate with a PT_EXIT(1).
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).
62 * 2/1/98 jjm Add mdw's changes for bit mapping for supergroups
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.
76 #if defined(SUPERGROUPS)
78 * A general description of the supergroup changes
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.
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.
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.
98 * Bit mapping support for supergroups:
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.
111 #include <afsconfig.h>
112 #include <afs/param.h>
113 #include <afs/stds.h>
117 #ifdef AFS_PTHREAD_ENV
118 # include <opr/softsig.h>
122 #include <WINNT/afsevent.h>
127 #include <rx/rx_globals.h>
128 #include <rx/rxstat.h>
132 #include <afs/cellconfig.h>
133 #include <afs/auth.h>
134 #include <afs/keys.h>
135 #include <afs/afsutil.h>
136 #include <afs/audit.h>
137 #include <afs/com_err.h>
139 #include "ptserver.h"
140 #include "ptprototypes.h"
141 #include "error_macros.h"
143 /* make all of these into a structure if you want */
144 struct prheader cheader;
145 struct ubik_dbase *dbase;
146 struct afsconf_dir *prdir;
148 #if defined(SUPERGROUPS)
149 extern afs_int32 depthsg;
153 int restrict_anonymous = 0;
156 int rxkadDisableDotCheck = 0;
158 #define ADDRSPERSITE 16 /* Same global is in rx/rx_user.c */
159 afs_uint32 SHostAddrs[ADDRSPERSITE];
161 static struct afsconf_cell info;
163 extern int prp_group_default;
164 extern int prp_user_default;
166 #include "AFS_component_version_number.c"
169 prp_access_mask(char *s)
172 if (*s >= '0' && *s <= '9') {
173 return strtol(s, NULL, 0);
176 while (*s) switch(*s++)
178 case 'S': r |= PRP_STATUS_ANY; break;
179 case 's': r |= PRP_STATUS_MEM; break;
180 case 'O': r |= PRP_OWNED_ANY; break;
181 case 'M': r |= PRP_MEMBER_ANY; break;
182 case 'm': r |= PRP_MEMBER_MEM; break;
183 case 'A': r |= PRP_ADD_ANY; break;
184 case 'a': r |= PRP_ADD_MEM; break;
185 case 'r': r |= PRP_REMOVE_MEM; break;
190 /* check whether caller is authorized to manage RX statistics */
192 pr_rxstat_userok(struct rx_call *call)
194 return afsconf_SuperUser(prdir, call, NULL);
198 * Return true if this name is a member of the local realm.
201 pr_IsLocalRealmMatch(void *rock, char *name, char *inst, char *cell)
203 struct afsconf_dir *dir = (struct afsconf_dir *)rock;
204 afs_int32 islocal = 0; /* default to no */
207 code = afsconf_IsLocalRealmMatch(dir, &islocal, name, inst, cell);
209 ViceLog(0, ("Failed local realm check; code=%d, name=%s, inst=%s, cell=%s\n",
210 code, name, inst, cell));
221 OPT_restrict_anonymous,
241 main(int argc, char **argv)
247 struct rx_service *tservice;
248 struct rx_securityClass **securityClasses;
249 afs_int32 numClasses;
251 char clones[MAXHOSTSPERCELL];
253 afs_uint32 host = htonl(INADDR_ANY);
254 struct cmd_syndesc *opts;
255 struct cmd_item *list;
260 struct logOptions logopts;
261 char *whoami = "ptserver";
263 char *auditIface = NULL;
264 struct cmd_item *auditLogList = NULL;
265 char *s2s_crypt_behavior = NULL;
269 * The following signal action for AIX is necessary so that in case of a
270 * crash (i.e. core is generated) we can include the user's data section
271 * in the core dump. Unfortunately, by default, only a partial core is
272 * generated which, in many cases, isn't too useful.
274 struct sigaction nsa;
276 sigemptyset(&nsa.sa_mask);
277 nsa.sa_handler = SIG_DFL;
278 nsa.sa_flags = SA_FULLDUMP;
279 sigaction(SIGABRT, &nsa, NULL);
280 sigaction(SIGSEGV, &nsa, NULL);
284 /* Initialize dirpaths */
285 if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
287 ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
289 fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
294 pr_dbaseName = strdup(AFSDIR_SERVER_PRDB_FILEPATH);
295 configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
296 memset(&logopts, 0, sizeof(logopts));
298 #if defined(SUPERGROUPS)
299 /* make sure the structures for database records are the same size */
300 if ((sizeof(struct prentry) != ENTRYSIZE)
301 || (sizeof(struct prentryg) != ENTRYSIZE)) {
303 "The structures for the database records are different"
304 " sizes\n" "struct prentry = %" AFS_SIZET_FMT "\n"
305 "struct prentryg = %" AFS_SIZET_FMT "\n"
306 "ENTRYSIZE = %d\n", sizeof(struct prentry),
307 sizeof(struct prentryg), ENTRYSIZE);
312 cmd_DisableAbbreviations();
313 cmd_DisablePositionalCommands();
314 opts = cmd_CreateSyntax(NULL, NULL, NULL, 0, NULL);
316 /* ptserver specific options */
317 cmd_AddParmAtOffset(opts, OPT_database, "-database", CMD_SINGLE,
318 CMD_OPTIONAL, "database file");
319 cmd_AddParmAlias(opts, OPT_database, "-db");
321 cmd_AddParmAtOffset(opts, OPT_access, "-default_access", CMD_LIST,
322 CMD_OPTIONAL, "default access flags for new entries");
323 #if defined(SUPERGROUPS)
324 cmd_AddParmAtOffset(opts, OPT_groupdepth, "-groupdepth", CMD_SINGLE,
325 CMD_OPTIONAL, "max search depth for supergroups");
326 cmd_AddParmAlias(opts, OPT_groupdepth, "-depth");
328 cmd_AddParmAtOffset(opts, OPT_restricted, "-restricted", CMD_FLAG,
329 CMD_OPTIONAL, "enable restricted mode");
330 cmd_AddParmAtOffset(opts, OPT_restrict_anonymous, "-restrict_anonymous",
331 CMD_FLAG, CMD_OPTIONAL, "enable restricted anonymous mode");
333 /* general server options */
334 cmd_AddParmAtOffset(opts, OPT_auditlog, "-auditlog", CMD_LIST,
335 CMD_OPTIONAL, "[interface:]path[:options]");
336 cmd_AddParmAtOffset(opts, OPT_auditiface, "-audit-interface", CMD_SINGLE,
337 CMD_OPTIONAL, "default interface");
338 cmd_AddParmAtOffset(opts, OPT_config, "-config", CMD_SINGLE,
339 CMD_OPTIONAL, "configuration location");
340 cmd_AddParmAtOffset(opts, OPT_debug, "-d", CMD_SINGLE,
341 CMD_OPTIONAL, "debug level");
342 cmd_AddParmAtOffset(opts, OPT_logfile, "-logfile", CMD_SINGLE,
343 CMD_OPTIONAL, "location of logfile");
344 cmd_AddParmAtOffset(opts, OPT_threads, "-p", CMD_SINGLE,
345 CMD_OPTIONAL, "number of threads");
347 cmd_AddParmAtOffset(opts, OPT_syslog, "-syslog", CMD_SINGLE_OR_FLAG,
348 CMD_OPTIONAL, "log to syslog");
350 cmd_AddParmAtOffset(opts, OPT_transarc_logs, "-transarc-logs", CMD_FLAG,
351 CMD_OPTIONAL, "enable Transarc style logging");
354 cmd_AddParmAtOffset(opts, OPT_peer, "-enable_peer_stats", CMD_FLAG,
355 CMD_OPTIONAL, "enable RX RPC statistics by peer");
356 cmd_AddParmAtOffset(opts, OPT_process, "-enable_process_stats", CMD_FLAG,
357 CMD_OPTIONAL, "enable RX RPC statistics");
358 cmd_AddParmAtOffset(opts, OPT_rxbind, "-rxbind", CMD_FLAG,
359 CMD_OPTIONAL, "bind only to the primary interface");
360 cmd_AddParmAtOffset(opts, OPT_rxmaxmtu, "-rxmaxmtu", CMD_SINGLE,
361 CMD_OPTIONAL, "maximum MTU for RX");
364 cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals",
365 CMD_FLAG, CMD_OPTIONAL,
366 "permit Kerberos 5 principals with dots");
369 cmd_AddParmAtOffset(opts, OPT_s2s_crypt, "-s2scrypt", CMD_SINGLE,
371 "rxgk-crypt | never");
373 code = cmd_Parse(argc, argv, &opts);
374 if (code == CMD_HELP) {
380 cmd_OptionAsString(opts, OPT_config, &configDir);
382 cmd_OpenConfigFile(AFSDIR_SERVER_CONFIG_FILE_FILEPATH);
383 cmd_SetCommandName("ptserver");
385 if (cmd_OptionAsList(opts, OPT_access, &list) == 0) {
386 prp_user_default = prp_access_mask(list->data);
387 if (list->next == NULL || list->next->data == NULL) {
388 fprintf(stderr, "Missing second argument for -default_access\n");
391 prp_group_default = prp_access_mask(list->next->data);
394 #if defined(SUPERGROUPS)
395 cmd_OptionAsInt(opts, OPT_groupdepth, &depthsg);
398 cmd_OptionAsFlag(opts, OPT_restricted, &restricted);
399 cmd_OptionAsFlag(opts, OPT_restrict_anonymous, &restrict_anonymous);
401 /* general server options */
403 cmd_OptionAsString(opts, OPT_auditiface, &auditIface);
404 cmd_OptionAsList(opts, OPT_auditlog, &auditLogList);
406 cmd_OptionAsString(opts, OPT_database, &pr_dbaseName);
408 if (cmd_OptionAsInt(opts, OPT_threads, &lwps) == 0) {
409 if (lwps > 64) { /* maximum of 64 */
410 printf("Warning: '-p %d' is too big; using %d instead\n",
413 } else if (lwps < 3) { /* minimum of 3 */
414 printf("Warning: '-p %d' is too small; using %d instead\n",
421 if (cmd_OptionPresent(opts, OPT_syslog)) {
422 if (cmd_OptionPresent(opts, OPT_logfile)) {
423 fprintf(stderr, "Invalid options: -syslog and -logfile are exclusive.");
426 if (cmd_OptionPresent(opts, OPT_transarc_logs)) {
427 fprintf(stderr, "Invalid options: -syslog and -transarc-logs are exclusive.");
430 logopts.lopt_dest = logDest_syslog;
431 logopts.lopt_facility = LOG_DAEMON;
432 logopts.lopt_tag = "ptserver";
433 cmd_OptionAsInt(opts, OPT_syslog, &logopts.lopt_facility);
437 logopts.lopt_dest = logDest_file;
438 if (cmd_OptionPresent(opts, OPT_transarc_logs)) {
439 logopts.lopt_rotateOnOpen = 1;
440 logopts.lopt_rotateStyle = logRotate_old;
442 if (cmd_OptionPresent(opts, OPT_logfile))
443 cmd_OptionAsString(opts, OPT_logfile, (char**)&logopts.lopt_filename);
445 logopts.lopt_filename = AFSDIR_SERVER_PTLOG_FILEPATH;
447 cmd_OptionAsInt(opts, OPT_debug, &logopts.lopt_logLevel);
450 if (cmd_OptionPresent(opts, OPT_peer))
451 rx_enablePeerRPCStats();
453 if (cmd_OptionPresent(opts, OPT_process))
454 rx_enableProcessRPCStats();
456 cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
458 cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU);
461 cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
464 if (cmd_OptionAsString(opts, OPT_s2s_crypt, &s2s_crypt_behavior) == 0) {
465 if (strcmp(s2s_crypt_behavior, "never") == 0) {
466 /* noop; this is the default */
467 } else if (strcmp(s2s_crypt_behavior, "rxgk-crypt") == 0) {
470 fprintf(stderr, "Invalid argument for -s2scrypt: %s\n", s2s_crypt_behavior);
473 free(s2s_crypt_behavior);
474 s2s_crypt_behavior = NULL;
477 code = osi_audit_cmd_Options(auditIface, auditLogList);
482 cmd_FreeOptions(&opts);
485 osi_audit(PTS_StartEvent, 0, AUD_END);
488 #ifdef AFS_PTHREAD_ENV
490 SetupLogSoftSignals();
495 prdir = afsconf_Open(configDir);
497 fprintf(stderr, "ptserver: can't open configuration directory.\n");
500 if (afsconf_GetNoAuthFlag(prdir))
501 printf("ptserver: running unauthenticated\n");
504 /* initialize winsock */
505 if (afs_winsockInit() < 0) {
506 ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
508 fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
513 gethostname(hostname, sizeof(hostname));
514 th = gethostbyname(hostname);
516 fprintf(stderr, "ptserver: couldn't get address of this host.\n");
519 memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
521 /* get list of servers */
523 afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, clones);
525 afs_com_err(whoami, code, "Couldn't get server list");
529 /* initialize audit user check */
530 osi_audit_set_user_check(prdir, pr_IsLocalRealmMatch);
532 /* initialize ubik */
534 ubik_SetClientSecurityProcs(afsconf_ClientAuthRXGKCrypt,
535 afsconf_UpToDate, prdir);
537 ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate,
540 ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
541 afsconf_CheckAuth, prdir);
543 /* The max needed is when deleting an entry. A full CoEntry deletion
544 * required removal from 39 entries. Each of which may refers to the entry
545 * being deleted in one of its CoEntries. If a CoEntry is freed its
546 * predecessor CoEntry will be modified as well. Any freed blocks also
547 * modifies the database header. Counting the entry being deleted and its
548 * CoEntry this adds up to as much as 1+1+39*3 = 119. If all these entries
549 * and the header are in separate Ubik buffers then 120 buffers may be
551 ubik_nBuffers = 120 + /*fudge */ 40;
555 if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
556 AFSDIR_SERVER_NETINFO_FILEPATH) {
558 ccode = afsconf_ParseNetFiles(SHostAddrs, NULL, NULL,
559 ADDRSPERSITE, reason,
560 AFSDIR_SERVER_NETINFO_FILEPATH,
561 AFSDIR_SERVER_NETRESTRICT_FILEPATH);
564 ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
567 host = SHostAddrs[0];
571 ViceLog(0, ("ptserver binding rx to %s:%d\n",
572 afs_inet_ntoa_r(host, hoststr), AFSCONF_PROTPORT));
573 code = rx_InitHost(host, htons(AFSCONF_PROTPORT));
575 ViceLog(0, ("ptserver: Rx init failed: %d\n", code));
579 /* Disable jumbograms */
582 if (rxMaxMTU != -1) {
583 if (rx_SetMaxMTU(rxMaxMTU) != 0) {
584 printf("rxMaxMTU %d is invalid\n", rxMaxMTU);
590 ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
591 pr_dbaseName, &dbase);
593 afs_com_err(whoami, code, "Ubik init failed");
597 #if defined(SUPERGROUPS)
601 afsconf_BuildServerSecurityObjects(prdir, &securityClasses, &numClasses);
604 rx_NewServiceHost(host, 0, PRSRV, "Protection Server", securityClasses,
605 numClasses, PR_ExecuteRequest);
606 if (tservice == (struct rx_service *)0) {
607 fprintf(stderr, "ptserver: Could not create new rx service.\n");
610 rx_SetMinProcs(tservice, 2);
611 rx_SetMaxProcs(tservice, lwps);
612 if (rxkadDisableDotCheck) {
613 code = rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
614 (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
616 afs_com_err(whoami, code, "Failed to allow dotted principals");
622 rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
623 securityClasses, numClasses, RXSTATS_ExecuteRequest);
624 if (tservice == (struct rx_service *)0) {
625 fprintf(stderr, "ptserver: Could not create new rx service.\n");
628 rx_SetMinProcs(tservice, 2);
629 rx_SetMaxProcs(tservice, 4);
631 /* allow super users to manage RX statistics */
632 rx_SetRxStatUserOk(pr_rxstat_userok);
634 LogCommandLine(argc, argv, "ptserver",
635 #if defined(SUPERGROUPS)
640 "Starting AFS", FSLog);
641 if (afsconf_CountKeys(prdir) == 0) {
642 ViceLog(0, ("WARNING: No encryption keys found! "
643 "All authenticated accesses will fail. "
644 "Run akeyconvert or asetkey to import encryption keys.\n"));
645 } else if (afsconf_GetLatestKey(prdir, NULL, NULL) == 0) {
650 osi_audit(PTS_FinishEvent, -1, AUD_END);