source: openpam/trunk/lib/libpam/pam_get_item.c @ 935

Last change on this file since 935 was 935, checked in by Dag-Erling Smørgrav, 4 years ago

Bump copyright year.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.8 KB
Line 
1/*-
2 * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
3 * Copyright (c) 2004-2017 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 935 2017-04-26 21:04:10Z 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
55int
56pam_get_item(const pam_handle_t *pamh,
57        int item_type,
58        const void **item)
59{
60
61        ENTERI(item_type);
62        switch (item_type) {
63        case PAM_SERVICE:
64        case PAM_USER:
65        case PAM_AUTHTOK:
66        case PAM_OLDAUTHTOK:
67        case PAM_TTY:
68        case PAM_RHOST:
69        case PAM_RUSER:
70        case PAM_CONV:
71        case PAM_USER_PROMPT:
72        case PAM_REPOSITORY:
73        case PAM_AUTHTOK_PROMPT:
74        case PAM_OLDAUTHTOK_PROMPT:
75        case PAM_HOST:
76                *item = pamh->item[item_type];
77                RETURNC(PAM_SUCCESS);
78        default:
79                RETURNC(PAM_BAD_ITEM);
80        }
81}
82
83/*
84 * Error codes:
85 *
86 *      PAM_BAD_ITEM
87 */
88
89/**
90 * The =pam_get_item function stores a pointer to the item specified by
91 * the =item_type argument in the location pointed to by the =item
92 * argument.
93 * The item is retrieved from the PAM context specified by the =pamh
94 * argument.
95 * If =pam_get_item fails, the =item argument is untouched.
96 *
97 * The following item types are recognized:
98 *
99 *      =PAM_SERVICE:
100 *              The name of the requesting service.
101 *      =PAM_USER:
102 *              The name of the user the application is trying to
103 *              authenticate.
104 *      =PAM_TTY:
105 *              The name of the current terminal.
106 *      =PAM_RHOST:
107 *              The name of the applicant's host.
108 *      =PAM_CONV:
109 *              A =struct pam_conv describing the current conversation
110 *              function.
111 *      =PAM_AUTHTOK:
112 *              The current authentication token.
113 *      =PAM_OLDAUTHTOK:
114 *              The expired authentication token.
115 *      =PAM_RUSER:
116 *              The name of the applicant.
117 *      =PAM_USER_PROMPT:
118 *              The prompt to use when asking the applicant for a user
119 *              name to authenticate as.
120 *      =PAM_AUTHTOK_PROMPT:
121 *              The prompt to use when asking the applicant for an
122 *              authentication token.
123 *      =PAM_OLDAUTHTOK_PROMPT:
124 *              The prompt to use when asking the applicant for an
125 *              expired authentication token prior to changing it.
126 *      =PAM_HOST:
127 *              The name of the host the application runs on.
128 *
129 * See =pam_start for a description of =struct pam_conv.
130 *
131 * >pam_set_item
132 */
Note: See TracBrowser for help on using the repository browser.