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