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