src/libadmin/client/afs_clientAdmin.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
  13 RCSID
  14     ("$Header$");
  15
  16 #include <afs/stds.h>
  17 #include "afs_clientAdmin.h"
  18 #include "../adminutil/afs_AdminInternal.h"
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <sys/types.h>
  22 #include <afs/cellconfig.h>
  23 #ifdef AFS_NT40_ENV
  24 #include <afs/afssyscalls.h>
  25 #include <winsock2.h>
  26 #include <afs/fs_utils.h>
  27 #define close(x) closesocket(x)
  28 #else
  29 #include <sys/socket.h>
  30 #include <netinet/in.h>
  31 #include <arpa/inet.h>
  32 #include <netdb.h>
  33 #include <afs/venus.h>
  34 #include <errno.h>
  35 #include <strings.h>
  36 #include <unistd.h>
  37 #endif
  38 #include <string.h>
  39 #include <afs/kautils.h>
  40 #include <rx/rx.h>
  41 #include <rx/rxstat.h>
  42 #include <rx/rx_null.h>
  43 #include <rx/rxkad.h>
  44 #include <afs/dirpath.h>
  45 #include <afs/afs_AdminErrors.h>
  46 #include <afs/afs_vosAdmin.h>
  47 #include <afs/afs_utilAdmin.h>
  48 #include <afs/ptserver.h>
  49 #include <afs/vlserver.h>
  50 #include <afs/pthread_glock.h>
  51
  52 /*
  53  * AFS client administration functions.
  54  *
  55  * Admin functions that are normally associated with the client.
  56  *
  57  * All of the functions related to authentication are here, plus
  58  * some miscellaneous others.
  59  *
  60  */
  61
  62 static const unsigned long ADMIN_TICKET_LIFETIME = 24 * 3600;
  63
  64 static const unsigned long SERVER_TTL = 10 * 60;
  65
  66 /*
  67  * We need a way to track whether or not the client library has been
  68  * initialized.  We count on the fact that the other library initialization
  69  * functions are protected by their own once mechanism.  We only track
  70  * our own internal status
  71  */
  72
  73 static int client_init;
  74 static pthread_once_t client_init_once = PTHREAD_ONCE_INIT;
  75
  76 static void
  77 client_once(void)
  78 {
  79     client_init = 1;
  80 }
  81
  82 /*
  83  * IsTokenValid - validate a token handle
  84  *
  85  * PARAMETERS
  86  *
  87  * IN token - the token to be validated.
  88  *
  89  * LOCKS
  90  *
  91  * No locks are obtained or released by this function
  92  *
  93  * CAUTIONS
  94  *
  95  * None.
  96  *
  97  * RETURN CODES
  98  *
  99  * Returns != 0 upon successful completion.
 100  */
 101
 102 static int
 103 IsTokenValid(const afs_token_handle_p token, afs_status_p st)
 104 {
 105     int rc = 0;
 106     afs_status_t tst = 0;
 107
 108     if (token == NULL) {
 109         tst = ADMCLIENTTOKENHANDLENULL;
 110         goto fail_IsTokenValid;
 111     }
 112
 113     if (token->is_valid == 0) {
 114         tst = ADMCLIENTTOKENHANDLEINVALID;
 115         goto fail_IsTokenValid;
 116     }
 117
 118     if ((token->begin_magic != BEGIN_MAGIC)
 119         || (token->end_magic != END_MAGIC)) {
 120         tst = ADMCLIENTTOKENHANDLEBADMAGIC;
 121         goto fail_IsTokenValid;
 122     }
 123     rc = 1;
 124
 125   fail_IsTokenValid:
 126
 127     if (st != NULL) {
 128         *st = tst;
 129     }
 130     return rc;
 131 }
 132
 133 /*
 134  * afsclient_TokenGetExisting - get tokens that already exist and
 135  * are held by the cache manager.
 136  *
 137  * PARAMETERS
 138  *
 139  * IN cellName - the name of the cell where the token originated.
 140  *
 141  * OUT tokenHandle - a handle to the tokens if they were obtained
 142  * successfully.
 143  *
 144  * LOCKS
 145  *
 146  * No locks are obtained or released by this function
 147  *
 148  * CAUTIONS
 149  *
 150  * The tokenHandle returned by this function cannot be used for kas
 151  * related operations, since kas tokens aren't stored in the kernel.
 152  *
 153  * RETURN CODES
 154  *
 155  * Returns != 0 upon successful completion.
 156  */
 157
 158 int ADMINAPI
 159 afsclient_TokenGetExisting(const char *cellName, void **tokenHandle,
 160                            afs_status_p st)
 161 {
 162     int rc = 0;
 163     afs_status_t tst = 0;
 164     struct ktc_principal afs_server;
 165     afs_token_handle_p t_handle =
 166         (afs_token_handle_p) calloc(1, sizeof(afs_token_handle_t));
 167
 168     if (client_init == 0) {
 169         tst = ADMCLIENTNOINIT;
 170         goto fail_afsclient_TokenGetExisting;
 171     }
 172
 173     if (cellName == NULL) {
 174         tst = ADMCLIENTCELLNAMENULL;
 175         goto fail_afsclient_TokenGetExisting;
 176     }
 177
 178     if (tokenHandle == NULL) {
 179         tst = ADMCLIENTTOKENHANDLENULL;
 180         goto fail_afsclient_TokenGetExisting;
 181     }
 182
 183     if (t_handle == NULL) {
 184         tst = ADMNOMEM;
 185         goto fail_afsclient_TokenGetExisting;
 186     }
 187
 188     strcpy(afs_server.name, "afs");
 189     afs_server.instance[0] = 0;
 190     strcpy(afs_server.cell, cellName);
 191
 192     if (!
 193         (tst =
 194          ktc_GetToken(&afs_server, &t_handle->afs_token,
 195                       sizeof(t_handle->afs_token), &t_handle->client))) {
 196         /*
 197          * The token has been retrieved successfully, initialize
 198          * the rest of the token handle structure
 199          */
 200         strncpy(t_handle->cell, cellName, MAXCELLCHARS);
 201         t_handle->cell[MAXCELLCHARS - 1] = '\0';
 202         t_handle->afs_token_set = 1;
 203         t_handle->from_kernel = 1;
 204         t_handle->kas_token_set = 0;
 205         t_handle->sc_index = 2;
 206         t_handle->afs_sc[t_handle->sc_index] =
 207             rxkad_NewClientSecurityObject(rxkad_clear,
 208                                           &t_handle->afs_token.sessionKey,
 209                                           t_handle->afs_token.kvno,
 210                                           t_handle->afs_token.ticketLen,
 211                                           t_handle->afs_token.ticket);
 212         t_handle->afs_encrypt_sc[t_handle->sc_index] =
 213             rxkad_NewClientSecurityObject(rxkad_crypt,
 214                                           &t_handle->afs_token.sessionKey,
 215                                           t_handle->afs_token.kvno,
 216                                           t_handle->afs_token.ticketLen,
 217                                           t_handle->afs_token.ticket);
 218         if ((t_handle->afs_sc[t_handle->sc_index] == NULL)
 219             || (t_handle->afs_sc[t_handle->sc_index] == NULL)) {
 220             tst = ADMCLIENTTOKENHANDLENOSECURITY;
 221             goto fail_afsclient_TokenGetExisting;
 222         } else {
 223             t_handle->begin_magic = BEGIN_MAGIC;
 224             t_handle->is_valid = 1;
 225             t_handle->end_magic = END_MAGIC;
 226             *tokenHandle = (void *)t_handle;
 227         }
 228     } else {
 229         goto fail_afsclient_TokenGetExisting;
 230     }
 231     rc = 1;
 232
 233   fail_afsclient_TokenGetExisting:
 234
 235     if ((rc == 0) && (t_handle != NULL)) {
 236         free(t_handle);
 237     }
 238     if (st != NULL) {
 239         *st = tst;
 240     }
 241     return rc;
 242 }
 243
 244 /*
 245  * afsclient_TokenSet - set the tokens represented by tokenHandle to be
 246  * active in the kernel (aka ka_SetToken).
 247  *
 248  * PARAMETERS
 249  *
 250  * IN cellName - the name of the cell where the token originated.
 251  *
 252  * OUT tokenHandle - a handle to the tokens if they were obtained
 253  * successfully.
 254  *
 255  * LOCKS
 256  *
 257  * No locks are obtained or released by this function
 258  *
 259  * CAUTIONS
 260  *
 261  * The tokenHandle returned by this function cannot be used for kas
 262  * related operations, since kas tokens aren't stored in the kernel.
 263  *
 264  * RETURN CODES
 265  *
 266  * Returns != 0 upon successful completion.
 267  */
 268
 269 int ADMINAPI
 270 afsclient_TokenSet(const void *tokenHandle, afs_status_p st)
 271 {
 272     int rc = 0;
 273     afs_status_t tst = 0;
 274     struct ktc_principal afs_server;
 275     afs_token_handle_p t_handle = (afs_token_handle_p) tokenHandle;
 276
 277     if (!IsTokenValid(t_handle, &tst)) {
 278         goto fail_afsclient_TokenSet;
 279     }
 280
 281     strcpy(afs_server.name, "afs");
 282     afs_server.instance[0] = 0;
 283     strcpy(afs_server.cell, t_handle->cell);
 284
 285     tst =
 286         ktc_SetToken(&afs_server, &t_handle->afs_token, &t_handle->client, 0);
 287
 288     if (!tst) {
 289         rc = 1;
 290     }
 291
 292   fail_afsclient_TokenSet:
 293
 294     if (st != NULL) {
 295         *st = tst;
 296     }
 297     return rc;
 298 }
 299
 300 /*
 301  * GetKASToken - get a KAS token and store it in the tokenHandle.
 302  *
 303  * PARAMETERS
 304  *
 305  * IN cellName - the name of the cell where the token should be obtained.
 306  *
 307  * IN principal - the name of the user of the token.
 308  *
 309  * IN password - the password for the principal.
 310  *
 311  * OUT tokenHandle - a handle to the tokens if they were obtained
 312  * successfully.
 313  *
 314  * LOCKS
 315  *
 316  * No locks are obtained or released by this function
 317  *
 318  * CAUTIONS
 319  *
 320  * None.
 321  *
 322  * RETURN CODES
 323  *
 324  * Returns != 0 upon successful completion.
 325  */
 326
 327 static int
 328 GetKASToken(const char *cellName, const char *principal, const char *password,
 329             afs_token_handle_p tokenHandle, afs_status_p st)
 330 {
 331     int rc = 0;
 332     afs_status_t tst = 0;
 333     struct ubik_client *unauth_conn;
 334     afs_int32 expire;
 335     struct ktc_encryptionKey key;
 336     struct ktc_token *token;
 337     unsigned long now = time(0);
 338     char name[MAXKTCNAMELEN];
 339     char inst[MAXKTCNAMELEN];
 340     int have_server_conn = 0;
 341
 342     token = &tokenHandle->kas_token;
 343
 344     ka_StringToKey((char *)password, (char *)cellName, &key);
 345
 346     /*
 347      * Get an unauthenticated connection in the right cell to use for
 348      * retrieving the token.
 349      */
 350
 351     tst =
 352         ka_AuthServerConn((char *)cellName, KA_AUTHENTICATION_SERVICE, 0,
 353                           &unauth_conn);
 354     if (tst != 0) {
 355         goto fail_GetKASToken;
 356     }
 357     have_server_conn = 1;
 358
 359     tst = ka_ParseLoginName((char *)principal, name, inst, NULL);
 360     if (tst != 0) {
 361         goto fail_GetKASToken;
 362     }
 363
 364     tst =
 365         ka_Authenticate(name, inst, (char *)cellName, unauth_conn,
 366                         KA_MAINTENANCE_SERVICE, &key, now,
 367                         now + ADMIN_TICKET_LIFETIME, token, &expire);
 368     if (tst != 0) {
 369         goto fail_GetKASToken;
 370     }
 371     rc = 1;
 372
 373   fail_GetKASToken:
 374
 375     if (have_server_conn) {
 376         ubik_ClientDestroy(unauth_conn);
 377     }
 378
 379     if (st != NULL) {
 380         *st = tst;
 381     }
 382     return rc;
 383 }
 384
 385 /*
 386  * GetAFSToken - get a AFS token and store it in the tokenHandle.
 387  *
 388  * PARAMETERS
 389  *
 390  * IN cellName - the name of the cell where the token should be obtained.
 391  *
 392  * IN principal - the name of the user of the token.
 393  *
 394  * IN password - the password for the principal.
 395  *
 396  * OUT tokenHandle - a handle to the tokens if they were obtained
 397  * successfully.
 398  *
 399  * LOCKS
 400  *
 401  * No locks are obtained or released by this function
 402  *
 403  * CAUTIONS
 404  *
 405  * None.
 406  *
 407  * RETURN CODES
 408  *
 409  * Returns != 0 upon successful completion.
 410  */
 411
 412 static int
 413 GetAFSToken(const char *cellName, const char *principal, const char *password,
 414             afs_token_handle_p tokenHandle, afs_status_p st)
 415 {
 416     int rc = 0;
 417     afs_status_t tst = 0;
 418     struct ubik_client *unauth_conn = NULL, *auth_conn = NULL;
 419     afs_int32 expire;
 420     struct ktc_encryptionKey key;
 421     struct ktc_token auth_token;
 422     struct ktc_token *token;
 423     unsigned long now = time(0);
 424
 425     token = &tokenHandle->afs_token;
 426
 427     ka_StringToKey((char *)password, (char *)cellName, &key);
 428
 429     /*
 430      * Get an unauthenticated connection in the right cell to use for
 431      * retrieving the token.
 432      */
 433
 434     tst =
 435         ka_AuthServerConn((char *)cellName, KA_AUTHENTICATION_SERVICE, 0,
 436                           &unauth_conn);
 437     if (tst) {
 438         goto fail_GetAFSToken;
 439     }
 440
 441     tst =
 442         ka_ParseLoginName((char *)principal, tokenHandle->client.name,
 443                           tokenHandle->client.instance, NULL);
 444     if (tst) {
 445         goto fail_GetAFSToken;
 446     }
 447
 448     tst =
 449         ka_Authenticate(tokenHandle->client.name,
 450                         tokenHandle->client.instance, (char *)cellName,
 451                         unauth_conn, KA_TICKET_GRANTING_SERVICE, &key, now,
 452                         now + ADMIN_TICKET_LIFETIME, &auth_token, &expire);
 453     if (tst) {
 454         goto fail_GetAFSToken;
 455     }
 456
 457     tst =
 458         ka_AuthServerConn((char *)cellName, KA_TICKET_GRANTING_SERVICE, 0,
 459                           &auth_conn);
 460     if (tst) {
 461         goto fail_GetAFSToken;
 462     }
 463
 464     tst =
 465         ka_CellToRealm((char *)cellName, tokenHandle->client.cell, (int *)0);
 466     if (tst) {
 467         goto fail_GetAFSToken;
 468     }
 469
 470     tst =
 471         ka_GetToken("afs", "", (char *)cellName, tokenHandle->client.name,
 472                     tokenHandle->client.instance, auth_conn, now,
 473                     now + ADMIN_TICKET_LIFETIME, &auth_token,
 474                     tokenHandle->client.cell, token);
 475     if (tst) {
 476         goto fail_GetAFSToken;
 477     }
 478     rc = 1;
 479
 480   fail_GetAFSToken:
 481
 482     if (auth_conn) {
 483         ubik_ClientDestroy(auth_conn);
 484     }
 485
 486     if (unauth_conn) {
 487         ubik_ClientDestroy(unauth_conn);
 488     }
 489
 490     if (st != NULL) {
 491         *st = tst;
 492     }
 493     return rc;
 494 }
 495
 496
 497 /*
 498  * afsclient_TokenGetNew - get new tokens for a user and store them
 499  * in the tokenHandle.
 500  *
 501  * PARAMETERS
 502  *
 503  * IN cellName - the name of the cell where the tokens should be obtained.
 504  *
 505  * IN principal - the name of the user of the tokens.
 506  *
 507  * IN password - the password for the principal.
 508  *
 509  * OUT tokenHandle - a handle to the tokens if they were obtained
 510  * successfully.
 511  *
 512  * LOCKS
 513  *
 514  * No locks are obtained or released by this function
 515  *
 516  * CAUTIONS
 517  *
 518  * None.
 519  *
 520  * RETURN CODES
 521  *
 522  * Returns != 0 upon successful completion.
 523  */
 524
 525 int ADMINAPI
 526 afsclient_TokenGetNew(const char *cellName, const char *principal,
 527                       const char *password, void **tokenHandle,
 528                       afs_status_p st)
 529 {
 530     int rc = 0;
 531     afs_status_t tst = 0;
 532     afs_token_handle_p t_handle =
 533         (afs_token_handle_p) calloc(1, sizeof(afs_token_handle_t));
 534
 535     if (client_init == 0) {
 536         tst = ADMCLIENTNOINIT;
 537         goto fail_afsclient_TokenGetNew;
 538     }
 539
 540     if (t_handle == NULL) {
 541         tst = ADMNOMEM;
 542         goto fail_afsclient_TokenGetNew;
 543     }
 544
 545     /*
 546      * Check to see if the principal or password is missing.  If it is,
 547      * get unauthenticated tokens for the cell
 548      */
 549
 550     if ((principal == NULL) || (*principal == 0) || (password == NULL)
 551         || (*password == 0)) {
 552         t_handle->from_kernel = 0;
 553         t_handle->afs_token_set = 1;
 554         t_handle->kas_token_set = 1;
 555         t_handle->sc_index = 0;
 556         t_handle->afs_sc[t_handle->sc_index] =
 557             rxnull_NewClientSecurityObject();
 558         t_handle->afs_encrypt_sc[t_handle->sc_index] =
 559             rxnull_NewClientSecurityObject();
 560         t_handle->kas_sc[t_handle->sc_index] =
 561             rxnull_NewClientSecurityObject();
 562         t_handle->begin_magic = BEGIN_MAGIC;
 563         t_handle->is_valid = 1;
 564         t_handle->afs_token.endTime = 0;
 565         t_handle->end_magic = END_MAGIC;
 566         *tokenHandle = (void *)t_handle;
 567
 568     } else {
 569
 570         /*
 571          * create an authenticated token
 572          */
 573
 574         if ((GetAFSToken(cellName, principal, password, t_handle, &tst))
 575             && (GetKASToken(cellName, principal, password, t_handle, &tst))) {
 576             strncpy(t_handle->cell, cellName, MAXCELLCHARS);
 577             t_handle->cell[MAXCELLCHARS - 1] = '\0';
 578             t_handle->from_kernel = 0;
 579             t_handle->afs_token_set = 1;
 580             t_handle->kas_token_set = 1;
 581             t_handle->sc_index = 2;
 582             t_handle->afs_sc[t_handle->sc_index] =
 583                 rxkad_NewClientSecurityObject(rxkad_clear,
 584                                               &t_handle->afs_token.sessionKey,
 585                                               t_handle->afs_token.kvno,
 586                                               t_handle->afs_token.ticketLen,
 587                                               t_handle->afs_token.ticket);
 588             t_handle->afs_encrypt_sc[t_handle->sc_index] =
 589                 rxkad_NewClientSecurityObject(rxkad_crypt,
 590                                               &t_handle->afs_token.sessionKey,
 591                                               t_handle->afs_token.kvno,
 592                                               t_handle->afs_token.ticketLen,
 593                                               t_handle->afs_token.ticket);
 594             t_handle->kas_sc[t_handle->sc_index] =
 595                 rxkad_NewClientSecurityObject(rxkad_crypt,
 596                                               &t_handle->kas_token.sessionKey,
 597                                               t_handle->kas_token.kvno,
 598                                               t_handle->kas_token.ticketLen,
 599                                               t_handle->kas_token.ticket);
 600             if ((t_handle->afs_sc[t_handle->sc_index] != NULL)
 601                 && (t_handle->afs_encrypt_sc[t_handle->sc_index] != NULL)
 602                 && (t_handle->kas_sc[t_handle->sc_index] != NULL)) {
 603                 t_handle->begin_magic = BEGIN_MAGIC;
 604                 t_handle->is_valid = 1;
 605                 t_handle->end_magic = END_MAGIC;
 606                 *tokenHandle = (void *)t_handle;
 607             } else {
 608                 tst = ADMCLIENTTOKENHANDLENOSECURITY;
 609                 goto fail_afsclient_TokenGetNew;
 610             }
 611         } else {
 612             goto fail_afsclient_TokenGetNew;
 613         }
 614     }
 615     rc = 1;
 616
 617   fail_afsclient_TokenGetNew:
 618
 619     if ((rc == 0) && (t_handle != NULL)) {
 620         free(t_handle);
 621     }
 622
 623     if (st != NULL) {
 624         *st = tst;
 625     }
 626     return rc;
 627 }
 628
 629 /*
 630  * afsclient_TokenQuery - get the expiration time of the tokens.
 631  *
 632  * PARAMETERS
 633  *
 634  * IN tokenHandle - a previously obtained valid token.
 635  *
 636  * OUT expirationDateP - the time at which the tokens expire.
 637  *
 638  * OUT principal - the owning principal
 639  *
 640  * OUT instance - principal instance if it exists.
 641  *
 642  * OUT cell - the principal's cell
 643  *
 644  * OUT hasKasTokens - set to 1 if the token handle contains kas tokens.
 645  *
 646  * LOCKS
 647  *
 648  * No locks are obtained or released by this function
 649  *
 650  * CAUTIONS
 651  *
 652  * We only check the AFS tokens since we always get these.  The
 653  * KAS tokens may expirer later than the AFS tokens, but this
 654  * difference is minor and reporting an earlier time won't cause
 655  * the user problems.
 656  *
 657  * RETURN CODES
 658  *
 659  * Returns != 0 upon successful completion.
 660  */
 661
 662 int ADMINAPI
 663 afsclient_TokenQuery(void *tokenHandle, unsigned long *expirationDateP,
 664                      char *principal, char *instance, char *cell,
 665                      int *hasKasTokens, afs_status_p st)
 666 {
 667     int rc = 0;
 668     afs_status_t tst = 0;
 669     afs_token_handle_p t_handle = (afs_token_handle_p) tokenHandle;
 670
 671     if (client_init == 0) {
 672         tst = ADMCLIENTNOINIT;
 673         rc = 0;
 674         goto fail_afsclient_TokenQuery;
 675     }
 676
 677     if (IsTokenValid(t_handle, &tst)) {
 678         if (principal != NULL) {
 679             strcpy(principal, t_handle->client.name);
 680         }
 681         if (instance != NULL) {
 682             strcpy(instance, t_handle->client.instance);
 683         }
 684         if (cell != NULL) {
 685             strcpy(cell, t_handle->client.cell);
 686         }
 687         if (hasKasTokens != NULL) {
 688             *hasKasTokens = t_handle->kas_token_set;
 689         }
 690         if (expirationDateP != NULL) {
 691             *expirationDateP = t_handle->afs_token.endTime;
 692         }
 693         rc = 1;
 694     }
 695
 696   fail_afsclient_TokenQuery:
 697
 698     if (st != NULL) {
 699         *st = tst;
 700     }
 701     return rc;
 702 }
 703
 704 /*
 705  * afsclient_TokenClose - close an existing token.
 706  *
 707  * PARAMETERS
 708  *
 709  * IN token - the token to be closed.
 710  *
 711  * LOCKS
 712  *
 713  * No locks are obtained or released by this function
 714  *
 715  * CAUTIONS
 716  *
 717  * None.
 718  *
 719  * RETURN CODES
 720  *
 721  * Returns != 0 upon successful completion.
 722  */
 723
 724 int ADMINAPI
 725 afsclient_TokenClose(const void *tokenHandle, afs_status_p st)
 726 {
 727     int rc = 0;
 728     afs_status_t tst = 0;
 729     afs_token_handle_p t_handle = (afs_token_handle_p) tokenHandle;
 730
 731     if (client_init == 0) {
 732         tst = ADMCLIENTNOINIT;
 733         goto fail_afsclient_TokenClose;
 734     }
 735
 736     if (IsTokenValid(t_handle, &tst)) {
 737         t_handle->is_valid = 0;
 738         free(t_handle);
 739         rc = 1;
 740     }
 741
 742   fail_afsclient_TokenClose:
 743
 744     if (st != NULL) {
 745         *st = tst;
 746     }
 747     return rc;
 748 }
 749
 750 #define NUM_SERVER_TYPES 3
 751
 752 /* must match NUM_SERVER_TYPES */
 753 typedef enum { KAS, PTS, VOS } afs_server_list_t;
 754
 755 typedef struct afs_server {
 756     char *serv;
 757     int serviceId;
 758     struct ubik_client **ubik;
 759     struct rx_securityClass *sc;
 760     int *valid;
 761 } afs_server_t, *afs_server_p;
 762
 763 /*
 764  * afsclient_CellOpen - Open a particular cell for work as a particular
 765  * user.
 766  *
 767  * PARAMETERS
 768  *
 769  * IN cellName - the cell where future admin calls will be made.
 770  *
 771  * IN tokenHandle - the tokens work will be done under.
 772  *
 773  * OUT cellHandleP - an opaque pointer that is the first parameter to
 774  * almost all subsequent admin api calls.
 775  *
 776  * LOCKS
 777  *
 778  * No locks are obtained or released by this function
 779  *
 780  * CAUTIONS
 781  *
 782  * None.
 783  *
 784  * RETURN CODES
 785  *
 786  * Returns != 0 upon successful completion.
 787  */
 788
 789 int ADMINAPI
 790 afsclient_CellOpen(const char *cellName, const void *tokenHandle,
 791                    void **cellHandleP, afs_status_p st)
 792 {
 793     int rc = 0;
 794     afs_status_t tst = 0;
 795     afs_token_handle_p t_handle = (afs_token_handle_p) tokenHandle;
 796     afs_cell_handle_p c_handle = (afs_cell_handle_p)
 797         calloc(1, sizeof(afs_cell_handle_t));
 798     struct afsconf_dir *tdir = NULL;
 799     struct afsconf_cell info;
 800     struct rx_connection *serverconns[MAXSERVERS];
 801     int i, j;
 802     struct rx_securityClass *sc[3];
 803     int scIndex;
 804     char copyCell[MAXCELLCHARS];
 805
 806     afs_server_t servers[NUM_SERVER_TYPES]
 807       = { {AFSCONF_KAUTHSERVICE, KA_MAINTENANCE_SERVICE, 0, 0, 0},
 808           {AFSCONF_PROTSERVICE, PRSRV, 0, 0, 0},
 809           {AFSCONF_VLDBSERVICE, USER_SERVICE_ID, 0, 0, 0}
 810       };
 811
 812     if (client_init == 0) {
 813         tst = ADMCLIENTNOINIT;
 814         goto fail_afsclient_CellOpen;
 815     }
 816
 817     if (c_handle == NULL) {
 818         tst = ADMNOMEM;
 819         goto fail_afsclient_CellOpen;
 820     }
 821
 822     if (t_handle == NULL) {
 823         tst = ADMCLIENTTOKENHANDLENULL;
 824         goto fail_afsclient_CellOpen;
 825     }
 826
 827     if ((cellName == NULL) || (*cellName == 0)) {
 828         tst = ADMCLIENTCELLNAMENULL;
 829         goto fail_afsclient_CellOpen;
 830     }
 831
 832     if (cellHandleP == NULL) {
 833         tst = ADMCLIENTCELLHANDLEPNULL;
 834         goto fail_afsclient_CellOpen;
 835     }
 836
 837     /*
 838      * Check that the token handle contains valid data and the calloc
 839      * succeeded
 840      */
 841     if (!t_handle->afs_token_set) {
 842         tst = ADMCLIENTCELLOPENBADTOKEN;
 843         goto fail_afsclient_CellOpen;
 844     }
 845
 846     /*
 847      * Use a table to initialize the cell handle structure, since
 848      * most of the steps are the same for all the servers.
 849      *
 850      * Start by creating rx_securityClass objects for each of the
 851      * servers.  A potential optimization is to do this in
 852      * afsclient_TokenGetNew and just keep the expiration time of
 853      * the tokens around.
 854      * Also, initialize the ubik client pointers in the table
 855      */
 856     servers[KAS].sc = t_handle->kas_sc[t_handle->sc_index];
 857     servers[PTS].sc = t_handle->afs_sc[t_handle->sc_index];
 858     servers[VOS].sc = servers[PTS].sc;
 859     servers[KAS].ubik = &c_handle->kas;
 860     servers[PTS].ubik = &c_handle->pts;
 861     servers[VOS].ubik = &c_handle->vos;
 862     servers[KAS].valid = &c_handle->kas_valid;
 863     servers[PTS].valid = &c_handle->pts_valid;
 864     servers[VOS].valid = &c_handle->vos_valid;
 865     c_handle->vos_new = 1;
 866
 867     if ((servers[PTS].sc == NULL) || (servers[VOS].sc == NULL)) {
 868         tst = ADMCLIENTBADTOKENHANDLE;
 869         goto fail_afsclient_CellOpen;
 870     }
 871
 872     /*
 873      * If the initialization has succeeded so far, get the address
 874      * information for each server in the cell
 875      */
 876
 877     strncpy(c_handle->working_cell, cellName, MAXCELLCHARS);
 878     c_handle->working_cell[MAXCELLCHARS - 1] = '\0';
 879     if (!(tdir = afsconf_Open(AFSDIR_CLIENT_ETC_DIRPATH))) {
 880         tst = ADMCLIENTBADCLIENTCONFIG;
 881         goto fail_afsclient_CellOpen;
 882     }
 883
 884     /*
 885      * We must copy the cellName here because afsconf_GetCellInfo
 886      * actually writes over the cell name it is passed.
 887      */
 888     strncpy(copyCell, cellName, MAXCELLCHARS);
 889     copyCell[MAXCELLCHARS - 1] ='\0';
 890     for (i = 0; (i < NUM_SERVER_TYPES); i++) {
 891         if (i == KAS) {
 892             tst =
 893                 ka_AuthServerConn((char *)cellName, servers[i].serviceId,
 894                                   ((t_handle->sc_index == 0)
 895                                    || (!t_handle->
 896                                        kas_token_set)) ? 0 : &t_handle->
 897                                   kas_token, servers[i].ubik);
 898             if (tst) {
 899                 goto fail_afsclient_CellOpen;
 900             }
 901         } else {
 902             tst = afsconf_GetCellInfo(tdir, copyCell, servers[i].serv, &info);
 903             if (!tst) {
 904                 /* create ubik client handles for each server */
 905                 scIndex = t_handle->sc_index;
 906                 sc[scIndex] = servers[i].sc;
 907                 for (j = 0; (j < info.numServers); j++) {
 908                     serverconns[j] =
 909                         rx_GetCachedConnection(info.hostAddr[j].sin_addr.
 910                                                s_addr,
 911                                                info.hostAddr[j].sin_port,
 912                                                servers[i].serviceId,
 913                                                sc[scIndex], scIndex);
 914                 }
 915                 serverconns[j] = 0;
 916                 tst = ubik_ClientInit(serverconns, servers[i].ubik);
 917                 if (tst) {
 918                     goto fail_afsclient_CellOpen;
 919                 }
 920             } else {
 921                 goto fail_afsclient_CellOpen;
 922             }
 923         }
 924         /* initialization complete, mark handle valid */
 925         *servers[i].valid = 1;
 926     }
 927     c_handle->tokens = t_handle;
 928     rc = 1;
 929
 930   fail_afsclient_CellOpen:
 931
 932     if (tdir) {
 933         afsconf_Close(tdir);
 934     }
 935
 936     /*
 937      * Upon error, free any obtained resources.
 938      */
 939     if (rc == 0) {
 940         if (c_handle != NULL) {
 941             if (c_handle->kas_valid)
 942                 ubik_ClientDestroy(c_handle->kas);
 943             if (c_handle->pts_valid)
 944                 ubik_ClientDestroy(c_handle->pts);
 945             if (c_handle->vos_valid)
 946                 ubik_ClientDestroy(c_handle->vos);
 947             free(c_handle);
 948         }
 949     } else {
 950         c_handle->begin_magic = BEGIN_MAGIC;
 951         c_handle->is_valid = 1;
 952         c_handle->is_null = 0;
 953         c_handle->server_list = NULL;
 954         c_handle->server_ttl = 0;
 955         c_handle->end_magic = END_MAGIC;
 956         *cellHandleP = (void *)c_handle;
 957     }
 958
 959     if (st != NULL) {
 960         *st = tst;
 961     }
 962     return rc;
 963 }
 964
 965 /*
 966  * afsclient_NullCellOpen - open a null cell handle for access.
 967  *
 968  * PARAMETERS
 969  *
 970  * OUT cellHandleP - an opaque pointer that is the first parameter to
 971  * almost all subsequent admin api calls.
 972  *
 973  * LOCKS
 974  *
 975  * No locks are obtained or released by this function
 976  *
 977  * CAUTIONS
 978  *
 979  * None.
 980  *
 981  * RETURN CODES
 982  *
 983  * Returns != 0 upon successful completion.
 984  */
 985
 986 int ADMINAPI
 987 afsclient_NullCellOpen(void **cellHandleP, afs_status_p st)
 988 {
 989     int rc = 0;
 990     afs_status_t tst = 0;
 991     afs_cell_handle_p c_handle = (afs_cell_handle_p)
 992         calloc(1, sizeof(afs_cell_handle_t));
 993
 994
 995     /*
 996      * Validate parameters
 997      */
 998
 999     if (cellHandleP == NULL) {
1000         tst = ADMCLIENTCELLHANDLEPNULL;
1001         goto fail_afsclient_NullCellOpen;
1002     }
1003
1004     if (client_init == 0) {
1005         tst = ADMCLIENTNOINIT;
1006         goto fail_afsclient_NullCellOpen;
1007     }
1008
1009     if (c_handle == NULL) {
1010         tst = ADMNOMEM;
1011         goto fail_afsclient_NullCellOpen;
1012     }
1013
1014     /*
1015      * Get unauthenticated tokens for any cell
1016      */
1017
1018     if (!afsclient_TokenGetNew(0, 0, 0, (void *)&c_handle->tokens, &tst)) {
1019         goto fail_afsclient_NullCellOpen;
1020     }
1021
1022     c_handle->begin_magic = BEGIN_MAGIC;
1023     c_handle->is_valid = 1;
1024     c_handle->is_null = 1;
1025     c_handle->end_magic = END_MAGIC;
1026     c_handle->kas_valid = 0;
1027     c_handle->pts_valid = 0;
1028     c_handle->vos_valid = 0;
1029     c_handle->kas = NULL;
1030     c_handle->pts = NULL;
1031     c_handle->vos = NULL;
1032     c_handle->server_list = NULL;
1033     c_handle->server_ttl = 0;
1034     *cellHandleP = (void *)c_handle;
1035     rc = 1;
1036
1037   fail_afsclient_NullCellOpen:
1038
1039     if (st != NULL) {
1040         *st = tst;
1041     }
1042     return rc;
1043 }
1044
1045 /*
1046  * afsclient_CellClose - close a previously opened cellHandle.
1047  *
1048  * PARAMETERS
1049  *
1050  * IN cellHandle - a cellHandle created by afsclient_CellOpen.
1051  *
1052  * LOCKS
1053  *
1054  * No locks are obtained or released by this function
1055  *
1056  * CAUTIONS
1057  *
1058  * None.
1059  *
1060  * RETURN CODES
1061  *
1062  * Returns != 0 upon successful completion.
1063  */
1064
1065 int ADMINAPI
1066 afsclient_CellClose(const void *cellHandle, afs_status_p st)
1067 {
1068     int rc = 0;
1069     afs_status_t tst = 0;
1070     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
1071
1072     if (client_init == 0) {
1073         tst = ADMCLIENTNOINIT;
1074         goto fail_afsclient_CellClose;
1075     }
1076
1077     if (c_handle == NULL) {
1078         tst = ADMCLIENTCELLHANDLENULL;
1079         goto fail_afsclient_CellClose;
1080     }
1081
1082     if (c_handle->server_list)
1083         free(c_handle->server_list);
1084     if (c_handle->kas_valid)
1085         ubik_ClientDestroy(c_handle->kas);
1086     if (c_handle->pts_valid)
1087         ubik_ClientDestroy(c_handle->pts);
1088     if (c_handle->vos_valid)
1089         ubik_ClientDestroy(c_handle->vos);
1090     if (c_handle->is_null)
1091         afsclient_TokenClose(c_handle->tokens, 0);
1092     c_handle->kas_valid = 0;
1093     c_handle->pts_valid = 0;
1094     c_handle->vos_valid = 0;
1095     c_handle->is_valid = 0;
1096     free(c_handle);
1097     rc = 1;
1098
1099   fail_afsclient_CellClose:
1100
1101     if (st != NULL) {
1102         *st = tst;
1103     }
1104     return rc;
1105 }
1106
1107
1108 /*
1109  * afsclient_CellNameGet() -- get a pointer to the cell name in a cell handle
1110  *
1111  * PARAMETERS
1112  *
1113  * IN  cellHandle - a valid cell handle
1114  * OUT cellNameP  - a pointer to the cell name in the cell handle.
1115  *
1116  * LOCKS
1117  *
1118  * No locks are obtained or released by this function
1119  *
1120  * CAUTIONS
1121  *
1122  * If cellHandle is closed then the pointer returned by this function
1123  * is no longer valid.
1124  *
1125  * RETURN CODES
1126  *
1127  * Returns != 0 upon successful completion.
1128  */
1129 int ADMINAPI
1130 afsclient_CellNameGet(const void *cellHandle, const char **cellNameP,
1131                       afs_status_p st)
1132 {
1133     int rc = 0;
1134     afs_status_t tst = 0;
1135     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
1136
1137     if (!CellHandleIsValid(cellHandle, &tst)) {
1138         goto fail_afsclient_CellNameGet;
1139     }
1140
1141     *cellNameP = c_handle->working_cell;
1142     rc = 1;
1143
1144   fail_afsclient_CellNameGet:
1145
1146     if (st != NULL) {
1147         *st = tst;
1148     }
1149     return rc;
1150 }
1151
1152
1153 /*
1154  * afsclient_LocalCellGet - get the name of the cell the machine
1155  * belongs to where this process is running.
1156  *
1157  * PARAMETERS
1158  *
1159  * OUT cellName - an array of characters that must be MAXCELLCHARS
1160  * long.
1161  *
1162  * LOCKS
1163  *
1164  * No locks are obtained or released by this function
1165  *
1166  * CAUTIONS
1167  *
1168  * If cellName is smaller than MAXCELLCHARS chars, this function won't
1169  * detect it.
1170  *
1171  * RETURN CODES
1172  *
1173  * Returns != 0 upon successful completion.
1174  */
1175
1176 int ADMINAPI
1177 afsclient_LocalCellGet(char *cellName, afs_status_p st)
1178 {
1179     int rc = 0;
1180     afs_status_t tst = 0;
1181     struct afsconf_dir *tdir = NULL;
1182
1183     if (client_init == 0) {
1184         tst = ADMCLIENTNOINIT;
1185         goto fail_afsclient_LocalCellGet;
1186     }
1187
1188     if (cellName == NULL) {
1189         tst = ADMCLIENTCELLNAMENULL;
1190         goto fail_afsclient_LocalCellGet;
1191     }
1192
1193     tdir = afsconf_Open(AFSDIR_CLIENT_ETC_DIRPATH);
1194
1195     if (!tdir) {
1196         tst = ADMCLIENTBADCLIENTCONFIG;
1197         goto fail_afsclient_LocalCellGet;
1198     }
1199
1200     if ((tst = afsconf_GetLocalCell(tdir, cellName, MAXCELLCHARS))) {
1201         goto fail_afsclient_LocalCellGet;
1202     }
1203
1204     rc = 1;
1205
1206   fail_afsclient_LocalCellGet:
1207
1208     if (tdir != NULL) {
1209         afsconf_Close(tdir);
1210     }
1211
1212     if (st != NULL) {
1213         *st = tst;
1214     }
1215     return rc;
1216 }
1217
1218
1219 #ifdef AFS_NT40_ENV
1220
1221 static int
1222 client_ExtractDriveLetter(char *path)
1223 {
1224     int rc = 0;
1225
1226     if (path[0] != 0 && path[1] == ':') {
1227         path[2] = 0;
1228         rc = 1;
1229     }
1230
1231     return rc;
1232 }
1233
1234 /*
1235  * Determine the parent directory of a give directory
1236  */
1237
1238 static int
1239 Parent(char *directory, char *parentDirectory)
1240 {
1241     register char *tp;
1242     int rc = 0;
1243
1244     strcpy(parentDirectory, directory);
1245     tp = strrchr(parentDirectory, '\\');
1246     if (tp) {
1247         /* lv trailing slash so Parent("k:\foo") is "k:\" not "k :" */
1248         *(tp + 1) = 0;
1249         rc = 1;
1250     } else {
1251         if (client_ExtractDriveLetter(parentDirectory)) {
1252             strcat(parentDirectory, ".");
1253             rc = 1;
1254         }
1255     }
1256
1257     return rc;
1258 }
1259
1260 #else
1261 /*
1262  * Determine the parent directory of a give directory
1263  */
1264 static int
1265 Parent(const char *directory, char *parentDirectory)
1266 {
1267     char *tp;
1268     int rc = 0;
1269
1270     strcpy(parentDirectory, directory);
1271     tp = strrchr(parentDirectory, '/');
1272     if (tp) {
1273         *tp = 0;
1274         rc = 1;
1275     } else {
1276         strcpy(parentDirectory, ".");
1277         rc = 1;
1278     }
1279
1280     return rc;
1281 }
1282 #endif
1283
1284 /*
1285  * afsclient_MountPointCreate - create a mount point for a volume.
1286  *
1287  * PARAMETERS
1288  *
1289  * IN cellHandle - a handle to the cell where volumeName resides.
1290  *
1291  * IN directory - the directory where the mountpoint should be created.
1292  *
1293  * IN volumeName - the name of the volume to mount.
1294  *
1295  * IN volType - the type of mount point to create.
1296  *
1297  * IN volCheck - indicates whether or not to check the VLDB to see if
1298  * volumeName exists.
1299  *
1300  * LOCKS
1301  *
1302  * No locks are obtained or released by this function
1303  *
1304  * RETURN CODES
1305  *
1306  * Returns != 0 upon successful completion.
1307  */
1308
1309 #define TMP_DATA_SIZE 2048
1310
1311 int ADMINAPI
1312 afsclient_MountPointCreate(const void *cellHandle, const char *directory,
1313                            const char *volumeName, vol_type_t volType,
1314                            vol_check_t volCheck, afs_status_p st)
1315 {
1316     int rc = 0;
1317     afs_status_t tst = 0;
1318     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
1319     char parent_dir[TMP_DATA_SIZE];
1320     char space[TMP_DATA_SIZE];
1321     char directoryCell[MAXCELLCHARS];
1322     struct ViceIoctl idata;
1323     int i;
1324     vos_vldbEntry_t vldbEntry;
1325
1326     /*
1327      * Validate arguments
1328      */
1329
1330     if (client_init == 0) {
1331         tst = ADMCLIENTNOINIT;
1332         goto fail_afsclient_MountPointCreate;
1333     }
1334
1335     if ((directory == NULL) || (*directory == 0)) {
1336         tst = ADMCLIENTDIRECTORYNULL;
1337         goto fail_afsclient_MountPointCreate;
1338     }
1339
1340     if ((volumeName == NULL) || (*volumeName == 0)) {
1341         tst = ADMCLIENTVOLUMENAME;
1342         goto fail_afsclient_MountPointCreate;
1343     }
1344
1345     /*
1346      * Extract the parent directory and make sure it is in AFS.
1347      */
1348
1349     if (!Parent(directory, parent_dir)) {
1350         tst = ADMCLIENTBADDIRECTORY;
1351         goto fail_afsclient_MountPointCreate;
1352     }
1353
1354     idata.in_size = 0;
1355     idata.out_size = TMP_DATA_SIZE;
1356     idata.out = space;
1357     i = pioctl(parent_dir, VIOC_FILE_CELL_NAME, &idata, 1);
1358     if (i) {
1359         if ((errno == EINVAL) || (errno == ENOENT)) {
1360             tst = ADMCLIENTNOAFSDIRECTORY;
1361             goto fail_afsclient_MountPointCreate;
1362         }
1363     }
1364     strcpy(directoryCell, space);
1365
1366     /*
1367      * If the user requested, check that the volume exists
1368      */
1369
1370     if (volCheck == CHECK_VOLUME) {
1371         if (!vos_VLDBGet(cellHandle, 0, 0, volumeName, &vldbEntry, &tst)) {
1372             goto fail_afsclient_MountPointCreate;
1373         }
1374     }
1375
1376     /*
1377      * Begin constructing the pioctl buffer
1378      */
1379
1380     if (volType == READ_WRITE) {
1381         strcpy(space, "%");
1382     } else {
1383         strcpy(space, "#");
1384     }
1385
1386     /*
1387      * Append the cell to the mount point if the volume is in a different
1388      * cell than the directory
1389      */
1390
1391     if (strcmp(c_handle->working_cell, directoryCell)) {
1392         strcat(space, c_handle->working_cell);
1393         strcat(space, ":");
1394     }
1395     strcat(space, volumeName);
1396     strcat(space, ".");
1397
1398
1399 #ifdef AFS_NT40_ENV
1400     idata.out_size = 0;
1401     idata.out = NULL;
1402     idata.in_size = 1 + strlen(space);
1403     idata.in = space;
1404     if (tst = pioctl(directory, VIOC_AFS_CREATE_MT_PT, &idata, 0)) {
1405         goto fail_afsclient_MountPointCreate;
1406     }
1407 #else
1408     if ((tst = symlink(space, directory))) {
1409         goto fail_afsclient_MountPointCreate;
1410     }
1411 #endif
1412
1413     rc = 1;
1414
1415   fail_afsclient_MountPointCreate:
1416
1417     if (st != NULL) {
1418         *st = tst;
1419     }
1420     return rc;
1421 }
1422
1423 typedef struct Acl {
1424     int dfs;
1425     char cell[1025];
1426     int nplus;
1427     int nminus;
1428 } Acl_t, *Acl_p;
1429
1430 int ADMINAPI
1431 afsclient_ACLEntryAdd(const char *directory, const char *user,
1432                       const acl_p acl, afs_status_p st)
1433 {
1434     int rc = 0;
1435     afs_status_t tst = 0;
1436     struct ViceIoctl idata;
1437     char old_acl_string[2048];
1438     char new_acl_string[2048];
1439     int newacl = 0;
1440     char *ptr;
1441     Acl_t cur_acl;
1442     char cur_user[64];
1443     int cur_user_acl = 0;
1444     int i;
1445     char tmp[64 + 35];
1446     int is_dfs;
1447
1448     if (client_init == 0) {
1449         tst = ADMCLIENTNOINIT;
1450         goto fail_afsclient_ACLEntryAdd;
1451     }
1452
1453     if ((directory == NULL) || (*directory == 0)) {
1454         tst = ADMMISCDIRECTORYNULL;
1455         goto fail_afsclient_ACLEntryAdd;
1456     }
1457
1458     if ((user == NULL) || (*user == 0)) {
1459         tst = ADMMISCUSERNULL;
1460         goto fail_afsclient_ACLEntryAdd;
1461     }
1462
1463     if (acl == NULL) {
1464         tst = ADMMISCACLNULL;
1465         goto fail_afsclient_ACLEntryAdd;
1466     }
1467
1468     if (acl->read == READ) {
1469         newacl |= 0x01;
1470     }
1471
1472     if (acl->write == WRITE) {
1473         newacl |= 0x02;
1474     }
1475
1476     if (acl->insert == INSERT) {
1477         newacl |= 0x04;
1478     }
1479
1480     if (acl->lookup == LOOKUP) {
1481         newacl |= 0x08;
1482     }
1483
1484     if (acl->del == DELETE) {
1485         newacl |= 0x10;
1486     }
1487
1488     if (acl->lock == LOCK) {
1489         newacl |= 0x20;
1490     }
1491
1492     if (acl->admin == ADMIN) {
1493         newacl |= 0x40;
1494     }
1495
1496     /*
1497      * Get the current acl for the directory
1498      */
1499
1500     idata.out_size = 2048;
1501     idata.in_size = 0;
1502     idata.in = idata.out = old_acl_string;
1503     tst = pioctl(directory, VIOCGETAL, &idata, 1);
1504
1505     if (tst != 0) {
1506         goto fail_afsclient_ACLEntryAdd;
1507     }
1508
1509     /*
1510      * The acl is presented to us in string format.  The format of the
1511      * string is:
1512      *
1513      * A header which contains the number of positive and negative entries
1514      * and a string indicating whether or not this is a dfs acl:
1515      *
1516      * num_pos "\n" dfs_string "\n" num_neg
1517      *
1518      * An entry for each acl that's of the form:
1519      *
1520      * name rights "\n"
1521      *
1522      * There are no blanks in the string between fields, but I use them here
1523      * to make the reading easier.
1524      *
1525      * Since we are only going to add another entry to the acl, our approach
1526      * is simple.  Get the num_pos dfs_string and num_neg from the current acl,
1527      * increment num_pos by one and create a new string.  Concatenate the new
1528      * user and rights to the new string, and then concatenate the remaining
1529      * contents of the old acl to the new string.
1530      *
1531      * Unfortunately, this approach doesn't work since the format the kernel
1532      * hands the acl back to us in, is NOT WHAT IT WANTS BACK!!!!
1533      * So instead we need to parse the entire freaking acl and put a space
1534      * between each user and their acl.
1535      *
1536      * This is really ugly.
1537      */
1538
1539     /*
1540      * Parse the first few fields of the acl and see if this is a DFS
1541      * file.
1542      */
1543
1544     is_dfs =
1545         sscanf(old_acl_string, "%d dfs:%d %s", &cur_acl.nplus, &cur_acl.dfs,
1546                cur_acl.cell);
1547     ptr = strchr(old_acl_string, '\n');
1548     ptr++;
1549     sscanf(ptr, "%d", &cur_acl.nminus);
1550     ptr = strchr(ptr, '\n');
1551     ptr++;
1552     if (is_dfs == 3) {
1553         tst = ADMMISCNODFSACL;
1554         goto fail_afsclient_ACLEntryAdd;
1555     } else {
1556         /*
1557          * It isn't a DFS file, so create the beginning of the string
1558          * we will hand back to the kernel
1559          */
1560         sprintf(new_acl_string, "%d\n%d\n%s %d\n", (cur_acl.nplus + 1),
1561                 cur_acl.nminus, user, newacl);
1562     }
1563
1564     /*
1565      * Finish scanning the old acl, parsing each user/acl pair and
1566      * adding a space in the new acl.
1567      */
1568
1569     for (i = 0; i < (cur_acl.nplus + cur_acl.nminus); i++) {
1570         sscanf(ptr, "%s%d\n", cur_user, &cur_user_acl);
1571         /*
1572          * Skip the entry for the user we are replacing/adding
1573          */
1574
1575         if (strcmp(cur_user, user)) {
1576             ptr = strchr(ptr, '\n');
1577             ptr++;
1578             sprintf(tmp, "%s %d\n", cur_user, cur_user_acl);
1579             strcat(new_acl_string, tmp);
1580         }
1581     }
1582
1583     strcat(new_acl_string, ptr);
1584
1585     /*
1586      * Set the acl
1587      */
1588
1589     idata.out_size = 0;
1590     idata.in_size = strlen(new_acl_string) + 1;
1591     idata.in = idata.out = new_acl_string;
1592     tst = pioctl(directory, VIOCSETAL, &idata, 1);
1593
1594     if (tst != 0) {
1595         goto fail_afsclient_ACLEntryAdd;
1596     }
1597     rc = 1;
1598
1599   fail_afsclient_ACLEntryAdd:
1600
1601     if (st != NULL) {
1602         *st = tst;
1603     }
1604     return rc;
1605 }
1606
1607 /*
1608  * afsclient_Init - initialize AFS components before use.
1609  *
1610  * PARAMETERS
1611  *
1612  * LOCKS
1613  *
1614  * No locks are obtained or released by this function
1615  *
1616  * CAUTIONS
1617  *
1618  * None.
1619  *
1620  * RETURN CODES
1621  *
1622  * Returns != 0 upon successful completion.
1623  */
1624
1625 int ADMINAPI
1626 afsclient_Init(afs_status_p st)
1627 {
1628     int rc = 0;
1629     afs_status_t tst = 0;
1630
1631     if (!client_init)
1632         pthread_once(&client_init_once, client_once);
1633
1634 #ifdef AFS_NT40_ENV
1635     if (afs_winsockInit() < 0) {
1636         tst = ADMCLIENTCANTINITWINSOCK;
1637         goto fail_afsclient_Init;
1638     }
1639 #endif
1640
1641     if (!(initAFSDirPath() & AFSDIR_CLIENT_PATHS_OK)) {
1642         tst = ADMCLIENTCANTINITAFSLOCATION;
1643         goto fail_afsclient_Init;
1644     }
1645
1646     if (rx_Init(0) < 0) {
1647         tst = ADMCLIENTCANTINITRX;
1648         goto fail_afsclient_Init;
1649     }
1650
1651     if ((tst = ka_CellConfig((char *)AFSDIR_CLIENT_ETC_DIRPATH))) {
1652         goto fail_afsclient_Init;
1653     }
1654
1655     rc = 1;
1656
1657   fail_afsclient_Init:
1658
1659     if (st != NULL) {
1660         *st = tst;
1661     }
1662     return rc;
1663 }
1664
1665 /*
1666  * afsclient_AFSServerGet - determine what kind of server serverName
1667  * is and fill in serverEntryP accordingly.
1668  *
1669  * PARAMETERS
1670  *
1671  * IN cellHandle - a cellHandle previously returned by afsclient_CellOpen.
1672  *
1673  * IN serverName - the hostname of the server of interest.
1674  *
1675  * OUT serverEntryP - upon successful completion contains a description of
1676  * the server.
1677  *
1678  * LOCKS
1679  *
1680  * No locks are obtained or released by this function
1681  *
1682  * CAUTIONS
1683  *
1684  * None.
1685  *
1686  * RETURN CODES
1687  *
1688  * Returns != 0 upon successful completion.
1689  */
1690
1691 int ADMINAPI
1692 afsclient_AFSServerGet(const void *cellHandle, const char *serverName,
1693                        afs_serverEntry_p serverEntryP, afs_status_p st)
1694 {
1695     int rc = 0;
1696     afs_status_t tst = 0;
1697     void *iter;
1698     int found_match = 0;
1699
1700     if ((serverName == NULL) || (*serverName == 0)) {
1701         tst = ADMUTILSERVERNAMENULL;
1702         goto fail_afsclient_AFSServerGet;
1703     }
1704
1705     if (serverEntryP == NULL) {
1706         tst = ADMUTILSERVERENTRYPNULL;
1707         goto fail_afsclient_AFSServerGet;
1708     }
1709
1710     /*
1711      * Iterate over server entries and try to find a match for serverName
1712      */
1713
1714     if (!afsclient_AFSServerGetBegin(cellHandle, &iter, &tst)) {
1715         goto fail_afsclient_AFSServerGet;
1716     }
1717
1718     while (afsclient_AFSServerGetNext(iter, serverEntryP, &tst)) {
1719         if (!strcmp(serverName, serverEntryP->serverName)) {
1720             found_match = 1;
1721             break;
1722         }
1723     }
1724
1725     /*
1726      * If we didn't find a match, the iterator should have terminated
1727      * normally.  If it didn't, return the error
1728      */
1729
1730     if (!found_match) {
1731         if (tst != ADMITERATORDONE) {
1732             afsclient_AFSServerGetDone(iter, 0);
1733         } else {
1734             afsclient_AFSServerGetDone(iter, &tst);
1735         }
1736         tst = ADMCLIENTNOMATCHINGSERVER;
1737         goto fail_afsclient_AFSServerGet;
1738     } else {
1739         if (!afsclient_AFSServerGetDone(iter, &tst)) {
1740             goto fail_afsclient_AFSServerGet;
1741         }
1742     }
1743     rc = 1;
1744
1745   fail_afsclient_AFSServerGet:
1746
1747     if (st != NULL) {
1748         *st = tst;
1749     }
1750     return rc;
1751 }
1752
1753 /*
1754  * The iterator functions and data for the server retrieval functions
1755  */
1756
1757 typedef struct server_get {
1758     int total;
1759     int index;
1760     afs_serverEntry_t server[MAXHOSTSPERCELL + BADSERVERID];
1761     afs_serverEntry_t cache[CACHED_ITEMS];
1762 } server_get_t, *server_get_p;
1763
1764 static int
1765 GetServerRPC(void *rpc_specific, int slot, int *last_item,
1766              int *last_item_contains_data, afs_status_p st)
1767 {
1768     int rc = 0;
1769     afs_status_t tst = 0;
1770     server_get_p serv = (server_get_p) rpc_specific;
1771
1772     memcpy(&serv->cache[slot], &serv->server[serv->index],
1773            sizeof(afs_serverEntry_t));
1774
1775     serv->index++;
1776     if (serv->index == serv->total) {
1777         *last_item = 1;
1778         *last_item_contains_data = 1;
1779     }
1780     rc = 1;
1781
1782     if (st != NULL) {
1783         *st = tst;
1784     }
1785     return rc;
1786 }
1787
1788 static int
1789 GetServerFromCache(void *rpc_specific, int slot, void *dest, afs_status_p st)
1790 {
1791     int rc = 0;
1792     afs_status_t tst = 0;
1793     server_get_p serv = (server_get_p) rpc_specific;
1794
1795     memcpy(dest, (const void *)&serv->cache[slot], sizeof(afs_serverEntry_t));
1796     rc = 1;
1797
1798     if (st != NULL) {
1799         *st = tst;
1800     }
1801     return rc;
1802 }
1803
1804 /*
1805  * afsclient_AFSServerGetBegin - start the process of iterating over
1806  * every server in the cell.
1807  *
1808  * PARAMETERS
1809  *
1810  * IN cellHandle - a cellHandle previously returned by afsclient_CellOpen.
1811  *
1812  * OUT iterationIdP - - upon successful completion contains an iterator
1813  * that can be passed to afsclient_AFSServerGetNext.
1814  *
1815  * LOCKS
1816  *
1817  * No locks are obtained or released by this function
1818  *
1819  * CAUTIONS
1820  *
1821  * None.
1822  *
1823  * RETURN CODES
1824  *
1825  * Returns != 0 upon successful completion.
1826  */
1827
1828 int ADMINAPI
1829 afsclient_AFSServerGetBegin(const void *cellHandle, void **iterationIdP,
1830                             afs_status_p st)
1831 {
1832     int rc = 0;
1833     afs_status_t tst = 0;
1834     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
1835     afs_admin_iterator_p iter =
1836         (afs_admin_iterator_p) malloc(sizeof(afs_admin_iterator_t));
1837     server_get_p serv = (server_get_p) calloc(1, sizeof(server_get_t));
1838     server_get_p serv_cache = NULL;
1839     const char *cellName = NULL;
1840     void *database_iter;
1841     util_databaseServerEntry_t database_entry;
1842     void *fileserver_iter;
1843     vos_fileServerEntry_t fileserver_entry;
1844     int iserv, iservaddr, ientryaddr, is_dup;
1845     struct hostent *host;
1846
1847     if (!CellHandleIsValid(c_handle, &tst)) {
1848         goto fail_afsclient_AFSServerGetBegin;
1849     }
1850
1851     if (iterationIdP == NULL) {
1852         tst = ADMITERATIONIDPNULL;
1853         goto fail_afsclient_AFSServerGetBegin;
1854     }
1855
1856     if ((serv == NULL) || (iter == NULL)) {
1857         tst = ADMNOMEM;
1858         goto fail_afsclient_AFSServerGetBegin;
1859     }
1860
1861   restart:
1862     LOCK_GLOBAL_MUTEX;
1863     if (c_handle->server_list != NULL && c_handle->server_ttl < time(NULL)) {
1864         serv_cache = c_handle->server_list;
1865         c_handle->server_list = NULL;
1866     }
1867     UNLOCK_GLOBAL_MUTEX;
1868
1869     if (c_handle->server_list == NULL) {
1870         if (serv_cache == NULL) {
1871             serv_cache = (server_get_p) calloc(1, sizeof(server_get_t));
1872
1873             if (serv_cache == NULL) {
1874                 tst = ADMNOMEM;
1875                 goto fail_afsclient_AFSServerGetBegin;
1876             }
1877         }
1878
1879         /*
1880          * Retrieve the list of database servers for this cell.
1881          */
1882
1883         if (!afsclient_CellNameGet(c_handle, &cellName, &tst)) {
1884             goto fail_afsclient_AFSServerGetBegin;
1885         }
1886
1887         if (!util_DatabaseServerGetBegin(cellName, &database_iter, &tst)) {
1888             goto fail_afsclient_AFSServerGetBegin;
1889         }
1890
1891         while (util_DatabaseServerGetNext(database_iter, &database_entry, &tst)) {
1892             serv->server[serv->total].serverAddress[0] =
1893                 database_entry.serverAddress;
1894             serv->server[serv->total].serverType = DATABASE_SERVER;
1895             serv->total++;
1896         }
1897
1898         if (tst != ADMITERATORDONE) {
1899             util_DatabaseServerGetDone(database_iter, 0);
1900             goto fail_afsclient_AFSServerGetBegin;
1901         }
1902
1903         if (!util_DatabaseServerGetDone(database_iter, &tst)) {
1904             goto fail_afsclient_AFSServerGetBegin;
1905         }
1906
1907         /*
1908          * Retrieve the list of file servers for this cell.
1909          */
1910
1911         if (!vos_FileServerGetBegin(c_handle, 0, &fileserver_iter, &tst)) {
1912             goto fail_afsclient_AFSServerGetBegin;
1913         }
1914
1915         while (vos_FileServerGetNext(fileserver_iter, &fileserver_entry, &tst)) {
1916             /*
1917              * See if any of the addresses returned in this fileserver_entry
1918              * structure already exist in the list of servers we're building.
1919              * If not, create a new record for this server.
1920              */
1921             is_dup = 0;
1922             for (iserv = 0; iserv < serv->total; iserv++) {
1923                 for (ientryaddr = 0; ientryaddr < fileserver_entry.count; ientryaddr++) {
1924                     for (iservaddr = 0; iservaddr < AFS_MAX_SERVER_ADDRESS; iservaddr++) {
1925                         if (serv->server[iserv].serverAddress[iservaddr] ==
1926                              fileserver_entry.serverAddress[ientryaddr]) {
1927                             is_dup = 1;
1928                             break;
1929                         }
1930                     }
1931                     if (is_dup) {
1932                         break;
1933                     }
1934                 }
1935                 if (is_dup) {
1936                     break;
1937                 }
1938             }
1939
1940             if (is_dup) {
1941                 serv->server[iserv].serverType |= FILE_SERVER;
1942             } else {
1943                 iserv = serv->total++;
1944                 serv->server[iserv].serverType = FILE_SERVER;
1945             }
1946
1947             /*
1948              * Add the addresses from the vldb list to the serv->server[iserv]
1949              * record.  Remember that VLDB's list-of-addrs is not guaranteed
1950              * to be unique in a particular entry, or to return only one entry
1951              * per machine--so when we add addresses, always check for
1952              * duplicate entries.
1953              */
1954
1955             for (ientryaddr = 0; ientryaddr < fileserver_entry.count; ientryaddr++) {
1956                 for (iservaddr = 0; iservaddr < AFS_MAX_SERVER_ADDRESS; iservaddr++) {
1957                     if (serv->server[iserv].serverAddress[iservaddr] ==
1958                          fileserver_entry.serverAddress[ientryaddr]) {
1959                         break;
1960                     }
1961                 }
1962                 if (iservaddr == AFS_MAX_SERVER_ADDRESS) {
1963                     for (iservaddr = 0; iservaddr < AFS_MAX_SERVER_ADDRESS;
1964                           iservaddr++) {
1965                         if (!serv->server[iserv].serverAddress[iservaddr]) {
1966                             serv->server[iserv].serverAddress[iservaddr] =
1967                                 fileserver_entry.serverAddress[ientryaddr];
1968                             break;
1969                         }
1970                     }
1971                 }
1972             }
1973         }
1974
1975         if (tst != ADMITERATORDONE) {
1976             vos_FileServerGetDone(fileserver_iter, 0);
1977             goto fail_afsclient_AFSServerGetBegin;
1978         }
1979
1980         if (!vos_FileServerGetDone(fileserver_iter, &tst)) {
1981             goto fail_afsclient_AFSServerGetBegin;
1982         }
1983
1984         /*
1985          * Iterate over the list and fill in the hostname of each of the servers
1986          */
1987
1988         for (iserv = 0; iserv < serv->total; iserv++) {
1989             int addr = htonl(serv->server[iserv].serverAddress[0]);
1990             LOCK_GLOBAL_MUTEX;
1991             host = gethostbyaddr((const char *)&addr, sizeof(int), AF_INET);
1992             if (host != NULL) {
1993                 strncpy(serv->server[iserv].serverName, host->h_name,
1994                          AFS_MAX_SERVER_NAME_LEN);
1995                 serv->server[iserv].serverName[AFS_MAX_SERVER_NAME_LEN - 1] = '\0';
1996             }
1997             UNLOCK_GLOBAL_MUTEX;
1998         }
1999
2000         memcpy(serv_cache, serv, sizeof(server_get_t));
2001     } else {
2002         int race = 0;
2003         LOCK_GLOBAL_MUTEX;
2004         if (c_handle->server_list == NULL)
2005             race = 1;
2006         else
2007             memcpy(serv, c_handle->server_list, sizeof(server_get_t));
2008         UNLOCK_GLOBAL_MUTEX;
2009         if (race)
2010             goto restart;
2011     }
2012
2013     if (IteratorInit
2014             (iter, (void *)serv, GetServerRPC, GetServerFromCache, NULL, NULL,
2015              &tst)) {
2016         *iterationIdP = (void *)iter;
2017         rc = 1;
2018     }
2019
2020   fail_afsclient_AFSServerGetBegin:
2021
2022     if (rc == 0) {
2023         if (iter != NULL)
2024             free(iter);
2025         if (serv != NULL)
2026             free(serv);
2027         if (serv_cache != NULL)
2028             free(serv_cache);
2029     } else {
2030         if (serv_cache) {
2031             LOCK_GLOBAL_MUTEX;
2032             /* in case there was a race and we constructed the list twice */
2033             if (c_handle->server_list)
2034                 free(c_handle->server_list);
2035
2036             c_handle->server_list = serv_cache;
2037             c_handle->server_ttl = time(NULL) + SERVER_TTL;
2038             UNLOCK_GLOBAL_MUTEX;
2039         }
2040     }
2041
2042     if (st != NULL)
2043         *st = tst;
2044
2045     return rc;
2046 }
2047
2048 /*
2049  * afsclient_AFSServerGetNext - retrieve the next server in the cell.
2050  *
2051  * PARAMETERS
2052  *
2053  * IN iterationId - an iterator previously returned by
2054  * afsclient_AFSServerGetBegin.
2055  *
2056  * OUT serverEntryP - upon successful completion contains the next server.
2057  *
2058  * LOCKS
2059  *
2060  * No locks are obtained or released by this function
2061  *
2062  * CAUTIONS
2063  *
2064  * None.
2065  *
2066  * RETURN CODES
2067  *
2068  * Returns != 0 upon successful completion.
2069  */
2070
2071 int ADMINAPI
2072 afsclient_AFSServerGetNext(void *iterationId, afs_serverEntry_p serverEntryP,
2073                            afs_status_p st)
2074 {
2075     int rc = 0;
2076     afs_status_t tst = 0;
2077     afs_admin_iterator_p iter = (afs_admin_iterator_p) iterationId;
2078
2079     if (iterationId == NULL) {
2080         tst = ADMITERATORNULL;
2081         goto fail_afsclient_AFSServerGetNext;
2082     }
2083
2084     if (serverEntryP == NULL) {
2085         tst = ADMUTILSERVERENTRYPNULL;
2086         goto fail_afsclient_AFSServerGetNext;
2087     }
2088
2089     rc = IteratorNext(iter, (void *)serverEntryP, &tst);
2090
2091   fail_afsclient_AFSServerGetNext:
2092
2093     if (st != NULL) {
2094         *st = tst;
2095     }
2096     return rc;
2097 }
2098
2099 /*
2100  * afsclient_AFSServerGetDone - finish using a server iterator.
2101  *
2102  * PARAMETERS
2103  *
2104  * IN iterationId - an iterator previously returned by
2105  * afsclient_AFSServerGetBegin.
2106  *
2107  * LOCKS
2108  *
2109  * No locks are obtained or released by this function
2110  *
2111  * CAUTIONS
2112  *
2113  * None.
2114  *
2115  * RETURN CODES
2116  *
2117  * Returns != 0 upon successful completion.
2118  */
2119
2120 int ADMINAPI
2121 afsclient_AFSServerGetDone(void *iterationId, afs_status_p st)
2122 {
2123     int rc = 0;
2124     afs_status_t tst = 0;
2125     afs_admin_iterator_p iter = (afs_admin_iterator_p) iterationId;
2126
2127     if (iterationId == NULL) {
2128         tst = ADMITERATORNULL;
2129         goto fail_afsclient_AFSServerGetDone;
2130     }
2131
2132     rc = IteratorDone(iter, &tst);
2133
2134   fail_afsclient_AFSServerGetDone:
2135
2136     if (st != NULL) {
2137         *st = tst;
2138     }
2139     return rc;
2140 }
2141
2142 /*
2143  * afsclient_RPCStatOpen - open an rx connection to a server to retrieve
2144  * statistics.
2145  *
2146  * PARAMETERS
2147  *
2148  * IN cellHandle - a cellHandle created by afsclient_CellOpen.
2149  *
2150  * IN serverName - the host name where the server resides.
2151  *
2152  * IN type - what type of process to query
2153  *
2154  * OUT rpcStatHandleP - contains an rx connection to the server of interest
2155  *
2156  * LOCKS
2157  *
2158  * No locks are obtained or released by this function
2159  *
2160  * CAUTIONS
2161  *
2162  * None.
2163  *
2164  * RETURN CODES
2165  *
2166  * Returns != 0 upon successful completion.
2167  */
2168
2169 int ADMINAPI
2170 afsclient_RPCStatOpen(const void *cellHandle, const char *serverName,
2171                       afs_stat_source_t type,
2172                       struct rx_connection **rpcStatHandleP, afs_status_p st)
2173 {
2174     int rc = 0;
2175     afs_status_t tst = 0;
2176     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
2177     int servAddr = 0;
2178     int servPort;
2179     struct rx_securityClass *sc;
2180
2181     if (!CellHandleIsValid(cellHandle, &tst)) {
2182         goto fail_afsclient_RPCStatOpen;
2183     }
2184
2185     if (!util_AdminServerAddressGetFromName(serverName, &servAddr, &tst)) {
2186         goto fail_afsclient_RPCStatOpen;
2187     }
2188
2189     if (rpcStatHandleP == NULL) {
2190         tst = ADMCLIENTRPCSTATHANDLEPNULL;
2191         goto fail_afsclient_RPCStatOpen;
2192     }
2193
2194     switch (type) {
2195
2196     case AFS_BOSSERVER:
2197         servPort = AFSCONF_NANNYPORT;
2198         break;
2199
2200     case AFS_FILESERVER:
2201         servPort = AFSCONF_FILEPORT;
2202         break;
2203
2204     case AFS_KASERVER:
2205         servPort = AFSCONF_KAUTHPORT;
2206         break;
2207
2208     case AFS_PTSERVER:
2209         servPort = AFSCONF_PROTPORT;
2210         break;
2211
2212     case AFS_VOLSERVER:
2213         servPort = AFSCONF_VOLUMEPORT;
2214         break;
2215
2216     case AFS_VLSERVER:
2217         servPort = AFSCONF_VLDBPORT;
2218         break;
2219
2220     case AFS_CLIENT:
2221         servPort = AFSCONF_CALLBACKPORT;
2222         break;
2223
2224     default:
2225         tst = ADMTYPEINVALID;
2226         goto fail_afsclient_RPCStatOpen;
2227     }
2228
2229     /*
2230      * special processing of tokens by server type
2231      */
2232
2233     if (type == AFS_KASERVER) {
2234         if (!c_handle->tokens->kas_token_set) {
2235             tst = ADMCLIENTNOKASTOKENS;
2236             goto fail_afsclient_RPCStatOpen;
2237         }
2238         sc = c_handle->tokens->kas_sc[c_handle->tokens->sc_index];
2239     } else {
2240         sc = c_handle->tokens->afs_sc[c_handle->tokens->sc_index];
2241     }
2242
2243     *rpcStatHandleP =
2244         rx_GetCachedConnection(htonl(servAddr), htons(servPort),
2245                                RX_STATS_SERVICE_ID, sc,
2246                                c_handle->tokens->sc_index);
2247
2248     if (*rpcStatHandleP == NULL) {
2249         tst = ADMCLIENTRPCSTATNOCONNECTION;
2250         goto fail_afsclient_RPCStatOpen;
2251     }
2252     rc = 1;
2253
2254   fail_afsclient_RPCStatOpen:
2255
2256     if (st != NULL) {
2257         *st = tst;
2258     }
2259     return rc;
2260 }
2261
2262 /*
2263  * afsclient_RPCStatOpenPort - open an rx connection to a server to retrieve
2264  * statistics.
2265  *
2266  * PARAMETERS
2267  *
2268  * IN cellHandle - a cellHandle created by afsclient_CellOpen.
2269  *
2270  * IN serverName - the host name where the server resides.
2271  *
2272  * IN port - the UDP port number where the server resides.
2273  *
2274  * OUT rpcStatHandleP - contains an rx connection to the server of interest
2275  *
2276  * LOCKS
2277  *
2278  * No locks are obtained or released by this function
2279  *
2280  * CAUTIONS
2281  *
2282  * None.
2283  *
2284  * RETURN CODES
2285  *
2286  * Returns != 0 upon successful completion.
2287  */
2288
2289 int ADMINAPI
2290 afsclient_RPCStatOpenPort(const void *cellHandle, const char *serverName,
2291                           const int serverPort,
2292                           struct rx_connection **rpcStatHandleP,
2293                           afs_status_p st)
2294 {
2295     int rc = 0;
2296     afs_status_t tst = 0;
2297     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
2298     int servAddr = 0;
2299     struct rx_securityClass *sc;
2300
2301     if (!CellHandleIsValid(cellHandle, &tst)) {
2302         goto fail_afsclient_RPCStatOpenPort;
2303     }
2304
2305     if (!util_AdminServerAddressGetFromName(serverName, &servAddr, &tst)) {
2306         goto fail_afsclient_RPCStatOpenPort;
2307     }
2308
2309     if (rpcStatHandleP == NULL) {
2310         tst = ADMCLIENTRPCSTATHANDLEPNULL;
2311         goto fail_afsclient_RPCStatOpenPort;
2312     }
2313
2314     /*
2315      * special processing of tokens by server type
2316      */
2317
2318     if (serverPort == AFSCONF_KAUTHPORT) {
2319         if (!c_handle->tokens->kas_token_set) {
2320             tst = ADMCLIENTNOKASTOKENS;
2321             goto fail_afsclient_RPCStatOpenPort;
2322         }
2323         sc = c_handle->tokens->kas_sc[c_handle->tokens->sc_index];
2324     } else {
2325         sc = c_handle->tokens->afs_sc[c_handle->tokens->sc_index];
2326     }
2327
2328     *rpcStatHandleP =
2329         rx_GetCachedConnection(htonl(servAddr), htons(serverPort),
2330                                RX_STATS_SERVICE_ID, sc,
2331                                c_handle->tokens->sc_index);
2332
2333     if (*rpcStatHandleP == NULL) {
2334         tst = ADMCLIENTRPCSTATNOCONNECTION;
2335         goto fail_afsclient_RPCStatOpenPort;
2336     }
2337     rc = 1;
2338
2339   fail_afsclient_RPCStatOpenPort:
2340
2341     if (st != NULL) {
2342         *st = tst;
2343     }
2344     return rc;
2345 }
2346
2347 /*
2348  * afsclient_RPCStatClose - close a previously opened rx connection.
2349  *
2350  * PARAMETERS
2351  *
2352  * IN rpcStatHandle - an rx connection returned by afsclient_RPCStatOpen
2353  *
2354  * LOCKS
2355  *
2356  * No locks are obtained or released by this function
2357  *
2358  * CAUTIONS
2359  *
2360  * None.
2361  *
2362  * RETURN CODES
2363  *
2364  * Returns != 0 upon successful completion.
2365  */
2366
2367 int ADMINAPI
2368 afsclient_RPCStatClose(struct rx_connection *rpcStatHandle, afs_status_p st)
2369 {
2370     int rc = 0;
2371     afs_status_t tst = 0;
2372
2373     if (rpcStatHandle == NULL) {
2374         tst = ADMCLIENTRPCSTATHANDLEPNULL;
2375         goto fail_afsclient_RPCStatClose;
2376     }
2377
2378     rx_ReleaseCachedConnection(rpcStatHandle);
2379     rc = 1;
2380   fail_afsclient_RPCStatClose:
2381
2382     if (st != NULL) {
2383         *st = tst;
2384     }
2385     return rc;
2386 }
2387
2388 /*
2389  * afsclient_CMStatOpen - open an rx connection to a server to retrieve
2390  * statistics.
2391  *
2392  * PARAMETERS
2393  *
2394  * IN cellHandle - a cellHandle created by afsclient_CellOpen.
2395  *
2396  * IN serverName - the host name where the server resides.
2397  *
2398  * OUT cmStatHandleP - contains an rx connection to the server of interest
2399  *
2400  * LOCKS
2401  *
2402  * No locks are obtained or released by this function
2403  *
2404  * CAUTIONS
2405  *
2406  * None.
2407  *
2408  * RETURN CODES
2409  *
2410  * Returns != 0 upon successful completion.
2411  */
2412
2413 int ADMINAPI
2414 afsclient_CMStatOpen(const void *cellHandle, const char *serverName,
2415                      struct rx_connection **cmStatHandleP, afs_status_p st)
2416 {
2417     int rc = 0;
2418     afs_status_t tst = 0;
2419     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
2420     int servAddr = 0;
2421     struct rx_securityClass *sc;
2422
2423     if (!CellHandleIsValid(cellHandle, &tst)) {
2424         goto fail_afsclient_CMStatOpen;
2425     }
2426
2427     if (!util_AdminServerAddressGetFromName(serverName, &servAddr, &tst)) {
2428         goto fail_afsclient_CMStatOpen;
2429     }
2430
2431     if (cmStatHandleP == NULL) {
2432         tst = ADMCLIENTCMSTATHANDLEPNULL;
2433         goto fail_afsclient_CMStatOpen;
2434     }
2435
2436     sc = c_handle->tokens->afs_sc[c_handle->tokens->sc_index];
2437
2438     *cmStatHandleP =
2439         rx_GetCachedConnection(htonl(servAddr), htons(AFSCONF_CALLBACKPORT),
2440                                1, sc, c_handle->tokens->sc_index);
2441
2442     if (*cmStatHandleP == NULL) {
2443         tst = ADMCLIENTCMSTATNOCONNECTION;
2444         goto fail_afsclient_CMStatOpen;
2445     }
2446     rc = 1;
2447
2448   fail_afsclient_CMStatOpen:
2449
2450     if (st != NULL) {
2451         *st = tst;
2452     }
2453     return rc;
2454 }
2455
2456 /*
2457  * afsclient_CMStatOpenPort - open an rx connection to a server to retrieve
2458  * statistics.
2459  *
2460  * PARAMETERS
2461  *
2462  * IN cellHandle - a cellHandle created by afsclient_CellOpen.
2463  *
2464  * IN serverName - the host name where the server resides.
2465  *
2466  * IN port - the UDP port number where the server resides.
2467  *
2468  * OUT cmStatHandleP - contains an rx connection to the server of interest
2469  *
2470  * LOCKS
2471  *
2472  * No locks are obtained or released by this function
2473  *
2474  * CAUTIONS
2475  *
2476  * None.
2477  *
2478  * RETURN CODES
2479  *
2480  * Returns != 0 upon successful completion.
2481  */
2482
2483 int ADMINAPI
2484 afsclient_CMStatOpenPort(const void *cellHandle, const char *serverName,
2485                          const int serverPort,
2486                          struct rx_connection **cmStatHandleP,
2487                          afs_status_p st)
2488 {
2489     int rc = 0;
2490     afs_status_t tst = 0;
2491     afs_cell_handle_p c_handle = (afs_cell_handle_p) cellHandle;
2492     int servAddr = 0;
2493     struct rx_securityClass *sc;
2494
2495     if (!CellHandleIsValid(cellHandle, &tst)) {
2496         goto fail_afsclient_CMStatOpenPort;
2497     }
2498
2499     if (!util_AdminServerAddressGetFromName(serverName, &servAddr, &tst)) {
2500         goto fail_afsclient_CMStatOpenPort;
2501     }
2502
2503     if (cmStatHandleP == NULL) {
2504         tst = ADMCLIENTCMSTATHANDLEPNULL;
2505         goto fail_afsclient_CMStatOpenPort;
2506     }
2507
2508     sc = c_handle->tokens->afs_sc[c_handle->tokens->sc_index];
2509
2510     *cmStatHandleP =
2511         rx_GetCachedConnection(htonl(servAddr), htons(serverPort), 1, sc,
2512                                c_handle->tokens->sc_index);
2513
2514     if (*cmStatHandleP == NULL) {
2515         tst = ADMCLIENTCMSTATNOCONNECTION;
2516         goto fail_afsclient_CMStatOpenPort;
2517     }
2518     rc = 1;
2519
2520   fail_afsclient_CMStatOpenPort:
2521
2522     if (st != NULL) {
2523         *st = tst;
2524     }
2525     return rc;
2526 }
2527
2528 /*
2529  * afsclient_CMStatClose - close a previously opened rx connection.
2530  *
2531  * PARAMETERS
2532  *
2533  * IN cmStatHandle - an rx connection returned by afsclient_CMStatOpen
2534  *
2535  * LOCKS
2536  *
2537  * No locks are obtained or released by this function
2538  *
2539  * CAUTIONS
2540  *
2541  * None.
2542  *
2543  * RETURN CODES
2544  *
2545  * Returns != 0 upon successful completion.
2546  */
2547
2548 int ADMINAPI
2549 afsclient_CMStatClose(struct rx_connection *cmStatHandle, afs_status_p st)
2550 {
2551     int rc = 0;
2552     afs_status_t tst = 0;
2553
2554     if (cmStatHandle == NULL) {
2555         tst = ADMCLIENTCMSTATHANDLEPNULL;
2556         goto fail_afsclient_CMStatClose;
2557     }
2558
2559     rx_ReleaseCachedConnection(cmStatHandle);
2560     rc = 1;
2561   fail_afsclient_CMStatClose:
2562
2563     if (st != NULL) {
2564         *st = tst;
2565     }
2566     return rc;
2567 }
2568
2569 /*
2570  * afsclient_RXDebugOpen - open an rxdebug handle to a server.
2571  *
2572  * PARAMETERS
2573  *
2574  * IN serverName - the host name where the server resides.
2575  *
2576  * IN type - what type of process to query
2577  *
2578  * OUT rxdebugHandle_p - contains an rxdebug handle for the server of interest
2579  *
2580  * LOCKS
2581  *
2582  * No locks are obtained or released by this function
2583  *
2584  * CAUTIONS
2585  *
2586  * None.
2587  *
2588  * RETURN CODES
2589  *
2590  * Returns != 0 upon successful completion.
2591  */
2592
2593 int ADMINAPI
2594 afsclient_RXDebugOpen(const char *serverName, afs_stat_source_t type,
2595                       rxdebugHandle_p * rxdebugHandleP, afs_status_p st)
2596 {
2597     int rc = 0;
2598     afs_status_t tst = 0;
2599     int code;
2600     rxdebugHandle_p handle;
2601     rxdebugSocket_t sock;
2602     struct sockaddr_in taddr;
2603     int serverPort;
2604     int serverAddr;
2605
2606     if (rxdebugHandleP == NULL) {
2607         tst = ADMCLIENTRXDEBUGHANDLEPNULL;
2608         goto fail_afsclient_RXDebugOpen;
2609     }
2610
2611     switch (type) {
2612
2613     case AFS_BOSSERVER:
2614         serverPort = AFSCONF_NANNYPORT;
2615         break;
2616
2617     case AFS_FILESERVER:
2618         serverPort = AFSCONF_FILEPORT;
2619         break;
2620
2621     case AFS_KASERVER:
2622         serverPort = AFSCONF_KAUTHPORT;
2623         break;
2624
2625     case AFS_PTSERVER:
2626         serverPort = AFSCONF_PROTPORT;
2627         break;
2628
2629     case AFS_VOLSERVER:
2630         serverPort = AFSCONF_VOLUMEPORT;
2631         break;
2632
2633     case AFS_VLSERVER:
2634         serverPort = AFSCONF_VLDBPORT;
2635         break;
2636
2637     case AFS_CLIENT:
2638         serverPort = AFSCONF_CALLBACKPORT;
2639         break;
2640
2641     default:
2642         tst = ADMTYPEINVALID;
2643         goto fail_afsclient_RXDebugOpen;
2644     }
2645
2646     if (!util_AdminServerAddressGetFromName(serverName, &serverAddr, &tst)) {
2647         goto fail_afsclient_RXDebugOpen;
2648     }
2649
2650     sock = (rxdebugSocket_t) socket(AF_INET, SOCK_DGRAM, 0);
2651     if (sock == INVALID_RXDEBUG_SOCKET) {
2652         tst = ADMSOCKFAIL;
2653         goto fail_afsclient_RXDebugOpen;
2654     }
2655
2656     memset(&taddr, 0, sizeof(taddr));
2657     taddr.sin_family = AF_INET;
2658     taddr.sin_port = 0;
2659     taddr.sin_addr.s_addr = INADDR_ANY;
2660     code = bind(sock, (struct sockaddr *)&taddr, sizeof(taddr));
2661     if (code) {
2662         close(sock);
2663         tst = ADMSOCKFAIL;
2664         goto fail_afsclient_RXDebugOpen;
2665     }
2666
2667     handle = (rxdebugHandle_p) malloc(sizeof(rxdebugHandle_t));
2668     if (!handle) {
2669         close(sock);
2670         tst = ADMNOMEM;
2671         goto fail_afsclient_RXDebugOpen;
2672     }
2673
2674     handle->sock = sock;
2675     handle->ipAddr = serverAddr;
2676     handle->udpPort = serverPort;
2677     handle->firstFlag = 1;
2678     handle->supportedStats = 0;
2679     *rxdebugHandleP = handle;
2680     rc = 1;
2681
2682   fail_afsclient_RXDebugOpen:
2683
2684     if (st != NULL) {
2685         *st = tst;
2686     }
2687     return rc;
2688 }
2689
2690 /*
2691  * afsclient_RXDebugOpenPort - open an rxdebug handle to a server.
2692  *
2693  * PARAMETERS
2694  *
2695  * IN serverName - the host name where the server resides.
2696  *
2697  * IN port - the UDP port number where the server resides.
2698  *
2699  * OUT rxdebugHandle_p - contains an rxdebug handle for the server of interest
2700  *
2701  * LOCKS
2702  *
2703  * No locks are obtained or released by this function
2704  *
2705  * CAUTIONS
2706  *
2707  * None.
2708  *
2709  * RETURN CODES
2710  *
2711  * Returns != 0 upon successful completion.
2712  */
2713
2714 int ADMINAPI
2715 afsclient_RXDebugOpenPort(const char *serverName, int serverPort,
2716                           rxdebugHandle_p * rxdebugHandleP, afs_status_p st)
2717 {
2718     int rc = 0;
2719     afs_status_t tst = 0;
2720     int code;
2721     rxdebugHandle_p handle;
2722     rxdebugSocket_t sock;
2723     struct sockaddr_in taddr;
2724     int serverAddr;
2725
2726     if (rxdebugHandleP == NULL) {
2727         tst = ADMCLIENTRXDEBUGHANDLEPNULL;
2728         goto fail_afsclient_RXDebugOpenPort;
2729     }
2730
2731     if (!util_AdminServerAddressGetFromName(serverName, &serverAddr, &tst)) {
2732         goto fail_afsclient_RXDebugOpenPort;
2733     }
2734
2735     sock = (rxdebugSocket_t) socket(AF_INET, SOCK_DGRAM, 0);
2736     if (sock == INVALID_RXDEBUG_SOCKET) {
2737         tst = ADMSOCKFAIL;
2738         goto fail_afsclient_RXDebugOpenPort;
2739     }
2740
2741     memset(&taddr, 0, sizeof(taddr));
2742     taddr.sin_family = AF_INET;
2743     taddr.sin_port = 0;
2744     taddr.sin_addr.s_addr = INADDR_ANY;
2745     code = bind(sock, (struct sockaddr *)&taddr, sizeof(taddr));
2746     if (code) {
2747         close(sock);
2748         tst = ADMSOCKFAIL;
2749         goto fail_afsclient_RXDebugOpenPort;
2750     }
2751
2752     handle = (rxdebugHandle_p) malloc(sizeof(rxdebugHandle_t));
2753     if (!handle) {
2754         close(sock);
2755         tst = ADMNOMEM;
2756         goto fail_afsclient_RXDebugOpenPort;
2757     }
2758
2759     handle->sock = sock;
2760     handle->ipAddr = serverAddr;
2761     handle->udpPort = serverPort;
2762     handle->firstFlag = 1;
2763     handle->supportedStats = 0;
2764     *rxdebugHandleP = handle;
2765     rc = 1;
2766
2767   fail_afsclient_RXDebugOpenPort:
2768
2769     if (st != NULL) {
2770         *st = tst;
2771     }
2772     return rc;
2773 }
2774
2775 /*
2776  * afsclient_RXDebugClose - close a previously opened rxdebug handle.
2777  *
2778  * PARAMETERS
2779  *
2780  * IN rxdebugHandle - an rxdebug handle returned by afsclient_RXDebugOpen
2781  *
2782  * LOCKS
2783  *
2784  * No locks are obtained or released by this function
2785  *
2786  * CAUTIONS
2787  *
2788  * None.
2789  *
2790  * RETURN CODES
2791  *
2792  * Returns != 0 upon successful completion.
2793  */
2794
2795 int ADMINAPI
2796 afsclient_RXDebugClose(rxdebugHandle_p rxdebugHandle, afs_status_p st)
2797 {
2798     int rc = 0;
2799     afs_status_t tst = 0;
2800
2801     if (rxdebugHandle == NULL) {
2802         tst = ADMCLIENTRXDEBUGHANDLEPNULL;
2803         goto fail_afsclient_RXDebugClose;
2804     }
2805
2806     close(rxdebugHandle->sock);
2807     free(rxdebugHandle);
2808     rc = 1;
2809   fail_afsclient_RXDebugClose:
2810
2811     if (st != NULL) {
2812         *st = tst;
2813     }
2814     return rc;
2815 }