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 /* a way to disable palloc
41  * - useful if compiled into standalone
42  */
43 #ifndef PX_OWN_ALLOC
44 #define px_alloc(s) palloc(s)
45 #define px_realloc(p, s) repalloc(p, s)
46 #define px_free(p) pfree(p)
47 #else
48 void *px_alloc(size_t s);
49 void *px_realloc(void *p, size_t s);
50 void px_free(void *p);
51 #endif
52 
53 /* max salt returned */
54 #define PX_MAX_SALT_LEN 128
55 
56 /*
57  * PX error codes
58  */
59 #define PXE_OK 0
60 #define PXE_ERR_GENERIC -1
61 #define PXE_NO_HASH -2
62 #define PXE_NO_CIPHER -3
63 #define PXE_NOTBLOCKSIZE -4
64 #define PXE_BAD_OPTION -5
65 #define PXE_BAD_FORMAT -6
66 #define PXE_KEY_TOO_BIG -7
67 #define PXE_CIPHER_INIT -8
68 #define PXE_HASH_UNUSABLE_FOR_HMAC -9
69 #define PXE_DEV_READ_ERROR -10
70 #define PXE_BUG -12
71 #define PXE_ARGUMENT_ERROR -13
72 #define PXE_UNKNOWN_SALT_ALGO -14
73 #define PXE_BAD_SALT_ROUNDS -15
74 #define PXE_MCRYPT_INTERNAL -16
75 #define PXE_NO_RANDOM -17
76 #define PXE_DECRYPT_FAILED -18
77 
78 #define PXE_PGP_CORRUPT_DATA -100
79 #define PXE_PGP_CORRUPT_ARMOR -101
80 #define PXE_PGP_UNSUPPORTED_COMPR -102
81 #define PXE_PGP_UNSUPPORTED_CIPHER -103
82 #define PXE_PGP_UNSUPPORTED_HASH -104
83 #define PXE_PGP_COMPRESSION_ERROR -105
84 #define PXE_PGP_NOT_TEXT -106
85 #define PXE_PGP_UNEXPECTED_PKT -107
86 /* -108 is unused */
87 #define PXE_PGP_MATH_FAILED -109
88 #define PXE_PGP_SHORT_ELGAMAL_KEY -110
89 /* -111 is unused */
90 #define PXE_PGP_UNKNOWN_PUBALGO -112
91 #define PXE_PGP_WRONG_KEY -113
92 #define PXE_PGP_MULTIPLE_KEYS -114
93 #define PXE_PGP_EXPECT_PUBLIC_KEY -115
94 #define PXE_PGP_EXPECT_SECRET_KEY -116
95 #define PXE_PGP_NOT_V4_KEYPKT -117
96 #define PXE_PGP_KEYPKT_CORRUPT -118
97 #define PXE_PGP_NO_USABLE_KEY -119
98 #define PXE_PGP_NEED_SECRET_PSW -120
99 #define PXE_PGP_BAD_S2K_MODE -121
100 #define PXE_PGP_UNSUPPORTED_PUBALGO -122
101 #define PXE_PGP_MULTIPLE_SUBKEYS -123
102 
103 
104 typedef struct px_digest PX_MD;
105 typedef struct px_alias PX_Alias;
106 typedef struct px_hmac PX_HMAC;
107 typedef struct px_cipher PX_Cipher;
108 typedef struct px_combo PX_Combo;
109 
110 struct px_digest
111 {
112  unsigned (*result_size) (PX_MD *h);
113  unsigned (*block_size) (PX_MD *h);
114  void (*reset) (PX_MD *h);
115  void (*update) (PX_MD *h, const uint8 *data, unsigned dlen);
116  void (*finish) (PX_MD *h, uint8 *dst);
117  void (*free) (PX_MD *h);
118  /* private */
119  union
120  {
121  unsigned code;
122  void *ptr;
123  } p;
124 };
125 
126 struct px_alias
127 {
128  char *alias;
129  char *name;
130 };
131 
132 struct px_hmac
133 {
134  unsigned (*result_size) (PX_HMAC *h);
135  unsigned (*block_size) (PX_HMAC *h);
136  void (*reset) (PX_HMAC *h);
137  void (*update) (PX_HMAC *h, const uint8 *data, unsigned dlen);
138  void (*finish) (PX_HMAC *h, uint8 *dst);
139  void (*free) (PX_HMAC *h);
140  void (*init) (PX_HMAC *h, const uint8 *key, unsigned klen);
141 
143  /* private */
144  struct
145  {
148  } p;
149 };
150 
151 struct px_cipher
152 {
153  unsigned (*block_size) (PX_Cipher *c);
154  unsigned (*key_size) (PX_Cipher *c); /* max key len */
155  unsigned (*iv_size) (PX_Cipher *c);
156 
157  int (*init) (PX_Cipher *c, const uint8 *key, unsigned klen, const uint8 *iv);
158  int (*encrypt) (PX_Cipher *c, const uint8 *data, unsigned dlen, uint8 *res);
159  int (*decrypt) (PX_Cipher *c, const uint8 *data, unsigned dlen, uint8 *res);
160  void (*free) (PX_Cipher *c);
161  /* private */
162  void *ptr;
163  int pstat; /* mcrypt uses it */
164 };
165 
166 struct px_combo
167 {
168  int (*init) (PX_Combo *cx, const uint8 *key, unsigned klen,
169  const uint8 *iv, unsigned ivlen);
170  int (*encrypt) (PX_Combo *cx, const uint8 *data, unsigned dlen,
171  uint8 *res, unsigned *rlen);
172  int (*decrypt) (PX_Combo *cx, const uint8 *data, unsigned dlen,
173  uint8 *res, unsigned *rlen);
174  unsigned (*encrypt_len) (PX_Combo *cx, unsigned dlen);
175  unsigned (*decrypt_len) (PX_Combo *cx, unsigned dlen);
176  void (*free) (PX_Combo *cx);
177 
179  unsigned padding;
180 };
181 
182 int px_find_digest(const char *name, PX_MD **res);
183 int px_find_hmac(const char *name, PX_HMAC **res);
184 int px_find_cipher(const char *name, PX_Cipher **res);
185 int px_find_combo(const char *name, PX_Combo **res);
186 
187 void px_THROW_ERROR(int err) pg_attribute_noreturn();
188 const char *px_strerror(int err);
189 
190 const char *px_resolve_alias(const PX_Alias *aliases, const char *name);
191 
192 void px_set_debug_handler(void (*handler) (const char *));
193 
194 void px_memset(void *ptr, int c, size_t len);
195 
196 #ifdef PX_DEBUG
197 void px_debug(const char *fmt,...) pg_attribute_printf(1, 2);
198 #else
199 #define px_debug(...)
200 #endif
201 
202 #define px_md_result_size(md) (md)->result_size(md)
203 #define px_md_block_size(md) (md)->block_size(md)
204 #define px_md_reset(md) (md)->reset(md)
205 #define px_md_update(md, data, dlen) (md)->update(md, data, dlen)
206 #define px_md_finish(md, buf) (md)->finish(md, buf)
207 #define px_md_free(md) (md)->free(md)
208 
209 #define px_hmac_result_size(hmac) (hmac)->result_size(hmac)
210 #define px_hmac_block_size(hmac) (hmac)->block_size(hmac)
211 #define px_hmac_reset(hmac) (hmac)->reset(hmac)
212 #define px_hmac_init(hmac, key, klen) (hmac)->init(hmac, key, klen)
213 #define px_hmac_update(hmac, data, dlen) (hmac)->update(hmac, data, dlen)
214 #define px_hmac_finish(hmac, buf) (hmac)->finish(hmac, buf)
215 #define px_hmac_free(hmac) (hmac)->free(hmac)
216 
217 
218 #define px_cipher_key_size(c) (c)->key_size(c)
219 #define px_cipher_block_size(c) (c)->block_size(c)
220 #define px_cipher_iv_size(c) (c)->iv_size(c)
221 #define px_cipher_init(c, k, klen, iv) (c)->init(c, k, klen, iv)
222 #define px_cipher_encrypt(c, data, dlen, res) \
223  (c)->encrypt(c, data, dlen, res)
224 #define px_cipher_decrypt(c, data, dlen, res) \
225  (c)->decrypt(c, data, dlen, res)
226 #define px_cipher_free(c) (c)->free(c)
227 
228 
229 #define px_combo_encrypt_len(c, dlen) (c)->encrypt_len(c, dlen)
230 #define px_combo_decrypt_len(c, dlen) (c)->decrypt_len(c, dlen)
231 #define px_combo_init(c, key, klen, iv, ivlen) \
232  (c)->init(c, key, klen, iv, ivlen)
233 #define px_combo_encrypt(c, data, dlen, res, rlen) \
234  (c)->encrypt(c, data, dlen, res, rlen)
235 #define px_combo_decrypt(c, data, dlen, res, rlen) \
236  (c)->decrypt(c, data, dlen, res, rlen)
237 #define px_combo_free(c) (c)->free(c)
238 
239 #endif /* __PX_H */
void px_THROW_ERROR(int err) pg_attribute_noreturn()
Definition: px.c:96
unsigned code
Definition: px.h:121
void * ptr
Definition: px.h:122
int px_find_digest(const char *name, PX_MD **res)
Definition: internal.c:559
unsigned padding
Definition: px.h:179
void(* free)(PX_MD *h)
Definition: px.h:117
#define px_free(p)
Definition: px.h:46
unsigned char uint8
Definition: c.h:357
int px_find_hmac(const char *name, PX_HMAC **res)
Definition: px-hmac.c:143
Definition: px.h:166
void * ptr
Definition: px.h:162
int pstat
Definition: px.h:163
void px_debug(const char *fmt,...) pg_attribute_printf(1
PX_Cipher * cipher
Definition: px.h:178
Definition: px.h:126
#define pg_attribute_printf(f, a)
Definition: c.h:132
PX_MD * md
Definition: px.h:142
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:113
int px_find_combo(const char *name, PX_Combo **res)
Definition: px.c:402
Definition: px.h:110
int px_find_cipher(const char *name, PX_Cipher **res)
Definition: internal.c:578
void(* update)(PX_MD *h, const uint8 *data, unsigned dlen)
Definition: px.h:115
void(* finish)(PX_MD *h, uint8 *dst)
Definition: px.h:116
char * c
#define init()
#define px_realloc(p, s)
Definition: px.h:45
uint8 * opad
Definition: px.h:147
unsigned(* result_size)(PX_MD *h)
Definition: px.h:112
void px_set_debug_handler(void(*handler)(const char *))
Definition: px.c:146
union px_digest::@13 p
const char * px_strerror(int err)
Definition: px.c:114
char * alias
Definition: px.h:128
const char * px_resolve_alias(const PX_Alias *aliases, const char *name)
Definition: px.c:132
void(* reset)(PX_MD *h)
Definition: px.h:114
Definition: px.h:151
const char * name
Definition: encode.c:521
#define pg_attribute_noreturn()
Definition: c.h:147
#define px_alloc(s)
Definition: px.h:44
uint8 * ipad
Definition: px.h:146
char * name
Definition: px.h:129
Definition: px.h:132
void px_memset(void *ptr, int c, size_t len)
Definition: px.c:126