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