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
 115 #include <afs/stds.h>
 116 #ifdef  AFS_AIX32_ENV
 117 #include <signal.h>
 118 #endif
 119 #include <sys/types.h>
 120 #include <stdio.h>
 121 #include <fcntl.h>
 122 #include <sys/stat.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 #include <string.h>
 131 #include <rx/xdr.h>
 132 #include <rx/rx.h>
 133 #include <rx/rx_globals.h>
 134 #include <lock.h>
 135 #include <ubik.h>
 136 #include <afs/cellconfig.h>
 137 #include <afs/auth.h>
 138 #include <afs/keys.h>
 139 #include "ptserver.h"
 140 #include "ptprototypes.h"
 141 #include "error_macros.h"
 142 #include "afs/audit.h"
 143 #include <afs/afsutil.h>
 144 #include <afs/com_err.h>
 145 #include <rx/rxstat.h>
 146
 147 /* make all of these into a structure if you want */
 148 struct prheader cheader;
 149 struct ubik_dbase *dbase;
 150 struct afsconf_dir *prdir;
 151
 152 #if defined(SUPERGROUPS)
 153 extern afs_int32 depthsg;
 154 #endif
 155
 156 char *pr_realmName;
 157
 158 int debuglevel = 0;
 159 int restricted = 0;
 160 int rxMaxMTU = -1;
 161 int rxBind = 0;
 162 int rxkadDisableDotCheck = 0;
 163
 164 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
 165 afs_uint32 SHostAddrs[ADDRSPERSITE];
 166
 167 static struct afsconf_cell info;
 168
 169 extern int prp_group_default;
 170 extern int prp_user_default;
 171
 172 #include "AFS_component_version_number.c"
 173
 174 int
 175 prp_access_mask(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     afs_int32 code;
 207     afs_uint32 myHost;
 208     struct hostent *th;
 209     char hostname[64];
 210     struct rx_service *tservice;
 211     struct rx_securityClass **securityClasses;
 212     afs_int32 numClasses;
 213     int kerberosKeys;           /* set if found some keys */
 214     int lwps = 3;
 215     char clones[MAXHOSTSPERCELL];
 216     afs_uint32 host = htonl(INADDR_ANY);
 217
 218     const char *pr_dbaseName;
 219     char *whoami = "ptserver";
 220
 221     int a;
 222     char arg[100];
 223
 224     char *auditFileName = NULL;
 225
 226 #ifdef  AFS_AIX32_ENV
 227     /*
 228      * The following signal action for AIX is necessary so that in case of a
 229      * crash (i.e. core is generated) we can include the user's data section
 230      * in the core dump. Unfortunately, by default, only a partial core is
 231      * generated which, in many cases, isn't too useful.
 232      */
 233     struct sigaction nsa;
 234
 235     sigemptyset(&nsa.sa_mask);
 236     nsa.sa_handler = SIG_DFL;
 237     nsa.sa_flags = SA_FULLDUMP;
 238     sigaction(SIGABRT, &nsa, NULL);
 239     sigaction(SIGSEGV, &nsa, NULL);
 240 #endif
 241     osi_audit_init();
 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 = %" AFS_SIZET_FMT "\n"
 263                 "struct prentryg = %" AFS_SIZET_FMT "\n"
 264                 "ENTRYSIZE = %d\n", sizeof(struct prentry),
 265                 sizeof(struct prentryg), ENTRYSIZE);
 266         PT_EXIT(1);
 267     }
 268 #endif
 269
 270     for (a = 1; a < argc; a++) {
 271         int alen;
 272         lcstring(arg, argv[a], sizeof(arg));
 273         alen = strlen(arg);
 274         if (strcmp(argv[a], "-d") == 0) {
 275             if ((a + 1) >= argc) {
 276                 fprintf(stderr, "missing argument for -d\n");
 277                 return -1;
 278             }
 279             debuglevel = atoi(argv[++a]);
 280             LogLevel = debuglevel;
 281         } else if ((strncmp(arg, "-database", alen) == 0)
 282             || (strncmp(arg, "-db", alen) == 0)) {
 283             pr_dbaseName = argv[++a];   /* specify a database */
 284         } else if (strncmp(arg, "-p", alen) == 0) {
 285             lwps = atoi(argv[++a]);
 286             if (lwps > 16) {    /* maximum of 16 */
 287                 printf("Warning: '-p %d' is too big; using %d instead\n",
 288                        lwps, 16);
 289                 lwps = 16;
 290             } else if (lwps < 3) {      /* minimum of 3 */
 291                 printf("Warning: '-p %d' is too small; using %d instead\n",
 292                        lwps, 3);
 293                 lwps = 3;
 294             }
 295 #if defined(SUPERGROUPS)
 296         } else if ((strncmp(arg, "-groupdepth", alen) == 0)
 297                  || (strncmp(arg, "-depth", alen) == 0)) {
 298             depthsg = atoi(argv[++a]);  /* Max search depth for supergroups */
 299 #endif
 300         } else if (strncmp(arg, "-default_access", alen) == 0) {
 301             prp_user_default = prp_access_mask(argv[++a]);
 302             prp_group_default = prp_access_mask(argv[++a]);
 303         }
 304         else if (strncmp(arg, "-restricted", alen) == 0) {
 305             restricted = 1;
 306         }
 307         else if (strncmp(arg, "-rxbind", alen) == 0) {
 308             rxBind = 1;
 309         }
 310         else if (strncmp(arg, "-allow-dotted-principals", alen) == 0) {
 311             rxkadDisableDotCheck = 1;
 312         }
 313         else if (strncmp(arg, "-enable_peer_stats", alen) == 0) {
 314             rx_enablePeerRPCStats();
 315         } else if (strncmp(arg, "-enable_process_stats", alen) == 0) {
 316             rx_enableProcessRPCStats();
 317         }
 318 #ifndef AFS_NT40_ENV
 319         else if (strncmp(arg, "-syslog", alen) == 0) {
 320             /* set syslog logging flag */
 321             serverLogSyslog = 1;
 322         } else if (strncmp(arg, "-syslog=", MIN(8, alen)) == 0) {
 323             serverLogSyslog = 1;
 324             serverLogSyslogFacility = atoi(arg + 8);
 325         }
 326 #endif
 327         else if (strncmp(arg, "-auditlog", alen) == 0) {
 328             auditFileName = argv[++a];
 329
 330         } else if (strncmp(arg, "-audit-interface", alen) == 0) {
 331             char *interface = argv[++a];
 332             if (osi_audit_interface(interface)) {
 333                 printf("Invalid audit interface '%s'\n", interface);
 334                 PT_EXIT(1);
 335             }
 336         }
 337         else if (!strncmp(arg, "-rxmaxmtu", alen)) {
 338             if ((a + 1) >= argc) {
 339                 fprintf(stderr, "missing argument for -rxmaxmtu\n");
 340                 PT_EXIT(1);
 341             }
 342             rxMaxMTU = atoi(argv[++a]);
 343             if ((rxMaxMTU < RX_MIN_PACKET_SIZE) ||
 344                  (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
 345                 printf("rxMaxMTU %d invalid; must be between %d-%" AFS_SIZET_FMT "\n",
 346                         rxMaxMTU, RX_MIN_PACKET_SIZE,
 347                         RX_MAX_PACKET_DATA_SIZE);
 348                 PT_EXIT(1);
 349             }
 350         }
 351         else if (*arg == '-') {
 352             /* hack in help flag support */
 353
 354 #if defined(SUPERGROUPS)
 355 #ifndef AFS_NT40_ENV
 356             printf("Usage: ptserver [-database <db path>] "
 357                    "[-auditlog <log path>] "
 358                    "[-audit-interface <file|sysvmq> (default is file)] "
 359                    "[-syslog[=FACILITY]] [-d <debug level>] "
 360                    "[-p <number of processes>] [-rebuild] "
 361                    "[-groupdepth <depth>] "
 362                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
 363                    "[-allow-dotted-principals] "
 364                    "[-enable_peer_stats] [-enable_process_stats] "
 365                    "[-default_access default_user_access default_group_access] "
 366                    "[-help]\n");
 367 #else /* AFS_NT40_ENV */
 368             printf("Usage: ptserver [-database <db path>] "
 369                    "[-auditlog <log path>] "
 370                    "[-audit-interface <file|sysvmq> (default is file)] "
 371                    "[-d <debug level>] "
 372                    "[-p <number of processes>] [-rebuild] [-rxbind] "
 373                    "[-allow-dotted-principals] "
 374                    "[-default_access default_user_access default_group_access] "
 375                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
 376                    "[-groupdepth <depth>] " "[-help]\n");
 377 #endif
 378 #else
 379 #ifndef AFS_NT40_ENV
 380             printf("Usage: ptserver [-database <db path>] "
 381                    "[-auditlog <log path>] "
 382                    "[-audit-interface <file|sysvmq> (default is file)] "
 383                    "[-d <debug level>] "
 384                    "[-syslog[=FACILITY]] "
 385                    "[-p <number of processes>] [-rebuild] "
 386                    "[-enable_peer_stats] [-enable_process_stats] "
 387                    "[-default_access default_user_access default_group_access] "
 388                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
 389                    "[-allow-dotted-principals] "
 390                    "[-help]\n");
 391 #else /* AFS_NT40_ENV */
 392             printf("Usage: ptserver [-database <db path>] "
 393                    "[-auditlog <log path>] [-d <debug level>] "
 394                    "[-default_access default_user_access default_group_access] "
 395                    "[-restricted] [-rxmaxmtu <bytes>] [-rxbind] "
 396                    "[-allow-dotted-principals] "
 397                    "[-p <number of processes>] [-rebuild] " "[-help]\n");
 398 #endif
 399 #endif
 400             fflush(stdout);
 401
 402             PT_EXIT(1);
 403         }
 404 #if defined(SUPERGROUPS)
 405         else {
 406             fprintf(stderr, "Unrecognized arg: '%s' ignored!\n", arg);
 407         }
 408 #endif
 409     }
 410
 411     if (auditFileName) {
 412         osi_audit_file(auditFileName);
 413         osi_audit(PTS_StartEvent, 0, AUD_END);
 414     }
 415
 416 #ifndef AFS_NT40_ENV
 417     serverLogSyslogTag = "ptserver";
 418 #endif
 419     OpenLog(AFSDIR_SERVER_PTLOG_FILEPATH);      /* set up logging */
 420     SetupLogSignals();
 421
 422     prdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
 423     if (!prdir) {
 424         fprintf(stderr, "ptserver: can't open configuration directory.\n");
 425         PT_EXIT(1);
 426     }
 427     if (afsconf_GetNoAuthFlag(prdir))
 428         printf("ptserver: running unauthenticated\n");
 429
 430 #ifdef AFS_NT40_ENV
 431     /* initialize winsock */
 432     if (afs_winsockInit() < 0) {
 433         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
 434
 435         fprintf(stderr, "ptserver: couldn't initialize winsock. \n");
 436         PT_EXIT(1);
 437     }
 438 #endif
 439     /* get this host */
 440     gethostname(hostname, sizeof(hostname));
 441     th = gethostbyname(hostname);
 442     if (!th) {
 443         fprintf(stderr, "ptserver: couldn't get address of this host.\n");
 444         PT_EXIT(1);
 445     }
 446     memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
 447
 448     /* get list of servers */
 449     code =
 450         afsconf_GetExtendedCellInfo(prdir, NULL, "afsprot", &info, clones);
 451     if (code) {
 452         afs_com_err(whoami, code, "Couldn't get server list");
 453         PT_EXIT(2);
 454     }
 455     pr_realmName = info.name;
 456
 457     {
 458         afs_int32 kvno;         /* see if there is a KeyFile here */
 459         struct ktc_encryptionKey key;
 460         code = afsconf_GetLatestKey(prdir, &kvno, &key);
 461         kerberosKeys = (code == 0);
 462         if (!kerberosKeys)
 463             printf
 464                 ("ptserver: can't find any Kerberos keys, code = %d, ignoring\n",
 465                  code);
 466     }
 467     if (kerberosKeys) {
 468         /* initialize ubik */
 469         ubik_CRXSecurityProc = afsconf_ClientAuth;
 470         ubik_CRXSecurityRock = prdir;
 471         ubik_SRXSecurityProc = afsconf_ServerAuth;
 472         ubik_SRXSecurityRock = prdir;
 473         ubik_CheckRXSecurityProc = afsconf_CheckAuth;
 474         ubik_CheckRXSecurityRock = 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     code =
 510         ubik_ServerInitByInfo(myHost, htons(AFSCONF_PROTPORT), &info, clones,
 511                               pr_dbaseName, &dbase);
 512     if (code) {
 513         afs_com_err(whoami, code, "Ubik init failed");
 514         PT_EXIT(2);
 515     }
 516 #if defined(SUPERGROUPS)
 517     pt_hook_write();
 518 #endif
 519
 520     afsconf_BuildServerSecurityObjects(prdir, 0, &securityClasses,
 521                                        &numClasses);
 522
 523     /* Disable jumbograms */
 524     rx_SetNoJumbo();
 525
 526     if (rxMaxMTU != -1) {
 527         rx_SetMaxMTU(rxMaxMTU);
 528     }
 529
 530     tservice =
 531         rx_NewServiceHost(host, 0, PRSRV, "Protection Server", securityClasses,
 532                           numClasses, PR_ExecuteRequest);
 533     if (tservice == (struct rx_service *)0) {
 534         fprintf(stderr, "ptserver: Could not create new rx service.\n");
 535         PT_EXIT(3);
 536     }
 537     rx_SetMinProcs(tservice, 2);
 538     rx_SetMaxProcs(tservice, lwps);
 539     if (rxkadDisableDotCheck) {
 540         rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
 541                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
 542     }
 543
 544     tservice =
 545         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
 546                           securityClasses, numClasses, RXSTATS_ExecuteRequest);
 547     if (tservice == (struct rx_service *)0) {
 548         fprintf(stderr, "ptserver: Could not create new rx service.\n");
 549         PT_EXIT(3);
 550     }
 551     rx_SetMinProcs(tservice, 2);
 552     rx_SetMaxProcs(tservice, 4);
 553
 554     /* allow super users to manage RX statistics */
 555     rx_SetRxStatUserOk(pr_rxstat_userok);
 556
 557     LogCommandLine(argc, argv, "ptserver",
 558 #if defined(SUPERGROUPS)
 559                    "1.1",
 560 #else
 561                    "1.0",
 562 #endif
 563                    "Starting AFS", FSLog);
 564
 565     rx_StartServer(1);
 566     osi_audit(PTS_FinishEvent, -1, AUD_END);
 567     exit(0);
 568 }