xref: /freebsd/contrib/openpam/lib/libpam/pam_end.c (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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 
36 #ifdef HAVE_CONFIG_H
37 # include "config.h"
38 #endif
39 
40 #include <stdlib.h>
41 
42 #include <security/pam_appl.h>
43 
44 #include "openpam_impl.h"
45 
46 /*
47  * XSSO 4.2.1
48  * XSSO 6 page 42
49  *
50  * Terminate the PAM transaction
51  */
52 
53 int
54 pam_end(pam_handle_t *pamh,
55 	int status)
56 {
57 	pam_data_t *dp;
58 	int i;
59 
60 	ENTER();
61 	if (pamh == NULL)
62 		RETURNC(PAM_BAD_HANDLE);
63 
64 	/* clear module data */
65 	while ((dp = pamh->module_data) != NULL) {
66 		if (dp->cleanup)
67 			(dp->cleanup)(pamh, dp->data, status);
68 		pamh->module_data = dp->next;
69 		FREE(dp->name);
70 		FREE(dp);
71 	}
72 
73 	/* clear environment */
74 	while (pamh->env_count) {
75 		--pamh->env_count;
76 		FREE(pamh->env[pamh->env_count]);
77 	}
78 	FREE(pamh->env);
79 
80 	/* clear chains */
81 	openpam_clear_chains(pamh->chains);
82 
83 	/* clear items */
84 	for (i = 0; i < PAM_NUM_ITEMS; ++i)
85 		pam_set_item(pamh, i, NULL);
86 
87 	FREE(pamh);
88 
89 	RETURNC(PAM_SUCCESS);
90 }
91 
92 /*
93  * Error codes:
94  *
95  *	PAM_BAD_HANDLE
96  */
97 
98 /**
99  * The =pam_end function terminates a PAM transaction and destroys the
100  * corresponding PAM context, releasing all resources allocated to it.
101  *
102  * The =status argument should be set to the error code returned by the
103  * last API call before the call to =pam_end.
104  */
105