contrib/openpam/lib/pam_start.c

   1 /*-
   2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
   3  * All rights reserved.
   4  *
   5  * This software was developed for the FreeBSD Project by ThinkSec AS and
   6  * Network Associates Laboratories, the Security Research Division of
   7  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
   8  * ("CBOSS"), as part of the DARPA CHATS research program.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. The name of the author may not be used to endorse or promote
  19  *    products derived from this software without specific prior written
  20  *    permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $P4: //depot/projects/openpam/lib/pam_start.c#18 $
  35  */
  36
  37 #include <stdlib.h>
  38
  39 #include <security/pam_appl.h>
  40
  41 #include "openpam_impl.h"
  42
  43 /*
  44  * XSSO 4.2.1
  45  * XSSO 6 page 89
  46  *
  47  * Initiate a PAM transaction
  48  */
  49
  50 int
  51 pam_start(const char *service,
  52         const char *user,
  53         const struct pam_conv *pam_conv,
  54         pam_handle_t **pamh)
  55 {
  56         struct pam_handle *ph;
  57         int r;
  58
  59         ENTER();
  60         if ((ph = calloc(1, sizeof *ph)) == NULL)
  61                 RETURNC(PAM_BUF_ERR);
  62         if ((r = pam_set_item(ph, PAM_SERVICE, service)) != PAM_SUCCESS)
  63                 goto fail;
  64         if ((r = pam_set_item(ph, PAM_USER, user)) != PAM_SUCCESS)
  65                 goto fail;
  66         if ((r = pam_set_item(ph, PAM_CONV, pam_conv)) != PAM_SUCCESS)
  67                 goto fail;
  68
  69         r = openpam_configure(ph, service);
  70         if (r != PAM_SUCCESS)
  71                 goto fail;
  72
  73         *pamh = ph;
  74         openpam_log(PAM_LOG_DEBUG, "pam_start(\"%s\") succeeded", service);
  75         RETURNC(PAM_SUCCESS);
  76
  77  fail:
  78         pam_end(ph, r);
  79         RETURNC(r);
  80 }
  81
  82 /*
  83  * Error codes:
  84  *
  85  *      =openpam_configure
  86  *      =pam_set_item
  87  *      !PAM_SYMBOL_ERR
  88  *      PAM_BUF_ERR
  89  */
  90
  91 /**
  92  * The =pam_start function creates and initializes a PAM context.
  93  *
  94  * The =service argument specifies the name of the policy to apply, and is
  95  * stored in the =PAM_SERVICE item in the created context.
  96  *
  97  * The =user argument specifies the name of the target user - the user the
  98  * created context will serve to authenticate.
  99  * It is stored in the =PAM_USER item in the created context.
 100  *
 101  * The =pam_conv argument points to a =struct pam_conv describing the
 102  * conversation function to use; see =pam_conv for details.
 103  *
 104  * >pam_get_item
 105  * >pam_set_item
 106  * >pam_end
 107  */