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