PostgreSQL Source Code  git master
px.h
Go to the documentation of this file.
1 /*
2  * px.h
3  * Header file for pgcrypto.
4  *
5  * Copyright (c) 2001 Marko Kreen
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * contrib/pgcrypto/px.h
30  */
31 
32 #ifndef __PX_H
33 #define __PX_H
34 
35 #include <sys/param.h>
36 
37 /* keep debug messages? */
38 #define PX_DEBUG
39 
40 /* max salt returned */
41 #define PX_MAX_SALT_LEN 128
42 
43 /*
44  * PX error codes
45  */
46 #define PXE_OK 0
47 #define PXE_ERR_GENERIC -1
48 #define PXE_NO_HASH -2
49 #define PXE_NO_CIPHER -3
50 #define PXE_NOTBLOCKSIZE -4
51 #define PXE_BAD_OPTION -5
52 #define PXE_BAD_FORMAT -6
53 #define PXE_KEY_TOO_BIG -7
54 #define PXE_CIPHER_INIT -8
55 #define PXE_HASH_UNUSABLE_FOR_HMAC -9
56 #define PXE_DEV_READ_ERROR -10
57 #define PXE_BUG -12
58 #define PXE_ARGUMENT_ERROR -13
59 #define PXE_UNKNOWN_SALT_ALGO -14
60 #define PXE_BAD_SALT_ROUNDS -15
61 #define PXE_MCRYPT_INTERNAL -16
62 #define PXE_NO_RANDOM -17
63 #define PXE_DECRYPT_FAILED -18
64 #define PXE_ENCRYPT_FAILED -19
65 
66 #define PXE_PGP_CORRUPT_DATA -100
67 #define PXE_PGP_CORRUPT_ARMOR -101
68 #define PXE_PGP_UNSUPPORTED_COMPR -102
69 #define PXE_PGP_UNSUPPORTED_CIPHER -103
70 #define PXE_PGP_UNSUPPORTED_HASH -104
71 #define PXE_PGP_COMPRESSION_ERROR -105
72 #define PXE_PGP_NOT_TEXT -106
73 #define PXE_PGP_UNEXPECTED_PKT -107
74 /* -108 is unused */
75 #define PXE_PGP_MATH_FAILED -109
76 #define PXE_PGP_SHORT_ELGAMAL_KEY -110
77 /* -111 is unused */
78 #define PXE_PGP_UNKNOWN_PUBALGO -112
79 #define PXE_PGP_WRONG_KEY -113
80 #define PXE_PGP_MULTIPLE_KEYS -114
81 #define PXE_PGP_EXPECT_PUBLIC_KEY -115
82 #define PXE_PGP_EXPECT_SECRET_KEY -116
83 #define PXE_PGP_NOT_V4_KEYPKT -117
84 #define PXE_PGP_KEYPKT_CORRUPT -118
85 #define PXE_PGP_NO_USABLE_KEY -119
86 #define PXE_PGP_NEED_SECRET_PSW -120
87 #define PXE_PGP_BAD_S2K_MODE -121
88 #define PXE_PGP_UNSUPPORTED_PUBALGO -122
89 #define PXE_PGP_MULTIPLE_SUBKEYS -123
90 
91 
92 typedef struct px_digest PX_MD;
93 typedef struct px_alias PX_Alias;
94 typedef struct px_hmac PX_HMAC;
95 typedef struct px_cipher PX_Cipher;
96 typedef struct px_combo PX_Combo;
97 
98 struct px_digest
99 {
100  unsigned (*result_size) (PX_MD *h);
101  unsigned (*block_size) (PX_MD *h);
102  void (*reset) (PX_MD *h);
103  void (*update) (PX_MD *h, const uint8 *data, unsigned dlen);
104  void (*finish) (PX_MD *h, uint8 *dst);
105  void (*free) (PX_MD *h);
106  /* private */
107  union
108  {
109  unsigned code;
110  void *ptr;
111  } p;
112 };
113 
114 struct px_alias
115 {
116  char *alias;
117  char *name;
118 };
119 
120 struct px_hmac
121 {
122  unsigned (*result_size) (PX_HMAC *h);
123  unsigned (*block_size) (PX_HMAC *h);
124  void (*reset) (PX_HMAC *h);
125  void (*update) (PX_HMAC *h, const uint8 *data, unsigned dlen);
126  void (*finish) (PX_HMAC *h, uint8 *dst);
127  void (*free) (PX_HMAC *h);
128  void (*init) (PX_HMAC *h, const uint8 *key, unsigned klen);
129 
131  /* private */
132  struct
133  {
136  } p;
137 };
138 
139 struct px_cipher
140 {
141  unsigned (*block_size) (PX_Cipher *c);
142  unsigned (*key_size) (PX_Cipher *c); /* max key len */
143  unsigned (*iv_size) (PX_Cipher *c);
144 
145  int (*init) (PX_Cipher *c, const uint8 *key, unsigned klen, const uint8 *iv);
146  int (*encrypt) (PX_Cipher *c, const uint8 *data, unsigned dlen, uint8 *res);
147  int (*decrypt) (PX_Cipher *c, const uint8 *data, unsigned dlen, uint8 *res);
148  void (*free) (PX_Cipher *c);
149  /* private */
150  void *ptr;
151  int pstat; /* mcrypt uses it */
152 };
153 
154 struct px_combo
155 {
156  int (*init) (PX_Combo *cx, const uint8 *key, unsigned klen,
157  const uint8 *iv, unsigned ivlen);
158  int (*encrypt) (PX_Combo *cx, const uint8 *data, unsigned dlen,
159  uint8 *res, unsigned *rlen);
160  int (*decrypt) (PX_Combo *cx, const uint8 *data, unsigned dlen,
161  uint8 *res, unsigned *rlen);
162  unsigned (*encrypt_len) (PX_Combo *cx, unsigned dlen);
163  unsigned (*decrypt_len) (PX_Combo *cx, unsigned dlen);
164  void (*free) (PX_Combo *cx);
165 
167  unsigned padding;
168 };
169 
170 int px_find_digest(const char *name, PX_MD **res);
171 int px_find_hmac(const char *name, PX_HMAC **res);
172 int px_find_cipher(const char *name, PX_Cipher **res);
173 int px_find_combo(const char *name, PX_Combo **res);
174 
175 void px_THROW_ERROR(int err) pg_attribute_noreturn();
176 const char *px_strerror(int err);
177 
178 const char *px_resolve_alias(const PX_Alias *aliases, const char *name);
179 
180 void px_set_debug_handler(void (*handler) (const char *));
181 
182 void px_memset(void *ptr, int c, size_t len);
183 
184 #ifdef PX_DEBUG
185 void px_debug(const char *fmt,...) pg_attribute_printf(1, 2);
186 #else
187 #define px_debug(...)
188 #endif
189 
190 #define px_md_result_size(md) (md)->result_size(md)
191 #define px_md_block_size(md) (md)->block_size(md)
192 #define px_md_reset(md) (md)->reset(md)
193 #define px_md_update(md, data, dlen) (md)->update(md, data, dlen)
194 #define px_md_finish(md, buf) (md)->finish(md, buf)
195 #define px_md_free(md) (md)->free(md)
196 
197 #define px_hmac_result_size(hmac) (hmac)->result_size(hmac)
198 #define px_hmac_block_size(hmac) (hmac)->block_size(hmac)
199 #define px_hmac_reset(hmac) (hmac)->reset(hmac)
200 #define px_hmac_init(hmac, key, klen) (hmac)->init(hmac, key, klen)
201 #define px_hmac_update(hmac, data, dlen) (hmac)->update(hmac, data, dlen)
202 #define px_hmac_finish(hmac, buf) (hmac)->finish(hmac, buf)
203 #define px_hmac_free(hmac) (hmac)->free(hmac)
204 
205 
206 #define px_cipher_key_size(c) (c)->key_size(c)
207 #define px_cipher_block_size(c) (c)->block_size(c)
208 #define px_cipher_iv_size(c) (c)->iv_size(c)
209 #define px_cipher_init(c, k, klen, iv) (c)->init(c, k, klen, iv)
210 #define px_cipher_encrypt(c, data, dlen, res) \
211  (c)->encrypt(c, data, dlen, res)
212 #define px_cipher_decrypt(c, data, dlen, res) \
213  (c)->decrypt(c, data, dlen, res)
214 #define px_cipher_free(c) (c)->free(c)
215 
216 
217 #define px_combo_encrypt_len(c, dlen) (c)->encrypt_len(c, dlen)
218 #define px_combo_decrypt_len(c, dlen) (c)->decrypt_len(c, dlen)
219 #define px_combo_init(c, key, klen, iv, ivlen) \
220  (c)->init(c, key, klen, iv, ivlen)
221 #define px_combo_encrypt(c, data, dlen, res, rlen) \
222  (c)->encrypt(c, data, dlen, res, rlen)
223 #define px_combo_decrypt(c, data, dlen, res, rlen) \
224  (c)->decrypt(c, data, dlen, res, rlen)
225 #define px_combo_free(c) (c)->free(c)
226 
227 #endif /* __PX_H */
void px_THROW_ERROR(int err) pg_attribute_noreturn()
Definition: px.c:97
#define pg_attribute_noreturn()
Definition: c.h:179
unsigned code
Definition: px.h:109
void * ptr
Definition: px.h:110
int px_find_digest(const char *name, PX_MD **res)
Definition: internal.c:547
unsigned padding
Definition: px.h:167
void(* free)(PX_MD *h)
Definition: px.h:105
unsigned char uint8
Definition: c.h:439
int px_find_hmac(const char *name, PX_HMAC **res)
Definition: px-hmac.c:142
Definition: px.h:154
void * ptr
Definition: px.h:150
int pstat
Definition: px.h:151
void px_debug(const char *fmt,...) pg_attribute_printf(1
PX_Cipher * cipher
Definition: px.h:166
Definition: px.h:114
#define pg_attribute_printf(f, a)
Definition: c.h:164
PX_MD * md
Definition: px.h:130
int cx(PlannerInfo *root, Gene *tour1, Gene *tour2, Gene *offspring, int num_gene, City *city_table)
unsigned(* block_size)(PX_MD *h)
Definition: px.h:101
int px_find_combo(const char *name, PX_Combo **res)
Definition: px.c:402
union px_digest::@9 p
Definition: px.h:98
int px_find_cipher(const char *name, PX_Cipher **res)
Definition: internal.c:566
void(* update)(PX_MD *h, const uint8 *data, unsigned dlen)
Definition: px.h:103
void(* finish)(PX_MD *h, uint8 *dst)
Definition: px.h:104
char * c
#define init()
uint8 * opad
Definition: px.h:135
unsigned(* result_size)(PX_MD *h)
Definition: px.h:100
void px_set_debug_handler(void(*handler)(const char *))
Definition: px.c:147
const char * px_strerror(int err)
Definition: px.c:115
char * alias
Definition: px.h:116
const char * px_resolve_alias(const PX_Alias *aliases, const char *name)
Definition: px.c:133
void(* reset)(PX_MD *h)
Definition: px.h:102
Definition: px.h:139
const char * name
Definition: encode.c:515
uint8 * ipad
Definition: px.h:134
char * name
Definition: px.h:117
Definition: px.h:120
void px_memset(void *ptr, int c, size_t len)
Definition: px.c:127