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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef APU_ERRNO_H
#define APU_ERRNO_H
/**
* @file apu_errno.h
* @brief APR-Util Error Codes
*/
#include "apr.h"
#include "apr_errno.h"
#include "apr_pools.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @defgroup apu_errno Error Codes
* @ingroup APR
* @{
*/
/**
* @defgroup APR_Util_Error APR_Util Error Values
* <PRE>
* <b>APU ERROR VALUES</b>
* APR_ENOKEY The key provided was empty or NULL
* APR_ENOIV The initialisation vector provided was NULL
* APR_EKEYTYPE The key type was not recognised
* APR_ENOSPACE The buffer supplied was not big enough
* APR_ECRYPT An error occurred while encrypting or decrypting
* APR_EPADDING Padding was not supported
* APR_EKEYLENGTH The key length was incorrect
* APR_ENOCIPHER The cipher provided was not recognised
* APR_ENODIGEST The digest provided was not recognised
* APR_ENOENGINE The engine provided was not recognised
* APR_EINITENGINE The engine could not be initialised
* APR_EREINIT Underlying crypto has already been initialised
* APR_ENOVERIFY The signature verification failed
* </PRE>
*
* <PRE>
* <b>APR STATUS VALUES</b>
* APR_INCHILD Program is currently executing in the child
* </PRE>
* @{
*/
/** @see APR_STATUS_IS_ENOKEY */
#define APR_ENOKEY (APR_UTIL_START_STATUS + 1)
/** @see APR_STATUS_IS_ENOIV */
#define APR_ENOIV (APR_UTIL_START_STATUS + 2)
/** @see APR_STATUS_IS_EKEYTYPE */
#define APR_EKEYTYPE (APR_UTIL_START_STATUS + 3)
/** @see APR_STATUS_IS_ENOSPACE */
#define APR_ENOSPACE (APR_UTIL_START_STATUS + 4)
/** @see APR_STATUS_IS_ECRYPT */
#define APR_ECRYPT (APR_UTIL_START_STATUS + 5)
/** @see APR_STATUS_IS_EPADDING */
#define APR_EPADDING (APR_UTIL_START_STATUS + 6)
/** @see APR_STATUS_IS_EKEYLENGTH */
#define APR_EKEYLENGTH (APR_UTIL_START_STATUS + 7)
/** @see APR_STATUS_IS_ENOCIPHER */
#define APR_ENOCIPHER (APR_UTIL_START_STATUS + 8)
/** @see APR_STATUS_IS_ENODIGEST */
#define APR_ENODIGEST (APR_UTIL_START_STATUS + 9)
/** @see APR_STATUS_IS_ENOENGINE */
#define APR_ENOENGINE (APR_UTIL_START_STATUS + 10)
/** @see APR_STATUS_IS_EINITENGINE */
#define APR_EINITENGINE (APR_UTIL_START_STATUS + 11)
/** @see APR_STATUS_IS_EREINIT */
#define APR_EREINIT (APR_UTIL_START_STATUS + 12)
/** @see APR_STATUS_IS_ENOVERIFY */
#define APR_ENOVERIFY (APR_UTIL_START_STATUS + 13)
/** @} */
/**
* @defgroup APU_STATUS_IS Status Value Tests
* @warning For any particular error condition, more than one of these tests
* may match. This is because platform-specific error codes may not
* always match the semantics of the POSIX codes these tests (and the
* corresponding APR error codes) are named after. A notable example
* are the APR_STATUS_IS_ENOENT and APR_STATUS_IS_ENOTDIR tests on
* Win32 platforms. The programmer should always be aware of this and
* adjust the order of the tests accordingly.
* @{
*/
/** @} */
/**
* @addtogroup APR_Util_Error
* @{
*/
/**
* The key was empty or not provided
*/
#define APR_STATUS_IS_ENOKEY(s) ((s) == APR_ENOKEY)
/**
* The initialisation vector was not provided
*/
#define APR_STATUS_IS_ENOIV(s) ((s) == APR_ENOIV)
/**
* The key type was not recognised
*/
#define APR_STATUS_IS_EKEYTYPE(s) ((s) == APR_EKEYTYPE)
/**
* The buffer provided was not big enough
*/
#define APR_STATUS_IS_ENOSPACE(s) ((s) == APR_ENOSPACE)
/**
* An error occurred while encrypting or decrypting
*/
#define APR_STATUS_IS_ECRYPT(s) ((s) == APR_ECRYPT)
/**
* An error occurred while padding
*/
#define APR_STATUS_IS_EPADDING(s) ((s) == APR_EPADDING)
/**
* An error occurred with the key length
*/
#define APR_STATUS_IS_EKEYLENGTH(s) ((s) == APR_EKEYLENGTH)
/**
* The cipher provided was not recognised
*/
#define APR_STATUS_IS_ENOCIPHER(s) ((s) == APR_ENOCIPHER)
/**
* The digest provided was not recognised
*/
#define APR_STATUS_IS_ENODIGEST(s) ((s) == APR_ENODIGEST)
/**
* The engine provided was not recognised
*/
#define APR_STATUS_IS_ENOENGINE(s) ((s) == APR_ENOENGINE)
/**
* The engine could not be initialised
*/
#define APR_STATUS_IS_EINITENGINE(s) ((s) == APR_EINITENGINE)
/**
* Crypto has already been initialised
*/
#define APR_STATUS_IS_EREINIT(s) ((s) == APR_EREINIT)
/**
* The signature verification failed
*/
#define APR_STATUS_IS_ENOVERIFY(s) ((s) == APR_ENOVERIFY)
/** @} */
/**
* This structure allows the underlying API error codes to be returned
* along with plain text error messages that explain to us mere mortals
* what really happened.
*/
typedef struct apu_err_t {
const char *reason;
const char *msg;
int rc;
} apu_err_t;
/**
* Populate a apu_err_t structure with the given error, allocated
* from the given pool.
*
* If the result parameter points at a NULL pointer, a apu_err_t
* structure will be allocated, otherwise the apu_err_t structure
* will be reused.
* @param result If NULL, the apu_err_t structure is allocated and
* returned, otherwise the existing apu_err_t is used.
* @param p The pool to use.
* @param reason The reason string, may be NULL.
* @param rc The underlying result code.
* @param fmt The format of the string
* @param ... The arguments to use while printing the data
* @return The apu_err_t structure on success, NULL if out of memory.
*/
APR_DECLARE_NONSTD(apu_err_t *) apr_errprintf(apu_err_t *result,
apr_pool_t *p, const char *reason, int rc, const char *fmt, ...)
__attribute__((format(printf,5,6)))
__attribute__((nonnull(2)));
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* ! APU_ERRNO_H */
|
