contrib/openpam/lib/pam_authenticate.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_authenticate.c 408 2007-12-21 11:36:24Z des $
  36  */
  37
  38 #include <sys/param.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 34
  47  *
  48  * Perform authentication within the PAM framework
  49  */
  50
  51 int
  52 pam_authenticate(pam_handle_t *pamh,
  53         int flags)
  54 {
  55         int r;
  56
  57         ENTER();
  58         if (flags & ~(PAM_SILENT|PAM_DISALLOW_NULL_AUTHTOK))
  59                 RETURNC(PAM_SYMBOL_ERR);
  60         r = openpam_dispatch(pamh, PAM_SM_AUTHENTICATE, flags);
  61         pam_set_item(pamh, PAM_AUTHTOK, NULL);
  62         RETURNC(r);
  63 }
  64
  65 /*
  66  * Error codes:
  67  *
  68  *      =openpam_dispatch
  69  *      =pam_sm_authenticate
  70  *      !PAM_IGNORE
  71  *      PAM_SYMBOL_ERR
  72  */
  73
  74 /**
  75  * The =pam_authenticate function attempts to authenticate the user
  76  * associated with the pam context specified by the =pamh argument.
  77  *
  78  * The application is free to call =pam_authenticate as many times as it
  79  * wishes, but some modules may maintain an internal retry counter and
  80  * return =PAM_MAXTRIES when it exceeds some preset or hardcoded limit.
  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  *      =PAM_DISALLOW_NULL_AUTHTOK:
  88  *              Fail if the user's authentication token is null.
  89  *
  90  * If any other bits are set, =pam_authenticate will return
  91  * =PAM_SYMBOL_ERR.
  92  */