summaryrefslogtreecommitdiff
path: root/crypto/external/bsd/netpgp/dist/src/lib/errors.h
blob: ab518d08c67c61cc3dae8cbd44e6318a5a968ad0 (plain)
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
/*-
 * Copyright (c) 2009 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Alistair Crooks (agc@NetBSD.org)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
/*
 * Copyright (c) 2005-2008 Nominet UK (www.nic.uk)
 * All rights reserved.
 * Contributors: Ben Laurie, Rachel Willmer. The Contributors have asserted
 * their moral rights under the UK Copyright Design and Patents Act 1988 to
 * be recorded as the authors of this copyright work.
 *
 * Licensed 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.
 */

/** \file
 */

#ifndef ERRORS_H_
#define ERRORS_H_

#include <errno.h>

#ifndef __printflike
#define __printflike(n, m)	__attribute__((format(printf,n,m)))
#endif

/** error codes */
/* Remember to add names to map in errors.c */
typedef enum {
	PGP_E_OK = 0x0000,	/* no error */
	PGP_E_FAIL = 0x0001,	/* general error */
	PGP_E_SYSTEM_ERROR = 0x0002,	/* system error, look at errno for
					 * details */
	PGP_E_UNIMPLEMENTED = 0x0003,	/* feature not yet implemented */

	/* reader errors */
	PGP_E_R = 0x1000,	/* general reader error */
	PGP_E_R_READ_FAILED = PGP_E_R + 1,
	PGP_E_R_EARLY_EOF = PGP_E_R + 2,
	PGP_E_R_BAD_FORMAT = PGP_E_R + 3,	/* For example, malformed
						 * armour */
	PGP_E_R_UNSUPPORTED = PGP_E_R + 4,
	PGP_E_R_UNCONSUMED_DATA = PGP_E_R + 5,

	/* writer errors */
	PGP_E_W = 0x2000,	/* general writer error */
	PGP_E_W_WRITE_FAILED = PGP_E_W + 1,
	PGP_E_W_WRITE_TOO_SHORT = PGP_E_W + 2,

	/* parser errors */
	PGP_E_P = 0x3000,	/* general parser error */
	PGP_E_P_NOT_ENOUGH_DATA = PGP_E_P + 1,
	PGP_E_P_UNKNOWN_TAG = PGP_E_P + 2,
	PGP_E_P_PACKET_CONSUMED = PGP_E_P + 3,
	PGP_E_P_MPI_FORMAT_ERROR = PGP_E_P + 4,
	PGP_E_P_PACKET_NOT_CONSUMED = PGP_E_P + 5,
	PGP_E_P_DECOMPRESSION_ERROR = PGP_E_P + 6,
	PGP_E_P_NO_USERID = PGP_E_P + 7,

	/* creator errors */
	PGP_E_C = 0x4000,	/* general creator error */

	/* validation errors */
	PGP_E_V = 0x5000,	/* general validation error */
	PGP_E_V_BAD_SIGNATURE = PGP_E_V + 1,
	PGP_E_V_NO_SIGNATURE = PGP_E_V + 2,
	PGP_E_V_UNKNOWN_SIGNER = PGP_E_V + 3,
	PGP_E_V_BAD_HASH = PGP_E_V + 4,

	/* Algorithm support errors */
	PGP_E_ALG = 0x6000,	/* general algorithm error */
	PGP_E_ALG_UNSUPPORTED_SYMMETRIC_ALG = PGP_E_ALG + 1,
	PGP_E_ALG_UNSUPPORTED_PUBLIC_KEY_ALG = PGP_E_ALG + 2,
	PGP_E_ALG_UNSUPPORTED_SIGNATURE_ALG = PGP_E_ALG + 3,
	PGP_E_ALG_UNSUPPORTED_HASH_ALG = PGP_E_ALG + 4,
	PGP_E_ALG_UNSUPPORTED_COMPRESS_ALG = PGP_E_ALG + 5,

	/* Protocol errors */
	PGP_E_PROTO = 0x7000,	/* general protocol error */
	PGP_E_PROTO_BAD_SYMMETRIC_DECRYPT = PGP_E_PROTO + 2,
	PGP_E_PROTO_UNKNOWN_SS = PGP_E_PROTO + 3,
	PGP_E_PROTO_CRITICAL_SS_IGNORED = PGP_E_PROTO + 4,
	PGP_E_PROTO_BAD_PUBLIC_KEY_VRSN = PGP_E_PROTO + 5,
	PGP_E_PROTO_BAD_SIGNATURE_VRSN = PGP_E_PROTO + 6,
	PGP_E_PROTO_BAD_ONE_PASS_SIG_VRSN = PGP_E_PROTO + 7,
	PGP_E_PROTO_BAD_PKSK_VRSN = PGP_E_PROTO + 8,
	PGP_E_PROTO_DECRYPTED_MSG_WRONG_LEN = PGP_E_PROTO + 9,
	PGP_E_PROTO_BAD_SK_CHECKSUM = PGP_E_PROTO + 10
} pgp_errcode_t;

/** one entry in a linked list of errors */
typedef struct pgp_error {
	pgp_errcode_t		errcode;
	int			sys_errno;	/* irrelevent unless errcode ==
					 * PGP_E_SYSTEM_ERROR */
	char			*comment;
	const char		*file;
	int			 line;
	struct pgp_error	*next;
} pgp_error_t;

const char     *pgp_errcode(const pgp_errcode_t);

void 
pgp_push_error(pgp_error_t **, pgp_errcode_t,
		int,
		const char *, int, const char *,...) __printflike(6, 7);
void pgp_print_error(pgp_error_t *);
void pgp_print_errors(pgp_error_t *);
void pgp_free_errors(pgp_error_t *);
int  pgp_has_error(pgp_error_t *, pgp_errcode_t);

#define PGP_SYSTEM_ERROR_1(err,code,sys,fmt,arg)	do {		\
	pgp_push_error(err,PGP_E_SYSTEM_ERROR,errno,__FILE__,__LINE__,sys);\
	pgp_push_error(err,code,0,__FILE__,__LINE__,fmt,arg);		\
} while(/*CONSTCOND*/0)

#define PGP_MEMORY_ERROR(err) {						\
	fprintf(stderr, "Memory error\n");				\
}				/* \todo placeholder for better error
				 * handling */
#define PGP_ERROR_1(err,code,fmt,arg)	do {				\
	pgp_push_error(err,code,0,__FILE__,__LINE__,fmt,arg);		\
} while(/*CONSTCOND*/0)
#define PGP_ERROR_2(err,code,fmt,arg,arg2)	do {			\
	pgp_push_error(err,code,0,__FILE__,__LINE__,fmt,arg,arg2);	\
} while(/*CONSTCOND*/0)
#define PGP_ERROR_3(err,code,fmt,arg,arg2,arg3)	do {			\
	pgp_push_error(err,code,0,__FILE__,__LINE__,fmt,arg,arg2,arg3);	\
} while(/*CONSTCOND*/0)
#define PGP_ERROR_4(err,code,fmt,arg,arg2,arg3,arg4)	do {		\
	pgp_push_error(err,code,0,__FILE__,__LINE__,fmt,arg,arg2,arg3,arg4); \
} while(/*CONSTCOND*/0)

#endif /* ERRORS_H_ */