source: openpam/trunk/lib/pam_get_item.c @ 63

Last change on this file since 63 was 63, checked in by des, 13 years ago

Add in-line documentation. Some functions still lack descriptions.

Sponsored by: DARPA, NAI Labs

  • Property svn:keywords set to Id LastChangedRevision HeadURL LastChangedDate LastChangedBy
File size: 3.4 KB
Line 
1/*-
2 * Copyright (c) 2002 Networks Associates Technologies, 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 * $Id$
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                *item = pamh->item[item_type];
70                return (PAM_SUCCESS);
71        default:
72                return (PAM_SYMBOL_ERR);
73        }
74}
75
76/*
77 * Error codes:
78 *
79 *      PAM_SYMBOL_ERR
80 *      PAM_SYSTEM_ERR
81 */
82
83/**
84 * The =pam_get_item function stores a pointer to the item specified by
85 * the =item_type argument in the location specified by the =item
86 * argument.
87 * The item is retrieved from the PAM context specified by the =pamh
88 * argument.
89 * The following item types are recognized:
90 *
91 *      =PAM_SERVICE:
92 *              The name of the requesting service.
93 *      =PAM_USER:
94 *              The name of the user the application is trying to
95 *              authenticate.
96 *      =PAM_TTY:
97 *              The name of the current terminal.
98 *      =PAM_RHOST:
99 *              The name of the applicant's host.
100 *      =PAM_CONV:
101 *              A =struct pam_conv describing the current conversation
102 *              function.
103 *      =PAM_AUTHTOK:
104 *              The current authentication token.
105 *      =PAM_OLDAUTHTOK:
106 *              The expired authentication token.
107 *      =PAM_RUSER:
108 *              The name of the applicant.
109 *      =PAM_USER_PROMPT:
110 *              The prompt to use when asking the applicant for a user
111 *              name to authenticate as.
112 *      =PAM_AUTHTOK_PROMPT:
113 *              The prompt to use when asking the applicant for an
114 *              authentication token.
115 *
116 * See =pam_start for a description of =struct pam_conv.
117 *
118 * >pam_set_item
119 */
Note: See TracBrowser for help on using the repository browser.