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;
154 int rxkadDisableDotCheck = 0;
156 #define ADDRSPERSITE 16 /* Same global is in rx/rx_user.c */
157 afs_uint32 SHostAddrs[ADDRSPERSITE];
159 static struct afsconf_cell info;
161 extern int prp_group_default;
162 extern int prp_user_default;
164 #include "AFS_component_version_number.c"
167 prp_access_mask(char *s)
170 if (*s >= '0' && *s <= '9') {
171 return strtol(s, NULL, 0);
174 while (*s) switch(*s++)
176 case 'S': r |= PRP_STATUS_ANY; break;
177 case 's': r |= PRP_STATUS_MEM; break;
178 case 'O': r |= PRP_OWNED_ANY; break;
179 case 'M': r |= PRP_MEMBER_ANY; break;
180 case 'm': r |= PRP_MEMBER_MEM; break;
181 case 'A': r |= PRP_ADD_ANY; break;
182 case 'a': r |= PRP_ADD_MEM; break;
183 case 'r': r |= PRP_REMOVE_MEM; break;
188 /* check whether caller is authorized to manage RX statistics */
190 pr_rxstat_userok(struct rx_call *call)
192 return afsconf_SuperUser(prdir, call, NULL);
215 main(int argc, char **argv)
221 struct rx_service *tservice;
222 struct rx_securityClass **securityClasses;
223 afs_int32 numClasses;
225 char clones[MAXHOSTSPERCELL];
226 afs_uint32 host = htonl(INADDR_ANY);
227 struct cmd_syndesc *opts;
228 struct cmd_item *list;
233 char *whoami = "ptserver";
235 char *auditFileName = NULL;
236 char *interface = NULL;
240 * The following signal action for AIX is necessary so that in case of a
241 * crash (i.e. core is generated) we can include the user's data section
242 * in the core dump. Unfortunately, by default, only a partial core is
243 * generated which, in many cases, isn't too useful.
245 struct sigaction nsa;
247 sigemptyset(&nsa.sa_mask);
248 nsa.sa_handler = SIG_DFL;
249 nsa.sa_flags = SA_FULLDUMP;
250 sigaction(SIGABRT, &nsa, NULL);
251 sigaction(SIGSEGV, &nsa, NULL);
254 osi_audit(PTS_StartEvent, 0, AUD_END);
256 /* Initialize dirpaths */
257 if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
259 ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
261 fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
266 pr_dbaseName = strdup(AFSDIR_SERVER_PRDB_FILEPATH);
267 configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
268 logFile = strdup(AFSDIR_SERVER_PTLOG_FILEPATH);
270 #if defined(SUPERGROUPS)
271 /* make sure the structures for database records are the same size */
272 if ((sizeof(struct prentry) != ENTRYSIZE)
273 || (sizeof(struct prentryg) != ENTRYSIZE)) {
275 "The structures for the database records are different"
276 " sizes\n" "struct prentry = %" AFS_SIZET_FMT "\n"
277 "struct prentryg = %" AFS_SIZET_FMT "\n"
278 "ENTRYSIZE = %d\n", sizeof(struct prentry),
279 sizeof(struct prentryg), ENTRYSIZE);
284 cmd_DisableAbbreviations();
285 cmd_DisablePositionalCommands();
286 opts = cmd_CreateSyntax(NULL, NULL, NULL, NULL);
288 /* ptserver specific options */
289 cmd_AddParmAtOffset(opts, OPT_database, "-database", CMD_SINGLE,
290 CMD_OPTIONAL, "database file");
291 cmd_AddParmAlias(opts, OPT_database, "db");
293 cmd_AddParmAtOffset(opts, OPT_access, "-default_access", CMD_SINGLE,
294 CMD_OPTIONAL, "default access flags for new entries");
295 #if defined(SUPERGROUPS)
296 cmd_AddParmAtOffset(opts, OPT_groupdepth, "-groupdepth", CMD_SINGLE,
297 CMD_OPTIONAL, "max search depth for supergroups");
298 cmd_AddParmAlias(opts, OPT_groupdepth, "depth");
300 cmd_AddParmAtOffset(opts, OPT_restricted, "-restricted", CMD_FLAG,
301 CMD_OPTIONAL, "enable restricted mode");
303 /* general server options */
304 cmd_AddParmAtOffset(opts, OPT_auditlog, "-auditlog", CMD_SINGLE,
305 CMD_OPTIONAL, "location of audit log");
306 cmd_AddParmAtOffset(opts, OPT_auditiface, "-audit-interface", CMD_SINGLE,
307 CMD_OPTIONAL, "interface to use for audit logging");
308 cmd_AddParmAtOffset(opts, OPT_config, "-config", CMD_SINGLE,
309 CMD_OPTIONAL, "configuration location");
310 cmd_AddParmAtOffset(opts, OPT_debug, "-d", CMD_SINGLE,
311 CMD_OPTIONAL, "debug level");
312 cmd_AddParmAtOffset(opts, OPT_logfile, "-logfile", CMD_SINGLE,
313 CMD_OPTIONAL, "location of logfile");
314 cmd_AddParmAtOffset(opts, OPT_threads, "-p", CMD_SINGLE,
315 CMD_OPTIONAL, "number of threads");
316 #if !defined(AFS_NT40_ENV)
317 cmd_AddParmAtOffset(opts, OPT_syslog, "-syslog", CMD_SINGLE_OR_FLAG,
318 CMD_OPTIONAL, "log to syslog");
322 cmd_AddParmAtOffset(opts, OPT_peer, "-enable_peer_stats", CMD_FLAG,
323 CMD_OPTIONAL, "enable RX transport statistics");
324 cmd_AddParmAtOffset(opts, OPT_process, "-enable_process_stats", CMD_FLAG,
325 CMD_OPTIONAL, "enable RX RPC statistics");
326 cmd_AddParmAtOffset(opts, OPT_rxbind, "-rxbind", CMD_FLAG,
327 CMD_OPTIONAL, "bind only to the primary interface");
328 cmd_AddParmAtOffset(opts, OPT_rxmaxmtu, "-rxmaxmtu", CMD_SINGLE,
329 CMD_OPTIONAL, "maximum MTU for RX");
332 cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals",
333 CMD_FLAG, CMD_OPTIONAL,
334 "permit Kerberos 5 principals with dots");
336 code = cmd_Parse(argc, argv, &opts);
340 if (cmd_OptionAsList(opts, OPT_access, &list) == 0) {
341 prp_user_default = prp_access_mask(list->data);
342 if (list->next == NULL || list->next->data == NULL) {
343 fprintf(stderr, "Missing second argument for -default_access\n");
346 prp_group_default = prp_access_mask(list->next->data);
349 #if defined(SUPERGROUPS)
350 cmd_OptionAsInt(opts, OPT_groupdepth, &depthsg);
353 cmd_OptionAsFlag(opts, OPT_restricted, &restricted);
355 /* general server options */
356 cmd_OptionAsString(opts, OPT_auditlog, &auditFileName);
358 if (cmd_OptionAsString(opts, OPT_auditiface, &interface) == 0) {
359 if (osi_audit_interface(interface)) {
360 printf("Invalid audit interface '%s'\n", interface);
366 cmd_OptionAsString(opts, OPT_config, &configDir);
367 cmd_OptionAsInt(opts, OPT_debug, &LogLevel);
368 cmd_OptionAsString(opts, OPT_database, &pr_dbaseName);
369 cmd_OptionAsString(opts, OPT_logfile, &logFile);
371 if (cmd_OptionAsInt(opts, OPT_threads, &lwps) == 0) {
372 if (lwps > 16) { /* maximum of 16 */
373 printf("Warning: '-p %d' is too big; using %d instead\n",
376 } else if (lwps < 3) { /* minimum of 3 */
377 printf("Warning: '-p %d' is too small; using %d instead\n",
384 if (cmd_OptionPresent(opts, OPT_syslog)) {
386 cmd_OptionAsInt(opts, OPT_syslog, &serverLogSyslogFacility);
391 if (cmd_OptionPresent(opts, OPT_peer))
392 rx_enablePeerRPCStats();
394 if (cmd_OptionPresent(opts, OPT_process))
395 rx_enableProcessRPCStats();
397 cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
399 cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU);
402 cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
404 cmd_FreeOptions(&opts);
407 osi_audit_file(auditFileName);
408 osi_audit(PTS_StartEvent, 0, AUD_END);
412 serverLogSyslogTag = "ptserver";
414 OpenLog(logFile); /* set up logging */
417 prdir = afsconf_Open(configDir);
419 fprintf(stderr, "ptserver: can't open configuration directory.\n");
422 if (afsconf_GetNoAuthFlag(prdir))
423 printf("ptserver: running unauthenticated\n");
426 /* initialize winsock */
427 if (afs_winsockInit() < 0) {
428 ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
430 fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
435 gethostname(hostname, sizeof(hostname));
436 th = gethostbyname(hostname);
438 fprintf(stderr, "ptserver: couldn't get address of this host.\n");
441 memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
443 /* get list of servers */
445 afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, clones);
447 afs_com_err(whoami, code, "Couldn't get server list");
450 pr_realmName = info.name;
452 /* initialize ubik */
453 ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate, prdir);
454 ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
455 afsconf_CheckAuth, prdir);
457 /* The max needed is when deleting an entry. A full CoEntry deletion
458 * required removal from 39 entries. Each of which may refers to the entry
459 * being deleted in one of its CoEntries. If a CoEntry is freed its
460 * predecessor CoEntry will be modified as well. Any freed blocks also
461 * modifies the database header. Counting the entry being deleted and its
462 * CoEntry this adds up to as much as 1+1+39*3 = 119. If all these entries
463 * and the header are in separate Ubik buffers then 120 buffers may be
465 ubik_nBuffers = 120 + /*fudge */ 40;
469 if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
470 AFSDIR_SERVER_NETINFO_FILEPATH) {
472 ccode = parseNetFiles(SHostAddrs, NULL, NULL,
473 ADDRSPERSITE, reason,
474 AFSDIR_SERVER_NETINFO_FILEPATH,
475 AFSDIR_SERVER_NETRESTRICT_FILEPATH);
478 ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
481 host = SHostAddrs[0];
482 /* the following call is idempotent so if/when it gets called
483 * again by the ubik init stuff, it doesn't really matter
486 rx_InitHost(host, htons(AFSCONF_PROTPORT));
491 ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
492 pr_dbaseName, &dbase);
494 afs_com_err(whoami, code, "Ubik init failed");
498 #if defined(SUPERGROUPS)
502 afsconf_BuildServerSecurityObjects(prdir, &securityClasses, &numClasses);
504 /* Disable jumbograms */
507 if (rxMaxMTU != -1) {
508 if (rx_SetMaxMTU(rxMaxMTU) != 0) {
509 printf("rxMaxMTU %d is invalid\n", rxMaxMTU);
515 rx_NewServiceHost(host, 0, PRSRV, "Protection Server", securityClasses,
516 numClasses, PR_ExecuteRequest);
517 if (tservice == (struct rx_service *)0) {
518 fprintf(stderr, "ptserver: Could not create new rx service.\n");
521 rx_SetMinProcs(tservice, 2);
522 rx_SetMaxProcs(tservice, lwps);
523 if (rxkadDisableDotCheck) {
524 rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
525 (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
529 rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
530 securityClasses, numClasses, RXSTATS_ExecuteRequest);
531 if (tservice == (struct rx_service *)0) {
532 fprintf(stderr, "ptserver: Could not create new rx service.\n");
535 rx_SetMinProcs(tservice, 2);
536 rx_SetMaxProcs(tservice, 4);
538 /* allow super users to manage RX statistics */
539 rx_SetRxStatUserOk(pr_rxstat_userok);
541 LogCommandLine(argc, argv, "ptserver",
542 #if defined(SUPERGROUPS)
547 "Starting AFS", FSLog);
550 osi_audit(PTS_FinishEvent, -1, AUD_END);