3d797b4cddeb688cef8e810329149fc2f14f4a45
[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 #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 #ifdef HAVE_STRING_H
131 #include <string.h>
132 #else
133 #ifdef HAVE_STRINGS_H
134 #include <strings.h>
135 #endif
136 #endif
137 #include <rx/xdr.h>
138 #include <rx/rx.h>
139 #include <rx/rx_globals.h>
140 #include <lock.h>
141 #include <ubik.h>
142 #include <afs/cellconfig.h>
143 #include <afs/auth.h>
144 #include <afs/keys.h>
145 #include "ptserver.h"
146 #include "error_macros.h"
147 #include "afs/audit.h"
148 #include <afs/afsutil.h>
149
150
151 /* make all of these into a structure if you want */
152 struct prheader cheader;
153 struct ubik_dbase *dbase;
154 struct afsconf_dir *prdir;
155
156 #if defined(SUPERGROUPS)
157 extern afs_int32 depthsg;
158 #endif
159
160 extern int afsconf_ServerAuth();
161 extern int afsconf_CheckAuth();
162
163 int pr_realmNameLen;
164 char *pr_realmName;
165
166 static struct afsconf_cell info;
167
168 extern int prp_group_default;
169 extern int prp_user_default;
170
171 #include "AFS_component_version_number.c"
172
173 int
174 prp_access_mask(s)
175     char *s;
176 {
177     int r;
178     if (*s >= '0' && *s <= '9') {
179         return strtol(s, NULL, 0);
180     }
181     r = 0;
182     while (*s) switch(*s++)
183     {
184     case 'S':   r |= PRP_STATUS_ANY; break;
185     case 's':   r |= PRP_STATUS_MEM; break;
186     case 'O':   r |= PRP_OWNED_ANY; break;
187     case 'M':   r |= PRP_MEMBER_ANY; break;
188     case 'm':   r |= PRP_MEMBER_MEM; break;
189     case 'A':   r |= PRP_ADD_ANY; break;
190     case 'a':   r |= PRP_ADD_MEM; break;
191     case 'r':   r |= PRP_REMOVE_MEM; break;
192     }
193     return r;
194 }
195
196 /* check whether caller is authorized to manage RX statistics */
197 int
198 pr_rxstat_userok(struct rx_call *call)
199 {
200     return afsconf_SuperUser(prdir, call, NULL);
201 }
202
203 int
204 main(int argc, char **argv)
205 {
206     register afs_int32 code;
207     afs_int32 myHost;
208     register struct hostent *th;
209     char hostname[64];
210     struct rx_service *tservice;
211     struct rx_securityClass *sc[3];
212     extern int RXSTATS_ExecuteRequest();
213     extern int PR_ExecuteRequest();
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
221     const char *pr_dbaseName;
222     char *whoami = "ptserver";
223
224     int a;
225     char arg[100];
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(PTS_StartEvent, 0, AUD_END);
243
244     /* Initialize dirpaths */
245     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
246 #ifdef AFS_NT40_ENV
247         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
248 #endif
249         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
250                 argv[0]);
251         exit(2);
252     }
253
254     pr_dbaseName = AFSDIR_SERVER_PRDB_FILEPATH;
255
256 #if defined(SUPERGROUPS)
257     /* make sure the structures for database records are the same size */
258     if ((sizeof(struct prentry) != ENTRYSIZE)
259         || (sizeof(struct prentryg) != ENTRYSIZE)) {
260         fprintf(stderr,
261                 "The structures for the database records are different"
262                 " sizes\n" "struct prentry = %d\n" "struct prentryg = %d\n"
263                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
264                 sizeof(struct prentryg), ENTRYSIZE);
265         PT_EXIT(1);
266     }
267 #endif
268
269     for (a = 1; a < argc; a++) {
270         int alen;
271         lcstring(arg, argv[a], sizeof(arg));
272         alen = strlen(arg);
273         if ((strncmp(arg, "-database", alen) == 0)
274             || (strncmp(arg, "-db", alen) == 0)) {
275             pr_dbaseName = argv[++a];   /* specify a database */
276         } else if (strncmp(arg, "-p", alen) == 0) {
277             lwps = atoi(argv[++a]);
278             if (lwps > 16) {    /* maximum of 16 */
279                 printf("Warning: '-p %d' is too big; using %d instead\n",
280                        lwps, 16);
281                 lwps = 16;
282             } else if (lwps < 3) {      /* minimum of 3 */
283                 printf("Warning: '-p %d' is too small; using %d instead\n",
284                        lwps, 3);
285                 lwps = 3;
286             }
287         } else if (strncmp(arg, "-rebuild", alen) == 0) /* rebuildDB++ */
288             ;
289 #if defined(SUPERGROUPS)
290         else if ((strncmp(arg, "-groupdepth", alen) == 0)
291                  || (strncmp(arg, "-depth", alen) == 0)) {
292             depthsg = atoi(argv[++a]);  /* Max search depth for supergroups */
293         }
294 #endif
295         else if (strncmp(arg, "-default_access", alen) == 0) {
296             prp_user_default = prp_access_mask(argv[++a]);
297             prp_group_default = prp_access_mask(argv[++a]);
298         }
299         else if (strncmp(arg, "-enable_peer_stats", alen) == 0) {
300             rx_enablePeerRPCStats();
301         } else if (strncmp(arg, "-enable_process_stats", alen) == 0) {
302             rx_enableProcessRPCStats();
303         }
304 #ifndef AFS_NT40_ENV
305         else if (strncmp(arg, "-syslog", alen) == 0) {
306             /* set syslog logging flag */
307             serverLogSyslog = 1;
308         } else if (strncmp(arg, "-syslog=", MIN(8, alen)) == 0) {
309             serverLogSyslog = 1;
310             serverLogSyslogFacility = atoi(arg + 8);
311         }
312 #endif
313         else if (*arg == '-') {
314             /* hack in help flag support */
315
316 #if defined(SUPERGROUPS)
317 #ifndef AFS_NT40_ENV
318             printf("Usage: ptserver [-database <db path>] "
319                    "[-syslog[=FACILITY]] "
320                    "[-p <number of processes>] [-rebuild] "
321                    "[-groupdepth <depth>] "
322                    "[-enable_peer_stats] [-enable_process_stats] "
323                    "[-default_access default_user_access default_group_access] "
324                    "[-help]\n");
325 #else /* AFS_NT40_ENV */
326             printf("Usage: ptserver [-database <db path>] "
327                    "[-p <number of processes>] [-rebuild] "
328                    "[-default_access default_user_access default_group_access] "
329                    "[-groupdepth <depth>] " "[-help]\n");
330 #endif
331 #else
332 #ifndef AFS_NT40_ENV
333             printf("Usage: ptserver [-database <db path>] "
334                    "[-syslog[=FACILITY]] "
335                    "[-p <number of processes>] [-rebuild] "
336                    "[-enable_peer_stats] [-enable_process_stats] "
337                    "[-default_access default_user_access default_group_access] "
338                    "[-help]\n");
339 #else /* AFS_NT40_ENV */
340             printf("Usage: ptserver [-database <db path>] "
341                    "[-default_access default_user_access default_group_access] "
342                    "[-p <number of processes>] [-rebuild] " "[-help]\n");
343 #endif
344 #endif
345             fflush(stdout);
346
347             PT_EXIT(1);
348         }
349 #if defined(SUPERGROUPS)
350         else {
351             fprintf(stderr, "Unrecognized arg: '%s' ignored!\n", arg);
352         }
353 #endif
354     }
355
356 #ifndef AFS_NT40_ENV
357     serverLogSyslogTag = "ptserver";
358 #endif
359     OpenLog(AFSDIR_SERVER_PTLOG_FILEPATH);      /* set up logging */
360     SetupLogSignals();
361
362     prdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
363     if (!prdir) {
364         fprintf(stderr, "ptserver: can't open configuration directory.\n");
365         PT_EXIT(1);
366     }
367     if (afsconf_GetNoAuthFlag(prdir))
368         printf("ptserver: running unauthenticated\n");
369
370 #ifdef AFS_NT40_ENV
371     /* initialize winsock */
372     if (afs_winsockInit() < 0) {
373         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
374
375         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
376         PT_EXIT(1);
377     }
378 #endif
379     /* get this host */
380     gethostname(hostname, sizeof(hostname));
381     th = gethostbyname(hostname);
382     if (!th) {
383         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
384         PT_EXIT(1);
385     }
386     memcpy(&myHost, th->h_addr, sizeof(afs_int32));
387
388     /* get list of servers */
389     code =
390         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, &clones);
391     if (code) {
392         com_err(whoami, code, "Couldn't get server list");
393         PT_EXIT(2);
394     }
395     pr_realmName = info.name;
396     pr_realmNameLen = strlen(pr_realmName);
397
398 #if 0
399     /* get keys */
400     code = afsconf_GetKey(prdir, 999, &tkey);
401     if (code) {
402         com_err(whoami, code,
403                 "couldn't get bcrypt keys from key file, ignoring.");
404     }
405 #endif
406     {
407         afs_int32 kvno;         /* see if there is a KeyFile here */
408         struct ktc_encryptionKey key;
409         code = afsconf_GetLatestKey(prdir, &kvno, &key);
410         kerberosKeys = (code == 0);
411         if (!kerberosKeys)
412             printf
413                 ("ptserver: can't find any Kerberos keys, code = %d, ignoring\n",
414                  code);
415     }
416     if (kerberosKeys) {
417         /* initialize ubik */
418         ubik_CRXSecurityProc = afsconf_ClientAuth;
419         ubik_CRXSecurityRock = (char *)prdir;
420         ubik_SRXSecurityProc = afsconf_ServerAuth;
421         ubik_SRXSecurityRock = (char *)prdir;
422         ubik_CheckRXSecurityProc = afsconf_CheckAuth;
423         ubik_CheckRXSecurityRock = (char *)prdir;
424     }
425     /* The max needed is when deleting an entry.  A full CoEntry deletion
426      * required removal from 39 entries.  Each of which may refers to the entry
427      * being deleted in one of its CoEntries.  If a CoEntry is freed its
428      * predecessor CoEntry will be modified as well.  Any freed blocks also
429      * modifies the database header.  Counting the entry being deleted and its
430      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
431      * and the header are in separate Ubik buffers then 120 buffers may be
432      * required. */
433     ubik_nBuffers = 120 + /*fudge */ 40;
434     code =
435         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, &clones,
436                               pr_dbaseName, &dbase);
437     if (code) {
438         com_err(whoami, code, "Ubik init failed");
439         PT_EXIT(2);
440     }
441 #if defined(SUPERGROUPS)
442     pt_hook_write();
443 #endif
444
445     sc[0] = rxnull_NewServerSecurityObject();
446     sc[1] = 0;
447     if (kerberosKeys) {
448         sc[2] = rxkad_NewServerSecurityObject(0, prdir, afsconf_GetKey, NULL);
449     } else
450         sc[2] = sc[0];
451
452     /* Disable jumbograms */
453     rx_SetNoJumbo();
454
455     tservice =
456         rx_NewService(0, PRSRV, "Protection Server", sc, 3,
457                       PR_ExecuteRequest);
458     if (tservice == (struct rx_service *)0) {
459         fprintf(stderr, "ptserver: Could not create new rx service.\n");
460         PT_EXIT(3);
461     }
462     rx_SetMinProcs(tservice, 2);
463     rx_SetMaxProcs(tservice, lwps);
464
465     tservice =
466         rx_NewService(0, RX_STATS_SERVICE_ID, "rpcstats", sc, 3,
467                       RXSTATS_ExecuteRequest);
468     if (tservice == (struct rx_service *)0) {
469         fprintf(stderr, "ptserver: Could not create new rx service.\n");
470         PT_EXIT(3);
471     }
472     rx_SetMinProcs(tservice, 2);
473     rx_SetMaxProcs(tservice, 4);
474
475     /* allow super users to manage RX statistics */
476     rx_SetRxStatUserOk(pr_rxstat_userok);
477
478     rx_StartServer(1);
479     osi_audit(PTS_FinishEvent, -1, AUD_END);
480     exit(0);
481 }