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