crypto.h 8.9 KB
Newer Older
1
/* Copyright (c) 2001, Matej Pfajfar.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright (c) 2001-2004, Roger Dingledine.
3
4
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
 * Copyright (c) 2007, The Tor Project, Inc. */
5
6
7
/* See LICENSE for licensing information */
/* $Id$ */

Nick Mathewson's avatar
Nick Mathewson committed
8
/**
9
 * \file crypto.h
Nick Mathewson's avatar
Nick Mathewson committed
10
 *
11
 * \brief Headers for crypto.c
Nick Mathewson's avatar
Nick Mathewson committed
12
13
 **/

14
15
#ifndef __CRYPTO_H
#define __CRYPTO_H
16
#define CRYPTO_H_ID "$Id$"
17

18
#include <stdio.h>
19
#include "torint.h"
20

Nick Mathewson's avatar
Nick Mathewson committed
21
/** Length of the output of our message digest. */
22
#define DIGEST_LEN 20
Nick Mathewson's avatar
Nick Mathewson committed
23
/** Length of our symmetric cipher's keys. */
24
#define CIPHER_KEY_LEN 16
25
26
/** Length of our symmetric cipher's IV. */
#define CIPHER_IV_LEN 16
Nick Mathewson's avatar
Nick Mathewson committed
27
/** Length of our public keys. */
28
#define PK_BYTES (1024/8)
Nick Mathewson's avatar
Nick Mathewson committed
29
/** Length of our DH keys. */
30
#define DH_BYTES (1024/8)
31

32
33
/** Length of a message digest when encoded in base64 with trailing = signs
 * removed. */
34
35
#define BASE64_DIGEST_LEN 27

Nick Mathewson's avatar
Nick Mathewson committed
36
/** Constants used to indicate no padding for public-key encryption */
37
#define PK_NO_PADDING         60000
Nick Mathewson's avatar
Nick Mathewson committed
38
/** Constants used to indicate PKCS1 padding for public-key encryption */
39
#define PK_PKCS1_PADDING      60001
Nick Mathewson's avatar
Nick Mathewson committed
40
/** Constants used to indicate OAEP padding for public-key encryption */
41
#define PK_PKCS1_OAEP_PADDING 60002
42

Nick Mathewson's avatar
Nick Mathewson committed
43
/** Number of bytes added for PKCS1 padding. */
44
#define PKCS1_PADDING_OVERHEAD 11
Nick Mathewson's avatar
Nick Mathewson committed
45
/** Number of bytes added for PKCS1-OAEP padding. */
46
47
#define PKCS1_OAEP_PADDING_OVERHEAD 42

Nick Mathewson's avatar
Nick Mathewson committed
48
/** Length of encoded public key fingerprints, including space; but not
49
 * including terminating NUL. */
50
#define FINGERPRINT_LEN 49
51
52
/** Length of hex encoding of SHA1 digest, not including final NUL. */
#define HEX_DIGEST_LEN 40
53

54
55
typedef struct crypto_pk_env_t crypto_pk_env_t;
typedef struct crypto_cipher_env_t crypto_cipher_env_t;
56
typedef struct crypto_digest_env_t crypto_digest_env_t;
57
typedef struct crypto_dh_env_t crypto_dh_env_t;
58
59

/* global state */
60
int crypto_global_init(int hardwareAccel);
61
void crypto_thread_cleanup(void);
Nick Mathewson's avatar
Nick Mathewson committed
62
int crypto_global_cleanup(void);
63
64

/* environment setup */
65
crypto_pk_env_t *crypto_new_pk_env(void);
66
67
void crypto_free_pk_env(crypto_pk_env_t *env);

68
/* convenience function: wraps crypto_create_crypto_env, set_key, and init. */
69
70
crypto_cipher_env_t *crypto_create_init_cipher(const char *key,
                                               int encrypt_mode);
71

72
crypto_cipher_env_t *crypto_new_cipher_env(void);
73
74
75
76
77
void crypto_free_cipher_env(crypto_cipher_env_t *env);

/* public key crypto */
int crypto_pk_generate_key(crypto_pk_env_t *env);

78
79
80
81
82
83
84
85
int crypto_pk_read_private_key_from_filename(crypto_pk_env_t *env,
                                             const char *keyfile);
int crypto_pk_write_public_key_to_string(crypto_pk_env_t *env,
                                         char **dest, size_t *len);
int crypto_pk_read_public_key_from_string(crypto_pk_env_t *env,
                                          const char *src, size_t len);
int crypto_pk_write_private_key_to_filename(crypto_pk_env_t *env,
                                            const char *fname);
86

87
int crypto_pk_check_key(crypto_pk_env_t *env);
88
int crypto_pk_cmp_keys(crypto_pk_env_t *a, crypto_pk_env_t *b);
89
size_t crypto_pk_keysize(crypto_pk_env_t *env);
90
crypto_pk_env_t *crypto_pk_dup_key(crypto_pk_env_t *orig);
91

92
93
94
95
int crypto_pk_public_encrypt(crypto_pk_env_t *env, char *to,
                             const char *from, size_t fromlen, int padding);
int crypto_pk_private_decrypt(crypto_pk_env_t *env, char *to,
                              const char *from, size_t fromlen,
96
                              int padding, int warnOnFailure);
97
98
99
100
101
102
103
104
105
106
int crypto_pk_public_checksig(crypto_pk_env_t *env, char *to,
                              const char *from, size_t fromlen);
int crypto_pk_public_checksig_digest(crypto_pk_env_t *env, const char *data,
                                     int datalen, const char *sig, int siglen);
int crypto_pk_private_sign(crypto_pk_env_t *env, char *to,
                           const char *from, size_t fromlen);
int crypto_pk_private_sign_digest(crypto_pk_env_t *env, char *to,
                                  const char *from, size_t fromlen);
int crypto_pk_public_hybrid_encrypt(crypto_pk_env_t *env, char *to,
                                    const char *from, size_t fromlen,
107
                                    int padding, int force);
108
109
int crypto_pk_private_hybrid_decrypt(crypto_pk_env_t *env, char *to,
                                     const char *from, size_t fromlen,
110
                                     int padding, int warnOnFailure);
111

112
int crypto_pk_asn1_encode(crypto_pk_env_t *pk, char *dest, int dest_len);
113
crypto_pk_env_t *crypto_pk_asn1_decode(const char *str, size_t len);
114
int crypto_pk_get_digest(crypto_pk_env_t *pk, char *digest_out);
115
int crypto_pk_get_fingerprint(crypto_pk_env_t *pk, char *fp_out,int add_space);
116
int crypto_pk_check_fingerprint_syntax(const char *s);
117

118
/* symmetric crypto */
119
int crypto_cipher_generate_key(crypto_cipher_env_t *env);
120
int crypto_cipher_set_key(crypto_cipher_env_t *env, const char *key);
121
122
void crypto_cipher_generate_iv(char *iv_out);
int crypto_cipher_set_iv(crypto_cipher_env_t *env, const char *iv);
123
const char *crypto_cipher_get_key(crypto_cipher_env_t *env);
124
125
int crypto_cipher_encrypt_init_cipher(crypto_cipher_env_t *env);
int crypto_cipher_decrypt_init_cipher(crypto_cipher_env_t *env);
126

127
128
129
130
int crypto_cipher_encrypt(crypto_cipher_env_t *env, char *to,
                          const char *from, size_t fromlen);
int crypto_cipher_decrypt(crypto_cipher_env_t *env, char *to,
                          const char *from, size_t fromlen);
131

132
133
134
135
136
137
138
int crypto_cipher_encrypt_with_iv(crypto_cipher_env_t *env,
                                  char *to, size_t tolen,
                                  const char *from, size_t fromlen);
int crypto_cipher_decrypt_with_iv(crypto_cipher_env_t *env,
                                  char *to, size_t tolen,
                                  const char *from, size_t fromlen);

139
/* SHA-1 */
140
int crypto_digest(char *digest, const char *m, size_t len);
Nick Mathewson's avatar
Nick Mathewson committed
141
crypto_digest_env_t *crypto_new_digest_env(void);
142
void crypto_free_digest_env(crypto_digest_env_t *digest);
143
void crypto_digest_add_bytes(crypto_digest_env_t *digest, const char *data,
144
                             size_t len);
145
void crypto_digest_get_digest(crypto_digest_env_t *digest,
146
147
                              char *out, size_t out_len);
crypto_digest_env_t *crypto_digest_dup(const crypto_digest_env_t *digest);
148
void crypto_digest_assign(crypto_digest_env_t *into,
149
                          const crypto_digest_env_t *from);
150
151
152
void crypto_hmac_sha1(char *hmac_out,
                      const char *key, size_t key_len,
                      const char *msg, size_t msg_len);
153

154
155
156
157
158
159
160
161
162
163
/* Key negotiation */
crypto_dh_env_t *crypto_dh_new(void);
int crypto_dh_get_bytes(crypto_dh_env_t *dh);
int crypto_dh_generate_public(crypto_dh_env_t *dh);
int crypto_dh_get_public(crypto_dh_env_t *dh, char *pubkey_out,
                         size_t pubkey_out_len);
int crypto_dh_compute_secret(crypto_dh_env_t *dh,
                             const char *pubkey, size_t pubkey_len,
                             char *secret_out, size_t secret_out_len);
void crypto_dh_free(crypto_dh_env_t *dh);
164
165
int crypto_expand_key_material(const char *key_in, size_t in_len,
                               char *key_out, size_t key_out_len);
166

167
/* random numbers */
Nick Mathewson's avatar
Nick Mathewson committed
168
int crypto_seed_rng(void);
169
int crypto_rand(char *to, size_t n);
170
int crypto_rand_int(unsigned int max);
171
uint64_t crypto_rand_uint64(uint64_t max);
172

173
174
struct smartlist_t;
void *smartlist_choose(const struct smartlist_t *sl);
175
void smartlist_shuffle(struct smartlist_t *sl);
176
177
178

int base64_encode(char *dest, size_t destlen, const char *src, size_t srclen);
int base64_decode(char *dest, size_t destlen, const char *src, size_t srclen);
179
/** Characters that can appear (case-insensitively) in a base-32 encoding. */
180
181
#define BASE32_CHARS "abcdefghijklmnopqrstuvwxyz234567"
void base32_encode(char *dest, size_t destlen, const char *src, size_t srclen);
182
int base32_decode(char *dest, size_t destlen, const char *src, size_t srclen);
183

184
185
186
int digest_to_base64(char *d64, const char *digest);
int digest_from_base64(char *digest, const char *d64);

187
188
/** Length of RFC2440-style S2K specifier: the first 8 bytes are a salt, the
 * 9th describes how much iteration to do. */
189
190
191
192
#define S2K_SPECIFIER_LEN 9
void secret_to_key(char *key_out, size_t key_out_len, const char *secret,
                   size_t secret_len, const char *s2k_specifier);

193
194
#ifdef CRYPTO_PRIVATE
/* Prototypes for private functions only used by tortls.c and crypto.c */
195
196
197
198
struct rsa_st;
struct evp_pkey_st;
struct dh_st;
crypto_pk_env_t *_crypto_new_pk_env_rsa(struct rsa_st *rsa);
199
crypto_pk_env_t *_crypto_new_pk_env_evp_pkey(struct evp_pkey_st *pkey);
200
201
202
struct evp_pkey_st *_crypto_pk_env_get_evp_pkey(crypto_pk_env_t *env,
                                                int private);
struct dh_st *_crypto_dh_env_get_dh(crypto_dh_env_t *dh);
203
204
205
/* Prototypes for private functions only used by crypto.c and test.c*/
int crypto_pk_read_private_key_from_string(crypto_pk_env_t *env,
                                           const char *s);
206
207
#endif

208
#endif
209