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