contrib/openpam/lib/pam_start.c

   1 /*-
   2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
   3  * Copyright (c) 2004-2007 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  * $Id: pam_start.c 408 2007-12-21 11:36:24Z des $
  36  */
  37
  38 #include <stdlib.h>
  39
  40 #include <security/pam_appl.h>
  41
  42 #include "openpam_impl.h"
  43
  44 /*
  45  * XSSO 4.2.1
  46  * XSSO 6 page 89
  47  *
  48  * Initiate a PAM transaction
  49  */
  50
  51 int
  52 pam_start(const char *service,
  53         const char *user,
  54         const struct pam_conv *pam_conv,
  55         pam_handle_t **pamh)
  56 {
  57         struct pam_handle *ph;
  58         int r;
  59
  60         ENTER();
  61         if ((ph = calloc(1, sizeof *ph)) == NULL)
  62                 RETURNC(PAM_BUF_ERR);
  63         if ((r = pam_set_item(ph, PAM_SERVICE, service)) != PAM_SUCCESS)
  64                 goto fail;
  65         if ((r = pam_set_item(ph, PAM_USER, user)) != PAM_SUCCESS)
  66                 goto fail;
  67         if ((r = pam_set_item(ph, PAM_CONV, pam_conv)) != PAM_SUCCESS)
  68                 goto fail;
  69
  70         r = openpam_configure(ph, service);
  71         if (r != PAM_SUCCESS)
  72                 goto fail;
  73
  74         *pamh = ph;
  75         openpam_log(PAM_LOG_DEBUG, "pam_start(\"%s\") succeeded", service);
  76         RETURNC(PAM_SUCCESS);
  77
  78  fail:
  79         pam_end(ph, r);
  80         RETURNC(r);
  81 }
  82
  83 /*
  84  * Error codes:
  85  *
  86  *      =openpam_configure
  87  *      =pam_set_item
  88  *      !PAM_SYMBOL_ERR
  89  *      PAM_BUF_ERR
  90  */
  91
  92 /**
  93  * The =pam_start function creates and initializes a PAM context.
  94  *
  95  * The =service argument specifies the name of the policy to apply, and is
  96  * stored in the =PAM_SERVICE item in the created context.
  97  *
  98  * The =user argument specifies the name of the target user - the user the
  99  * created context will serve to authenticate.
 100  * It is stored in the =PAM_USER item in the created context.
 101  *
 102  * The =pam_conv argument points to a =struct pam_conv describing the
 103  * conversation function to use; see =pam_conv for details.
 104  *
 105  * >pam_get_item
 106  * >pam_set_item
 107  * >pam_end
 108  */