pam_get_item.c revision 93982
1/*- 2 * Copyright (c) 2002 Networks Associates Technology, Inc. 3 * All rights reserved. 4 * 5 * This software was developed for the FreeBSD Project by ThinkSec AS and 6 * NAI Labs, the Security Research Division of Network Associates, Inc. 7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 8 * 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#11 $ 35 */ 36 37#include <sys/param.h> 38 39#include <security/pam_appl.h> 40 41#include "openpam_impl.h" 42 43/* 44 * XSSO 4.2.1 45 * XSSO 6 page 46 46 * 47 * Get PAM information 48 */ 49 50int 51pam_get_item(pam_handle_t *pamh, 52 int item_type, 53 const void **item) 54{ 55 if (pamh == NULL) 56 return (PAM_SYSTEM_ERR); 57 58 switch (item_type) { 59 case PAM_SERVICE: 60 case PAM_USER: 61 case PAM_AUTHTOK: 62 case PAM_OLDAUTHTOK: 63 case PAM_TTY: 64 case PAM_RHOST: 65 case PAM_RUSER: 66 case PAM_CONV: 67 case PAM_USER_PROMPT: 68 case PAM_AUTHTOK_PROMPT: 69 case PAM_OLDAUTHTOK_PROMPT: 70 *item = pamh->item[item_type]; 71 return (PAM_SUCCESS); 72 default: 73 return (PAM_SYMBOL_ERR); 74 } 75} 76 77/* 78 * Error codes: 79 * 80 * PAM_SYMBOL_ERR 81 * PAM_SYSTEM_ERR 82 */ 83 84/** 85 * The =pam_get_item function stores a pointer to the item specified by 86 * the =item_type argument in the location specified by the =item 87 * argument. 88 * The item is retrieved from the PAM context specified by the =pamh 89 * argument. 90 * The following item types are recognized: 91 * 92 * =PAM_SERVICE: 93 * The name of the requesting service. 94 * =PAM_USER: 95 * The name of the user the application is trying to 96 * authenticate. 97 * =PAM_TTY: 98 * The name of the current terminal. 99 * =PAM_RHOST: 100 * The name of the applicant's host. 101 * =PAM_CONV: 102 * A =struct pam_conv describing the current conversation 103 * function. 104 * =PAM_AUTHTOK: 105 * The current authentication token. 106 * =PAM_OLDAUTHTOK: 107 * The expired authentication token. 108 * =PAM_RUSER: 109 * The name of the applicant. 110 * =PAM_USER_PROMPT: 111 * The prompt to use when asking the applicant for a user 112 * name to authenticate as. 113 * =PAM_AUTHTOK_PROMPT: 114 * The prompt to use when asking the applicant for an 115 * authentication token. 116 * =PAM_OLDAUTHTOK_PROMPT: 117 * The prompt to use when asking the applicant for an 118 * expired authentication token prior to changing it. 119 * 120 * See =pam_start for a description of =struct pam_conv. 121 * 122 * >pam_set_item 123 */ 124