contrib/openpam/lib/pam_get_item.c

   1 /*-
   2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
   3  * All rights reserved.
   4  *
   5  * This software was developed for the FreeBSD Project by ThinkSec AS and
   6  * Network Associates Laboratories, the Security Research Division of
   7  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
   8  * ("CBOSS"), as part of the DARPA CHATS research program.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. The name of the author may not be used to endorse or promote
  19  *    products derived from this software without specific prior written
  20  *    permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $P4: //depot/projects/openpam/lib/pam_get_item.c#17 $
  35  */
  36
  37 #include <sys/param.h>
  38
  39 #include <security/pam_appl.h>
  40
  41 #include "openpam_impl.h"
  42
  43 const char *_pam_item_name[PAM_NUM_ITEMS] = {
  44         "(NO ITEM)",
  45         "PAM_SERVICE",
  46         "PAM_USER",
  47         "PAM_TTY",
  48         "PAM_RHOST",
  49         "PAM_CONV",
  50         "PAM_AUTHTOK",
  51         "PAM_OLDAUTHTOK",
  52         "PAM_RUSER",
  53         "PAM_USER_PROMPT",
  54         "PAM_REPOSITORY",
  55         "PAM_AUTHTOK_PROMPT",
  56         "PAM_OLDAUTHTOK_PROMPT"
  57 };
  58
  59 /*
  60  * XSSO 4.2.1
  61  * XSSO 6 page 46
  62  *
  63  * Get PAM information
  64  */
  65
  66 int
  67 pam_get_item(pam_handle_t *pamh,
  68         int item_type,
  69         const void **item)
  70 {
  71
  72         ENTERI(item_type);
  73         if (pamh == NULL)
  74                 RETURNC(PAM_SYSTEM_ERR);
  75         switch (item_type) {
  76         case PAM_SERVICE:
  77         case PAM_USER:
  78         case PAM_AUTHTOK:
  79         case PAM_OLDAUTHTOK:
  80         case PAM_TTY:
  81         case PAM_RHOST:
  82         case PAM_RUSER:
  83         case PAM_CONV:
  84         case PAM_USER_PROMPT:
  85         case PAM_AUTHTOK_PROMPT:
  86         case PAM_OLDAUTHTOK_PROMPT:
  87         case PAM_REPOSITORY:
  88                 *item = pamh->item[item_type];
  89                 RETURNC(PAM_SUCCESS);
  90         default:
  91                 RETURNC(PAM_SYMBOL_ERR);
  92         }
  93 }
  94
  95 /*
  96  * Error codes:
  97  *
  98  *      PAM_SYMBOL_ERR
  99  *      PAM_SYSTEM_ERR
 100  */
 101
 102 /**
 103  * The =pam_get_item function stores a pointer to the item specified by
 104  * the =item_type argument in the location specified by the =item
 105  * argument.
 106  * The item is retrieved from the PAM context specified by the =pamh
 107  * argument.
 108  * The following item types are recognized:
 109  *
 110  *      =PAM_SERVICE:
 111  *              The name of the requesting service.
 112  *      =PAM_USER:
 113  *              The name of the user the application is trying to
 114  *              authenticate.
 115  *      =PAM_TTY:
 116  *              The name of the current terminal.
 117  *      =PAM_RHOST:
 118  *              The name of the applicant's host.
 119  *      =PAM_CONV:
 120  *              A =struct pam_conv describing the current conversation
 121  *              function.
 122  *      =PAM_AUTHTOK:
 123  *              The current authentication token.
 124  *      =PAM_OLDAUTHTOK:
 125  *              The expired authentication token.
 126  *      =PAM_RUSER:
 127  *              The name of the applicant.
 128  *      =PAM_USER_PROMPT:
 129  *              The prompt to use when asking the applicant for a user
 130  *              name to authenticate as.
 131  *      =PAM_AUTHTOK_PROMPT:
 132  *              The prompt to use when asking the applicant for an
 133  *              authentication token.
 134  *      =PAM_OLDAUTHTOK_PROMPT:
 135  *              The prompt to use when asking the applicant for an
 136  *              expired authentication token prior to changing it.
 137  *
 138  * See =pam_start for a description of =struct pam_conv.
 139  *
 140  * >pam_set_item
 141  */