Add rxgk client options to vl and pt utilities
[openafs.git] / src / vlserver / vlserver.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 #include <afsconfig.h>
11 #include <afs/param.h>
12 #include <afs/stds.h>
13
14 #include <roken.h>
15 #ifdef AFS_PTHREAD_ENV
16 # include <opr/softsig.h>
17 # include <afs/procmgmt_softsig.h> /* must come after softsig.h */
18 #endif
19
20 #ifdef AFS_NT40_ENV
21 #include <WINNT/afsevent.h>
22 #endif
23
24 #ifdef HAVE_SYS_FILE_H
25 #include <sys/file.h>
26 #endif
27
28 #include <rx/xdr.h>
29 #include <rx/rx.h>
30 #include <rx/rx_globals.h>
31 #include <rx/rxstat.h>
32 #include <afs/cmd.h>
33 #include <afs/cellconfig.h>
34 #include <afs/keys.h>
35 #include <afs/auth.h>
36 #include <afs/audit.h>
37 #include <afs/com_err.h>
38 #include <lock.h>
39 #include <ubik.h>
40 #include <afs/afsutil.h>
41
42 #include "vlserver.h"
43 #include "vlserver_internal.h"
44
45 #define MAXLWP 64
46 struct afsconf_dir *vldb_confdir = 0;   /* vldb configuration dir */
47 int lwps = 9;
48
49 struct vldstats dynamic_statistics;
50 struct ubik_dbase *VL_dbase;
51 afs_uint32 rd_HostAddress[MAXSERVERID + 1];
52 afs_uint32 wr_HostAddress[MAXSERVERID + 1];
53
54 static void *CheckSignal(void*);
55 int smallMem = 0;
56 int restrictedQueryLevel = RESTRICTED_QUERY_ANYUSER;
57 int rxJumbograms = 0;           /* default is to not send and receive jumbo grams */
58 int rxMaxMTU = -1;
59 afs_int32 rxBind = 0;
60 int rxkadDisableDotCheck = 0;
61
62 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
63 afs_uint32 SHostAddrs[ADDRSPERSITE];
64
65 static void
66 CheckSignal_Signal(int unused)
67 {
68 #if defined(AFS_PTHREAD_ENV)
69     CheckSignal(0);
70 #else
71     IOMGR_SoftSig(CheckSignal, 0);
72 #endif
73 }
74
75 static void *
76 CheckSignal(void *unused)
77 {
78     int i, errorcode;
79     struct vl_ctx ctx;
80
81     if ((errorcode =
82         Init_VLdbase(&ctx, LOCKREAD, VLGETSTATS - VL_LOWEST_OPCODE)))
83         return (void *)(intptr_t)errorcode;
84     VLog(0, ("Dump name hash table out\n"));
85     for (i = 0; i < HASHSIZE; i++) {
86         HashNDump(&ctx, i);
87     }
88     VLog(0, ("Dump id hash table out\n"));
89     for (i = 0; i < HASHSIZE; i++) {
90         HashIdDump(&ctx, i);
91     }
92     return ((void *)(intptr_t)ubik_EndTrans(ctx.trans));
93 }                               /*CheckSignal */
94
95
96 /* Initialize the stats for the opcodes */
97 void
98 initialize_dstats(void)
99 {
100     int i;
101
102     dynamic_statistics.start_time = (afs_uint32) time(0);
103     for (i = 0; i < MAX_NUMBER_OPCODES; i++) {
104         dynamic_statistics.requests[i] = 0;
105         dynamic_statistics.aborts[i] = 0;
106     }
107 }
108
109 /* check whether caller is authorized to manage RX statistics */
110 int
111 vldb_rxstat_userok(struct rx_call *call)
112 {
113     return afsconf_SuperUser(vldb_confdir, call, NULL);
114 }
115
116 /**
117  * Return true if this name is a member of the local realm.
118  */
119 int
120 vldb_IsLocalRealmMatch(void *rock, char *name, char *inst, char *cell)
121 {
122     struct afsconf_dir *dir = (struct afsconf_dir *)rock;
123     afs_int32 islocal = 0;      /* default to no */
124     int code;
125
126     code = afsconf_IsLocalRealmMatch(dir, &islocal, name, inst, cell);
127     if (code) {
128         VLog(0,
129                 ("Failed local realm check; code=%d, name=%s, inst=%s, cell=%s\n",
130                  code, name, inst, cell));
131     }
132     return islocal;
133 }
134
135 /* Main server module */
136
137 #include "AFS_component_version_number.c"
138
139 enum optionsList {
140     OPT_noauth,
141     OPT_smallmem,
142     OPT_auditlog,
143     OPT_auditiface,
144     OPT_config,
145     OPT_debug,
146     OPT_database,
147     OPT_logfile,
148     OPT_threads,
149 #ifdef HAVE_SYSLOG
150     OPT_syslog,
151 #endif
152     OPT_peer,
153     OPT_process,
154     OPT_nojumbo,
155     OPT_jumbo,
156     OPT_rxbind,
157     OPT_rxmaxmtu,
158     OPT_trace,
159     OPT_dotted,
160     OPT_restricted_query,
161     OPT_transarc_logs,
162     OPT_s2s_crypt
163 };
164
165 int
166 main(int argc, char **argv)
167 {
168     afs_int32 code;
169     afs_uint32 myHost;
170     struct rx_service *tservice;
171     struct rx_securityClass **securityClasses;
172     afs_int32 numClasses;
173     struct afsconf_dir *tdir;
174     struct ktc_encryptionKey tkey;
175     struct afsconf_cell info;
176     struct hostent *th;
177     char hostname[VL_MAXNAMELEN];
178     int noAuth = 0;
179     char clones[MAXHOSTSPERCELL];
180     char hoststr[16];
181     afs_uint32 host = ntohl(INADDR_ANY);
182     struct cmd_syndesc *opts;
183     struct logOptions logopts;
184     int s2s_rxgk = 0;
185
186     char *vl_dbaseName;
187     char *configDir;
188
189     char *auditFileName = NULL;
190     char *interface = NULL;
191     char *optstring = NULL;
192     char *s2s_crypt_behavior = NULL;
193
194     char *restricted_query_parameter = NULL;
195
196 #ifdef  AFS_AIX32_ENV
197     /*
198      * The following signal action for AIX is necessary so that in case of a
199      * crash (i.e. core is generated) we can include the user's data section
200      * in the core dump. Unfortunately, by default, only a partial core is
201      * generated which, in many cases, isn't too useful.
202      */
203     struct sigaction nsa;
204
205     rx_extraPackets = 100;      /* should be a switch, I guess... */
206     sigemptyset(&nsa.sa_mask);
207     nsa.sa_handler = SIG_DFL;
208     nsa.sa_flags = SA_FULLDUMP;
209     sigaction(SIGABRT, &nsa, NULL);
210     sigaction(SIGSEGV, &nsa, NULL);
211 #endif
212     osi_audit_init();
213
214     memset(&logopts, 0, sizeof(logopts));
215
216     /* Initialize dirpaths */
217     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
218 #ifdef AFS_NT40_ENV
219         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
220 #endif
221         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
222                 argv[0]);
223         exit(2);
224     }
225
226     vl_dbaseName = strdup(AFSDIR_SERVER_VLDB_FILEPATH);
227     configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
228
229     cmd_DisableAbbreviations();
230     cmd_DisablePositionalCommands();
231     opts = cmd_CreateSyntax(NULL, NULL, NULL, 0, NULL);
232
233     /* vlserver specific options */
234     cmd_AddParmAtOffset(opts, OPT_noauth, "-noauth", CMD_FLAG,
235                         CMD_OPTIONAL, "disable authentication");
236     cmd_AddParmAtOffset(opts, OPT_smallmem, "-smallmem", CMD_FLAG,
237                         CMD_OPTIONAL, "optimise for small memory systems");
238
239     /* general server options */
240     cmd_AddParmAtOffset(opts, OPT_auditlog, "-auditlog", CMD_SINGLE,
241                         CMD_OPTIONAL, "location of audit log");
242     cmd_AddParmAtOffset(opts, OPT_auditiface, "-audit-interface", CMD_SINGLE,
243                         CMD_OPTIONAL, "interface to use for audit logging");
244     cmd_AddParmAtOffset(opts, OPT_config, "-config", CMD_SINGLE,
245                         CMD_OPTIONAL, "configuration location");
246     cmd_AddParmAtOffset(opts, OPT_debug, "-d", CMD_SINGLE,
247                         CMD_OPTIONAL, "debug level");
248     cmd_AddParmAtOffset(opts, OPT_database, "-database", CMD_SINGLE,
249                         CMD_OPTIONAL, "database file");
250     cmd_AddParmAlias(opts, OPT_database, "-db");
251     cmd_AddParmAtOffset(opts, OPT_logfile, "-logfile", CMD_SINGLE,
252                         CMD_OPTIONAL, "location of logfile");
253     cmd_AddParmAtOffset(opts, OPT_threads, "-p", CMD_SINGLE, CMD_OPTIONAL,
254                         "number of threads");
255 #ifdef HAVE_SYSLOG
256     cmd_AddParmAtOffset(opts, OPT_syslog, "-syslog", CMD_SINGLE_OR_FLAG,
257                         CMD_OPTIONAL, "log to syslog");
258 #endif
259     cmd_AddParmAtOffset(opts, OPT_transarc_logs, "-transarc-logs", CMD_FLAG,
260                         CMD_OPTIONAL, "enable Transarc style logging");
261
262     /* rx options */
263     cmd_AddParmAtOffset(opts, OPT_peer, "-enable_peer_stats", CMD_FLAG,
264                         CMD_OPTIONAL, "enable RX transport statistics");
265     cmd_AddParmAtOffset(opts, OPT_process, "-enable_process_stats", CMD_FLAG,
266                         CMD_OPTIONAL, "enable RX RPC statistics");
267     cmd_AddParmAtOffset(opts, OPT_nojumbo, "-nojumbo", CMD_FLAG,
268                         CMD_OPTIONAL, "disable jumbograms");
269     cmd_AddParmAtOffset(opts, OPT_jumbo, "-jumbo", CMD_FLAG,
270                         CMD_OPTIONAL, "enable jumbograms");
271     cmd_AddParmAtOffset(opts, OPT_rxbind, "-rxbind", CMD_FLAG,
272                         CMD_OPTIONAL, "bind only to the primary interface");
273     cmd_AddParmAtOffset(opts, OPT_rxmaxmtu, "-rxmaxmtu", CMD_SINGLE,
274                         CMD_OPTIONAL, "maximum MTU for RX");
275     cmd_AddParmAtOffset(opts, OPT_trace, "-trace", CMD_SINGLE,
276                         CMD_OPTIONAL, "rx trace file");
277     cmd_AddParmAtOffset(opts, OPT_restricted_query, "-restricted_query",
278                         CMD_SINGLE, CMD_OPTIONAL, "anyuser | admin");
279
280
281     /* rxkad options */
282     cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals",
283                         CMD_FLAG, CMD_OPTIONAL,
284                         "permit Kerberos 5 principals with dots");
285
286     /* rxgk options */
287     cmd_AddParmAtOffset(opts, OPT_s2s_crypt, "-s2scrypt", CMD_SINGLE,
288                         CMD_OPTIONAL,
289                         "rxgk-crypt | never");
290
291     code = cmd_Parse(argc, argv, &opts);
292     if (code == CMD_HELP) {
293         exit(0);
294     }
295     if (code)
296         return -1;
297
298     cmd_OptionAsString(opts, OPT_config, &configDir);
299
300     cmd_OpenConfigFile(AFSDIR_SERVER_CONFIG_FILE_FILEPATH);
301     cmd_SetCommandName("vlserver");
302
303     /* vlserver options */
304     cmd_OptionAsFlag(opts, OPT_noauth, &noAuth);
305     cmd_OptionAsFlag(opts, OPT_smallmem, &smallMem);
306     if (cmd_OptionAsString(opts, OPT_trace, &optstring) == 0) {
307         extern char rxi_tracename[80];
308         strcpy(rxi_tracename, optstring);
309         free(optstring);
310         optstring = NULL;
311     }
312
313     /* general server options */
314
315     cmd_OptionAsString(opts, OPT_auditlog, &auditFileName);
316
317     if (cmd_OptionAsString(opts, OPT_auditiface, &interface) == 0) {
318         if (osi_audit_interface(interface)) {
319             printf("Invalid audit interface '%s'\n", interface);
320             return -1;
321         }
322         free(interface);
323     }
324
325     cmd_OptionAsString(opts, OPT_database, &vl_dbaseName);
326
327     if (cmd_OptionAsInt(opts, OPT_threads, &lwps) == 0) {
328         if (lwps > MAXLWP) {
329              printf("Warning: '-p %d' is too big; using %d instead\n",
330                     lwps, MAXLWP);
331              lwps = MAXLWP;
332         }
333     }
334
335     cmd_OptionAsInt(opts, OPT_debug, &logopts.lopt_logLevel);
336 #ifdef HAVE_SYSLOG
337     if (cmd_OptionPresent(opts, OPT_syslog)) {
338         if (cmd_OptionPresent(opts, OPT_logfile)) {
339             fprintf(stderr, "Invalid options: -syslog and -logfile are exclusive.\n");
340             return -1;
341         }
342         if (cmd_OptionPresent(opts, OPT_transarc_logs)) {
343             fprintf(stderr, "Invalid options: -syslog and -transarc-logs are exclusive.\n");
344             return -1;
345         }
346
347         logopts.lopt_dest = logDest_syslog;
348         logopts.lopt_facility = LOG_DAEMON; /* default value */
349         logopts.lopt_tag = "vlserver";
350         cmd_OptionAsInt(opts, OPT_syslog, &logopts.lopt_facility);
351     } else
352 #endif
353     {
354         logopts.lopt_dest = logDest_file;
355         if (cmd_OptionPresent(opts, OPT_transarc_logs)) {
356             logopts.lopt_rotateOnOpen = 1;
357             logopts.lopt_rotateStyle = logRotate_old;
358         }
359         if (cmd_OptionPresent(opts, OPT_logfile))
360             cmd_OptionAsString(opts, OPT_logfile, (char**)&logopts.lopt_filename);
361         else
362             logopts.lopt_filename = AFSDIR_SERVER_VLOG_FILEPATH;
363     }
364
365
366     /* rx options */
367     if (cmd_OptionPresent(opts, OPT_peer))
368         rx_enablePeerRPCStats();
369     if (cmd_OptionPresent(opts, OPT_process))
370         rx_enableProcessRPCStats();
371     if (cmd_OptionPresent(opts, OPT_nojumbo))
372         rxJumbograms = 0;
373     if (cmd_OptionPresent(opts, OPT_jumbo))
374         rxJumbograms = 1;
375
376     cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
377
378     cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU);
379
380     /* rxkad options */
381     cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
382
383     /* restricted query */
384     if (cmd_OptionAsString(opts, OPT_restricted_query,
385                            &restricted_query_parameter) == 0) {
386         if (strcmp(restricted_query_parameter, "anyuser") == 0)
387             restrictedQueryLevel = RESTRICTED_QUERY_ANYUSER;
388         else if (strcmp(restricted_query_parameter, "admin") == 0)
389             restrictedQueryLevel = RESTRICTED_QUERY_ADMIN;
390         else {
391             printf("invalid argument for -restricted_query: %s\n",
392                    restricted_query_parameter);
393             return -1;
394         }
395         free(restricted_query_parameter);
396     }
397
398     /* rxgk options */
399     if (cmd_OptionAsString(opts, OPT_s2s_crypt, &s2s_crypt_behavior) == 0) {
400         if (strcmp(s2s_crypt_behavior, "never") == 0) {
401             /* noop; this is the default */
402         } else if (strcmp(s2s_crypt_behavior, "rxgk-crypt") == 0) {
403             s2s_rxgk = 1;
404         } else {
405             printf("Invalid argument for -s2scrypt: %s\n", s2s_crypt_behavior);
406             return -1;
407         }
408         free(s2s_crypt_behavior);
409         s2s_crypt_behavior = NULL;
410     }
411
412     if (auditFileName) {
413         osi_audit_file(auditFileName);
414     }
415
416     OpenLog(&logopts);
417 #ifdef AFS_PTHREAD_ENV
418     opr_softsig_Init();
419     SetupLogSoftSignals();
420 #else
421     SetupLogSignals();
422 #endif
423
424     tdir = afsconf_Open(configDir);
425     if (!tdir) {
426         VLog(0,
427             ("vlserver: can't open configuration files in dir %s, giving up.\n",
428              configDir));
429         exit(1);
430     }
431
432     /* initialize audit user check */
433     osi_audit_set_user_check(tdir, vldb_IsLocalRealmMatch);
434
435 #ifdef AFS_NT40_ENV
436     /* initialize winsock */
437     if (afs_winsockInit() < 0) {
438         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
439         VLog(0, ("vlserver: couldn't initialize winsock. \n"));
440         exit(1);
441     }
442 #endif
443     /* get this host */
444     gethostname(hostname, sizeof(hostname));
445     th = gethostbyname(hostname);
446     if (!th) {
447         VLog(0, ("vlserver: couldn't get address of this host (%s).\n",
448                hostname));
449         exit(1);
450     }
451     memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
452
453 #if !defined(AFS_HPUX_ENV) && !defined(AFS_NT40_ENV)
454     signal(SIGXCPU, CheckSignal_Signal);
455 #endif
456     /* get list of servers */
457     code =
458         afsconf_GetExtendedCellInfo(tdir, NULL, AFSCONF_VLDBSERVICE, &info,
459                                     clones);
460     if (code) {
461         printf("vlserver: Couldn't get cell server list for 'afsvldb'.\n");
462         exit(2);
463     }
464
465     vldb_confdir = tdir;        /* Preserve our configuration dir */
466     /* rxvab no longer supported */
467     memset(&tkey, 0, sizeof(tkey));
468
469     if (noAuth)
470         afsconf_SetNoAuthFlag(tdir, 1);
471
472     if (rxBind) {
473         afs_int32 ccode;
474 #ifndef AFS_NT40_ENV
475         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
476             AFSDIR_SERVER_NETINFO_FILEPATH) {
477             char reason[1024];
478             ccode = afsconf_ParseNetFiles(SHostAddrs, NULL, NULL,
479                                           ADDRSPERSITE, reason,
480                                           AFSDIR_SERVER_NETINFO_FILEPATH,
481                                           AFSDIR_SERVER_NETRESTRICT_FILEPATH);
482         } else
483 #endif
484         {
485             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
486         }
487         if (ccode == 1) {
488             host = SHostAddrs[0];
489         }
490     }
491
492     if (!rxJumbograms) {
493         rx_SetNoJumbo();
494     }
495     if (rxMaxMTU != -1) {
496         if (rx_SetMaxMTU(rxMaxMTU) != 0) {
497             VLog(0, ("rxMaxMTU %d invalid\n", rxMaxMTU));
498             return -1;
499         }
500     }
501
502     VLog(0, ("vlserver binding rx to %s:%d\n",
503          afs_inet_ntoa_r(host, hoststr), AFSCONF_VLDBPORT));
504     code = rx_InitHost(host, htons(AFSCONF_VLDBPORT));
505     if (code < 0) {
506         VLog(0, ("vlserver: Rx init failed: %d\n", code));
507         exit(1);
508     }
509     rx_SetRxDeadTime(50);
510
511     ubik_nBuffers = 512;
512     if (s2s_rxgk) {
513         ubik_SetClientSecurityProcs(afsconf_ClientAuthRXGKCrypt,
514                                     afsconf_UpToDate, tdir);
515     } else {
516         ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate, tdir);
517     }
518     ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
519                                 afsconf_CheckAuth, tdir);
520
521     ubik_SyncWriterCacheProc = vlsynccache;
522     code =
523         ubik_ServerInitByInfo(myHost, htons(AFSCONF_VLDBPORT), &info, clones,
524                               vl_dbaseName, &VL_dbase);
525     if (code) {
526         VLog(0, ("vlserver: Ubik init failed: %s\n", afs_error_message(code)));
527         exit(2);
528     }
529
530     memset(rd_HostAddress, 0, sizeof(rd_HostAddress));
531     memset(wr_HostAddress, 0, sizeof(wr_HostAddress));
532     initialize_dstats();
533
534     afsconf_BuildServerSecurityObjects(tdir, &securityClasses, &numClasses);
535
536     tservice =
537         rx_NewServiceHost(host, 0, USER_SERVICE_ID, "Vldb server",
538                           securityClasses, numClasses,
539                           VL_ExecuteRequest);
540     if (tservice == (struct rx_service *)0) {
541         VLog(0, ("vlserver: Could not create VLDB_SERVICE rx service\n"));
542         exit(3);
543     }
544     rx_SetMinProcs(tservice, 2);
545     if (lwps < 4)
546         lwps = 4;
547     rx_SetMaxProcs(tservice, lwps);
548
549     if (rxkadDisableDotCheck) {
550         code = rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
551                                            (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
552         if (code) {
553             VLog(0, ("vlserver: failed to allow dotted principals: %s\n",
554                  afs_error_message(code)));
555             exit(2);
556         }
557     }
558
559     tservice =
560         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
561                           securityClasses, numClasses,
562                           RXSTATS_ExecuteRequest);
563     if (tservice == (struct rx_service *)0) {
564         VLog(0, ("vlserver: Could not create rpc stats rx service\n"));
565         exit(3);
566     }
567     rx_SetMinProcs(tservice, 2);
568     rx_SetMaxProcs(tservice, 4);
569
570     LogCommandLine(argc, argv, "vlserver", VldbVersion, "Starting AFS", FSLog);
571     if (afsconf_GetLatestKey(tdir, NULL, NULL) == 0) {
572         LogDesWarning();
573     }
574     VLog(0, ("%s\n", cml_version_number));
575
576     /* allow super users to manage RX statistics */
577     rx_SetRxStatUserOk(vldb_rxstat_userok);
578
579     rx_StartServer(1);          /* Why waste this idle process?? */
580
581     return 0; /* not reachable */
582 }