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