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