274265ce9eab8db1abb859097736f1fb48f9dea4
[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 #include "AFS_component_version_number.c"
169
170 /* check whether caller is authorized to manage RX statistics */
171 int
172 pr_rxstat_userok(call)
173      struct rx_call *call;
174 {
175     return afsconf_SuperUser(prdir, call, NULL);
176 }
177
178 int
179 main(int argc, char **argv)
180 {
181     register afs_int32 code;
182     afs_int32 myHost;
183     register struct hostent *th;
184     char hostname[64];
185     struct rx_service *tservice;
186     struct rx_securityClass *sc[3];
187     extern int RXSTATS_ExecuteRequest();
188     extern int PR_ExecuteRequest();
189 #if 0
190     struct ktc_encryptionKey tkey;
191 #endif
192     int kerberosKeys;           /* set if found some keys */
193     int lwps = 3;
194     char clones[MAXHOSTSPERCELL];
195
196     const char *pr_dbaseName;
197     char *whoami = "ptserver";
198
199     int a;
200     char arg[100];
201
202 #ifdef  AFS_AIX32_ENV
203     /*
204      * The following signal action for AIX is necessary so that in case of a 
205      * crash (i.e. core is generated) we can include the user's data section 
206      * in the core dump. Unfortunately, by default, only a partial core is
207      * generated which, in many cases, isn't too useful.
208      */
209     struct sigaction nsa;
210
211     sigemptyset(&nsa.sa_mask);
212     nsa.sa_handler = SIG_DFL;
213     nsa.sa_flags = SA_FULLDUMP;
214     sigaction(SIGABRT, &nsa, NULL);
215     sigaction(SIGSEGV, &nsa, NULL);
216 #endif
217     osi_audit(PTS_StartEvent, 0, AUD_END);
218
219     /* Initialize dirpaths */
220     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
221 #ifdef AFS_NT40_ENV
222         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
223 #endif
224         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
225                 argv[0]);
226         exit(2);
227     }
228
229     pr_dbaseName = AFSDIR_SERVER_PRDB_FILEPATH;
230
231 #if defined(SUPERGROUPS)
232     /* make sure the structures for database records are the same size */
233     if ((sizeof(struct prentry) != ENTRYSIZE)
234         || (sizeof(struct prentryg) != ENTRYSIZE)) {
235         fprintf(stderr,
236                 "The structures for the database records are different"
237                 " sizes\n" "struct prentry = %d\n" "struct prentryg = %d\n"
238                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
239                 sizeof(struct prentryg), ENTRYSIZE);
240         PT_EXIT(1);
241     }
242 #endif
243
244     for (a = 1; a < argc; a++) {
245         int alen;
246         lcstring(arg, argv[a], sizeof(arg));
247         alen = strlen(arg);
248         if ((strncmp(arg, "-database", alen) == 0)
249             || (strncmp(arg, "-db", alen) == 0)) {
250             pr_dbaseName = argv[++a];   /* specify a database */
251         } else if (strncmp(arg, "-p", alen) == 0) {
252             lwps = atoi(argv[++a]);
253             if (lwps > 16) {    /* maximum of 16 */
254                 printf("Warning: '-p %d' is too big; using %d instead\n",
255                        lwps, 16);
256                 lwps = 16;
257             } else if (lwps < 3) {      /* minimum of 3 */
258                 printf("Warning: '-p %d' is too small; using %d instead\n",
259                        lwps, 3);
260                 lwps = 3;
261             }
262         } else if (strncmp(arg, "-rebuild", alen) == 0) /* rebuildDB++ */
263             ;
264 #if defined(SUPERGROUPS)
265         else if ((strncmp(arg, "-groupdepth", alen) == 0)
266                  || (strncmp(arg, "-depth", alen) == 0)) {
267             depthsg = atoi(argv[++a]);  /* Max search depth for supergroups */
268         }
269 #endif
270         else if (strncmp(arg, "-enable_peer_stats", alen) == 0) {
271             rx_enablePeerRPCStats();
272         } else if (strncmp(arg, "-enable_process_stats", alen) == 0) {
273             rx_enableProcessRPCStats();
274         }
275 #ifndef AFS_NT40_ENV
276         else if (strncmp(arg, "-syslog", alen) == 0) {
277             /* set syslog logging flag */
278             serverLogSyslog = 1;
279         } else if (strncmp(arg, "-syslog=", MIN(8, alen)) == 0) {
280             serverLogSyslog = 1;
281             serverLogSyslogFacility = atoi(arg + 8);
282         }
283 #endif
284         else if (*arg == '-') {
285             /* hack in help flag support */
286
287 #if defined(SUPERGROUPS)
288 #ifndef AFS_NT40_ENV
289             printf("Usage: ptserver [-database <db path>] "
290                    "[-syslog[=FACILITY]] "
291                    "[-p <number of processes>] [-rebuild] "
292                    "[-groupdepth <depth>] "
293                    "[-enable_peer_stats] [-enable_process_stats] "
294                    "[-help]\n");
295 #else /* AFS_NT40_ENV */
296             printf("Usage: ptserver [-database <db path>] "
297                    "[-p <number of processes>] [-rebuild] "
298                    "[-groupdepth <depth>] " "[-help]\n");
299 #endif
300 #else
301 #ifndef AFS_NT40_ENV
302             printf("Usage: ptserver [-database <db path>] "
303                    "[-syslog[=FACILITY]] "
304                    "[-p <number of processes>] [-rebuild] "
305                    "[-enable_peer_stats] [-enable_process_stats] "
306                    "[-help]\n");
307 #else /* AFS_NT40_ENV */
308             printf("Usage: ptserver [-database <db path>] "
309                    "[-p <number of processes>] [-rebuild] " "[-help]\n");
310 #endif
311 #endif
312             fflush(stdout);
313
314             PT_EXIT(1);
315         }
316 #if defined(SUPERGROUPS)
317         else {
318             fprintf(stderr, "Unrecognized arg: '%s' ignored!\n", arg);
319         }
320 #endif
321     }
322
323 #ifndef AFS_NT40_ENV
324     serverLogSyslogTag = "ptserver";
325 #endif
326     OpenLog(AFSDIR_SERVER_PTLOG_FILEPATH);      /* set up logging */
327     SetupLogSignals();
328
329     prdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
330     if (!prdir) {
331         fprintf(stderr, "ptserver: can't open configuration directory.\n");
332         PT_EXIT(1);
333     }
334     if (afsconf_GetNoAuthFlag(prdir))
335         printf("ptserver: running unauthenticated\n");
336
337 #ifdef AFS_NT40_ENV
338     /* initialize winsock */
339     if (afs_winsockInit() < 0) {
340         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
341
342         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
343         PT_EXIT(1);
344     }
345 #endif
346     /* get this host */
347     gethostname(hostname, sizeof(hostname));
348     th = gethostbyname(hostname);
349     if (!th) {
350         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
351         PT_EXIT(1);
352     }
353     memcpy(&myHost, th->h_addr, sizeof(afs_int32));
354
355     /* get list of servers */
356     code =
357         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, &clones);
358     if (code) {
359         com_err(whoami, code, "Couldn't get server list");
360         PT_EXIT(2);
361     }
362     pr_realmName = info.name;
363     pr_realmNameLen = strlen(pr_realmName);
364
365 #if 0
366     /* get keys */
367     code = afsconf_GetKey(prdir, 999, &tkey);
368     if (code) {
369         com_err(whoami, code,
370                 "couldn't get bcrypt keys from key file, ignoring.");
371     }
372 #endif
373     {
374         afs_int32 kvno;         /* see if there is a KeyFile here */
375         struct ktc_encryptionKey key;
376         code = afsconf_GetLatestKey(prdir, &kvno, &key);
377         kerberosKeys = (code == 0);
378         if (!kerberosKeys)
379             printf
380                 ("ptserver: can't find any Kerberos keys, code = %d, ignoring\n",
381                  code);
382     }
383     if (kerberosKeys) {
384         /* initialize ubik */
385         ubik_CRXSecurityProc = afsconf_ClientAuth;
386         ubik_CRXSecurityRock = (char *)prdir;
387         ubik_SRXSecurityProc = afsconf_ServerAuth;
388         ubik_SRXSecurityRock = (char *)prdir;
389         ubik_CheckRXSecurityProc = afsconf_CheckAuth;
390         ubik_CheckRXSecurityRock = (char *)prdir;
391     }
392     /* The max needed is when deleting an entry.  A full CoEntry deletion
393      * required removal from 39 entries.  Each of which may refers to the entry
394      * being deleted in one of its CoEntries.  If a CoEntry is freed its
395      * predecessor CoEntry will be modified as well.  Any freed blocks also
396      * modifies the database header.  Counting the entry being deleted and its
397      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
398      * and the header are in separate Ubik buffers then 120 buffers may be
399      * required. */
400     ubik_nBuffers = 120 + /*fudge */ 40;
401     code =
402         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, &clones,
403                               pr_dbaseName, &dbase);
404     if (code) {
405         com_err(whoami, code, "Ubik init failed");
406         PT_EXIT(2);
407     }
408 #if defined(SUPERGROUPS)
409     pt_hook_write();
410 #endif
411
412     sc[0] = rxnull_NewServerSecurityObject();
413     sc[1] = 0;
414     if (kerberosKeys) {
415         sc[2] = rxkad_NewServerSecurityObject(0, prdir, afsconf_GetKey, NULL);
416     } else
417         sc[2] = sc[0];
418
419     /* Disable jumbograms */
420     rx_SetNoJumbo();
421
422     tservice =
423         rx_NewService(0, PRSRV, "Protection Server", sc, 3,
424                       PR_ExecuteRequest);
425     if (tservice == (struct rx_service *)0) {
426         fprintf(stderr, "ptserver: Could not create new rx service.\n");
427         PT_EXIT(3);
428     }
429     rx_SetMinProcs(tservice, 2);
430     rx_SetMaxProcs(tservice, lwps);
431
432     tservice =
433         rx_NewService(0, RX_STATS_SERVICE_ID, "rpcstats", sc, 3,
434                       RXSTATS_ExecuteRequest);
435     if (tservice == (struct rx_service *)0) {
436         fprintf(stderr, "ptserver: Could not create new rx service.\n");
437         PT_EXIT(3);
438     }
439     rx_SetMinProcs(tservice, 2);
440     rx_SetMaxProcs(tservice, 4);
441
442     /* allow super users to manage RX statistics */
443     rx_SetRxStatUserOk(pr_rxstat_userok);
444
445     rx_StartServer(1);
446     osi_audit(PTS_FinishEvent, -1, AUD_END);
447     exit(0);
448 }