Use AFS_PTR_FMT to format pointers
[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 *sc[3];
213     extern int RXSTATS_ExecuteRequest(struct rx_call *);
214 #if 0
215     struct ktc_encryptionKey tkey;
216 #endif
217     int kerberosKeys;           /* set if found some keys */
218     int lwps = 3;
219     char clones[MAXHOSTSPERCELL];
220     afs_uint32 host = htonl(INADDR_ANY);
221
222     const char *pr_dbaseName;
223     char *whoami = "ptserver";
224
225     int a;
226     char arg[100];
227
228 #ifdef  AFS_AIX32_ENV
229     /*
230      * The following signal action for AIX is necessary so that in case of a 
231      * crash (i.e. core is generated) we can include the user's data section 
232      * in the core dump. Unfortunately, by default, only a partial core is
233      * generated which, in many cases, isn't too useful.
234      */
235     struct sigaction nsa;
236
237     sigemptyset(&nsa.sa_mask);
238     nsa.sa_handler = SIG_DFL;
239     nsa.sa_flags = SA_FULLDUMP;
240     sigaction(SIGABRT, &nsa, NULL);
241     sigaction(SIGSEGV, &nsa, NULL);
242 #endif
243     osi_audit_init();
244     osi_audit(PTS_StartEvent, 0, AUD_END);
245
246     /* Initialize dirpaths */
247     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
248 #ifdef AFS_NT40_ENV
249         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
250 #endif
251         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
252                 argv[0]);
253         exit(2);
254     }
255
256     pr_dbaseName = AFSDIR_SERVER_PRDB_FILEPATH;
257
258 #if defined(SUPERGROUPS)
259     /* make sure the structures for database records are the same size */
260     if ((sizeof(struct prentry) != ENTRYSIZE)
261         || (sizeof(struct prentryg) != ENTRYSIZE)) {
262         fprintf(stderr,
263                 "The structures for the database records are different"
264                 " sizes\n" "struct prentry = %d\n" "struct prentryg = %d\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             char *fileName = argv[++a];
333
334             osi_audit_file(fileName);
335             osi_audit(PTS_StartEvent, 0, AUD_END);
336         }
337         else if (!strncmp(arg, "-rxmaxmtu", alen)) {
338             if ((a + 1) >= argc) {
339                 fprintf(stderr, "missing argument for -rxmaxmtu\n");
340                 PT_EXIT(1);
341             }
342             rxMaxMTU = atoi(argv[++a]);
343             if ((rxMaxMTU < RX_MIN_PACKET_SIZE) ||
344                  (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
345                 printf("rxMaxMTU %d invalid; must be between %d-%lu\n",
346                         rxMaxMTU, RX_MIN_PACKET_SIZE,
347                         RX_MAX_PACKET_DATA_SIZE);
348                 PT_EXIT(1);
349             }
350         } 
351         else if (*arg == '-') {
352             /* hack in help flag support */
353
354 #if defined(SUPERGROUPS)
355 #ifndef AFS_NT40_ENV
356             printf("Usage: ptserver [-database <db path>] "
357                    "[-auditlog <log path>] "
358                    "[-syslog[=FACILITY]] [-d <debug level>] "
359                    "[-p <number of processes>] [-rebuild] "
360                    "[-groupdepth <depth>] "
361                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
362                    "[-allow-dotted-principals] "
363                    "[-enable_peer_stats] [-enable_process_stats] "
364                    "[-default_access default_user_access default_group_access] "
365                    "[-help]\n");
366 #else /* AFS_NT40_ENV */
367             printf("Usage: ptserver [-database <db path>] "
368                    "[-auditlog <log path>] [-d <debug level>] "
369                    "[-p <number of processes>] [-rebuild] [-rxbind] "
370                    "[-allow-dotted-principals] "
371                    "[-default_access default_user_access default_group_access] "
372                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
373                    "[-groupdepth <depth>] " "[-help]\n");
374 #endif
375 #else
376 #ifndef AFS_NT40_ENV
377             printf("Usage: ptserver [-database <db path>] "
378                    "[-auditlog <log path>] [-d <debug level>] "
379                    "[-syslog[=FACILITY]] "
380                    "[-p <number of processes>] [-rebuild] "
381                    "[-enable_peer_stats] [-enable_process_stats] "
382                    "[-default_access default_user_access default_group_access] "
383                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
384                    "[-allow-dotted-principals] "
385                    "[-help]\n");
386 #else /* AFS_NT40_ENV */
387             printf("Usage: ptserver [-database <db path>] "
388                    "[-auditlog <log path>] [-d <debug level>] "
389                    "[-default_access default_user_access default_group_access] "
390                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
391                    "[-allow-dotted-principals] "
392                    "[-p <number of processes>] [-rebuild] " "[-help]\n");
393 #endif
394 #endif
395             fflush(stdout);
396
397             PT_EXIT(1);
398         }
399 #if defined(SUPERGROUPS)
400         else {
401             fprintf(stderr, "Unrecognized arg: '%s' ignored!\n", arg);
402         }
403 #endif
404     }
405
406 #ifndef AFS_NT40_ENV
407     serverLogSyslogTag = "ptserver";
408 #endif
409     OpenLog(AFSDIR_SERVER_PTLOG_FILEPATH);      /* set up logging */
410     SetupLogSignals();
411
412     prdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
413     if (!prdir) {
414         fprintf(stderr, "ptserver: can't open configuration directory.\n");
415         PT_EXIT(1);
416     }
417     if (afsconf_GetNoAuthFlag(prdir))
418         printf("ptserver: running unauthenticated\n");
419
420 #ifdef AFS_NT40_ENV
421     /* initialize winsock */
422     if (afs_winsockInit() < 0) {
423         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
424
425         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
426         PT_EXIT(1);
427     }
428 #endif
429     /* get this host */
430     gethostname(hostname, sizeof(hostname));
431     th = gethostbyname(hostname);
432     if (!th) {
433         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
434         PT_EXIT(1);
435     }
436     memcpy(&myHost, th->h_addr, sizeof(afs_int32));
437
438     /* get list of servers */
439     code =
440         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, &clones);
441     if (code) {
442         afs_com_err(whoami, code, "Couldn't get server list");
443         PT_EXIT(2);
444     }
445     pr_realmName = info.name;
446     pr_realmNameLen = strlen(pr_realmName);
447
448 #if 0
449     /* get keys */
450     code = afsconf_GetKey(prdir, 999, &tkey);
451     if (code) {
452         afs_com_err(whoami, code,
453                 "couldn't get bcrypt keys from key file, ignoring.");
454     }
455 #endif
456     {
457         afs_int32 kvno;         /* see if there is a KeyFile here */
458         struct ktc_encryptionKey key;
459         code = afsconf_GetLatestKey(prdir, &kvno, &key);
460         kerberosKeys = (code == 0);
461         if (!kerberosKeys)
462             printf
463                 ("ptserver: can't find any Kerberos keys, code = %d, ignoring\n",
464                  code);
465     }
466     if (kerberosKeys) {
467         /* initialize ubik */
468         ubik_CRXSecurityProc = afsconf_ClientAuth;
469         ubik_CRXSecurityRock = prdir;
470         ubik_SRXSecurityProc = afsconf_ServerAuth;
471         ubik_SRXSecurityRock = prdir;
472         ubik_CheckRXSecurityProc = afsconf_CheckAuth;
473         ubik_CheckRXSecurityRock = prdir;
474     }
475     /* The max needed is when deleting an entry.  A full CoEntry deletion
476      * required removal from 39 entries.  Each of which may refers to the entry
477      * being deleted in one of its CoEntries.  If a CoEntry is freed its
478      * predecessor CoEntry will be modified as well.  Any freed blocks also
479      * modifies the database header.  Counting the entry being deleted and its
480      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
481      * and the header are in separate Ubik buffers then 120 buffers may be
482      * required. */
483     ubik_nBuffers = 120 + /*fudge */ 40;
484
485     if (rxBind) {
486         afs_int32 ccode;
487         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH || 
488             AFSDIR_SERVER_NETINFO_FILEPATH) {
489             char reason[1024];
490             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
491                                            ADDRSPERSITE, reason,
492                                            AFSDIR_SERVER_NETINFO_FILEPATH,
493                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
494         } else 
495         {
496             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
497         }
498         if (ccode == 1) {
499             host = SHostAddrs[0];
500             /* the following call is idempotent so if/when it gets called
501              * again by the ubik init stuff, it doesn't really matter
502              * -- klm
503              */
504             rx_InitHost(host, htons(AFSCONF_PROTPORT));
505         }
506     }
507
508     code =
509         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
510                               pr_dbaseName, &dbase);
511     if (code) {
512         afs_com_err(whoami, code, "Ubik init failed");
513         PT_EXIT(2);
514     }
515 #if defined(SUPERGROUPS)
516     pt_hook_write();
517 #endif
518
519     sc[0] = rxnull_NewServerSecurityObject();
520     sc[1] = 0;
521     if (kerberosKeys) {
522         sc[2] = rxkad_NewServerSecurityObject(0, prdir, afsconf_GetKey, NULL);
523     } else
524         sc[2] = sc[0];
525
526     /* Disable jumbograms */
527     rx_SetNoJumbo();
528
529     if (rxMaxMTU != -1) {
530         rx_SetMaxMTU(rxMaxMTU);
531     }
532
533     tservice =
534         rx_NewServiceHost(host, 0, PRSRV, "Protection Server", sc, 3,
535                       PR_ExecuteRequest);
536     if (tservice == (struct rx_service *)0) {
537         fprintf(stderr, "ptserver: Could not create new rx service.\n");
538         PT_EXIT(3);
539     }
540     rx_SetMinProcs(tservice, 2);
541     rx_SetMaxProcs(tservice, lwps);
542     if (rxkadDisableDotCheck) {
543         rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
544                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
545     }
546
547     tservice =
548         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats", sc, 3,
549                       RXSTATS_ExecuteRequest);
550     if (tservice == (struct rx_service *)0) {
551         fprintf(stderr, "ptserver: Could not create new rx service.\n");
552         PT_EXIT(3);
553     }
554     rx_SetMinProcs(tservice, 2);
555     rx_SetMaxProcs(tservice, 4);
556
557     /* allow super users to manage RX statistics */
558     rx_SetRxStatUserOk(pr_rxstat_userok);
559
560     rx_StartServer(1);
561     osi_audit(PTS_FinishEvent, -1, AUD_END);
562     exit(0);
563 }