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