contrib/openpam/lib/pam_strerror.c

   1 /*-
   2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
   3  * Copyright (c) 2004-2011 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_strerror.c 491 2011-11-12 00:12:32Z des $
  36  */
  37
  38 #ifdef HAVE_CONFIG_H
  39 # include "config.h"
  40 #endif
  41
  42 #include <stdio.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 92
  51  *
  52  * Get PAM standard error message string
  53  */
  54
  55 const char *
  56 pam_strerror(const pam_handle_t *pamh,
  57         int error_number)
  58 {
  59         static char unknown[16];
  60
  61         (void)pamh;
  62
  63         switch (error_number) {
  64         case PAM_SUCCESS:
  65                 return ("success");
  66         case PAM_OPEN_ERR:
  67                 return ("failed to load module");
  68         case PAM_SYMBOL_ERR:
  69                 return ("invalid symbol");
  70         case PAM_SERVICE_ERR:
  71                 return ("error in service module");
  72         case PAM_SYSTEM_ERR:
  73                 return ("system error");
  74         case PAM_BUF_ERR:
  75                 return ("memory buffer error");
  76         case PAM_CONV_ERR:
  77                 return ("conversation failure");
  78         case PAM_PERM_DENIED:
  79                 return ("permission denied");
  80         case PAM_MAXTRIES:
  81                 return ("maximum number of tries exceeded");
  82         case PAM_AUTH_ERR:
  83                 return ("authentication error");
  84         case PAM_NEW_AUTHTOK_REQD:
  85                 return ("new authentication token required");
  86         case PAM_CRED_INSUFFICIENT:
  87                 return ("insufficient credentials");
  88         case PAM_AUTHINFO_UNAVAIL:
  89                 return ("authentication information is unavailable");
  90         case PAM_USER_UNKNOWN:
  91                 return ("unknown user");
  92         case PAM_CRED_UNAVAIL:
  93                 return ("failed to retrieve user credentials");
  94         case PAM_CRED_EXPIRED:
  95                 return ("user credentials have expired");
  96         case PAM_CRED_ERR:
  97                 return ("failed to set user credentials");
  98         case PAM_ACCT_EXPIRED:
  99                 return ("user account has expired");
 100         case PAM_AUTHTOK_EXPIRED:
 101                 return ("password has expired");
 102         case PAM_SESSION_ERR:
 103                 return ("session failure");
 104         case PAM_AUTHTOK_ERR:
 105                 return ("authentication token failure");
 106         case PAM_AUTHTOK_RECOVERY_ERR:
 107                 return ("failed to recover old authentication token");
 108         case PAM_AUTHTOK_LOCK_BUSY:
 109                 return ("authentication token lock busy");
 110         case PAM_AUTHTOK_DISABLE_AGING:
 111                 return ("authentication token aging disabled");
 112         case PAM_NO_MODULE_DATA:
 113                 return ("module data not found");
 114         case PAM_IGNORE:
 115                 return ("ignore this module");
 116         case PAM_ABORT:
 117                 return ("general failure");
 118         case PAM_TRY_AGAIN:
 119                 return ("try again");
 120         case PAM_MODULE_UNKNOWN:
 121                 return ("unknown module type");
 122         case PAM_DOMAIN_UNKNOWN:
 123                 return ("unknown authentication domain");
 124         default:
 125                 snprintf(unknown, sizeof unknown, "#%d", error_number);
 126                 return (unknown);
 127         }
 128 }
 129
 130 /**
 131  * The =pam_strerror function returns a pointer to a string containing a
 132  * textual description of the error indicated by the =error_number
 133  * argument.
 134  * The =pamh argument is ignored.
 135  * For compatibility with other implementations, it should be either a
 136  * valid PAM handle returned by a previous call to =pam_start, or =NULL.
 137  */