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