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>
119 #include <WINNT/afsevent.h>
124 #include <rx/rx_globals.h>
125 #include <rx/rxstat.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>
136 #include "ptserver.h"
137 #include "ptprototypes.h"
138 #include "error_macros.h"
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;
145 #if defined(SUPERGROUPS)
146 extern afs_int32 depthsg;
150 int restrict_anonymous = 0;
153 int rxkadDisableDotCheck = 0;
155 #define ADDRSPERSITE 16 /* Same global is in rx/rx_user.c */
156 afs_uint32 SHostAddrs[ADDRSPERSITE];
158 static struct afsconf_cell info;
160 extern int prp_group_default;
161 extern int prp_user_default;
163 #include "AFS_component_version_number.c"
166 prp_access_mask(char *s)
169 if (*s >= '0' && *s <= '9') {
170 return strtol(s, NULL, 0);
173 while (*s) switch(*s++)
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;
187 /* check whether caller is authorized to manage RX statistics */
189 pr_rxstat_userok(struct rx_call *call)
191 return afsconf_SuperUser(prdir, call, NULL);
195 * Return true if this name is a member of the local realm.
198 pr_IsLocalRealmMatch(void *rock, char *name, char *inst, char *cell)
200 struct afsconf_dir *dir = (struct afsconf_dir *)rock;
201 afs_int32 islocal = 0; /* default to no */
204 code = afsconf_IsLocalRealmMatch(dir, &islocal, name, inst, cell);
206 ViceLog(0, ("Failed local realm check; code=%d, name=%s, inst=%s, cell=%s\n",
207 code, name, inst, cell));
218 OPT_restrict_anonymous,
234 main(int argc, char **argv)
240 struct rx_service *tservice;
241 struct rx_securityClass **securityClasses;
242 afs_int32 numClasses;
244 char clones[MAXHOSTSPERCELL];
245 afs_uint32 host = htonl(INADDR_ANY);
246 struct cmd_syndesc *opts;
247 struct cmd_item *list;
252 char *whoami = "ptserver";
254 char *auditFileName = NULL;
255 char *interface = NULL;
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.
264 struct sigaction nsa;
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);
273 osi_audit(PTS_StartEvent, 0, AUD_END);
275 /* Initialize dirpaths */
276 if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
278 ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
280 fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
285 pr_dbaseName = strdup(AFSDIR_SERVER_PRDB_FILEPATH);
286 configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
287 logFile = strdup(AFSDIR_SERVER_PTLOG_FILEPATH);
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)) {
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);
303 cmd_DisableAbbreviations();
304 cmd_DisablePositionalCommands();
305 opts = cmd_CreateSyntax(NULL, NULL, NULL, NULL);
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");
312 cmd_AddParmAtOffset(opts, OPT_access, "-default_access", CMD_SINGLE,
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");
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");
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");
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");
353 cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals",
354 CMD_FLAG, CMD_OPTIONAL,
355 "permit Kerberos 5 principals with dots");
357 code = cmd_Parse(argc, argv, &opts);
358 if (code == CMD_HELP) {
364 cmd_OptionAsString(opts, OPT_config, &configDir);
366 cmd_OpenConfigFile(AFSDIR_SERVER_CONFIG_FILE_FILEPATH);
367 cmd_SetCommandName("ptserver");
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");
375 prp_group_default = prp_access_mask(list->next->data);
378 #if defined(SUPERGROUPS)
379 cmd_OptionAsInt(opts, OPT_groupdepth, &depthsg);
382 cmd_OptionAsFlag(opts, OPT_restricted, &restricted);
383 cmd_OptionAsFlag(opts, OPT_restrict_anonymous, &restrict_anonymous);
385 /* general server options */
386 cmd_OptionAsString(opts, OPT_auditlog, &auditFileName);
388 if (cmd_OptionAsString(opts, OPT_auditiface, &interface) == 0) {
389 if (osi_audit_interface(interface)) {
390 printf("Invalid audit interface '%s'\n", interface);
396 cmd_OptionAsInt(opts, OPT_debug, &LogLevel);
397 cmd_OptionAsString(opts, OPT_database, &pr_dbaseName);
398 cmd_OptionAsString(opts, OPT_logfile, &logFile);
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",
405 } else if (lwps < 3) { /* minimum of 3 */
406 printf("Warning: '-p %d' is too small; using %d instead\n",
413 if (cmd_OptionPresent(opts, OPT_syslog)) {
415 cmd_OptionAsInt(opts, OPT_syslog, &serverLogSyslogFacility);
420 if (cmd_OptionPresent(opts, OPT_peer))
421 rx_enablePeerRPCStats();
423 if (cmd_OptionPresent(opts, OPT_process))
424 rx_enableProcessRPCStats();
426 cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
428 cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU);
431 cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
433 cmd_FreeOptions(&opts);
436 osi_audit_file(auditFileName);
437 osi_audit(PTS_StartEvent, 0, AUD_END);
441 serverLogSyslogTag = "ptserver";
443 OpenLog(logFile); /* set up logging */
446 prdir = afsconf_Open(configDir);
448 fprintf(stderr, "ptserver: can't open configuration directory.\n");
451 if (afsconf_GetNoAuthFlag(prdir))
452 printf("ptserver: running unauthenticated\n");
455 /* initialize winsock */
456 if (afs_winsockInit() < 0) {
457 ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
459 fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
464 gethostname(hostname, sizeof(hostname));
465 th = gethostbyname(hostname);
467 fprintf(stderr, "ptserver: couldn't get address of this host.\n");
470 memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
472 /* get list of servers */
474 afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, clones);
476 afs_com_err(whoami, code, "Couldn't get server list");
480 /* initialize audit user check */
481 osi_audit_set_user_check(prdir, pr_IsLocalRealmMatch);
483 /* initialize ubik */
484 ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate, prdir);
485 ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
486 afsconf_CheckAuth, prdir);
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
496 ubik_nBuffers = 120 + /*fudge */ 40;
500 if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
501 AFSDIR_SERVER_NETINFO_FILEPATH) {
503 ccode = afsconf_ParseNetFiles(SHostAddrs, NULL, NULL,
504 ADDRSPERSITE, reason,
505 AFSDIR_SERVER_NETINFO_FILEPATH,
506 AFSDIR_SERVER_NETRESTRICT_FILEPATH);
509 ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
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
517 rx_InitHost(host, htons(AFSCONF_PROTPORT));
521 /* Disable jumbograms */
524 if (rxMaxMTU != -1) {
525 if (rx_SetMaxMTU(rxMaxMTU) != 0) {
526 printf("rxMaxMTU %d is invalid\n", rxMaxMTU);
532 ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
533 pr_dbaseName, &dbase);
535 afs_com_err(whoami, code, "Ubik init failed");
539 #if defined(SUPERGROUPS)
543 afsconf_BuildServerSecurityObjects(prdir, &securityClasses, &numClasses);
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");
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);
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");
566 rx_SetMinProcs(tservice, 2);
567 rx_SetMaxProcs(tservice, 4);
569 /* allow super users to manage RX statistics */
570 rx_SetRxStatUserOk(pr_rxstat_userok);
572 LogCommandLine(argc, argv, "ptserver",
573 #if defined(SUPERGROUPS)
578 "Starting AFS", FSLog);
579 if (afsconf_GetLatestKey(prdir, NULL, NULL) == 0) {
584 osi_audit(PTS_FinishEvent, -1, AUD_END);