]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/ssl/ssl.pod
Add some documentation for SSL_get_shared_ciphers()
[thirdparty/openssl.git] / doc / ssl / ssl.pod
CommitLineData
3604a4d3
UM
1
2=pod
3
4=head1 NAME
5
6SSL - OpenSSL SSL/TLS library
7
8=head1 SYNOPSIS
9
11b62699 10=head1 DESCRIPTION
3604a4d3
UM
11
12The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
13Transport Layer Security (TLS v1) protocols. It provides a rich API which is
14documented here.
15
9bd3bd22
UM
16At first the library must be initialized; see
17L<SSL_library_init(3)|SSL_library_init(3)>.
3604a4d3 18
9bd3bd22
UM
19Then an B<SSL_CTX> object is created as a framework to establish
20TLS/SSL enabled connections (see L<SSL_CTX_new(3)|SSL_CTX_new(3)>).
21Various options regarding certificates, algorithms etc. can be set
22in this object.
3604a4d3 23
9bd3bd22
UM
24When a network connection has been created, it can be assigned to an
25B<SSL> object. After the B<SSL> object has been created using
26L<SSL_new(3)|SSL_new(3)>, L<SSL_set_fd(3)|SSL_set_fd(3)> or
27L<SSL_set_bio(3)|SSL_set_bio(3)> can be used to associate the network
28connection with the object.
3604a4d3 29
9bd3bd22
UM
30Then the TLS/SSL handshake is performed using
31L<SSL_accept(3)|SSL_accept(3)> or L<SSL_connect(3)|SSL_connect(3)>
32respectively.
33L<SSL_read(3)|SSL_read(3)> and L<SSL_write(3)|SSL_write(3)> are used
34to read and write data on the TLS/SSL connection.
35L<SSL_shutdown(3)|SSL_shutdown(3)> can be used to shut down the
36TLS/SSL connection.
3604a4d3
UM
37
38=head1 DATA STRUCTURES
39
40Currently the OpenSSL B<ssl> library functions deals with the following data
41structures:
42
43=over 4
44
45=item B<SSL_METHOD> (SSL Method)
46
47That's a dispatch structure describing the internal B<ssl> library
48methods/functions which implement the various protocol versions (SSLv1, SSLv2
49and TLSv1). It's needed to create an B<SSL_CTX>.
50
51=item B<SSL_CIPHER> (SSL Cipher)
52
53This structure holds the algorithm information for a particular cipher which
54are a core part of the SSL/TLS protocol. The available ciphers are configured
55on a B<SSL_CTX> basis and the actually used ones are then part of the
56B<SSL_SESSION>.
57
58=item B<SSL_CTX> (SSL Context)
59
60That's the global context structure which is created by a server or client
61once per program life-time and which holds mainly default values for the
62B<SSL> structures which are later created for the connections.
63
64=item B<SSL_SESSION> (SSL Session)
65
37b08e83 66This is a structure containing the current TLS/SSL session details for a
3604a4d3
UM
67connection: B<SSL_CIPHER>s, client and server certificates, keys, etc.
68
69=item B<SSL> (SSL Connection)
70
71That's the main SSL/TLS structure which is created by a server or client per
72established connection. This actually is the core structure in the SSL API.
73Under run-time the application usually deals with this structure which has
74links to mostly all other structures.
75
76=back
77
9bd3bd22
UM
78
79=head1 HEADER FILES
80
81Currently the OpenSSL B<ssl> library provides the following C header files
82containing the prototypes for the data structures and and functions:
83
84=over 4
85
86=item B<ssl.h>
87
88That's the common header file for the SSL/TLS API. Include it into your
89program to make the API of the B<ssl> library available. It internally
90includes both more private SSL headers and headers from the B<crypto> library.
91Whenever you need hard-core details on the internals of the SSL API, look
92inside this header file.
93
94=item B<ssl2.h>
95
96That's the sub header file dealing with the SSLv2 protocol only.
97I<Usually you don't have to include it explicitly because
98it's already included by ssl.h>.
99
100=item B<ssl3.h>
101
102That's the sub header file dealing with the SSLv3 protocol only.
103I<Usually you don't have to include it explicitly because
104it's already included by ssl.h>.
105
106=item B<ssl23.h>
107
108That's the sub header file dealing with the combined use of the SSLv2 and
109SSLv3 protocols.
110I<Usually you don't have to include it explicitly because
111it's already included by ssl.h>.
112
113=item B<tls1.h>
114
115That's the sub header file dealing with the TLSv1 protocol only.
116I<Usually you don't have to include it explicitly because
117it's already included by ssl.h>.
118
119=back
120
3604a4d3
UM
121=head1 API FUNCTIONS
122
123Currently the OpenSSL B<ssl> library exports 214 API functions.
124They are documented in the following:
125
126=head2 DEALING WITH PROTOCOL METHODS
127
128Here we document the various API functions which deal with the SSL/TLS
129protocol methods defined in B<SSL_METHOD> structures.
130
131=over 4
132
021fb42d 133=item const SSL_METHOD *B<SSLv23_method>(void);
3604a4d3 134
021fb42d
VD
135Constructor for the I<version-flexible> SSL_METHOD structure for
136clients, servers or both.
137See L<SSL_CTX_new(3)> for details.
3604a4d3 138
021fb42d 139=item const SSL_METHOD *B<SSLv23_client_method>(void);
3604a4d3 140
021fb42d
VD
141Constructor for the I<version-flexible> SSL_METHOD structure for
142clients.
3604a4d3 143
021fb42d 144=item const SSL_METHOD *B<SSLv23_client_method>(void);
3604a4d3 145
021fb42d
VD
146Constructor for the I<version-flexible> SSL_METHOD structure for
147servers.
3604a4d3 148
021fb42d 149=item const SSL_METHOD *B<TLSv1_2_method>(void);
3604a4d3 150
021fb42d
VD
151Constructor for the TLSv1.2 SSL_METHOD structure for clients, servers
152or both.
3604a4d3 153
021fb42d 154=item const SSL_METHOD *B<TLSv1_2_client_method>(void);
3604a4d3 155
021fb42d 156Constructor for the TLSv1.2 SSL_METHOD structure for clients.
3604a4d3 157
021fb42d
VD
158=item const SSL_METHOD *B<TLSv1_2_server_method>(void);
159
160Constructor for the TLSv1.2 SSL_METHOD structure for servers.
161
162=item const SSL_METHOD *B<TLSv1_1_method>(void);
3604a4d3 163
021fb42d
VD
164Constructor for the TLSv1.1 SSL_METHOD structure for clients, servers
165or both.
166
167=item const SSL_METHOD *B<TLSv1_1_client_method>(void);
168
169Constructor for the TLSv1.1 SSL_METHOD structure for clients.
170
171=item const SSL_METHOD *B<TLSv1_1_server_method>(void);
172
173Constructor for the TLSv1.1 SSL_METHOD structure for servers.
174
175=item const SSL_METHOD *B<TLSv1_method>(void);
176
177Constructor for the TLSv1 SSL_METHOD structure for clients, servers
178or both.
3604a4d3 179
4ebb342f 180=item const SSL_METHOD *B<TLSv1_client_method>(void);
3604a4d3 181
021fb42d 182Constructor for the TLSv1 SSL_METHOD structure for clients.
3604a4d3 183
1dc4c8c7 184=item const SSL_METHOD *B<TLSv1_server_method>(void);
3604a4d3 185
021fb42d 186Constructor for the TLSv1 SSL_METHOD structure for servers.
3604a4d3 187
021fb42d
VD
188=item const SSL_METHOD *B<SSLv3_method>(void);
189
190Constructor for the SSLv3 SSL_METHOD structure for clients, servers
191or both.
192
193=item const SSL_METHOD *B<SSLv3_client_method>(void);
194
195Constructor for the SSLv3 SSL_METHOD structure for clients.
196
197=item const SSL_METHOD *B<SSLv3_server_method>(void);
198
199Constructor for the SSLv3 SSL_METHOD structure for servers.
200
201=item const SSL_METHOD *B<SSLv2_method>(void);
202
203Constructor for the SSLv2 SSL_METHOD structure for clients, servers
204or both.
205
206=item const SSL_METHOD *B<SSLv2_client_method>(void);
207
208Constructor for the SSLv2 SSL_METHOD structure for clients.
209
210=item const SSL_METHOD *B<SSLv2_server_method>(void);
3604a4d3 211
021fb42d 212Constructor for the SSLv2 SSL_METHOD structure for servers.
3604a4d3
UM
213
214=back
215
216=head2 DEALING WITH CIPHERS
217
218Here we document the various API functions which deal with the SSL/TLS
219ciphers defined in B<SSL_CIPHER> structures.
220
221=over 4
222
223=item char *B<SSL_CIPHER_description>(SSL_CIPHER *cipher, char *buf, int len);
224
225Write a string to I<buf> (with a maximum size of I<len>) containing a human
226readable description of I<cipher>. Returns I<buf>.
227
228=item int B<SSL_CIPHER_get_bits>(SSL_CIPHER *cipher, int *alg_bits);
229
230Determine the number of bits in I<cipher>. Because of export crippled ciphers
231there are two bits: The bits the algorithm supports in general (stored to
232I<alg_bits>) and the bits which are actually used (the return value).
233
d49f3797 234=item const char *B<SSL_CIPHER_get_name>(SSL_CIPHER *cipher);
3604a4d3
UM
235
236Return the internal name of I<cipher> as a string. These are the various
237strings defined by the I<SSL2_TXT_xxx>, I<SSL3_TXT_xxx> and I<TLS1_TXT_xxx>
238definitions in the header files.
239
240=item char *B<SSL_CIPHER_get_version>(SSL_CIPHER *cipher);
241
242Returns a string like "C<TLSv1/SSLv3>" or "C<SSLv2>" which indicates the
243SSL/TLS protocol version to which I<cipher> belongs (i.e. where it was defined
244in the specification the first time).
245
246=back
247
248=head2 DEALING WITH PROTOCOL CONTEXTS
249
250Here we document the various API functions which deal with the SSL/TLS
251protocol context defined in the B<SSL_CTX> structure.
252
253=over 4
254
255=item int B<SSL_CTX_add_client_CA>(SSL_CTX *ctx, X509 *x);
256
257=item long B<SSL_CTX_add_extra_chain_cert>(SSL_CTX *ctx, X509 *x509);
258
259=item int B<SSL_CTX_add_session>(SSL_CTX *ctx, SSL_SESSION *c);
260
c3e64028 261=item int B<SSL_CTX_check_private_key>(const SSL_CTX *ctx);
3604a4d3
UM
262
263=item long B<SSL_CTX_ctrl>(SSL_CTX *ctx, int cmd, long larg, char *parg);
264
265=item void B<SSL_CTX_flush_sessions>(SSL_CTX *s, long t);
266
267=item void B<SSL_CTX_free>(SSL_CTX *a);
268
269=item char *B<SSL_CTX_get_app_data>(SSL_CTX *ctx);
270
271=item X509_STORE *B<SSL_CTX_get_cert_store>(SSL_CTX *ctx);
272
c3e64028 273=item STACK *B<SSL_CTX_get_client_CA_list>(const SSL_CTX *ctx);
3604a4d3
UM
274
275=item int (*B<SSL_CTX_get_client_cert_cb>(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
276
6ca1dc97
MC
277=item void B<SSL_CTX_get_default_read_ahead>(SSL_CTX *ctx);
278
c3e64028 279=item char *B<SSL_CTX_get_ex_data>(const SSL_CTX *s, int idx);
3604a4d3
UM
280
281=item int B<SSL_CTX_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
282
283=item void (*B<SSL_CTX_get_info_callback>(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);
284
c3e64028 285=item int B<SSL_CTX_get_quiet_shutdown>(const SSL_CTX *ctx);
3604a4d3 286
6ca1dc97
MC
287=item void B<SSL_CTX_get_read_ahead>(SSL_CTX *ctx);
288
3604a4d3
UM
289=item int B<SSL_CTX_get_session_cache_mode>(SSL_CTX *ctx);
290
c3e64028 291=item long B<SSL_CTX_get_timeout>(const SSL_CTX *ctx);
3604a4d3 292
c3e64028 293=item int (*B<SSL_CTX_get_verify_callback>(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);
3604a4d3
UM
294
295=item int B<SSL_CTX_get_verify_mode>(SSL_CTX *ctx);
296
297=item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, char *CAfile, char *CApath);
298
299=item long B<SSL_CTX_need_tmp_RSA>(SSL_CTX *ctx);
300
4ebb342f 301=item SSL_CTX *B<SSL_CTX_new>(const SSL_METHOD *meth);
3604a4d3
UM
302
303=item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);
304
305=item int B<SSL_CTX_sess_accept>(SSL_CTX *ctx);
306
307=item int B<SSL_CTX_sess_accept_good>(SSL_CTX *ctx);
308
309=item int B<SSL_CTX_sess_accept_renegotiate>(SSL_CTX *ctx);
310
311=item int B<SSL_CTX_sess_cache_full>(SSL_CTX *ctx);
312
313=item int B<SSL_CTX_sess_cb_hits>(SSL_CTX *ctx);
314
315=item int B<SSL_CTX_sess_connect>(SSL_CTX *ctx);
316
317=item int B<SSL_CTX_sess_connect_good>(SSL_CTX *ctx);
318
319=item int B<SSL_CTX_sess_connect_renegotiate>(SSL_CTX *ctx);
320
321=item int B<SSL_CTX_sess_get_cache_size>(SSL_CTX *ctx);
322
323=item SSL_SESSION *(*B<SSL_CTX_sess_get_get_cb>(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);
324
325=item int (*B<SSL_CTX_sess_get_new_cb>(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);
326
327=item void (*B<SSL_CTX_sess_get_remove_cb>(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);
328
329=item int B<SSL_CTX_sess_hits>(SSL_CTX *ctx);
330
331=item int B<SSL_CTX_sess_misses>(SSL_CTX *ctx);
332
333=item int B<SSL_CTX_sess_number>(SSL_CTX *ctx);
334
335=item void B<SSL_CTX_sess_set_cache_size>(SSL_CTX *ctx,t);
336
337=item void B<SSL_CTX_sess_set_get_cb>(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));
338
339=item void B<SSL_CTX_sess_set_new_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));
340
341=item void B<SSL_CTX_sess_set_remove_cb>(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));
342
343=item int B<SSL_CTX_sess_timeouts>(SSL_CTX *ctx);
344
345=item LHASH *B<SSL_CTX_sessions>(SSL_CTX *ctx);
346
347=item void B<SSL_CTX_set_app_data>(SSL_CTX *ctx, void *arg);
348
349=item void B<SSL_CTX_set_cert_store>(SSL_CTX *ctx, X509_STORE *cs);
350
c4068186 351=item void B<SSL_CTX_set_cert_verify_cb>(SSL_CTX *ctx, int (*cb)(), char *arg)
3604a4d3
UM
352
353=item int B<SSL_CTX_set_cipher_list>(SSL_CTX *ctx, char *str);
354
355=item void B<SSL_CTX_set_client_CA_list>(SSL_CTX *ctx, STACK *list);
356
357=item void B<SSL_CTX_set_client_cert_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
358
359=item void B<SSL_CTX_set_default_passwd_cb>(SSL_CTX *ctx, int (*cb);(void))
360
361=item void B<SSL_CTX_set_default_read_ahead>(SSL_CTX *ctx, int m);
362
363=item int B<SSL_CTX_set_default_verify_paths>(SSL_CTX *ctx);
364
365=item int B<SSL_CTX_set_ex_data>(SSL_CTX *s, int idx, char *arg);
366
367=item void B<SSL_CTX_set_info_callback>(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));
368
65123f80
BM
369=item void B<SSL_CTX_set_msg_callback>(SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg));
370
371=item void B<SSL_CTX_set_msg_callback_arg>(SSL_CTX *ctx, void *arg);
372
3604a4d3
UM
373=item void B<SSL_CTX_set_options>(SSL_CTX *ctx, unsigned long op);
374
375=item void B<SSL_CTX_set_quiet_shutdown>(SSL_CTX *ctx, int mode);
376
6ca1dc97
MC
377=item void B<SSL_CTX_set_read_ahead>(SSL_CTX *ctx, int m);
378
3604a4d3
UM
379=item void B<SSL_CTX_set_session_cache_mode>(SSL_CTX *ctx, int mode);
380
4ebb342f 381=item int B<SSL_CTX_set_ssl_version>(SSL_CTX *ctx, const SSL_METHOD *meth);
3604a4d3
UM
382
383=item void B<SSL_CTX_set_timeout>(SSL_CTX *ctx, long t);
384
385=item long B<SSL_CTX_set_tmp_dh>(SSL_CTX* ctx, DH *dh);
386
387=item long B<SSL_CTX_set_tmp_dh_callback>(SSL_CTX *ctx, DH *(*cb)(void));
388
389=item long B<SSL_CTX_set_tmp_rsa>(SSL_CTX *ctx, RSA *rsa);
390
391=item SSL_CTX_set_tmp_rsa_callback
392
393C<long B<SSL_CTX_set_tmp_rsa_callback>(SSL_CTX *B<ctx>, RSA *(*B<cb>)(SSL *B<ssl>, int B<export>, int B<keylength>));>
394
395Sets the callback which will be called when a temporary private key is
396required. The B<C<export>> flag will be set if the reason for needing
397a temp key is that an export ciphersuite is in use, in which case,
398B<C<keylength>> will contain the required keylength in bits. Generate a key of
399appropriate size (using ???) and return it.
400
401=item SSL_set_tmp_rsa_callback
402
403long B<SSL_set_tmp_rsa_callback>(SSL *ssl, RSA *(*cb)(SSL *ssl, int export, int keylength));
404
84d828ab 405The same as B<SSL_CTX_set_tmp_rsa_callback>, except it operates on an SSL
3604a4d3
UM
406session instead of a context.
407
408=item void B<SSL_CTX_set_verify>(SSL_CTX *ctx, int mode, int (*cb);(void))
409
410=item int B<SSL_CTX_use_PrivateKey>(SSL_CTX *ctx, EVP_PKEY *pkey);
411
412=item int B<SSL_CTX_use_PrivateKey_ASN1>(int type, SSL_CTX *ctx, unsigned char *d, long len);
413
414=item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, char *file, int type);
415
416=item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);
417
418=item int B<SSL_CTX_use_RSAPrivateKey_ASN1>(SSL_CTX *ctx, unsigned char *d, long len);
419
420=item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, char *file, int type);
421
422=item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);
423
424=item int B<SSL_CTX_use_certificate_ASN1>(SSL_CTX *ctx, int len, unsigned char *d);
425
426=item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, char *file, int type);
427
2a1b7bd3
DSH
428=item X509 *B<SSL_CTX_get0_certificate>(const SSL_CTX *ctx);
429
430=item EVP_PKEY *B<SSL_CTX_get0_privatekey>(const SSL_CTX *ctx);
431
ddac1974
NL
432=item void B<SSL_CTX_set_psk_client_callback>(SSL_CTX *ctx, unsigned int (*callback)(SSL *ssl, const char *hint, char *identity, unsigned int max_identity_len, unsigned char *psk, unsigned int max_psk_len));
433
434=item int B<SSL_CTX_use_psk_identity_hint>(SSL_CTX *ctx, const char *hint);
435
436=item void B<SSL_CTX_set_psk_server_callback>(SSL_CTX *ctx, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len));
437
438
439
440
3604a4d3
UM
441=back
442
443=head2 DEALING WITH SESSIONS
444
445Here we document the various API functions which deal with the SSL/TLS
446sessions defined in the B<SSL_SESSION> structures.
447
448=over 4
449
c3e64028 450=item int B<SSL_SESSION_cmp>(const SSL_SESSION *a, const SSL_SESSION *b);
3604a4d3
UM
451
452=item void B<SSL_SESSION_free>(SSL_SESSION *ss);
453
454=item char *B<SSL_SESSION_get_app_data>(SSL_SESSION *s);
455
c3e64028 456=item char *B<SSL_SESSION_get_ex_data>(const SSL_SESSION *s, int idx);
3604a4d3
UM
457
458=item int B<SSL_SESSION_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
459
c3e64028 460=item long B<SSL_SESSION_get_time>(const SSL_SESSION *s);
3604a4d3 461
c3e64028 462=item long B<SSL_SESSION_get_timeout>(const SSL_SESSION *s);
3604a4d3 463
c3e64028 464=item unsigned long B<SSL_SESSION_hash>(const SSL_SESSION *a);
3604a4d3
UM
465
466=item SSL_SESSION *B<SSL_SESSION_new>(void);
467
c3e64028 468=item int B<SSL_SESSION_print>(BIO *bp, const SSL_SESSION *x);
3604a4d3 469
c3e64028 470=item int B<SSL_SESSION_print_fp>(FILE *fp, const SSL_SESSION *x);
3604a4d3
UM
471
472=item void B<SSL_SESSION_set_app_data>(SSL_SESSION *s, char *a);
473
474=item int B<SSL_SESSION_set_ex_data>(SSL_SESSION *s, int idx, char *arg);
475
476=item long B<SSL_SESSION_set_time>(SSL_SESSION *s, long t);
477
478=item long B<SSL_SESSION_set_timeout>(SSL_SESSION *s, long t);
479
480=back
481
482=head2 DEALING WITH CONNECTIONS
483
484Here we document the various API functions which deal with the SSL/TLS
485connection defined in the B<SSL> structure.
486
487=over 4
488
489=item int B<SSL_accept>(SSL *ssl);
490
491=item int B<SSL_add_dir_cert_subjects_to_stack>(STACK *stack, const char *dir);
492
493=item int B<SSL_add_file_cert_subjects_to_stack>(STACK *stack, const char *file);
494
495=item int B<SSL_add_client_CA>(SSL *ssl, X509 *x);
496
497=item char *B<SSL_alert_desc_string>(int value);
498
499=item char *B<SSL_alert_desc_string_long>(int value);
500
501=item char *B<SSL_alert_type_string>(int value);
502
503=item char *B<SSL_alert_type_string_long>(int value);
504
c3e64028 505=item int B<SSL_check_private_key>(const SSL *ssl);
3604a4d3
UM
506
507=item void B<SSL_clear>(SSL *ssl);
508
509=item long B<SSL_clear_num_renegotiations>(SSL *ssl);
510
511=item int B<SSL_connect>(SSL *ssl);
512
c3e64028 513=item void B<SSL_copy_session_id>(SSL *t, const SSL *f);
3604a4d3
UM
514
515=item long B<SSL_ctrl>(SSL *ssl, int cmd, long larg, char *parg);
516
517=item int B<SSL_do_handshake>(SSL *ssl);
518
519=item SSL *B<SSL_dup>(SSL *ssl);
520
521=item STACK *B<SSL_dup_CA_list>(STACK *sk);
522
523=item void B<SSL_free>(SSL *ssl);
524
c3e64028 525=item SSL_CTX *B<SSL_get_SSL_CTX>(const SSL *ssl);
3604a4d3
UM
526
527=item char *B<SSL_get_app_data>(SSL *ssl);
528
c3e64028 529=item X509 *B<SSL_get_certificate>(const SSL *ssl);
3604a4d3 530
c3e64028 531=item const char *B<SSL_get_cipher>(const SSL *ssl);
3604a4d3 532
c3e64028 533=item int B<SSL_get_cipher_bits>(const SSL *ssl, int *alg_bits);
3604a4d3 534
c3e64028 535=item char *B<SSL_get_cipher_list>(const SSL *ssl, int n);
3604a4d3 536
c3e64028 537=item char *B<SSL_get_cipher_name>(const SSL *ssl);
3604a4d3 538
c3e64028 539=item char *B<SSL_get_cipher_version>(const SSL *ssl);
3604a4d3 540
c3e64028 541=item STACK *B<SSL_get_ciphers>(const SSL *ssl);
3604a4d3 542
c3e64028 543=item STACK *B<SSL_get_client_CA_list>(const SSL *ssl);
3604a4d3
UM
544
545=item SSL_CIPHER *B<SSL_get_current_cipher>(SSL *ssl);
546
c3e64028 547=item long B<SSL_get_default_timeout>(const SSL *ssl);
3604a4d3 548
c3e64028 549=item int B<SSL_get_error>(const SSL *ssl, int i);
3604a4d3 550
c3e64028 551=item char *B<SSL_get_ex_data>(const SSL *ssl, int idx);
3604a4d3
UM
552
553=item int B<SSL_get_ex_data_X509_STORE_CTX_idx>(void);
554
555=item int B<SSL_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
556
c3e64028 557=item int B<SSL_get_fd>(const SSL *ssl);
3604a4d3 558
c3e64028 559=item void (*B<SSL_get_info_callback>(const SSL *ssl);)()
3604a4d3 560
c3e64028 561=item STACK *B<SSL_get_peer_cert_chain>(const SSL *ssl);
3604a4d3 562
c3e64028 563=item X509 *B<SSL_get_peer_certificate>(const SSL *ssl);
3604a4d3 564
2a1b7bd3 565=item EVP_PKEY *B<SSL_get_privatekey>(const SSL *ssl);
3604a4d3 566
c3e64028 567=item int B<SSL_get_quiet_shutdown>(const SSL *ssl);
3604a4d3 568
c3e64028 569=item BIO *B<SSL_get_rbio>(const SSL *ssl);
3604a4d3 570
c3e64028 571=item int B<SSL_get_read_ahead>(const SSL *ssl);
3604a4d3 572
c3e64028 573=item SSL_SESSION *B<SSL_get_session>(const SSL *ssl);
3604a4d3 574
bd05644d 575=item char *B<SSL_get_shared_ciphers>(const SSL *ssl, char *buf, int size);
3604a4d3 576
c3e64028 577=item int B<SSL_get_shutdown>(const SSL *ssl);
3604a4d3 578
4ebb342f 579=item const SSL_METHOD *B<SSL_get_ssl_method>(SSL *ssl);
3604a4d3 580
c3e64028 581=item int B<SSL_get_state>(const SSL *ssl);
3604a4d3 582
c3e64028 583=item long B<SSL_get_time>(const SSL *ssl);
3604a4d3 584
c3e64028 585=item long B<SSL_get_timeout>(const SSL *ssl);
3604a4d3 586
c3e64028 587=item int (*B<SSL_get_verify_callback>(const SSL *ssl))(int,X509_STORE_CTX *)
3604a4d3 588
c3e64028 589=item int B<SSL_get_verify_mode>(const SSL *ssl);
3604a4d3 590
c3e64028 591=item long B<SSL_get_verify_result>(const SSL *ssl);
3604a4d3 592
c3e64028 593=item char *B<SSL_get_version>(const SSL *ssl);
3604a4d3 594
c3e64028 595=item BIO *B<SSL_get_wbio>(const SSL *ssl);
3604a4d3
UM
596
597=item int B<SSL_in_accept_init>(SSL *ssl);
598
599=item int B<SSL_in_before>(SSL *ssl);
600
601=item int B<SSL_in_connect_init>(SSL *ssl);
602
603=item int B<SSL_in_init>(SSL *ssl);
604
605=item int B<SSL_is_init_finished>(SSL *ssl);
606
607=item STACK *B<SSL_load_client_CA_file>(char *file);
608
609=item void B<SSL_load_error_strings>(void);
610
611=item SSL *B<SSL_new>(SSL_CTX *ctx);
612
613=item long B<SSL_num_renegotiations>(SSL *ssl);
614
e34cfcf7 615=item int B<SSL_peek>(SSL *ssl, void *buf, int num);
3604a4d3 616
c3e64028 617=item int B<SSL_pending>(const SSL *ssl);
3604a4d3 618
e34cfcf7 619=item int B<SSL_read>(SSL *ssl, void *buf, int num);
3604a4d3
UM
620
621=item int B<SSL_renegotiate>(SSL *ssl);
622
623=item char *B<SSL_rstate_string>(SSL *ssl);
624
625=item char *B<SSL_rstate_string_long>(SSL *ssl);
626
627=item long B<SSL_session_reused>(SSL *ssl);
628
629=item void B<SSL_set_accept_state>(SSL *ssl);
630
631=item void B<SSL_set_app_data>(SSL *ssl, char *arg);
632
633=item void B<SSL_set_bio>(SSL *ssl, BIO *rbio, BIO *wbio);
634
635=item int B<SSL_set_cipher_list>(SSL *ssl, char *str);
636
637=item void B<SSL_set_client_CA_list>(SSL *ssl, STACK *list);
638
639=item void B<SSL_set_connect_state>(SSL *ssl);
640
641=item int B<SSL_set_ex_data>(SSL *ssl, int idx, char *arg);
642
643=item int B<SSL_set_fd>(SSL *ssl, int fd);
644
645=item void B<SSL_set_info_callback>(SSL *ssl, void (*cb);(void))
646
65123f80
BM
647=item void B<SSL_set_msg_callback>(SSL *ctx, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg));
648
649=item void B<SSL_set_msg_callback_arg>(SSL *ctx, void *arg);
650
3604a4d3
UM
651=item void B<SSL_set_options>(SSL *ssl, unsigned long op);
652
653=item void B<SSL_set_quiet_shutdown>(SSL *ssl, int mode);
654
655=item void B<SSL_set_read_ahead>(SSL *ssl, int yes);
656
657=item int B<SSL_set_rfd>(SSL *ssl, int fd);
658
659=item int B<SSL_set_session>(SSL *ssl, SSL_SESSION *session);
660
661=item void B<SSL_set_shutdown>(SSL *ssl, int mode);
662
4ebb342f 663=item int B<SSL_set_ssl_method>(SSL *ssl, const SSL_METHOD *meth);
3604a4d3
UM
664
665=item void B<SSL_set_time>(SSL *ssl, long t);
666
667=item void B<SSL_set_timeout>(SSL *ssl, long t);
668
669=item void B<SSL_set_verify>(SSL *ssl, int mode, int (*callback);(void))
670
671=item void B<SSL_set_verify_result>(SSL *ssl, long arg);
672
673=item int B<SSL_set_wfd>(SSL *ssl, int fd);
674
675=item int B<SSL_shutdown>(SSL *ssl);
676
c3e64028 677=item int B<SSL_state>(const SSL *ssl);
3604a4d3 678
c3e64028 679=item char *B<SSL_state_string>(const SSL *ssl);
3604a4d3 680
c3e64028 681=item char *B<SSL_state_string_long>(const SSL *ssl);
3604a4d3
UM
682
683=item long B<SSL_total_renegotiations>(SSL *ssl);
684
685=item int B<SSL_use_PrivateKey>(SSL *ssl, EVP_PKEY *pkey);
686
687=item int B<SSL_use_PrivateKey_ASN1>(int type, SSL *ssl, unsigned char *d, long len);
688
689=item int B<SSL_use_PrivateKey_file>(SSL *ssl, char *file, int type);
690
691=item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);
692
693=item int B<SSL_use_RSAPrivateKey_ASN1>(SSL *ssl, unsigned char *d, long len);
694
695=item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, char *file, int type);
696
697=item int B<SSL_use_certificate>(SSL *ssl, X509 *x);
698
699=item int B<SSL_use_certificate_ASN1>(SSL *ssl, int len, unsigned char *d);
700
701=item int B<SSL_use_certificate_file>(SSL *ssl, char *file, int type);
702
c3e64028 703=item int B<SSL_version>(const SSL *ssl);
3604a4d3 704
c3e64028 705=item int B<SSL_want>(const SSL *ssl);
3604a4d3 706
c3e64028 707=item int B<SSL_want_nothing>(const SSL *ssl);
3604a4d3 708
c3e64028 709=item int B<SSL_want_read>(const SSL *ssl);
3604a4d3 710
c3e64028 711=item int B<SSL_want_write>(const SSL *ssl);
3604a4d3 712
c3e64028 713=item int B<SSL_want_x509_lookup>(const SSL *ssl);
3604a4d3 714
e34cfcf7 715=item int B<SSL_write>(SSL *ssl, const void *buf, int num);
3604a4d3 716
ddac1974
NL
717=item void B<SSL_set_psk_client_callback>(SSL *ssl, unsigned int (*callback)(SSL *ssl, const char *hint, char *identity, unsigned int max_identity_len, unsigned char *psk, unsigned int max_psk_len));
718
719=item int B<SSL_use_psk_identity_hint>(SSL *ssl, const char *hint);
720
721=item void B<SSL_set_psk_server_callback>(SSL *ssl, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len));
722
723=item const char *B<SSL_get_psk_identity_hint>(SSL *ssl);
724
725=item const char *B<SSL_get_psk_identity>(SSL *ssl);
726
3604a4d3
UM
727=back
728
729=head1 SEE ALSO
730
20ead2c6 731L<openssl(1)|openssl(1)>, L<crypto(3)|crypto(3)>,
53e44d90 732L<SSL_accept(3)|SSL_accept(3)>, L<SSL_clear(3)|SSL_clear(3)>,
356c06c7 733L<SSL_connect(3)|SSL_connect(3)>,
553615f5 734L<SSL_CIPHER_get_name(3)|SSL_CIPHER_get_name(3)>,
336736ef 735L<SSL_COMP_add_compression_method(3)|SSL_COMP_add_compression_method(3)>,
66ebbb6a 736L<SSL_CTX_add_extra_chain_cert(3)|SSL_CTX_add_extra_chain_cert(3)>,
0bc6597d 737L<SSL_CTX_add_session(3)|SSL_CTX_add_session(3)>,
d59c3e50 738L<SSL_CTX_ctrl(3)|SSL_CTX_ctrl(3)>,
0bc6597d 739L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>,
e58d808a 740L<SSL_CTX_get_ex_new_index(3)|SSL_CTX_get_ex_new_index(3)>,
553615f5 741L<SSL_CTX_get_verify_mode(3)|SSL_CTX_get_verify_mode(3)>,
356c06c7
RL
742L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>
743L<SSL_CTX_new(3)|SSL_CTX_new(3)>,
41ecaba9 744L<SSL_CTX_sess_number(3)|SSL_CTX_sess_number(3)>,
0bc6597d 745L<SSL_CTX_sess_set_cache_size(3)|SSL_CTX_sess_set_cache_size(3)>,
8cbceba6 746L<SSL_CTX_sess_set_get_cb(3)|SSL_CTX_sess_set_get_cb(3)>,
7b9cb4a2 747L<SSL_CTX_sessions(3)|SSL_CTX_sessions(3)>,
141e5849 748L<SSL_CTX_set_cert_store(3)|SSL_CTX_set_cert_store(3)>,
c4068186 749L<SSL_CTX_set_cert_verify_callback(3)|SSL_CTX_set_cert_verify_callback(3)>,
397ba0f0 750L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>,
66ebbb6a 751L<SSL_CTX_set_client_CA_list(3)|SSL_CTX_set_client_CA_list(3)>,
f0d6ee6b 752L<SSL_CTX_set_client_cert_cb(3)|SSL_CTX_set_client_cert_cb(3)>,
66ebbb6a 753L<SSL_CTX_set_default_passwd_cb(3)|SSL_CTX_set_default_passwd_cb(3)>,
3cdc8ad0 754L<SSL_CTX_set_generate_session_id(3)|SSL_CTX_set_generate_session_id(3)>,
f1b28074 755L<SSL_CTX_set_info_callback(3)|SSL_CTX_set_info_callback(3)>,
c0f5dd07 756L<SSL_CTX_set_max_cert_list(3)|SSL_CTX_set_max_cert_list(3)>,
f282ca74 757L<SSL_CTX_set_mode(3)|SSL_CTX_set_mode(3)>,
65123f80 758L<SSL_CTX_set_msg_callback(3)|SSL_CTX_set_msg_callback(3)>,
7b9cb4a2 759L<SSL_CTX_set_options(3)|SSL_CTX_set_options(3)>,
cdd7c3ce 760L<SSL_CTX_set_quiet_shutdown(3)|SSL_CTX_set_quiet_shutdown(3)>,
6ca1dc97 761L<SSL_CTX_set_read_ahead(3)|SSL_CTX_set_read_ahead(3)>,
8cbceba6 762L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,
cd6aa710 763L<SSL_CTX_set_session_id_context(3)|SSL_CTX_set_session_id_context(3)>,
69431c29 764L<SSL_CTX_set_ssl_version(3)|SSL_CTX_set_ssl_version(3)>,
0bc6597d 765L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>,
4db48ec0
LJ
766L<SSL_CTX_set_tmp_rsa_callback(3)|SSL_CTX_set_tmp_rsa_callback(3)>,
767L<SSL_CTX_set_tmp_dh_callback(3)|SSL_CTX_set_tmp_dh_callback(3)>,
553615f5 768L<SSL_CTX_set_verify(3)|SSL_CTX_set_verify(3)>,
66ebbb6a 769L<SSL_CTX_use_certificate(3)|SSL_CTX_use_certificate(3)>,
a403188f 770L<SSL_alert_type_string(3)|SSL_alert_type_string(3)>,
02b7ec88 771L<SSL_do_handshake(3)|SSL_do_handshake(3)>,
a52877a2 772L<SSL_get_SSL_CTX(3)|SSL_get_SSL_CTX(3)>,
69431c29 773L<SSL_get_ciphers(3)|SSL_get_ciphers(3)>,
356c06c7 774L<SSL_get_client_CA_list(3)|SSL_get_client_CA_list(3)>,
52129c0b 775L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>,
751b5e8f
LJ
776L<SSL_get_error(3)|SSL_get_error(3)>,
777L<SSL_get_ex_data_X509_STORE_CTX_idx(3)|SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
778L<SSL_get_ex_new_index(3)|SSL_get_ex_new_index(3)>,
779L<SSL_get_fd(3)|SSL_get_fd(3)>,
69431c29 780L<SSL_get_peer_cert_chain(3)|SSL_get_peer_cert_chain(3)>,
53e44d90 781L<SSL_get_rbio(3)|SSL_get_rbio(3)>,
69431c29
UM
782L<SSL_get_session(3)|SSL_get_session(3)>,
783L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>,
2c1571b4 784L<SSL_get_version(3)|SSL_get_version(3)>,
356c06c7
RL
785L<SSL_library_init(3)|SSL_library_init(3)>,
786L<SSL_load_client_CA_file(3)|SSL_load_client_CA_file(3)>,
787L<SSL_new(3)|SSL_new(3)>,
2d3b6a5b
LJ
788L<SSL_pending(3)|SSL_pending(3)>,
789L<SSL_read(3)|SSL_read(3)>,
11c8f0b7 790L<SSL_rstate_string(3)|SSL_rstate_string(3)>,
2d3b6a5b
LJ
791L<SSL_session_reused(3)|SSL_session_reused(3)>,
792L<SSL_set_bio(3)|SSL_set_bio(3)>,
b72ff470 793L<SSL_set_connect_state(3)|SSL_set_connect_state(3)>,
2d3b6a5b 794L<SSL_set_fd(3)|SSL_set_fd(3)>,
53e44d90 795L<SSL_set_session(3)|SSL_set_session(3)>,
8e495e4a 796L<SSL_set_shutdown(3)|SSL_set_shutdown(3)>,
2d3b6a5b 797L<SSL_shutdown(3)|SSL_shutdown(3)>,
11c8f0b7 798L<SSL_state_string(3)|SSL_state_string(3)>,
c1497b4d 799L<SSL_want(3)|SSL_want(3)>,
2d3b6a5b 800L<SSL_write(3)|SSL_write(3)>,
e58d808a 801L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>,
8cbceba6 802L<SSL_SESSION_get_ex_new_index(3)|SSL_SESSION_get_ex_new_index(3)>,
0bc6597d 803L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,
ddac1974
NL
804L<d2i_SSL_SESSION(3)|d2i_SSL_SESSION(3)>,
805L<SSL_CTX_set_psk_client_callback(3)|SSL_CTX_set_psk_client_callback(3)>,
806L<SSL_CTX_use_psk_identity_hint(3)|SSL_CTX_use_psk_identity_hint(3)>,
807L<SSL_get_psk_identity(3)|SSL_get_psk_identity(3)>
3604a4d3
UM
808
809=head1 HISTORY
810
bb075f88 811The L<ssl(3)|ssl(3)> document appeared in OpenSSL 0.9.2
3604a4d3
UM
812
813=cut
814