]> git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/CyaSSL/cyassl/ssl.h
Add FreeRTOS-Plus directory.
[freertos] / FreeRTOS-Plus / CyaSSL / cyassl / ssl.h
1 /* ssl.h
2  *
3  * Copyright (C) 2006-2012 Sawtooth Consulting Ltd.
4  *
5  * This file is part of CyaSSL.
6  *
7  * CyaSSL is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * CyaSSL is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22
23 /* CyaSSL API */
24
25 #ifndef CYASSL_SSL_H
26 #define CYASSL_SSL_H
27
28
29 /* for users not using preprocessor flags*/
30 #include <cyassl/ctaocrypt/settings.h>
31 #include <cyassl/version.h>
32
33
34 #ifndef NO_FILESYSTEM
35     #include <stdio.h>   /* ERR_printf */
36 #endif
37
38 #ifdef YASSL_PREFIX
39     #include "prefix_ssl.h"
40 #endif
41
42 #ifdef LIBCYASSL_VERSION_STRING
43     #define CYASSL_VERSION LIBCYASSL_VERSION_STRING
44 #endif
45
46
47
48 #ifdef __cplusplus
49     extern "C" {
50 #endif
51
52
53 typedef struct CYASSL          CYASSL;          
54 typedef struct CYASSL_SESSION  CYASSL_SESSION;
55 typedef struct CYASSL_METHOD   CYASSL_METHOD;
56 typedef struct CYASSL_CTX      CYASSL_CTX;
57
58 typedef struct CYASSL_X509       CYASSL_X509;
59 typedef struct CYASSL_X509_NAME  CYASSL_X509_NAME;
60 typedef struct CYASSL_X509_CHAIN CYASSL_X509_CHAIN;
61
62 typedef struct CYASSL_CERT_MANAGER CYASSL_CERT_MANAGER;
63
64 /* redeclare guard */
65 #define CYASSL_TYPES_DEFINED
66
67
68 typedef struct CYASSL_RSA            CYASSL_RSA;
69 typedef struct CYASSL_DSA            CYASSL_DSA;
70 typedef struct CYASSL_CIPHER         CYASSL_CIPHER;
71 typedef struct CYASSL_X509_LOOKUP    CYASSL_X509_LOOKUP;
72 typedef struct CYASSL_X509_LOOKUP_METHOD CYASSL_X509_LOOKUP_METHOD;
73 typedef struct CYASSL_X509_CRL       CYASSL_X509_CRL;
74 typedef struct CYASSL_BIO            CYASSL_BIO;
75 typedef struct CYASSL_BIO_METHOD     CYASSL_BIO_METHOD;
76 typedef struct CYASSL_X509_EXTENSION CYASSL_X509_EXTENSION;
77 typedef struct CYASSL_ASN1_TIME      CYASSL_ASN1_TIME;
78 typedef struct CYASSL_ASN1_INTEGER   CYASSL_ASN1_INTEGER;
79 typedef struct CYASSL_ASN1_OBJECT    CYASSL_ASN1_OBJECT;
80 typedef struct CYASSL_ASN1_STRING    CYASSL_ASN1_STRING;
81 typedef struct CYASSL_dynlock_value  CYASSL_dynlock_value;
82
83 #define CYASSL_ASN1_UTCTIME CYASSL_ASN1_TIME
84
85 typedef struct CYASSL_EVP_PKEY {
86     int type;         /* openssh dereference */
87     int save_type;    /* openssh dereference */
88 } CYASSL_EVP_PKEY;
89
90 typedef struct CYASSL_MD4_CTX {
91     int buffer[32];      /* big enough to hold, check size in Init */
92 } CYASSL_MD4_CTX;
93
94
95 typedef struct CYASSL_COMP_METHOD {
96     int type;            /* stunnel dereference */
97 } CYASSL_COMP_METHOD;
98
99
100 typedef struct CYASSL_X509_STORE {
101     int cache;          /* stunnel dereference */
102 } CYASSL_X509_STORE;
103
104
105 typedef struct CYASSL_X509_REVOKED {
106     CYASSL_ASN1_INTEGER* serialNumber;          /* stunnel dereference */
107 } CYASSL_X509_REVOKED;
108
109
110 typedef struct CYASSL_X509_OBJECT {
111     union {
112         char* ptr;
113         CYASSL_X509_CRL* crl;           /* stunnel dereference */
114     } data;
115 } CYASSL_X509_OBJECT;
116
117
118 /* in internal.h too, change there !! */
119 typedef struct CYASSL_X509_STORE_CTX {
120     int   error;
121     int   error_depth;
122     CYASSL_X509* current_cert;   /* stunnel dereference */
123     char* domain;                /* subject CN domain name */
124     void* ex_data;               /* external data, for fortress build */
125     /* in internal.h too, change there !! */
126 } CYASSL_X509_STORE_CTX;
127
128
129 CYASSL_API CYASSL_METHOD *CyaSSLv3_server_method(void);
130 CYASSL_API CYASSL_METHOD *CyaSSLv3_client_method(void);
131 CYASSL_API CYASSL_METHOD *CyaTLSv1_server_method(void);  
132 CYASSL_API CYASSL_METHOD *CyaTLSv1_client_method(void);
133 CYASSL_API CYASSL_METHOD *CyaTLSv1_1_server_method(void);  
134 CYASSL_API CYASSL_METHOD *CyaTLSv1_1_client_method(void);
135 CYASSL_API CYASSL_METHOD *CyaTLSv1_2_server_method(void);  
136 CYASSL_API CYASSL_METHOD *CyaTLSv1_2_client_method(void);
137
138 #ifdef CYASSL_DTLS
139     CYASSL_API CYASSL_METHOD *CyaDTLSv1_client_method(void);
140     CYASSL_API CYASSL_METHOD *CyaDTLSv1_server_method(void);
141 #endif
142
143 #ifndef NO_FILESYSTEM
144
145 CYASSL_API int CyaSSL_CTX_use_certificate_file(CYASSL_CTX*, const char*, int);
146 CYASSL_API int CyaSSL_CTX_use_PrivateKey_file(CYASSL_CTX*, const char*, int);
147 CYASSL_API int CyaSSL_CTX_load_verify_locations(CYASSL_CTX*, const char*,
148                                                 const char*);
149 CYASSL_API int CyaSSL_CTX_use_certificate_chain_file(CYASSL_CTX *,
150                                                      const char *file);
151 CYASSL_API int CyaSSL_CTX_use_RSAPrivateKey_file(CYASSL_CTX*, const char*, int);
152
153 CYASSL_API int CyaSSL_use_certificate_file(CYASSL*, const char*, int);
154 CYASSL_API int CyaSSL_use_PrivateKey_file(CYASSL*, const char*, int);
155 CYASSL_API int CyaSSL_use_certificate_chain_file(CYASSL*, const char *file);
156 CYASSL_API int CyaSSL_use_RSAPrivateKey_file(CYASSL*, const char*, int);
157
158 #ifdef CYASSL_DER_LOAD
159     CYASSL_API int CyaSSL_CTX_der_load_verify_locations(CYASSL_CTX*,
160                                                     const char*, int);
161 #endif
162
163 #ifdef HAVE_NTRU
164     CYASSL_API int CyaSSL_CTX_use_NTRUPrivateKey_file(CYASSL_CTX*, const char*);
165     /* load NTRU private key blob */
166 #endif
167
168 CYASSL_API int CyaSSL_PemCertToDer(const char*, unsigned char*, int);
169
170 #endif /* NO_FILESYSTEM */
171
172 CYASSL_API CYASSL_CTX* CyaSSL_CTX_new(CYASSL_METHOD*);
173 CYASSL_API CYASSL* CyaSSL_new(CYASSL_CTX*);
174 CYASSL_API int  CyaSSL_set_fd (CYASSL*, int);
175 CYASSL_API int  CyaSSL_get_fd(const CYASSL*);
176 CYASSL_API int  CyaSSL_connect(CYASSL*);     /* please see note at top of README
177                                              if you get an error from connect */
178 CYASSL_API int  CyaSSL_write(CYASSL*, const void*, int);
179 CYASSL_API int  CyaSSL_read(CYASSL*, void*, int);
180 CYASSL_API int  CyaSSL_accept(CYASSL*);
181 CYASSL_API void CyaSSL_CTX_free(CYASSL_CTX*);
182 CYASSL_API void CyaSSL_free(CYASSL*);
183 CYASSL_API int  CyaSSL_shutdown(CYASSL*);
184
185 CYASSL_API void CyaSSL_CTX_set_quiet_shutdown(CYASSL_CTX*, int);
186 CYASSL_API void CyaSSL_set_quiet_shutdown(CYASSL*, int);
187
188 CYASSL_API int  CyaSSL_get_error(CYASSL*, int);
189
190 CYASSL_API int          CyaSSL_set_session(CYASSL* ssl,CYASSL_SESSION* session);
191 CYASSL_API CYASSL_SESSION* CyaSSL_get_session(CYASSL* ssl);
192 CYASSL_API void         CyaSSL_flush_sessions(CYASSL_CTX *ctx, long tm);
193
194
195 typedef int (*VerifyCallback)(int, CYASSL_X509_STORE_CTX*);
196 typedef int (*pem_password_cb)(char*, int, int, void*);
197
198 CYASSL_API void CyaSSL_CTX_set_verify(CYASSL_CTX*, int, 
199                                       VerifyCallback verify_callback);
200 CYASSL_API void CyaSSL_set_verify(CYASSL*, int, VerifyCallback verify_callback);
201
202 CYASSL_API int  CyaSSL_pending(CYASSL*);
203
204 CYASSL_API void CyaSSL_load_error_strings(void);
205 CYASSL_API int  CyaSSL_library_init(void);
206 CYASSL_API long CyaSSL_CTX_set_session_cache_mode(CYASSL_CTX*, long);
207
208 /* only supports full name from cipher_name[] delimited by : */
209 CYASSL_API int  CyaSSL_CTX_set_cipher_list(CYASSL_CTX*, const char*);
210 CYASSL_API int  CyaSSL_set_cipher_list(CYASSL*, const char*);
211
212 CYASSL_API int   CyaSSL_ERR_GET_REASON(int err);
213 CYASSL_API char* CyaSSL_ERR_error_string(unsigned long,char*);
214 CYASSL_API void  CyaSSL_ERR_error_string_n(unsigned long e, char* buf,
215                                            unsigned long sz);
216
217 /* extras */
218
219 #define STACK_OF(x) x
220
221 CYASSL_API int  CyaSSL_set_ex_data(CYASSL*, int, void*);
222 CYASSL_API int  CyaSSL_get_shutdown(const CYASSL*);
223 CYASSL_API int  CyaSSL_set_rfd(CYASSL*, int);
224 CYASSL_API int  CyaSSL_set_wfd(CYASSL*, int);
225 CYASSL_API void CyaSSL_set_shutdown(CYASSL*, int);
226 CYASSL_API int  CyaSSL_set_session_id_context(CYASSL*, const unsigned char*,
227                                            unsigned int);
228 CYASSL_API void CyaSSL_set_connect_state(CYASSL*);
229 CYASSL_API void CyaSSL_set_accept_state(CYASSL*);
230 CYASSL_API int  CyaSSL_session_reused(CYASSL*);
231 CYASSL_API void CyaSSL_SESSION_free(CYASSL_SESSION* session);
232 CYASSL_API int  CyaSSL_is_init_finished(CYASSL*);
233
234 CYASSL_API const char*  CyaSSL_get_version(CYASSL*);
235 CYASSL_API CYASSL_CIPHER*  CyaSSL_get_current_cipher(CYASSL*);
236 CYASSL_API char*        CyaSSL_CIPHER_description(CYASSL_CIPHER*, char*, int);
237 CYASSL_API const char*  CyaSSL_CIPHER_get_name(const CYASSL_CIPHER* cipher);
238 CYASSL_API const char*  CyaSSL_get_cipher(CYASSL*);
239 CYASSL_API CYASSL_SESSION* CyaSSL_get1_session(CYASSL* ssl);
240                            /* what's ref count */
241
242 CYASSL_API void CyaSSL_X509_free(CYASSL_X509*);
243 CYASSL_API void CyaSSL_OPENSSL_free(void*);
244
245 CYASSL_API int CyaSSL_OCSP_parse_url(char* url, char** host, char** port,
246                                      char** path, int* ssl);
247
248 CYASSL_API CYASSL_METHOD* CyaSSLv23_client_method(void);
249 CYASSL_API CYASSL_METHOD* CyaSSLv2_client_method(void);
250 CYASSL_API CYASSL_METHOD* CyaSSLv2_server_method(void);
251
252 CYASSL_API void CyaSSL_MD4_Init(CYASSL_MD4_CTX*);
253 CYASSL_API void CyaSSL_MD4_Update(CYASSL_MD4_CTX*, const void*, unsigned long);
254 CYASSL_API void CyaSSL_MD4_Final(unsigned char*, CYASSL_MD4_CTX*);
255
256
257 CYASSL_API CYASSL_BIO* CyaSSL_BIO_new(CYASSL_BIO_METHOD*);
258 CYASSL_API int  CyaSSL_BIO_free(CYASSL_BIO*);
259 CYASSL_API int  CyaSSL_BIO_free_all(CYASSL_BIO*);
260 CYASSL_API int  CyaSSL_BIO_read(CYASSL_BIO*, void*, int);
261 CYASSL_API int  CyaSSL_BIO_write(CYASSL_BIO*, const void*, int);
262 CYASSL_API CYASSL_BIO* CyaSSL_BIO_push(CYASSL_BIO*, CYASSL_BIO* append);
263 CYASSL_API CYASSL_BIO* CyaSSL_BIO_pop(CYASSL_BIO*);
264 CYASSL_API int  CyaSSL_BIO_flush(CYASSL_BIO*);
265 CYASSL_API int  CyaSSL_BIO_pending(CYASSL_BIO*);
266
267 CYASSL_API CYASSL_BIO_METHOD* CyaSSL_BIO_f_buffer(void);
268 CYASSL_API long CyaSSL_BIO_set_write_buffer_size(CYASSL_BIO*, long size);
269 CYASSL_API CYASSL_BIO_METHOD* CyaSSL_BIO_f_ssl(void);
270 CYASSL_API CYASSL_BIO*        CyaSSL_BIO_new_socket(int sfd, int flag);
271 CYASSL_API int         CyaSSL_BIO_eof(CYASSL_BIO*);
272
273 CYASSL_API CYASSL_BIO_METHOD* CyaSSL_BIO_s_mem(void);
274 CYASSL_API CYASSL_BIO_METHOD* CyaSSL_BIO_f_base64(void);
275 CYASSL_API void CyaSSL_BIO_set_flags(CYASSL_BIO*, int);
276
277 CYASSL_API int CyaSSL_BIO_get_mem_data(CYASSL_BIO* bio,const unsigned char** p);
278 CYASSL_API CYASSL_BIO* CyaSSL_BIO_new_mem_buf(void* buf, int len);
279
280
281 CYASSL_API long        CyaSSL_BIO_set_ssl(CYASSL_BIO*, CYASSL*, int flag);
282 CYASSL_API void        CyaSSL_set_bio(CYASSL*, CYASSL_BIO* rd, CYASSL_BIO* wr);
283
284 CYASSL_API int  CyaSSL_add_all_algorithms(void);
285
286 CYASSL_API void        CyaSSL_RAND_screen(void);
287 CYASSL_API const char* CyaSSL_RAND_file_name(char*, unsigned long);
288 CYASSL_API int         CyaSSL_RAND_write_file(const char*);
289 CYASSL_API int         CyaSSL_RAND_load_file(const char*, long);
290 CYASSL_API int         CyaSSL_RAND_egd(const char*);
291 CYASSL_API int         CyaSSL_RAND_seed(const void*, int);
292 CYASSL_API void        CyaSSL_RAND_add(const void*, int, double);
293
294 CYASSL_API CYASSL_COMP_METHOD* CyaSSL_COMP_zlib(void);
295 CYASSL_API CYASSL_COMP_METHOD* CyaSSL_COMP_rle(void);
296 CYASSL_API int CyaSSL_COMP_add_compression_method(int, void*);
297
298 CYASSL_API int CyaSSL_get_ex_new_index(long, void*, void*, void*, void*);
299
300 CYASSL_API void CyaSSL_set_id_callback(unsigned long (*f)(void));
301 CYASSL_API void CyaSSL_set_locking_callback(void (*f)(int, int, const char*,
302                                                       int));
303 CYASSL_API void CyaSSL_set_dynlock_create_callback(CYASSL_dynlock_value* (*f)
304                                                    (const char*, int));
305 CYASSL_API void CyaSSL_set_dynlock_lock_callback(void (*f)(int,
306                                       CYASSL_dynlock_value*, const char*, int));
307 CYASSL_API void CyaSSL_set_dynlock_destroy_callback(void (*f)
308                                      (CYASSL_dynlock_value*, const char*, int));
309 CYASSL_API int  CyaSSL_num_locks(void);
310
311 CYASSL_API CYASSL_X509* CyaSSL_X509_STORE_CTX_get_current_cert(
312                                                         CYASSL_X509_STORE_CTX*);
313 CYASSL_API int   CyaSSL_X509_STORE_CTX_get_error(CYASSL_X509_STORE_CTX*);
314 CYASSL_API int   CyaSSL_X509_STORE_CTX_get_error_depth(CYASSL_X509_STORE_CTX*);
315
316 CYASSL_API char*       CyaSSL_X509_NAME_oneline(CYASSL_X509_NAME*, char*, int);
317 CYASSL_API CYASSL_X509_NAME*  CyaSSL_X509_get_issuer_name(CYASSL_X509*);
318 CYASSL_API CYASSL_X509_NAME*  CyaSSL_X509_get_subject_name(CYASSL_X509*);
319 CYASSL_API const char* CyaSSL_X509_verify_cert_error_string(long);
320
321 CYASSL_API int CyaSSL_X509_LOOKUP_add_dir(CYASSL_X509_LOOKUP*,const char*,long);
322 CYASSL_API int CyaSSL_X509_LOOKUP_load_file(CYASSL_X509_LOOKUP*, const char*,
323                                             long);
324 CYASSL_API CYASSL_X509_LOOKUP_METHOD* CyaSSL_X509_LOOKUP_hash_dir(void);
325 CYASSL_API CYASSL_X509_LOOKUP_METHOD* CyaSSL_X509_LOOKUP_file(void);
326
327 CYASSL_API CYASSL_X509_LOOKUP* CyaSSL_X509_STORE_add_lookup(CYASSL_X509_STORE*,
328                                                     CYASSL_X509_LOOKUP_METHOD*);
329 CYASSL_API CYASSL_X509_STORE*  CyaSSL_X509_STORE_new(void);
330 CYASSL_API int          CyaSSL_X509_STORE_get_by_subject(CYASSL_X509_STORE_CTX*,
331                                    int, CYASSL_X509_NAME*, CYASSL_X509_OBJECT*);
332 CYASSL_API int  CyaSSL_X509_STORE_CTX_init(CYASSL_X509_STORE_CTX*,
333                       CYASSL_X509_STORE*, CYASSL_X509*, STACK_OF(CYASSL_X509)*);
334 CYASSL_API void CyaSSL_X509_STORE_CTX_cleanup(CYASSL_X509_STORE_CTX*);
335
336 CYASSL_API CYASSL_ASN1_TIME* CyaSSL_X509_CRL_get_lastUpdate(CYASSL_X509_CRL*);
337 CYASSL_API CYASSL_ASN1_TIME* CyaSSL_X509_CRL_get_nextUpdate(CYASSL_X509_CRL*);
338
339 CYASSL_API CYASSL_EVP_PKEY* CyaSSL_X509_get_pubkey(CYASSL_X509*);
340 CYASSL_API int       CyaSSL_X509_CRL_verify(CYASSL_X509_CRL*, CYASSL_EVP_PKEY*);
341 CYASSL_API void      CyaSSL_X509_STORE_CTX_set_error(CYASSL_X509_STORE_CTX*,
342                                                      int);
343 CYASSL_API void      CyaSSL_X509_OBJECT_free_contents(CYASSL_X509_OBJECT*);
344 CYASSL_API void      CyaSSL_EVP_PKEY_free(CYASSL_EVP_PKEY*);
345 CYASSL_API int       CyaSSL_X509_cmp_current_time(const CYASSL_ASN1_TIME*);
346 CYASSL_API int       CyaSSL_sk_X509_REVOKED_num(CYASSL_X509_REVOKED*);
347
348 CYASSL_API CYASSL_X509_REVOKED* CyaSSL_X509_CRL_get_REVOKED(CYASSL_X509_CRL*);
349 CYASSL_API CYASSL_X509_REVOKED* CyaSSL_sk_X509_REVOKED_value(
350                                                       CYASSL_X509_REVOKED*,int);
351 CYASSL_API CYASSL_ASN1_INTEGER* CyaSSL_X509_get_serialNumber(CYASSL_X509*);
352
353 CYASSL_API int CyaSSL_ASN1_TIME_print(CYASSL_BIO*, const CYASSL_ASN1_TIME*);
354
355 CYASSL_API int  CyaSSL_ASN1_INTEGER_cmp(const CYASSL_ASN1_INTEGER*,
356                                        const CYASSL_ASN1_INTEGER*);
357 CYASSL_API long CyaSSL_ASN1_INTEGER_get(const CYASSL_ASN1_INTEGER*);
358
359 CYASSL_API STACK_OF(CYASSL_X509_NAME)* CyaSSL_load_client_CA_file(const char*);
360
361 CYASSL_API void  CyaSSL_CTX_set_client_CA_list(CYASSL_CTX*,
362                                                STACK_OF(CYASSL_X509_NAME)*);
363 CYASSL_API void* CyaSSL_X509_STORE_CTX_get_ex_data(CYASSL_X509_STORE_CTX*, int);
364 CYASSL_API int   CyaSSL_get_ex_data_X509_STORE_CTX_idx(void);
365 CYASSL_API void* CyaSSL_get_ex_data(const CYASSL*, int);
366
367 CYASSL_API void CyaSSL_CTX_set_default_passwd_cb_userdata(CYASSL_CTX*,
368                                                           void* userdata);
369 CYASSL_API void CyaSSL_CTX_set_default_passwd_cb(CYASSL_CTX*, pem_password_cb);
370
371
372 CYASSL_API void CyaSSL_CTX_set_info_callback(CYASSL_CTX*, void (*)(void));
373
374 CYASSL_API unsigned long CyaSSL_ERR_peek_error(void);
375 CYASSL_API int           CyaSSL_GET_REASON(int);
376
377 CYASSL_API char* CyaSSL_alert_type_string_long(int);
378 CYASSL_API char* CyaSSL_alert_desc_string_long(int);
379 CYASSL_API char* CyaSSL_state_string_long(CYASSL*);
380
381 CYASSL_API CYASSL_RSA* CyaSSL_RSA_generate_key(int, unsigned long,
382                                                void(*)(int, int, void*), void*);
383 CYASSL_API void CyaSSL_CTX_set_tmp_rsa_callback(CYASSL_CTX*,
384                                              CYASSL_RSA*(*)(CYASSL*, int, int));
385
386 CYASSL_API int CyaSSL_PEM_def_callback(char*, int num, int w, void* key);
387
388 CYASSL_API long CyaSSL_CTX_sess_accept(CYASSL_CTX*);
389 CYASSL_API long CyaSSL_CTX_sess_connect(CYASSL_CTX*);
390 CYASSL_API long CyaSSL_CTX_sess_accept_good(CYASSL_CTX*);
391 CYASSL_API long CyaSSL_CTX_sess_connect_good(CYASSL_CTX*);
392 CYASSL_API long CyaSSL_CTX_sess_accept_renegotiate(CYASSL_CTX*);
393 CYASSL_API long CyaSSL_CTX_sess_connect_renegotiate(CYASSL_CTX*);
394 CYASSL_API long CyaSSL_CTX_sess_hits(CYASSL_CTX*);
395 CYASSL_API long CyaSSL_CTX_sess_cb_hits(CYASSL_CTX*);
396 CYASSL_API long CyaSSL_CTX_sess_cache_full(CYASSL_CTX*);
397 CYASSL_API long CyaSSL_CTX_sess_misses(CYASSL_CTX*);
398 CYASSL_API long CyaSSL_CTX_sess_timeouts(CYASSL_CTX*);
399 CYASSL_API long CyaSSL_CTX_sess_number(CYASSL_CTX*);
400 CYASSL_API long CyaSSL_CTX_sess_get_cache_size(CYASSL_CTX*);
401
402
403 #define CYASSL_DEFAULT_CIPHER_LIST ""   /* default all */
404 #define CYASSL_RSA_F4 0x10001L
405
406 enum {
407     OCSP_NOCERTS     = 1,
408     OCSP_NOINTERN    = 2,
409     OCSP_NOSIGS      = 4,
410     OCSP_NOCHAIN     = 8,
411     OCSP_NOVERIFY    = 16,
412     OCSP_NOEXPLICIT  = 32,
413     OCSP_NOCASIGN    = 64,
414     OCSP_NODELEGATED = 128,
415     OCSP_NOCHECKS    = 256,
416     OCSP_TRUSTOTHER  = 512,
417     OCSP_RESPID_KEY  = 1024,
418     OCSP_NOTIME      = 2048,
419
420     OCSP_CERTID   = 2,
421     OCSP_REQUEST  = 4,
422     OCSP_RESPONSE = 8,
423     OCSP_BASICRESP = 16,
424
425     CYASSL_CRL_CHECKALL = 1,
426
427     ASN1_GENERALIZEDTIME = 4,
428
429     SSL_OP_MICROSOFT_SESS_ID_BUG = 1,
430     SSL_OP_NETSCAPE_CHALLENGE_BUG = 2,
431     SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG = 3,
432     SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG = 4,
433     SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER = 5,
434     SSL_OP_MSIE_SSLV2_RSA_PADDING = 6,
435     SSL_OP_SSLEAY_080_CLIENT_DH_BUG = 7,
436     SSL_OP_TLS_D5_BUG = 8,
437     SSL_OP_TLS_BLOCK_PADDING_BUG = 9,
438     SSL_OP_TLS_ROLLBACK_BUG = 10,
439     SSL_OP_ALL = 11,
440     SSL_OP_EPHEMERAL_RSA = 12,
441     SSL_OP_NO_SSLv3 = 13,
442     SSL_OP_NO_TLSv1 = 14,
443     SSL_OP_PKCS1_CHECK_1 = 15,
444     SSL_OP_PKCS1_CHECK_2 = 16,
445     SSL_OP_NETSCAPE_CA_DN_BUG = 17,
446     SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG = 18,
447     SSL_OP_SINGLE_DH_USE = 19,
448     SSL_OP_NO_TICKET = 20,
449     SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS = 21,
450     SSL_OP_NO_QUERY_MTU = 22,
451     SSL_OP_COOKIE_EXCHANGE = 23,
452     SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION = 24,
453     SSL_OP_SINGLE_ECDH_USE = 25,
454     SSL_OP_CIPHER_SERVER_PREFERENCE = 26,
455
456     SSL_MAX_SSL_SESSION_ID_LENGTH = 32,
457
458     EVP_R_BAD_DECRYPT = 2,
459
460     SSL_CB_LOOP = 4,
461     SSL_ST_CONNECT = 5,
462     SSL_ST_ACCEPT  = 6,
463     SSL_CB_ALERT   = 7,
464     SSL_CB_READ    = 8,
465     SSL_CB_HANDSHAKE_DONE = 9,
466
467     SSL_MODE_ENABLE_PARTIAL_WRITE = 2,
468
469     BIO_FLAGS_BASE64_NO_NL = 1,
470     BIO_CLOSE   = 1,
471     BIO_NOCLOSE = 0,
472
473     NID_undef = 0,
474
475     X509_FILETYPE_PEM = 8,
476     X509_LU_X509      = 9,
477     X509_LU_CRL       = 12,
478     
479     X509_V_ERR_CRL_SIGNATURE_FAILURE = 13,
480     X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD = 14,
481     X509_V_ERR_CRL_HAS_EXPIRED                = 15,
482     X509_V_ERR_CERT_REVOKED                   = 16,
483     X509_V_ERR_CERT_CHAIN_TOO_LONG            = 17,
484     X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT      = 18,
485     X509_V_ERR_CERT_NOT_YET_VALID             = 19,
486     X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD = 20,
487     X509_V_ERR_CERT_HAS_EXPIRED               = 21,
488     X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD  = 22,
489
490     X509_V_OK = 0,
491
492     CRYPTO_LOCK = 1,
493     CRYPTO_NUM_LOCKS = 10
494 };
495
496 /* extras end */
497
498 #ifndef NO_FILESYSTEM
499 /* CyaSSL extension, provide last error from SSL_get_error
500    since not using thread storage error queue */
501 CYASSL_API void  CyaSSL_ERR_print_errors_fp(FILE*, int err);
502 #endif
503
504 enum { /* ssl Constants */
505     SSL_ERROR_NONE      =  0,   /* for most functions */
506     SSL_FAILURE         =  0,   /* for some functions */
507     SSL_SUCCESS         =  1,
508
509     SSL_BAD_CERTTYPE    = -8,
510     SSL_BAD_STAT        = -7,
511     SSL_BAD_PATH        = -6,
512     SSL_BAD_FILETYPE    = -5,
513     SSL_BAD_FILE        = -4,
514     SSL_NOT_IMPLEMENTED = -3,
515     SSL_UNKNOWN         = -2,
516     SSL_FATAL_ERROR     = -1,
517
518     SSL_FILETYPE_ASN1    = 2,
519     SSL_FILETYPE_PEM     = 1,
520     SSL_FILETYPE_DEFAULT = 2, /* ASN1 */
521     SSL_FILETYPE_RAW     = 3, /* NTRU raw key blob */
522
523     SSL_VERIFY_NONE                 = 0,
524     SSL_VERIFY_PEER                 = 1,
525     SSL_VERIFY_FAIL_IF_NO_PEER_CERT = 2,
526     SSL_VERIFY_CLIENT_ONCE          = 4,
527
528     SSL_SESS_CACHE_OFF                = 30,
529     SSL_SESS_CACHE_CLIENT             = 31,
530     SSL_SESS_CACHE_SERVER             = 32,
531     SSL_SESS_CACHE_BOTH               = 33,
532     SSL_SESS_CACHE_NO_AUTO_CLEAR      = 34,
533     SSL_SESS_CACHE_NO_INTERNAL_LOOKUP = 35,
534
535     SSL_ERROR_WANT_READ        =  2,
536     SSL_ERROR_WANT_WRITE       =  3,
537     SSL_ERROR_WANT_CONNECT     =  7,
538     SSL_ERROR_WANT_ACCEPT      =  8,
539     SSL_ERROR_SYSCALL          =  5,
540     SSL_ERROR_WANT_X509_LOOKUP = 83,
541     SSL_ERROR_ZERO_RETURN      =  6,
542     SSL_ERROR_SSL              = 85,
543
544     SSL_SENT_SHUTDOWN     = 1,
545     SSL_RECEIVED_SHUTDOWN = 2,
546     SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER = 4,
547     SSL_OP_NO_SSLv2       = 8,
548
549     SSL_R_SSL_HANDSHAKE_FAILURE           = 101,
550     SSL_R_TLSV1_ALERT_UNKNOWN_CA          = 102,
551     SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN = 103,
552     SSL_R_SSLV3_ALERT_BAD_CERTIFICATE     = 104,
553
554     PEM_BUFSIZE = 1024
555 };
556
557
558 #ifndef NO_PSK
559     typedef unsigned int (*psk_client_callback)(CYASSL*, const char*, char*,
560                                     unsigned int, unsigned char*, unsigned int);
561     CYASSL_API void CyaSSL_CTX_set_psk_client_callback(CYASSL_CTX*,
562                                                     psk_client_callback);
563     CYASSL_API void CyaSSL_set_psk_client_callback(CYASSL*,psk_client_callback);
564
565     CYASSL_API const char* CyaSSL_get_psk_identity_hint(const CYASSL*);
566     CYASSL_API const char* CyaSSL_get_psk_identity(const CYASSL*);
567
568     CYASSL_API int CyaSSL_CTX_use_psk_identity_hint(CYASSL_CTX*, const char*);
569     CYASSL_API int CyaSSL_use_psk_identity_hint(CYASSL*, const char*);
570
571     typedef unsigned int (*psk_server_callback)(CYASSL*, const char*,
572                           unsigned char*, unsigned int);
573     CYASSL_API void CyaSSL_CTX_set_psk_server_callback(CYASSL_CTX*,
574                                                     psk_server_callback);
575     CYASSL_API void CyaSSL_set_psk_server_callback(CYASSL*,psk_server_callback);
576
577     #define PSK_TYPES_DEFINED
578 #endif /* NO_PSK */
579
580
581 /* extra begins */
582
583 enum {  /* ERR Constants */
584     ERR_TXT_STRING = 1
585 };
586
587 CYASSL_API unsigned long CyaSSL_ERR_get_error_line_data(const char**, int*,
588                                                  const char**, int *);
589
590 CYASSL_API unsigned long CyaSSL_ERR_get_error(void);
591 CYASSL_API void          CyaSSL_ERR_clear_error(void);
592
593
594 CYASSL_API int  CyaSSL_RAND_status(void);
595 CYASSL_API int  CyaSSL_RAND_bytes(unsigned char* buf, int num);
596 CYASSL_API CYASSL_METHOD *CyaSSLv23_server_method(void);
597 CYASSL_API long CyaSSL_CTX_set_options(CYASSL_CTX*, long);
598 CYASSL_API int  CyaSSL_CTX_check_private_key(CYASSL_CTX*);
599
600
601 CYASSL_API void CyaSSL_ERR_free_strings(void);
602 CYASSL_API void CyaSSL_ERR_remove_state(unsigned long);
603 CYASSL_API void CyaSSL_EVP_cleanup(void);
604
605 CYASSL_API void CyaSSL_cleanup_all_ex_data(void);
606 CYASSL_API long CyaSSL_CTX_set_mode(CYASSL_CTX* ctx, long mode);
607 CYASSL_API long CyaSSL_CTX_get_mode(CYASSL_CTX* ctx);
608 CYASSL_API void CyaSSL_CTX_set_default_read_ahead(CYASSL_CTX* ctx, int m);
609
610 CYASSL_API long CyaSSL_CTX_sess_set_cache_size(CYASSL_CTX*, long);
611
612 CYASSL_API int  CyaSSL_CTX_set_default_verify_paths(CYASSL_CTX*);
613 CYASSL_API int  CyaSSL_CTX_set_session_id_context(CYASSL_CTX*,
614                                             const unsigned char*, unsigned int);
615 CYASSL_API CYASSL_X509* CyaSSL_get_peer_certificate(CYASSL* ssl);
616
617 CYASSL_API int CyaSSL_want_read(CYASSL*);
618 CYASSL_API int CyaSSL_want_write(CYASSL*);
619
620 CYASSL_API int CyaSSL_BIO_printf(CYASSL_BIO*, const char*, ...);
621 CYASSL_API int CyaSSL_ASN1_UTCTIME_print(CYASSL_BIO*,
622                                          const CYASSL_ASN1_UTCTIME*);
623 CYASSL_API int   CyaSSL_sk_num(CYASSL_X509_REVOKED*);
624 CYASSL_API void* CyaSSL_sk_value(CYASSL_X509_REVOKED*, int);
625
626 /* stunnel 4.28 needs */
627 CYASSL_API void* CyaSSL_CTX_get_ex_data(const CYASSL_CTX*, int);
628 CYASSL_API int   CyaSSL_CTX_set_ex_data(CYASSL_CTX*, int, void*);
629 CYASSL_API void  CyaSSL_CTX_sess_set_get_cb(CYASSL_CTX*,
630                        CYASSL_SESSION*(*f)(CYASSL*, unsigned char*, int, int*));
631 CYASSL_API void  CyaSSL_CTX_sess_set_new_cb(CYASSL_CTX*,
632                                             int (*f)(CYASSL*, CYASSL_SESSION*));
633 CYASSL_API void  CyaSSL_CTX_sess_set_remove_cb(CYASSL_CTX*,
634                                        void (*f)(CYASSL_CTX*, CYASSL_SESSION*));
635
636 CYASSL_API int          CyaSSL_i2d_SSL_SESSION(CYASSL_SESSION*,unsigned char**);
637 CYASSL_API CYASSL_SESSION* CyaSSL_d2i_SSL_SESSION(CYASSL_SESSION**,const unsigned char**,
638                                         long);
639
640 CYASSL_API long CyaSSL_SESSION_get_timeout(const CYASSL_SESSION*);
641 CYASSL_API long CyaSSL_SESSION_get_time(const CYASSL_SESSION*);
642 CYASSL_API int  CyaSSL_CTX_get_ex_new_index(long, void*, void*, void*, void*);
643
644 /* extra ends */
645
646
647 /* CyaSSL extensions */
648
649 /* call before SSL_connect, if verifying will add name check to
650    date check and signature check */
651 CYASSL_API int CyaSSL_check_domain_name(CYASSL* ssl, const char* dn);
652
653 /* need to call once to load library (session cache) */
654 CYASSL_API int CyaSSL_Init(void);
655 /* call when done to cleanup/free session cache mutex / resources  */
656 CYASSL_API int CyaSSL_Cleanup(void);
657
658 /* turn logging on, only if compiled in */
659 CYASSL_API int  CyaSSL_Debugging_ON(void);
660 /* turn logging off */
661 CYASSL_API void CyaSSL_Debugging_OFF(void);
662
663 /* do accept or connect depedning on side */
664 CYASSL_API int CyaSSL_negotiate(CYASSL* ssl);
665 /* turn on CyaSSL data compression */
666 CYASSL_API int CyaSSL_set_compression(CYASSL* ssl);
667
668 CYASSL_API int CyaSSL_set_timeout(CYASSL*, unsigned int);
669 CYASSL_API int CyaSSL_CTX_set_timeout(CYASSL_CTX*, unsigned int);
670
671 /* get CyaSSL peer X509_CHAIN */
672 CYASSL_API CYASSL_X509_CHAIN* CyaSSL_get_peer_chain(CYASSL* ssl);
673 /* peer chain count */
674 CYASSL_API int  CyaSSL_get_chain_count(CYASSL_X509_CHAIN* chain);
675 /* index cert length */
676 CYASSL_API int  CyaSSL_get_chain_length(CYASSL_X509_CHAIN*, int idx);
677 /* index cert */
678 CYASSL_API unsigned char* CyaSSL_get_chain_cert(CYASSL_X509_CHAIN*, int idx);
679 /* get index cert in PEM */
680 CYASSL_API int  CyaSSL_get_chain_cert_pem(CYASSL_X509_CHAIN*, int idx,
681                                 unsigned char* buffer, int inLen, int* outLen);
682 CYASSL_API const unsigned char* CyaSSL_get_sessionID(const CYASSL_SESSION* s);
683 CYASSL_API int  CyaSSL_X509_get_serial_number(CYASSL_X509*,unsigned char*,int*);
684 CYASSL_API char*  CyaSSL_X509_get_subjectCN(CYASSL_X509*);
685 CYASSL_API const unsigned char* CyaSSL_X509_get_der(CYASSL_X509*, int*);
686
687 CYASSL_API int CyaSSL_cmp_peer_cert_to_file(CYASSL*, const char*);
688
689 /* connect enough to get peer cert */
690 CYASSL_API int  CyaSSL_connect_cert(CYASSL* ssl);
691
692 /* server Diffie-Hellman parameters */
693 CYASSL_API int  CyaSSL_SetTmpDH(CYASSL*, const unsigned char* p, int pSz,
694                                 const unsigned char* g, int gSz);
695 CYASSL_API int  CyaSSL_SetTmpDH_buffer(CYASSL*, const unsigned char* b, long sz,
696                                        int format);
697 CYASSL_API int  CyaSSL_SetTmpEC_DHE_Sz(CYASSL*, unsigned short);
698 #ifndef NO_FILESYSTEM
699     CYASSL_API int  CyaSSL_SetTmpDH_file(CYASSL*, const char* f, int format);
700 #endif
701
702 /* server ctx Diffie-Hellman parameters */
703 CYASSL_API int  CyaSSL_CTX_SetTmpDH(CYASSL_CTX*, const unsigned char* p,
704                                     int pSz, const unsigned char* g, int gSz);
705 CYASSL_API int  CyaSSL_CTX_SetTmpDH_buffer(CYASSL_CTX*, const unsigned char* b,
706                                            long sz, int format);
707 CYASSL_API int  CyaSSL_CTX_SetTmpEC_DHE_Sz(CYASSL_CTX*, unsigned short);
708 #ifndef NO_FILESYSTEM
709     CYASSL_API int  CyaSSL_CTX_SetTmpDH_file(CYASSL_CTX*, const char* f,
710                                              int format);
711 #endif
712
713 /* keyblock size in bytes or -1 */
714 CYASSL_API int CyaSSL_get_keyblock_size(CYASSL*);
715 CYASSL_API int CyaSSL_get_keys(CYASSL*,unsigned char** ms, unsigned int* msLen,
716                                        unsigned char** sr, unsigned int* srLen,
717                                        unsigned char** cr, unsigned int* crLen);
718
719 #ifndef _WIN32
720     #ifndef NO_WRITEV
721         #ifdef __PPU
722             #include <sys/types.h>
723             #include <sys/socket.h>
724         #else
725             #include <sys/uio.h>
726         #endif
727         /* allow writev style writing */
728         CYASSL_API int CyaSSL_writev(CYASSL* ssl, const struct iovec* iov,
729                                      int iovcnt);
730     #endif
731 #endif
732
733
734 /* SSL_CTX versions */
735 CYASSL_API int CyaSSL_CTX_load_verify_buffer(CYASSL_CTX*, const unsigned char*,
736                                              long, int);
737 CYASSL_API int CyaSSL_CTX_use_certificate_buffer(CYASSL_CTX*,
738                                                const unsigned char*, long, int);
739 CYASSL_API int CyaSSL_CTX_use_PrivateKey_buffer(CYASSL_CTX*,
740                                                const unsigned char*, long, int);
741 CYASSL_API int CyaSSL_CTX_use_certificate_chain_buffer(CYASSL_CTX*, 
742                                                     const unsigned char*, long);
743 CYASSL_API int CyaSSL_CTX_set_group_messages(CYASSL_CTX*);
744
745 /* SSL versions */
746 CYASSL_API int CyaSSL_use_certificate_buffer(CYASSL*, const unsigned char*,
747                                              long, int);
748 CYASSL_API int CyaSSL_use_PrivateKey_buffer(CYASSL*, const unsigned char*, long,
749                                             int);
750 CYASSL_API int CyaSSL_use_certificate_chain_buffer(CYASSL*, 
751                                                     const unsigned char*, long);
752 CYASSL_API int CyaSSL_set_group_messages(CYASSL*);
753
754 /* I/O callbacks */
755 typedef int (*CallbackIORecv)(char *buf, int sz, void *ctx);
756 typedef int (*CallbackIOSend)(char *buf, int sz, void *ctx);
757
758 CYASSL_API void CyaSSL_SetIORecv(CYASSL_CTX*, CallbackIORecv);
759 CYASSL_API void CyaSSL_SetIOSend(CYASSL_CTX*, CallbackIOSend);
760
761 CYASSL_API void CyaSSL_SetIOReadCtx(CYASSL* ssl, void *ctx);
762 CYASSL_API void CyaSSL_SetIOWriteCtx(CYASSL* ssl, void *ctx);
763
764 /* CA cache callbacks */
765 enum {
766     CYASSL_USER_CA  = 1,          /* user added as trusted */
767     CYASSL_CHAIN_CA = 2           /* added to cache from trusted chain */
768 };
769
770 CYASSL_API int CyaSSL_KeyPemToDer(const unsigned char*, int sz, unsigned char*,
771                                   int, const char*);
772
773 typedef void (*CallbackCACache)(unsigned char* der, int sz, int type);
774 typedef void (*CbMissingCRL)(const char* url);
775
776 CYASSL_API void CyaSSL_CTX_SetCACb(CYASSL_CTX*, CallbackCACache);
777
778
779 CYASSL_API CYASSL_CERT_MANAGER* CyaSSL_CertManagerNew(void);
780 CYASSL_API void                 CyaSSL_CertManagerFree(CYASSL_CERT_MANAGER*);
781
782 CYASSL_API int CyaSSL_CertManagerLoadCA(CYASSL_CERT_MANAGER*, const char* f,
783                                         const char* d);
784 CYASSL_API int CyaSSL_CertManagerVerify(CYASSL_CERT_MANAGER*, const char* f,
785                                         int format);
786 CYASSL_API int CyaSSL_CertManagerCheckCRL(CYASSL_CERT_MANAGER*, unsigned char*,
787                                           int sz);
788 CYASSL_API int CyaSSL_CertManagerEnableCRL(CYASSL_CERT_MANAGER*, int options);
789 CYASSL_API int CyaSSL_CertManagerDisableCRL(CYASSL_CERT_MANAGER*);
790 CYASSL_API int CyaSSL_CertManagerLoadCRL(CYASSL_CERT_MANAGER*, const char*, int,
791                                          int);
792 CYASSL_API int CyaSSL_CertManagerSetCRL_Cb(CYASSL_CERT_MANAGER*, CbMissingCRL);
793
794 CYASSL_API int CyaSSL_EnableCRL(CYASSL* ssl, int options);
795 CYASSL_API int CyaSSL_DisableCRL(CYASSL* ssl);
796 CYASSL_API int CyaSSL_LoadCRL(CYASSL*, const char*, int, int);
797 CYASSL_API int CyaSSL_SetCRL_Cb(CYASSL*, CbMissingCRL);
798
799 CYASSL_API int CyaSSL_CTX_EnableCRL(CYASSL_CTX* ctx, int options);
800 CYASSL_API int CyaSSL_CTX_DisableCRL(CYASSL_CTX* ctx);
801 CYASSL_API int CyaSSL_CTX_LoadCRL(CYASSL_CTX*, const char*, int, int);
802 CYASSL_API int CyaSSL_CTX_SetCRL_Cb(CYASSL_CTX*, CbMissingCRL);
803
804
805
806 #ifdef CYASSL_CALLBACKS
807
808 /* used internally by CyaSSL while OpenSSL types aren't */
809 #include <cyassl/callbacks.h>
810
811 typedef int (*HandShakeCallBack)(HandShakeInfo*);
812 typedef int (*TimeoutCallBack)(TimeoutInfo*);
813
814 /* CyaSSL connect extension allowing HandShakeCallBack and/or TimeoutCallBack
815    for diagnostics */
816 CYASSL_API int CyaSSL_connect_ex(CYASSL*, HandShakeCallBack, TimeoutCallBack,
817                                  Timeval);
818 CYASSL_API int CyaSSL_accept_ex(CYASSL*, HandShakeCallBack, TimeoutCallBack,
819                                 Timeval);
820
821 #endif /* CYASSL_CALLBACKS */
822
823
824 CYASSL_API long CyaSSL_CTX_OCSP_set_options(CYASSL_CTX*, long);
825 CYASSL_API int  CyaSSL_CTX_OCSP_set_override_url(CYASSL_CTX*, const char*);
826
827 /* OCSP Options */
828 #define CYASSL_OCSP_ENABLE       0x0001 /* Enable OCSP lookups */
829 #define CYASSL_OCSP_URL_OVERRIDE 0x0002 /* Use the override URL instead of URL
830                                          * in certificate */
831
832
833 #ifdef __cplusplus
834     }  /* extern "C" */
835 #endif
836
837
838 #endif /* CYASSL_SSL_H */
839