contrib/openpam/lib/libpam/pam_open_session.c

   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_open_session.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 <sys/param.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 54
  51  *
  52  * Open a user session
  53  */
  54
  55 int
  56 pam_open_session(pam_handle_t *pamh,
  57         int flags)
  58 {
  59         int r;
  60
  61         ENTER();
  62         if (flags & ~(PAM_SILENT))
  63                 RETURNC(PAM_BAD_CONSTANT);
  64         r = openpam_dispatch(pamh, PAM_SM_OPEN_SESSION, flags);
  65         RETURNC(r);
  66 }
  67
  68 /*
  69  * Error codes:
  70  *
  71  *      =openpam_dispatch
  72  *      =pam_sm_open_session
  73  *      !PAM_IGNORE
  74  *      PAM_BAD_CONSTANT
  75  */
  76
  77 /**
  78  * The =pam_open_session sets up a user session for a previously
  79  * authenticated user.
  80  * The session should later be torn down by a call to =pam_close_session.
  81  *
  82  * The =flags argument is the binary or of zero or more of the following
  83  * values:
  84  *
  85  *      =PAM_SILENT:
  86  *              Do not emit any messages.
  87  *
  88  * If any other bits are set, =pam_open_session will return
  89  * =PAM_BAD_CONSTANT.
  90  */