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 #include <afs/stds.h>
 114
 115 #include <roken.h>
 116 #include <afs/opr.h>
 117
 118 #ifdef AFS_NT40_ENV
 119 #include <WINNT/afsevent.h>
 120 #endif
 121
 122 #include <rx/xdr.h>
 123 #include <rx/rx.h>
 124 #include <rx/rx_globals.h>
 125 #include <rx/rxstat.h>
 126 #include <lock.h>
 127 #include <ubik.h>
 128 #include <afs/cmd.h>
 129 #include <afs/cellconfig.h>
 130 #include <afs/auth.h>
 131 #include <afs/keys.h>
 132 #include <afs/afsutil.h>
 133 #include <afs/audit.h>
 134 #include <afs/com_err.h>
 135
 136 #include "ptserver.h"
 137 #include "ptprototypes.h"
 138 #include "error_macros.h"
 139
 140 /* make all of these into a structure if you want */
 141 struct prheader cheader;
 142 struct ubik_dbase *dbase;
 143 struct afsconf_dir *prdir;
 144
 145 #if defined(SUPERGROUPS)
 146 extern afs_int32 depthsg;
 147 #endif
 148
 149 int restricted = 0;
 150 int rxMaxMTU = -1;
 151 int rxBind = 0;
 152 int rxkadDisableDotCheck = 0;
 153
 154 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
 155 afs_uint32 SHostAddrs[ADDRSPERSITE];
 156
 157 static struct afsconf_cell info;
 158
 159 extern int prp_group_default;
 160 extern int prp_user_default;
 161
 162 #include "AFS_component_version_number.c"
 163
 164 int
 165 prp_access_mask(char *s)
 166 {
 167     int r;
 168     if (*s >= '0' && *s <= '9') {
 169         return strtol(s, NULL, 0);
 170     }
 171     r = 0;
 172     while (*s) switch(*s++)
 173     {
 174     case 'S':   r |= PRP_STATUS_ANY; break;
 175     case 's':   r |= PRP_STATUS_MEM; break;
 176     case 'O':   r |= PRP_OWNED_ANY; break;
 177     case 'M':   r |= PRP_MEMBER_ANY; break;
 178     case 'm':   r |= PRP_MEMBER_MEM; break;
 179     case 'A':   r |= PRP_ADD_ANY; break;
 180     case 'a':   r |= PRP_ADD_MEM; break;
 181     case 'r':   r |= PRP_REMOVE_MEM; break;
 182     }
 183     return r;
 184 }
 185
 186 /* check whether caller is authorized to manage RX statistics */
 187 int
 188 pr_rxstat_userok(struct rx_call *call)
 189 {
 190     return afsconf_SuperUser(prdir, call, NULL);
 191 }
 192
 193 /**
 194  * Return true if this name is a member of the local realm.
 195  */
 196 int
 197 pr_IsLocalRealmMatch(void *rock, char *name, char *inst, char *cell)
 198 {
 199     struct afsconf_dir *dir = (struct afsconf_dir *)rock;
 200     afs_int32 islocal = 0;      /* default to no */
 201     int code;
 202
 203     code = afsconf_IsLocalRealmMatch(dir, &islocal, name, inst, cell);
 204     if (code) {
 205         ViceLog(0, ("Failed local realm check; code=%d, name=%s, inst=%s, cell=%s\n",
 206                  code, name, inst, cell));
 207     }
 208     return islocal;
 209 }
 210
 211
 212 enum optionsList {
 213     OPT_database,
 214     OPT_access,
 215     OPT_groupdepth,
 216     OPT_restricted,
 217     OPT_auditlog,
 218     OPT_auditiface,
 219     OPT_config,
 220     OPT_debug,
 221     OPT_logfile,
 222     OPT_threads,
 223     OPT_syslog,
 224     OPT_peer,
 225     OPT_process,
 226     OPT_rxbind,
 227     OPT_rxmaxmtu,
 228     OPT_dotted
 229 };
 230
 231 int
 232 main(int argc, char **argv)
 233 {
 234     afs_int32 code;
 235     afs_uint32 myHost;
 236     struct hostent *th;
 237     char hostname[64];
 238     struct rx_service *tservice;
 239     struct rx_securityClass **securityClasses;
 240     afs_int32 numClasses;
 241     int lwps = 3;
 242     char clones[MAXHOSTSPERCELL];
 243     afs_uint32 host = htonl(INADDR_ANY);
 244     struct cmd_syndesc *opts;
 245     struct cmd_item *list;
 246
 247     char *pr_dbaseName;
 248     char *configDir;
 249     char *logFile;
 250     char *whoami = "ptserver";
 251
 252     char *auditFileName = NULL;
 253     char *interface = NULL;
 254
 255 #ifdef  AFS_AIX32_ENV
 256     /*
 257      * The following signal action for AIX is necessary so that in case of a
 258      * crash (i.e. core is generated) we can include the user's data section
 259      * in the core dump. Unfortunately, by default, only a partial core is
 260      * generated which, in many cases, isn't too useful.
 261      */
 262     struct sigaction nsa;
 263
 264     sigemptyset(&nsa.sa_mask);
 265     nsa.sa_handler = SIG_DFL;
 266     nsa.sa_flags = SA_FULLDUMP;
 267     sigaction(SIGABRT, &nsa, NULL);
 268     sigaction(SIGSEGV, &nsa, NULL);
 269 #endif
 270     osi_audit_init();
 271     osi_audit(PTS_StartEvent, 0, AUD_END);
 272
 273     /* Initialize dirpaths */
 274     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
 275 #ifdef AFS_NT40_ENV
 276         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
 277 #endif
 278         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
 279                 argv[0]);
 280         exit(2);
 281     }
 282
 283     pr_dbaseName = strdup(AFSDIR_SERVER_PRDB_FILEPATH);
 284     configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
 285     logFile = strdup(AFSDIR_SERVER_PTLOG_FILEPATH);
 286
 287 #if defined(SUPERGROUPS)
 288     /* make sure the structures for database records are the same size */
 289     if ((sizeof(struct prentry) != ENTRYSIZE)
 290         || (sizeof(struct prentryg) != ENTRYSIZE)) {
 291         fprintf(stderr,
 292                 "The structures for the database records are different"
 293                 " sizes\n" "struct prentry = %" AFS_SIZET_FMT "\n"
 294                 "struct prentryg = %" AFS_SIZET_FMT "\n"
 295                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
 296                 sizeof(struct prentryg), ENTRYSIZE);
 297         PT_EXIT(1);
 298     }
 299 #endif
 300
 301     cmd_DisableAbbreviations();
 302     cmd_DisablePositionalCommands();
 303     opts = cmd_CreateSyntax(NULL, NULL, NULL, NULL);
 304
 305 /* ptserver specific options */
 306     cmd_AddParmAtOffset(opts, OPT_database, "-database", CMD_SINGLE,
 307                         CMD_OPTIONAL, "database file");
 308     cmd_AddParmAlias(opts, OPT_database, "db");
 309
 310     cmd_AddParmAtOffset(opts, OPT_access, "-default_access", CMD_SINGLE,
 311                         CMD_OPTIONAL, "default access flags for new entries");
 312 #if defined(SUPERGROUPS)
 313     cmd_AddParmAtOffset(opts, OPT_groupdepth, "-groupdepth", CMD_SINGLE,
 314                         CMD_OPTIONAL, "max search depth for supergroups");
 315     cmd_AddParmAlias(opts, OPT_groupdepth, "depth");
 316 #endif
 317     cmd_AddParmAtOffset(opts, OPT_restricted, "-restricted", CMD_FLAG,
 318                         CMD_OPTIONAL, "enable restricted mode");
 319
 320     /* general server options */
 321     cmd_AddParmAtOffset(opts, OPT_auditlog, "-auditlog", CMD_SINGLE,
 322                         CMD_OPTIONAL, "location of audit log");
 323     cmd_AddParmAtOffset(opts, OPT_auditiface, "-audit-interface", CMD_SINGLE,
 324                         CMD_OPTIONAL, "interface to use for audit logging");
 325     cmd_AddParmAtOffset(opts, OPT_config, "-config", CMD_SINGLE,
 326                         CMD_OPTIONAL, "configuration location");
 327     cmd_AddParmAtOffset(opts, OPT_debug, "-d", CMD_SINGLE,
 328                         CMD_OPTIONAL, "debug level");
 329     cmd_AddParmAtOffset(opts, OPT_logfile, "-logfile", CMD_SINGLE,
 330                         CMD_OPTIONAL, "location of logfile");
 331     cmd_AddParmAtOffset(opts, OPT_threads, "-p", CMD_SINGLE,
 332                         CMD_OPTIONAL, "number of threads");
 333 #if !defined(AFS_NT40_ENV)
 334     cmd_AddParmAtOffset(opts, OPT_syslog, "-syslog", CMD_SINGLE_OR_FLAG,
 335                         CMD_OPTIONAL, "log to syslog");
 336 #endif
 337
 338     /* rx options */
 339     cmd_AddParmAtOffset(opts, OPT_peer, "-enable_peer_stats", CMD_FLAG,
 340                         CMD_OPTIONAL, "enable RX transport statistics");
 341     cmd_AddParmAtOffset(opts, OPT_process, "-enable_process_stats", CMD_FLAG,
 342                         CMD_OPTIONAL, "enable RX RPC statistics");
 343     cmd_AddParmAtOffset(opts, OPT_rxbind, "-rxbind", CMD_FLAG,
 344                         CMD_OPTIONAL, "bind only to the primary interface");
 345     cmd_AddParmAtOffset(opts, OPT_rxmaxmtu, "-rxmaxmtu", CMD_SINGLE,
 346                         CMD_OPTIONAL, "maximum MTU for RX");
 347
 348     /* rxkad options */
 349     cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals",
 350                         CMD_FLAG, CMD_OPTIONAL,
 351                         "permit Kerberos 5 principals with dots");
 352
 353     code = cmd_Parse(argc, argv, &opts);
 354     if (code)
 355         PT_EXIT(1);
 356
 357     if (cmd_OptionAsList(opts, OPT_access, &list) == 0) {
 358         prp_user_default = prp_access_mask(list->data);
 359         if (list->next == NULL || list->next->data == NULL) {
 360             fprintf(stderr, "Missing second argument for -default_access\n");
 361             PT_EXIT(1);
 362         }
 363         prp_group_default = prp_access_mask(list->next->data);
 364     }
 365
 366 #if defined(SUPERGROUPS)
 367     cmd_OptionAsInt(opts, OPT_groupdepth, &depthsg);
 368 #endif
 369
 370     cmd_OptionAsFlag(opts, OPT_restricted, &restricted);
 371
 372     /* general server options */
 373     cmd_OptionAsString(opts, OPT_auditlog, &auditFileName);
 374
 375     if (cmd_OptionAsString(opts, OPT_auditiface, &interface) == 0) {
 376         if (osi_audit_interface(interface)) {
 377             printf("Invalid audit interface '%s'\n", interface);
 378             PT_EXIT(1);
 379         }
 380         free(interface);
 381     }
 382
 383     cmd_OptionAsString(opts, OPT_config, &configDir);
 384     cmd_OptionAsInt(opts, OPT_debug, &LogLevel);
 385     cmd_OptionAsString(opts, OPT_database, &pr_dbaseName);
 386     cmd_OptionAsString(opts, OPT_logfile, &logFile);
 387
 388     if (cmd_OptionAsInt(opts, OPT_threads, &lwps) == 0) {
 389         if (lwps > 16) {        /* maximum of 16 */
 390             printf("Warning: '-p %d' is too big; using %d instead\n",
 391                    lwps, 16);
 392             lwps = 16;
 393         } else if (lwps < 3) {  /* minimum of 3 */
 394             printf("Warning: '-p %d' is too small; using %d instead\n",
 395                    lwps, 3);
 396             lwps = 3;
 397         }
 398     }
 399
 400 #ifndef AFS_NT40_ENV
 401     if (cmd_OptionPresent(opts, OPT_syslog)) {
 402         serverLogSyslog = 1;
 403         cmd_OptionAsInt(opts, OPT_syslog, &serverLogSyslogFacility);
 404     }
 405 #endif
 406
 407     /* rx options */
 408     if (cmd_OptionPresent(opts, OPT_peer))
 409         rx_enablePeerRPCStats();
 410
 411     if (cmd_OptionPresent(opts, OPT_process))
 412         rx_enableProcessRPCStats();
 413
 414     cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
 415
 416     cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU);
 417
 418     /* rxkad options */
 419     cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
 420
 421     cmd_FreeOptions(&opts);
 422
 423     if (auditFileName) {
 424         osi_audit_file(auditFileName);
 425         osi_audit(PTS_StartEvent, 0, AUD_END);
 426     }
 427
 428 #ifndef AFS_NT40_ENV
 429     serverLogSyslogTag = "ptserver";
 430 #endif
 431     OpenLog(logFile);   /* set up logging */
 432     SetupLogSignals();
 433
 434     prdir = afsconf_Open(configDir);
 435     if (!prdir) {
 436         fprintf(stderr, "ptserver: can't open configuration directory.\n");
 437         PT_EXIT(1);
 438     }
 439     if (afsconf_GetNoAuthFlag(prdir))
 440         printf("ptserver: running unauthenticated\n");
 441
 442 #ifdef AFS_NT40_ENV
 443     /* initialize winsock */
 444     if (afs_winsockInit() < 0) {
 445         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
 446
 447         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
 448         PT_EXIT(1);
 449     }
 450 #endif
 451     /* get this host */
 452     gethostname(hostname, sizeof(hostname));
 453     th = gethostbyname(hostname);
 454     if (!th) {
 455         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
 456         PT_EXIT(1);
 457     }
 458     memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
 459
 460     /* get list of servers */
 461     code =
 462         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, clones);
 463     if (code) {
 464         afs_com_err(whoami, code, "Couldn't get server list");
 465         PT_EXIT(2);
 466     }
 467
 468     /* initialize audit user check */
 469     osi_audit_set_user_check(configDir, pr_IsLocalRealmMatch);
 470
 471     /* initialize ubik */
 472     ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate, prdir);
 473     ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
 474                                 afsconf_CheckAuth, prdir);
 475
 476     /* The max needed is when deleting an entry.  A full CoEntry deletion
 477      * required removal from 39 entries.  Each of which may refers to the entry
 478      * being deleted in one of its CoEntries.  If a CoEntry is freed its
 479      * predecessor CoEntry will be modified as well.  Any freed blocks also
 480      * modifies the database header.  Counting the entry being deleted and its
 481      * CoEntry this adds up to as much as 1+1+39*3 = 119.  If all these entries
 482      * and the header are in separate Ubik buffers then 120 buffers may be
 483      * required. */
 484     ubik_nBuffers = 120 + /*fudge */ 40;
 485
 486     if (rxBind) {
 487         afs_int32 ccode;
 488         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
 489             AFSDIR_SERVER_NETINFO_FILEPATH) {
 490             char reason[1024];
 491             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
 492                                            ADDRSPERSITE, reason,
 493                                            AFSDIR_SERVER_NETINFO_FILEPATH,
 494                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
 495         } else
 496         {
 497             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
 498         }
 499         if (ccode == 1) {
 500             host = SHostAddrs[0];
 501             /* the following call is idempotent so if/when it gets called
 502              * again by the ubik init stuff, it doesn't really matter
 503              * -- klm
 504              */
 505             rx_InitHost(host, htons(AFSCONF_PROTPORT));
 506         }
 507     }
 508
 509     /* Disable jumbograms */
 510     rx_SetNoJumbo();
 511
 512     if (rxMaxMTU != -1) {
 513         if (rx_SetMaxMTU(rxMaxMTU) != 0) {
 514             printf("rxMaxMTU %d is invalid\n", rxMaxMTU);
 515             PT_EXIT(1);
 516         }
 517     }
 518
 519     code =
 520         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
 521                               pr_dbaseName, &dbase);
 522     if (code) {
 523         afs_com_err(whoami, code, "Ubik init failed");
 524         PT_EXIT(2);
 525     }
 526
 527 #if defined(SUPERGROUPS)
 528     pt_hook_write();
 529 #endif
 530
 531     afsconf_BuildServerSecurityObjects(prdir, &securityClasses, &numClasses);
 532
 533     tservice =
 534         rx_NewServiceHost(host, 0, PRSRV, "Protection Server", securityClasses,
 535                           numClasses, PR_ExecuteRequest);
 536     if (tservice == (struct rx_service *)0) {
 537         fprintf(stderr, "ptserver: Could not create new rx service.\n");
 538         PT_EXIT(3);
 539     }
 540     rx_SetMinProcs(tservice, 2);
 541     rx_SetMaxProcs(tservice, lwps);
 542     if (rxkadDisableDotCheck) {
 543         rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
 544                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
 545     }
 546
 547     tservice =
 548         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
 549                           securityClasses, numClasses, RXSTATS_ExecuteRequest);
 550     if (tservice == (struct rx_service *)0) {
 551         fprintf(stderr, "ptserver: Could not create new rx service.\n");
 552         PT_EXIT(3);
 553     }
 554     rx_SetMinProcs(tservice, 2);
 555     rx_SetMaxProcs(tservice, 4);
 556
 557     /* allow super users to manage RX statistics */
 558     rx_SetRxStatUserOk(pr_rxstat_userok);
 559
 560     LogCommandLine(argc, argv, "ptserver",
 561 #if defined(SUPERGROUPS)
 562                    "1.1",
 563 #else
 564                    "1.0",
 565 #endif
 566                    "Starting AFS", FSLog);
 567
 568     rx_StartServer(1);
 569     osi_audit(PTS_FinishEvent, -1, AUD_END);
 570     exit(0);
 571 }