xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/pam_close_session.c (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1 /*	$NetBSD: pam_close_session.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_close_session.c,v 1.4 2023/06/30 21:46:21 christos Exp $");
44 
45 #include <sys/param.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 40
54  *
55  * Close an existing user session
56  */
57 
58 int
pam_close_session(pam_handle_t * pamh,int flags)59 pam_close_session(pam_handle_t *pamh,
60 	int flags)
61 {
62 	int r;
63 
64 	ENTER();
65 	if (flags & ~(PAM_SILENT))
66 		RETURNC(PAM_BAD_CONSTANT);
67 	r = openpam_dispatch(pamh, PAM_SM_CLOSE_SESSION, flags);
68 	RETURNC(r);
69 }
70 
71 /*
72  * Error codes:
73  *
74  *	=openpam_dispatch
75  *	=pam_sm_close_session
76  *	!PAM_IGNORE
77  *	PAM_BAD_CONSTANT
78  */
79 
80 /**
81  * The =pam_close_session function tears down the user session previously
82  * set up by =pam_open_session.
83  *
84  * The =flags argument is the binary or of zero or more of the following
85  * values:
86  *
87  *	=PAM_SILENT:
88  *		Do not emit any messages.
89  *
90  * If any other bits are set, =pam_close_session will return
91  * =PAM_BAD_CONSTANT.
92  */
93