contrib/openpam/lib/pam_strerror.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_strerror.c 408 2007-12-21 11:36:24Z des $
  36  */
  37
  38 #include <stdio.h>
  39
  40 #include <security/pam_appl.h>
  41
  42 #include "openpam_impl.h"
  43
  44 const char *_pam_err_name[PAM_NUM_ERRORS] = {
  45         "PAM_SUCCESS",
  46         "PAM_OPEN_ERR",
  47         "PAM_SYMBOL_ERR",
  48         "PAM_SERVICE_ERR",
  49         "PAM_SYSTEM_ERR",
  50         "PAM_BUF_ERR",
  51         "PAM_CONV_ERR",
  52         "PAM_PERM_DENIED",
  53         "PAM_MAXTRIES",
  54         "PAM_AUTH_ERR",
  55         "PAM_NEW_AUTHTOK_REQD",
  56         "PAM_CRED_INSUFFICIENT",
  57         "PAM_AUTHINFO_UNAVAIL",
  58         "PAM_USER_UNKNOWN",
  59         "PAM_CRED_UNAVAIL",
  60         "PAM_CRED_EXPIRED",
  61         "PAM_CRED_ERR",
  62         "PAM_ACCT_EXPIRED",
  63         "PAM_AUTHTOK_EXPIRED",
  64         "PAM_SESSION_ERR",
  65         "PAM_AUTHTOK_ERR",
  66         "PAM_AUTHTOK_RECOVERY_ERR",
  67         "PAM_AUTHTOK_LOCK_BUSY",
  68         "PAM_AUTHTOK_DISABLE_AGING",
  69         "PAM_NO_MODULE_DATA",
  70         "PAM_IGNORE",
  71         "PAM_ABORT",
  72         "PAM_TRY_AGAIN",
  73         "PAM_MODULE_UNKNOWN",
  74         "PAM_DOMAIN_UNKNOWN"
  75 };
  76
  77 /*
  78  * XSSO 4.2.1
  79  * XSSO 6 page 92
  80  *
  81  * Get PAM standard error message string
  82  */
  83
  84 const char *
  85 pam_strerror(const pam_handle_t *pamh,
  86         int error_number)
  87 {
  88         static char unknown[16];
  89
  90         (void)pamh;
  91
  92         switch (error_number) {
  93         case PAM_SUCCESS:
  94                 return ("success");
  95         case PAM_OPEN_ERR:
  96                 return ("failed to load module");
  97         case PAM_SYMBOL_ERR:
  98                 return ("invalid symbol");
  99         case PAM_SERVICE_ERR:
 100                 return ("error in service module");
 101         case PAM_SYSTEM_ERR:
 102                 return ("system error");
 103         case PAM_BUF_ERR:
 104                 return ("memory buffer error");
 105         case PAM_CONV_ERR:
 106                 return ("conversation failure");
 107         case PAM_PERM_DENIED:
 108                 return ("permission denied");
 109         case PAM_MAXTRIES:
 110                 return ("maximum number of tries exceeded");
 111         case PAM_AUTH_ERR:
 112                 return ("authentication error");
 113         case PAM_NEW_AUTHTOK_REQD:
 114                 return ("new authentication token required");
 115         case PAM_CRED_INSUFFICIENT:
 116                 return ("insufficient credentials");
 117         case PAM_AUTHINFO_UNAVAIL:
 118                 return ("authentication information is unavailable");
 119         case PAM_USER_UNKNOWN:
 120                 return ("unknown user");
 121         case PAM_CRED_UNAVAIL:
 122                 return ("failed to retrieve user credentials");
 123         case PAM_CRED_EXPIRED:
 124                 return ("user credentials have expired");
 125         case PAM_CRED_ERR:
 126                 return ("failed to set user credentials");
 127         case PAM_ACCT_EXPIRED:
 128                 return ("user account has expired");
 129         case PAM_AUTHTOK_EXPIRED:
 130                 return ("password has expired");
 131         case PAM_SESSION_ERR:
 132                 return ("session failure");
 133         case PAM_AUTHTOK_ERR:
 134                 return ("authentication token failure");
 135         case PAM_AUTHTOK_RECOVERY_ERR:
 136                 return ("failed to recover old authentication token");
 137         case PAM_AUTHTOK_LOCK_BUSY:
 138                 return ("authentication token lock busy");
 139         case PAM_AUTHTOK_DISABLE_AGING:
 140                 return ("authentication token aging disabled");
 141         case PAM_NO_MODULE_DATA:
 142                 return ("module data not found");
 143         case PAM_IGNORE:
 144                 return ("ignore this module");
 145         case PAM_ABORT:
 146                 return ("general failure");
 147         case PAM_TRY_AGAIN:
 148                 return ("try again");
 149         case PAM_MODULE_UNKNOWN:
 150                 return ("unknown module type");
 151         case PAM_DOMAIN_UNKNOWN:
 152                 return ("unknown authentication domain");
 153         default:
 154                 snprintf(unknown, sizeof unknown, "#%d", error_number);
 155                 return (unknown);
 156         }
 157 }
 158
 159 /**
 160  * The =pam_strerror function returns a pointer to a string containing a
 161  * textual description of the error indicated by the =error_number
 162  * argument, in the context of the PAM transaction described by the =pamh
 163  * argument.
 164  */