1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
Copyright (C) 2012 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Authors:
Simo Sorce <ssorce@redhat.com>
*/
#ifndef __SSSD_UTIL_ERRORS_H__
#define __SSSD_UTIL_ERRORS_H__
#ifndef HAVE_ERRNO_T
#define HAVE_ERRNO_T
typedef int errno_t;
#endif
/*
* We define a specific number space so that we do not overlap with other
* generic errors returned by various libraries. This will make it easy
* to have functions that double check that what was returned was a SSSD
* specific error where it matters. For example we may want to ensure some
* particularly sensitive paths only return SSSD sepcific errors as that
* will insure all error conditions have been explicitly dealt with,
* and are not the result of assigning the wrong return result.
*
* Basic system errno errors can still be used, but when an error condition
* does not properly map to a system error we should use a SSSD specific one
*/
#define ERR_BASE 0x555D0000
#define ERR_MASK 0x0000FFFF
/* never use ERR_INVALID, it is used for catching and returning
* information on invalid error numbers */
/* never use ERR_LAST, this represent the maximum error value available
* and is used to validate error codes */
enum sssd_errors {
ERR_INVALID = ERR_BASE + 0,
ERR_INTERNAL,
ERR_ACCOUNT_UNKNOWN,
ERR_INVALID_CRED_TYPE,
ERR_NO_CREDS,
ERR_CREDS_EXPIRED,
ERR_NO_CACHED_CREDS,
ERR_CACHED_CREDS_EXPIRED,
ERR_AUTH_DENIED,
ERR_AUTH_FAILED,
ERR_CHPASS_DENIED,
ERR_CHPASS_FAILED,
ERR_NETWORK_IO,
ERR_ACCOUNT_EXPIRED,
ERR_PASSWORD_EXPIRED,
ERR_ACCESS_DENIED,
ERR_LAST /* ALWAYS LAST */
};
#define SSSD_ERR_BASE(err) ((err) & ~ERR_MASK)
#define SSSD_ERR_IDX(err) ((err) & ERR_MASK)
#define IS_SSSD_ERROR(err) \
((SSSD_ERR_BASE(err) == ERR_BASE) && ((err) < ERR_LAST))
#define ERR_OK 0
/* Backwards compat */
#ifndef EOK
#define EOK ERR_OK
#endif
/**
* @brief return a string descriing the error number like strerror()
*
* @param error An errno_t number, can be a SSSD error or a system error
*
* @return A statically allocated string.
*/
const char *sss_strerror(errno_t error);
#endif /* __SSSD_UTIL_ERRORS_H__ */
|
