pam_strerror.c revision 91684 
1/*-
2 * Copyright (c) 2002 Networks Associates Technologies, Inc.
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by ThinkSec AS and
6 * NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * 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_strerror.c#8 $
35 */
36
37#include <stdio.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 92
46 *
47 * Get PAM standard error message string
48 */
49
50const char *
51pam_strerror(pam_handle_t *pamh,
52	int error_number)
53{
54	static char unknown[16];
55
56	pamh = pamh;
57
58	switch (error_number) {
59	case PAM_SUCCESS:
60		return ("success");
61	case PAM_OPEN_ERR:
62		return ("failed to load module");
63	case PAM_SYMBOL_ERR:
64		return ("invalid symbol");
65	case PAM_SERVICE_ERR:
66		return ("error in service module");
67	case PAM_SYSTEM_ERR:
68		return ("system error");
69	case PAM_BUF_ERR:
70		return ("memory buffer error");
71	case PAM_CONV_ERR:
72		return ("conversation failure");
73	case PAM_PERM_DENIED:
74		return ("permission denied");
75	case PAM_MAXTRIES:
76		return ("maximum number of tries exceeded");
77	case PAM_AUTH_ERR:
78		return ("authentication error");
79	case PAM_NEW_AUTHTOK_REQD:
80		return ("new authentication token required");
81	case PAM_CRED_INSUFFICIENT:
82		return ("insufficient credentials");
83	case PAM_AUTHINFO_UNAVAIL:
84		return ("authentication information is unavailable");
85	case PAM_USER_UNKNOWN:
86		return ("unknown user");
87	case PAM_CRED_UNAVAIL:
88		return ("failed to retrieve user credentials");
89	case PAM_CRED_EXPIRED:
90		return ("user credentials have expired");
91	case PAM_CRED_ERR:
92		return ("failed to set user credentials");
93	case PAM_ACCT_EXPIRED:
94		return ("user accound has expired");
95	case PAM_AUTHTOK_EXPIRED:
96		return ("password has expired");
97	case PAM_SESSION_ERR:
98		return ("session failure");
99	case PAM_AUTHTOK_ERR:
100		return ("authentication token failure");
101	case PAM_AUTHTOK_RECOVERY_ERR:
102		return ("failed to recover old authentication token");
103	case PAM_AUTHTOK_LOCK_BUSY:
104		return ("authentication token lock busy");
105	case PAM_AUTHTOK_DISABLE_AGING:
106		return ("authentication token aging disabled");
107	case PAM_NO_MODULE_DATA:
108		return ("module data not found");
109	case PAM_IGNORE:
110		return ("ignore this module");
111	case PAM_ABORT:
112		return ("general failure");
113	case PAM_TRY_AGAIN:
114		return ("try again");
115	case PAM_MODULE_UNKNOWN:
116		return ("unknown module type");
117	case PAM_DOMAIN_UNKNOWN:
118		return ("unknown authentication domain");
119	default:
120		snprintf(unknown, sizeof unknown, "#%d", error_number);
121		return (unknown);
122	}
123}
124
125/**
126 * The =pam_strerror function returns a pointer to a string containing a
127 * textual description of the error indicated by the =error_number
128 * argument, in the context of the PAM transaction described by the =pamh
129 * argument.
130 */
131