xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/pam_strerror.c (revision fdd524d4ccd2bb0c6f67401e938dabf773eb0372)
1 /*	$NetBSD: pam_strerror.c,v 1.2 2014/10/24 18:17:56 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
5  * Copyright (c) 2004-2011 Dag-Erling Smørgrav
6  * All rights reserved.
7  *
8  * This software was developed for the FreeBSD Project by ThinkSec AS and
9  * Network Associates Laboratories, the Security Research Division of
10  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
11  * ("CBOSS"), as part of the DARPA CHATS research program.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. The name of the author may not be used to endorse or promote
22  *    products derived from this software without specific prior written
23  *    permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  * Id: pam_strerror.c 648 2013-03-05 17:54:27Z des
38  */
39 
40 #ifdef HAVE_CONFIG_H
41 # include "config.h"
42 #endif
43 
44 #include <sys/cdefs.h>
45 __RCSID("$NetBSD: pam_strerror.c,v 1.2 2014/10/24 18:17:56 christos Exp $");
46 
47 #include <stdio.h>
48 
49 #include <security/pam_appl.h>
50 
51 #include "openpam_impl.h"
52 
53 /*
54  * XSSO 4.2.1
55  * XSSO 6 page 92
56  *
57  * Get PAM standard error message string
58  */
59 
60 const char *
61 pam_strerror(const pam_handle_t *pamh,
62 	int error_number)
63 {
64 	static char unknown[16];
65 
66 	/*LINTED unused*/
67 	(void)pamh;
68 
69 	switch (error_number) {
70 	case PAM_SUCCESS:
71 		return ("success");
72 	case PAM_OPEN_ERR:
73 		return ("failed to load module");
74 	case PAM_SYMBOL_ERR:
75 		return ("invalid symbol");
76 	case PAM_SERVICE_ERR:
77 		return ("error in service module");
78 	case PAM_SYSTEM_ERR:
79 		return ("system error");
80 	case PAM_BUF_ERR:
81 		return ("memory buffer error");
82 	case PAM_CONV_ERR:
83 		return ("conversation failure");
84 	case PAM_PERM_DENIED:
85 		return ("permission denied");
86 	case PAM_MAXTRIES:
87 		return ("maximum number of tries exceeded");
88 	case PAM_AUTH_ERR:
89 		return ("authentication error");
90 	case PAM_NEW_AUTHTOK_REQD:
91 		return ("new authentication token required");
92 	case PAM_CRED_INSUFFICIENT:
93 		return ("insufficient credentials");
94 	case PAM_AUTHINFO_UNAVAIL:
95 		return ("authentication information is unavailable");
96 	case PAM_USER_UNKNOWN:
97 		return ("unknown user");
98 	case PAM_CRED_UNAVAIL:
99 		return ("failed to retrieve user credentials");
100 	case PAM_CRED_EXPIRED:
101 		return ("user credentials have expired");
102 	case PAM_CRED_ERR:
103 		return ("failed to set user credentials");
104 	case PAM_ACCT_EXPIRED:
105 		return ("user account has expired");
106 	case PAM_AUTHTOK_EXPIRED:
107 		return ("password has expired");
108 	case PAM_SESSION_ERR:
109 		return ("session failure");
110 	case PAM_AUTHTOK_ERR:
111 		return ("authentication token failure");
112 	case PAM_AUTHTOK_RECOVERY_ERR:
113 		return ("failed to recover old authentication token");
114 	case PAM_AUTHTOK_LOCK_BUSY:
115 		return ("authentication token lock busy");
116 	case PAM_AUTHTOK_DISABLE_AGING:
117 		return ("authentication token aging disabled");
118 	case PAM_NO_MODULE_DATA:
119 		return ("module data not found");
120 	case PAM_IGNORE:
121 		return ("ignore this module");
122 	case PAM_ABORT:
123 		return ("general failure");
124 	case PAM_TRY_AGAIN:
125 		return ("try again");
126 	case PAM_MODULE_UNKNOWN:
127 		return ("unknown module type");
128 	case PAM_DOMAIN_UNKNOWN:
129 		return ("unknown authentication domain");
130 	default:
131 		snprintf(unknown, sizeof unknown, "#%d", error_number);
132 		return (unknown);
133 	}
134 }
135 
136 /**
137  * The =pam_strerror function returns a pointer to a string containing a
138  * textual description of the error indicated by the =error_number
139  * argument.
140  * The =pamh argument is ignored.
141  * For compatibility with other implementations, it should be either a
142  * valid PAM handle returned by a previous call to =pam_start, or =NULL.
143  */
144