xref: /freebsd/contrib/openpam/lib/libpam/pam_close_session.c (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
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 <sys/param.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 40
49  *
50  * Close an existing user session
51  */
52 
53 int
54 pam_close_session(pam_handle_t *pamh,
55 	int flags)
56 {
57 	int r;
58 
59 	ENTER();
60 	if (flags & ~(PAM_SILENT))
61 		RETURNC(PAM_BAD_CONSTANT);
62 	r = openpam_dispatch(pamh, PAM_SM_CLOSE_SESSION, flags);
63 	RETURNC(r);
64 }
65 
66 /*
67  * Error codes:
68  *
69  *	=openpam_dispatch
70  *	=pam_sm_close_session
71  *	!PAM_IGNORE
72  *	PAM_BAD_CONSTANT
73  */
74 
75 /**
76  * The =pam_close_session function tears down the user session previously
77  * set up by =pam_open_session.
78  *
79  * The =flags argument is the binary or of zero or more of the following
80  * values:
81  *
82  *	=PAM_SILENT:
83  *		Do not emit any messages.
84  *
85  * If any other bits are set, =pam_close_session will return
86  * =PAM_BAD_CONSTANT.
87  */
88