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

Last change on this file since 63 was 63, checked in by Dag-Erling Smørgrav, 19 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.2 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: pam_set_data.c 63 2002-02-18 19:31:10Z des $
35 */
36
37#include <stdlib.h>
38#include <string.h>
39
40#include <security/pam_appl.h>
41
42#include "openpam_impl.h"
43
44/*
45 * XSSO 4.2.1
46 * XSSO 6 page 59
47 *
48 * Set module information
49 */
50
51int
52pam_set_data(pam_handle_t *pamh,
53        const char *module_data_name,
54        void *data,
55        void (*cleanup)(pam_handle_t *pamh,
56                void *data,
57                int pam_end_status))
58{
59        pam_data_t *dp;
60
61        if (pamh == NULL)
62                return (PAM_SYSTEM_ERR);
63
64        for (dp = pamh->module_data; dp != NULL; dp = dp->next) {
65                if (strcmp(dp->name, module_data_name) == 0) {
66                        if (dp->cleanup)
67                                (dp->cleanup)(pamh, dp->data, PAM_SUCCESS);
68                        dp->data = data;
69                        dp->cleanup = cleanup;
70                        return (PAM_SUCCESS);
71                }
72        }
73
74        if ((dp = malloc(sizeof *dp)) == NULL)
75                return (PAM_BUF_ERR);
76        if ((dp->name = strdup(module_data_name)) == NULL) {
77                free(data);
78                return (PAM_BUF_ERR);
79        }
80        dp->next = pamh->module_data;
81        pamh->module_data = data;
82        return (PAM_SUCCESS);
83}
84
85/*
86 * Error codes:
87 *
88 *      PAM_SYSTEM_ERR
89 *      PAM_BUF_ERR
90 */
91
92/**
93 * The =pam_set_data function associates a pointer to an opaque object
94 * with an arbitrary string specified by the =module_data_name argument,
95 * in the PAM context specified by the =pamh argument.
96 *
97 * If not =NULL, the =cleanup argument should point to a function
98 * responsible for releasing the resources associated with the object.
99 *
100 * This function and its counterpart =pam_get_data are useful for managing
101 * data that are meaningful only to a particular service module.
102 */
Note: See TracBrowser for help on using the repository browser.