contrib/openpam/lib/pam_get_item.c

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