Merge branch 'refs/heads/t/duration-keyword' into pu
[paraslash.git] / crypt.h
1 /* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
2
3 /** \file crypt.h Public crypto interface. */
4
5 /*
6 * Asymmetric pubkey cryptosystem (apc).
7 *
8 * This is just RSA, but this fact is a hidden implementation detail.
9 */
10
11 /** The size of the challenge sent to the client. */
12 #define APC_CHALLENGE_SIZE 64
13
14 /** Opaque structure for public and private keys. */
15 struct asymmetric_key;
16
17 /**
18 * Encrypt a buffer using asymmetric keys.
19 *
20 * \param pub: The public key.
21 * \param inbuf The input buffer.
22 * \param len The length of \a inbuf.
23 * \param outbuf The output buffer.
24 *
25 * \return The size of the encrypted data on success, negative on errors.
26 */
27 int apc_pub_encrypt(struct asymmetric_key *pub, unsigned char *inbuf,
28 unsigned len, unsigned char *outbuf);
29
30 /**
31 * Decrypt a buffer using a private key.
32 *
33 * \param key_file Full path of the key.
34 * \param outbuf The output buffer.
35 * \param inbuf The encrypted input buffer.
36 * \param inlen The length of \a inbuf.
37 *
38 * The \a outbuf must be large enough to hold at least 512 bytes.
39 *
40 * \return The size of the recovered plaintext on success, negative on errors.
41 */
42 int apc_priv_decrypt(const char *key_file, unsigned char *outbuf,
43 unsigned char *inbuf, int inlen);
44
45 /**
46 * Read an asymmetric key from a file.
47 *
48 * \param key_file The file containing the key.
49 * \param result The key structure is returned here.
50 *
51 * \return The size of the key on success, negative on errors.
52 */
53 int apc_get_pubkey(const char *key_file, struct asymmetric_key **result);
54
55 /**
56 * Deallocate a public key.
57 *
58 * \param key Pointer to the key structure to free.
59 *
60 * This should be called for keys obtained by \ref apc_get_pubkey() if the key is no
61 * longer needed.
62 */
63 void apc_free_pubkey(struct asymmetric_key *key);
64
65
66 /**
67 * Fill a buffer with random content.
68 *
69 * \param buf The buffer to fill.
70 * \param num The size of \a buf in bytes.
71 *
72 * This function puts \a num cryptographically strong pseudo-random bytes into
73 * buf. If it can not guarantee an unpredictable byte sequence (for example
74 * because the PRNG has not been seeded with enough randomness) the function
75 * logs an error message and calls exit().
76 */
77 void get_random_bytes_or_die(unsigned char *buf, int num);
78
79 /**
80 * Initialize the crypto backend.
81 *
82 * This function initializes the crypto library and seeds the pseudo random
83 * number generator used by random() with a random seed obtained from the
84 * crypto implementation. On errors, an error message is logged and the
85 * function calls exit().
86 *
87 * \sa \ref get_random_bytes_or_die(), srandom(3), random(3), \ref
88 * para_random().
89 */
90 void crypt_init(void);
91
92 /** Allocate all resources of the crypto backend. */
93 void crypt_shutdown(void);
94
95 /** Opaque structure for stream ciphers. */
96 struct stream_cipher;
97
98 /** Number of bytes of the session key for stream ciphers. */
99 #define SESSION_KEY_LEN 32
100
101 /**
102 * Used for client-server communication encryption.
103 *
104 * The traffic between (the forked child of) para_server and the remote client
105 * process is crypted by a symmetric session key. This structure contains the
106 * keys for the stream cipher and the file descriptor for which these keys
107 * should be used.
108 */
109 struct stream_cipher_context {
110 /** The socket file descriptor. */
111 int fd;
112 /** Key used for receiving data. */
113 struct stream_cipher *recv;
114 /** Key used for sending data. */
115 struct stream_cipher *send;
116 };
117
118 /**
119 * Allocate and initialize an aes_ctr128 stream cipher structure.
120 *
121 * \param data The key.
122 * \param len The size of the key.
123 *
124 * \return A new stream cipher structure.
125 */
126 struct stream_cipher *sc_new(const unsigned char *data, int len);
127
128 /**
129 * Encrypt or decrypt a buffer using a stream cipher.
130 *
131 * \param sc Crypto key.
132 * \param src The source buffer and length.
133 * \param dst The destination buffer and length, filled out by the function.
134 *
135 * It is up to the implementation to decide whether the crypt operation is
136 * performed in place. The caller can tell by looking if the buffers given by
137 * \a src and \a dst coincide after the call. If (and only if) the crypt
138 * operation was not performed in place, the function allocated a new buffer
139 * for the result, so dst->iov_base is different from src->iov_base. In this
140 * case, the destination buffer must be freed by the caller when it is no
141 * longer needed.
142 */
143 void sc_crypt(struct stream_cipher *sc, struct iovec *src, struct iovec *dst);
144
145 /**
146 * Wrapper for \ref sc_crypt() that can be used as a sideband transformation.
147 *
148 * \param src Passed verbatim to \ref sc_crypt().
149 * \param dst Passed verbatim to \ref sc_crypt().
150 * \param trafo_context Must point to an initialized stream cipher.
151 */
152 _static_inline_ void sc_trafo(struct iovec *src, struct iovec *dst,
153 void *trafo_context)
154 {
155 sc_crypt(trafo_context, src, dst);
156 }
157
158 /**
159 * Deallocate a stream cipher structure.
160 *
161 * \param sc A stream cipher previously obtained by sc_new().
162 */
163 void sc_free(struct stream_cipher *sc);
164
165 /** Size of the hash value in bytes. */
166 #define HASH_SIZE 20
167
168 /**
169 * Compute the hash of the given input data.
170 *
171 * \param data Pointer to the data to compute the hash value from.
172 * \param len The length of \a data in bytes.
173 * \param hash Result pointer.
174 *
175 * \a hash must point to an area at least \p HASH_SIZE bytes large.
176 *
177 * \sa sha(3), openssl(1).
178 * */
179 void hash_function(const char *data, unsigned long len, unsigned char *hash);
180
181 /**
182 * Convert a hash value to ascii format.
183 *
184 * \param hash the hash value.
185 * \param asc Result pointer.
186 *
187 * \a asc must point to an area of at least 2 * \p HASH_SIZE + 1 bytes which
188 * will be filled by the function with the ascii representation of the hash
189 * value given by \a hash, and a terminating \p NULL byte.
190 */
191 void hash_to_asc(unsigned char *hash, char *asc);
192
193 /**
194 * Compare two hashes.
195 *
196 * \param h1 Pointer to the first hash value.
197 * \param h2 Pointer to the second hash value.
198 *
199 * \return 1, -1, or zero, depending on whether \a h1 is greater than,
200 * less than or equal to h2, respectively.
201 */
202 int hash_compare(unsigned char *h1, unsigned char *h2);