fcc6c7199b
is a pain to do, because of the various macro definitions which I had to expand manually to get their prototype :-( What's now needed is a volunteer who wants to write down one or two sentences per API function to document it a little bit...
495 lines
13 KiB
Text
495 lines
13 KiB
Text
|
|
=pod
|
|
|
|
=head1 NAME
|
|
|
|
SSL - OpenSSL SSL/TLS library
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
|
|
Transport Layer Security (TLS v1) protocols. It provides a rich API which is
|
|
documented here.
|
|
|
|
=head1 HEADERS
|
|
|
|
Currently the OpenSSL B<ssl> library provides the following C header files
|
|
containing the prototypes for the data structures and and functions:
|
|
|
|
=over 4
|
|
|
|
=item B<ssl.h>
|
|
|
|
That's the common header file for the SSL/TLS API. Include it into your
|
|
program to make the API of the B<ssl> library available. It internally
|
|
includes both more private SSL headers and headers from the B<crypto> library.
|
|
|
|
=back
|
|
|
|
=head1 STRUCTURES
|
|
|
|
Currently the OpenSSL B<ssl> library functions deal with the following data
|
|
structures:
|
|
|
|
=over 4
|
|
|
|
=item B<SSL_CTX> (SSL Context)
|
|
|
|
=item B<SSL> (SSL Connection)
|
|
|
|
That's the SSL/TLS structure which is created by
|
|
a server or client per established connection.
|
|
|
|
=item B<SSL_METHOD> (SSL Method)
|
|
|
|
=item B<SSL_CIPHER> (SSL Cipher)
|
|
|
|
=item B<SSL_SESSION> (SSL Session)
|
|
|
|
=back
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
Currently the OpenSSL B<ssl> library exports 214 API functions.
|
|
They are documented in the following:
|
|
|
|
=over 4
|
|
|
|
=item char *B<SSL_CIPHER_description>(SSL_CIPHER *cipher, char *buf, int len);
|
|
|
|
=item int B<SSL_CIPHER_get_bits>(SSL_CIPHER *c, int *alg_bits);
|
|
|
|
=item char *B<SSL_CIPHER_get_name>(SSL_CIPHER *c);
|
|
|
|
=item char *B<SSL_CIPHER_get_version>(SSL_CIPHER *c);
|
|
|
|
=item int B<SSL_CTX_add_client_CA>(SSL_CTX *ctx, X509 *x);
|
|
|
|
=item long B<SSL_CTX_add_extra_chain_cert>(SSL_CTX *ctx, X509 *x509);
|
|
|
|
=item int B<SSL_CTX_add_session>(SSL_CTX *ctx, SSL_SESSION *c);
|
|
|
|
=item int B<SSL_CTX_check_private_key>(SSL_CTX *ctx);
|
|
|
|
=item long B<SSL_CTX_ctrl>(SSL_CTX *ctx, int cmd, long larg, char *parg);
|
|
|
|
=item void B<SSL_CTX_flush_sessions>(SSL_CTX *s, long t);
|
|
|
|
=item void B<SSL_CTX_free>(SSL_CTX *a);
|
|
|
|
=item char *B<SSL_CTX_get_app_data>(SSL_CTX *ctx);
|
|
|
|
=item X509_STORE *B<SSL_CTX_get_cert_store>(SSL_CTX *ctx);
|
|
|
|
=item STACK *B<SSL_CTX_get_client_CA_list>(SSL_CTX *ctx);
|
|
|
|
=item int (*B<SSL_CTX_get_client_cert_cb>(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
|
|
|
|
=item char *B<SSL_CTX_get_ex_data>(SSL_CTX *s, int idx);
|
|
|
|
=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))
|
|
|
|
=item void (*B<SSL_CTX_get_info_callback>(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);
|
|
|
|
=item int B<SSL_CTX_get_quiet_shutdown>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_get_session_cache_mode>(SSL_CTX *ctx);
|
|
|
|
=item long B<SSL_CTX_get_timeout>(SSL_CTX *ctx);
|
|
|
|
=item int (*B<SSL_CTX_get_verify_callback>(SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_get_verify_mode>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, char *CAfile, char *CApath);
|
|
|
|
=item long B<SSL_CTX_need_tmp_RSA>(SSL_CTX *ctx);
|
|
|
|
=item SSL_CTX *B<SSL_CTX_new>(SSL_METHOD *meth);
|
|
|
|
=item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);
|
|
|
|
=item int B<SSL_CTX_sess_accept>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_accept_good>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_accept_renegotiate>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_cache_full>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_cb_hits>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_connect>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_connect_good>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_connect_renegotiate>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_get_cache_size>(SSL_CTX *ctx);
|
|
|
|
=item SSL_SESSION *(*B<SSL_CTX_sess_get_get_cb>(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);
|
|
|
|
=item int (*B<SSL_CTX_sess_get_new_cb>(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);
|
|
|
|
=item void (*B<SSL_CTX_sess_get_remove_cb>(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);
|
|
|
|
=item int B<SSL_CTX_sess_hits>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_misses>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_sess_number>(SSL_CTX *ctx);
|
|
|
|
=item void B<SSL_CTX_sess_set_cache_size>(SSL_CTX *ctx,t);
|
|
|
|
=item void B<SSL_CTX_sess_set_get_cb>(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));
|
|
|
|
=item void B<SSL_CTX_sess_set_new_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));
|
|
|
|
=item void B<SSL_CTX_sess_set_remove_cb>(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));
|
|
|
|
=item int B<SSL_CTX_sess_timeouts>(SSL_CTX *ctx);
|
|
|
|
=item LHASH *B<SSL_CTX_sessions>(SSL_CTX *ctx);
|
|
|
|
=item void B<SSL_CTX_set_app_data>(SSL_CTX *ctx, void *arg);
|
|
|
|
=item void B<SSL_CTX_set_cert_store>(SSL_CTX *ctx, X509_STORE *cs);
|
|
|
|
=item void B<SSL_CTX_set_cert_verify_cb>(SSL_CTX *ctx, int (*cb)(SSL_CTX *), char *arg)
|
|
|
|
=item int B<SSL_CTX_set_cipher_list>(SSL_CTX *ctx, char *str);
|
|
|
|
=item void B<SSL_CTX_set_client_CA_list>(SSL_CTX *ctx, STACK *list);
|
|
|
|
=item void B<SSL_CTX_set_client_cert_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
|
|
|
|
=item void B<SSL_CTX_set_default_passwd_cb>(SSL_CTX *ctx, int (*cb);(void))
|
|
|
|
=item void B<SSL_CTX_set_default_read_ahead>(SSL_CTX *ctx, int m);
|
|
|
|
=item int B<SSL_CTX_set_default_verify_paths>(SSL_CTX *ctx);
|
|
|
|
=item int B<SSL_CTX_set_ex_data>(SSL_CTX *s, int idx, char *arg);
|
|
|
|
=item void B<SSL_CTX_set_info_callback>(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));
|
|
|
|
=item void B<SSL_CTX_set_options>(SSL_CTX *ctx, unsigned long op);
|
|
|
|
=item void B<SSL_CTX_set_quiet_shutdown>(SSL_CTX *ctx, int mode);
|
|
|
|
=item void B<SSL_CTX_set_session_cache_mode>(SSL_CTX *ctx, int mode);
|
|
|
|
=item int B<SSL_CTX_set_ssl_version>(SSL_CTX *ctx, SSL_METHOD *meth);
|
|
|
|
=item void B<SSL_CTX_set_timeout>(SSL_CTX *ctx, long t);
|
|
|
|
=item long B<SSL_CTX_set_tmp_dh>(SSL_CTX* ctx, DH *dh);
|
|
|
|
=item long B<SSL_CTX_set_tmp_dh_callback>(SSL_CTX *ctx, DH *(*cb)(void));
|
|
|
|
=item long B<SSL_CTX_set_tmp_rsa>(SSL_CTX *ctx, RSA *rsa);
|
|
|
|
=item long B<SSL_CTX_set_tmp_rsa_callback>(SSL_CTX *ctx, RSA *(*cb)(void));
|
|
|
|
=item void B<SSL_CTX_set_verify>(SSL_CTX *ctx, int mode, int (*cb);(void))
|
|
|
|
=item int B<SSL_CTX_use_PrivateKey>(SSL_CTX *ctx, EVP_PKEY *pkey);
|
|
|
|
=item int B<SSL_CTX_use_PrivateKey_ASN1>(int type, SSL_CTX *ctx, unsigned char *d, long len);
|
|
|
|
=item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, char *file, int type);
|
|
|
|
=item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);
|
|
|
|
=item int B<SSL_CTX_use_RSAPrivateKey_ASN1>(SSL_CTX *ctx, unsigned char *d, long len);
|
|
|
|
=item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, char *file, int type);
|
|
|
|
=item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);
|
|
|
|
=item int B<SSL_CTX_use_certificate_ASN1>(SSL_CTX *ctx, int len, unsigned char *d);
|
|
|
|
=item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, char *file, int type);
|
|
|
|
=item int B<SSL_SESSION_cmp>(SSL_SESSION *a, SSL_SESSION *b);
|
|
|
|
=item void B<SSL_SESSION_free>(SSL_SESSION *ss);
|
|
|
|
=item char *B<SSL_SESSION_get_app_data>(SSL_SESSION *s);
|
|
|
|
=item char *B<SSL_SESSION_get_ex_data>(SSL_SESSION *s, int idx);
|
|
|
|
=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))
|
|
|
|
=item long B<SSL_SESSION_get_time>(SSL_SESSION *s);
|
|
|
|
=item long B<SSL_SESSION_get_timeout>(SSL_SESSION *s);
|
|
|
|
=item unsigned long B<SSL_SESSION_hash>(SSL_SESSION *a);
|
|
|
|
=item SSL_SESSION *B<SSL_SESSION_new>(void);
|
|
|
|
=item int B<SSL_SESSION_print>(BIO *bp, SSL_SESSION *x);
|
|
|
|
=item int B<SSL_SESSION_print_fp>(FILE *fp, SSL_SESSION *x);
|
|
|
|
=item void B<SSL_SESSION_set_app_data>(SSL_SESSION *s, char *a);
|
|
|
|
=item int B<SSL_SESSION_set_ex_data>(SSL_SESSION *s, int idx, char *arg);
|
|
|
|
=item long B<SSL_SESSION_set_time>(SSL_SESSION *s, long t);
|
|
|
|
=item long B<SSL_SESSION_set_timeout>(SSL_SESSION *s, long t);
|
|
|
|
=item int B<SSL_accept>(SSL *ssl);
|
|
|
|
=item int B<SSL_add_client_CA>(SSL *ssl, X509 *x);
|
|
|
|
=item char *B<SSL_alert_desc_string>(int value);
|
|
|
|
=item char *B<SSL_alert_desc_string_long>(int value);
|
|
|
|
=item char *B<SSL_alert_type_string>(int value);
|
|
|
|
=item char *B<SSL_alert_type_string_long>(int value);
|
|
|
|
=item int B<SSL_check_private_key>(SSL *ssl);
|
|
|
|
=item void B<SSL_clear>(SSL *ssl);
|
|
|
|
=item long B<SSL_clear_num_renegotiations>(SSL *ssl);
|
|
|
|
=item int B<SSL_connect>(SSL *ssl);
|
|
|
|
=item void B<SSL_copy_session_id>(SSL *t, SSL *f);
|
|
|
|
=item long B<SSL_ctrl>(SSL *ssl, int cmd, long larg, char *parg);
|
|
|
|
=item int B<SSL_do_handshake>(SSL *ssl);
|
|
|
|
=item SSL *B<SSL_dup>(SSL *ssl);
|
|
|
|
=item STACK *B<SSL_dup_CA_list>(STACK *sk);
|
|
|
|
=item void B<SSL_free>(SSL *ssl);
|
|
|
|
=item SSL_CTX *B<SSL_get_SSL_CTX>(SSL *ssl);
|
|
|
|
=item char *B<SSL_get_app_data>(SSL *ssl);
|
|
|
|
=item X509 *B<SSL_get_certificate>(SSL *ssl);
|
|
|
|
=item SSL_CIPHER *B<SSL_get_cipher>(SSL *ssl);
|
|
|
|
=item int B<SSL_get_cipher_bits>(SSL *ssl, int *alg_bits);
|
|
|
|
=item char *B<SSL_get_cipher_list>(SSL *ssl, int n);
|
|
|
|
=item char *B<SSL_get_cipher_name>(SSL *ssl);
|
|
|
|
=item char *B<SSL_get_cipher_version>(SSL *ssl);
|
|
|
|
=item STACK *B<SSL_get_ciphers>(SSL *ssl);
|
|
|
|
=item STACK *B<SSL_get_client_CA_list>(SSL *ssl);
|
|
|
|
=item SSL_CIPHER *B<SSL_get_current_cipher>(SSL *ssl);
|
|
|
|
=item long B<SSL_get_default_timeout>(SSL *ssl);
|
|
|
|
=item int B<SSL_get_error>(SSL *ssl, int i);
|
|
|
|
=item char *B<SSL_get_ex_data>(SSL *ssl, int idx);
|
|
|
|
=item int B<SSL_get_ex_data_X509_STORE_CTX_idx>(void);
|
|
|
|
=item int B<SSL_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
|
|
|
|
=item int B<SSL_get_fd>(SSL *ssl);
|
|
|
|
=item void (*B<SSL_get_info_callback>(SSL *ssl);)(void)
|
|
|
|
=item STACK *B<SSL_get_peer_cert_chain>(SSL *ssl);
|
|
|
|
=item X509 *B<SSL_get_peer_certificate>(SSL *ssl);
|
|
|
|
=item EVP_PKEY *B<SSL_get_privatekey>(SSL *ssl);
|
|
|
|
=item int B<SSL_get_quiet_shutdown>(SSL *ssl);
|
|
|
|
=item BIO *B<SSL_get_rbio>(SSL *ssl);
|
|
|
|
=item int B<SSL_get_read_ahead>(SSL *ssl);
|
|
|
|
=item SSL_SESSION *B<SSL_get_session>(SSL *ssl);
|
|
|
|
=item char *B<SSL_get_shared_ciphers>(SSL *ssl, char *buf, int len);
|
|
|
|
=item int B<SSL_get_shutdown>(SSL *ssl);
|
|
|
|
=item SSL_METHOD *B<SSL_get_ssl_method>(SSL *ssl);
|
|
|
|
=item int B<SSL_get_state>(SSL *ssl);
|
|
|
|
=item long B<SSL_get_time>(SSL *ssl);
|
|
|
|
=item long B<SSL_get_timeout>(SSL *ssl);
|
|
|
|
=item int (*B<SSL_get_verify_callback>(SSL *ssl);)(void)
|
|
|
|
=item int B<SSL_get_verify_mode>(SSL *ssl);
|
|
|
|
=item long B<SSL_get_verify_result>(SSL *ssl);
|
|
|
|
=item char *B<SSL_get_version>(SSL *ssl);
|
|
|
|
=item BIO *B<SSL_get_wbio>(SSL *ssl);
|
|
|
|
=item int B<SSL_in_accept_init>(SSL *ssl);
|
|
|
|
=item int B<SSL_in_before>(SSL *ssl);
|
|
|
|
=item int B<SSL_in_connect_init>(SSL *ssl);
|
|
|
|
=item int B<SSL_in_init>(SSL *ssl);
|
|
|
|
=item int B<SSL_is_init_finished>(SSL *ssl);
|
|
|
|
=item STACK *B<SSL_load_client_CA_file>(char *file);
|
|
|
|
=item void B<SSL_load_error_strings>(void);
|
|
|
|
=item SSL *B<SSL_new>(SSL_CTX *ctx);
|
|
|
|
=item long B<SSL_num_renegotiations>(SSL *ssl);
|
|
|
|
=item int B<SSL_peek>(SSL *ssl, char *buf, int num);
|
|
|
|
=item int B<SSL_pending>(SSL *ssl);
|
|
|
|
=item int B<SSL_read>(SSL *ssl, char *buf, int num);
|
|
|
|
=item int B<SSL_renegotiate>(SSL *ssl);
|
|
|
|
=item char *B<SSL_rstate_string>(SSL *ssl);
|
|
|
|
=item char *B<SSL_rstate_string_long>(SSL *ssl);
|
|
|
|
=item long B<SSL_session_reused>(SSL *ssl);
|
|
|
|
=item void B<SSL_set_accept_state>(SSL *ssl);
|
|
|
|
=item void B<SSL_set_app_data>(SSL *ssl, char *arg);
|
|
|
|
=item void B<SSL_set_bio>(SSL *ssl, BIO *rbio, BIO *wbio);
|
|
|
|
=item int B<SSL_set_cipher_list>(SSL *ssl, char *str);
|
|
|
|
=item void B<SSL_set_client_CA_list>(SSL *ssl, STACK *list);
|
|
|
|
=item void B<SSL_set_connect_state>(SSL *ssl);
|
|
|
|
=item int B<SSL_set_ex_data>(SSL *ssl, int idx, char *arg);
|
|
|
|
=item int B<SSL_set_fd>(SSL *ssl, int fd);
|
|
|
|
=item void B<SSL_set_info_callback>(SSL *ssl, void (*cb);(void))
|
|
|
|
=item void B<SSL_set_options>(SSL *ssl, unsigned long op);
|
|
|
|
=item void B<SSL_set_quiet_shutdown>(SSL *ssl, int mode);
|
|
|
|
=item void B<SSL_set_read_ahead>(SSL *ssl, int yes);
|
|
|
|
=item int B<SSL_set_rfd>(SSL *ssl, int fd);
|
|
|
|
=item int B<SSL_set_session>(SSL *ssl, SSL_SESSION *session);
|
|
|
|
=item void B<SSL_set_shutdown>(SSL *ssl, int mode);
|
|
|
|
=item int B<SSL_set_ssl_method>(SSL *ssl, SSL_METHOD *meth);
|
|
|
|
=item void B<SSL_set_time>(SSL *ssl, long t);
|
|
|
|
=item void B<SSL_set_timeout>(SSL *ssl, long t);
|
|
|
|
=item void B<SSL_set_verify>(SSL *ssl, int mode, int (*callback);(void))
|
|
|
|
=item void B<SSL_set_verify_result>(SSL *ssl, long arg);
|
|
|
|
=item int B<SSL_set_wfd>(SSL *ssl, int fd);
|
|
|
|
=item int B<SSL_shutdown>(SSL *ssl);
|
|
|
|
=item int B<SSL_state>(SSL *ssl);
|
|
|
|
=item char *B<SSL_state_string>(SSL *ssl);
|
|
|
|
=item char *B<SSL_state_string_long>(SSL *ssl);
|
|
|
|
=item long B<SSL_total_renegotiations>(SSL *ssl);
|
|
|
|
=item int B<SSL_use_PrivateKey>(SSL *ssl, EVP_PKEY *pkey);
|
|
|
|
=item int B<SSL_use_PrivateKey_ASN1>(int type, SSL *ssl, unsigned char *d, long len);
|
|
|
|
=item int B<SSL_use_PrivateKey_file>(SSL *ssl, char *file, int type);
|
|
|
|
=item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);
|
|
|
|
=item int B<SSL_use_RSAPrivateKey_ASN1>(SSL *ssl, unsigned char *d, long len);
|
|
|
|
=item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, char *file, int type);
|
|
|
|
=item int B<SSL_use_certificate>(SSL *ssl, X509 *x);
|
|
|
|
=item int B<SSL_use_certificate_ASN1>(SSL *ssl, int len, unsigned char *d);
|
|
|
|
=item int B<SSL_use_certificate_file>(SSL *ssl, char *file, int type);
|
|
|
|
=item int B<SSL_version>(SSL *ssl);
|
|
|
|
=item int B<SSL_want>(SSL *ssl);
|
|
|
|
=item int B<SSL_want_nothing>(SSL *ssl);
|
|
|
|
=item int B<SSL_want_read>(SSL *ssl);
|
|
|
|
=item int B<SSL_want_write>(SSL *ssl);
|
|
|
|
=item int B<SSL_want_x509_lookup>(s);
|
|
|
|
=item int B<SSL_write>(SSL *ssl, char *buf, int num);
|
|
|
|
=item SSL_METHOD *B<SSLv2_client_method>(void);
|
|
|
|
=item SSL_METHOD *B<SSLv2_method>(void);
|
|
|
|
=item SSL_METHOD *B<SSLv2_server_method>(void);
|
|
|
|
=item SSL_METHOD *B<SSLv3_client_method>(void);
|
|
|
|
=item SSL_METHOD *B<SSLv3_method>(void);
|
|
|
|
=item SSL_METHOD *B<SSLv3_server_method>(void);
|
|
|
|
=item SSL_METHOD *B<TLSv1_client_method>(void);
|
|
|
|
=item SSL_METHOD *B<TLSv1_method>(void);
|
|
|
|
=item SSL_METHOD *B<TLSv1_server_method>(void);
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
openssl(1), crypto(3)
|
|
|
|
=head1 HISTORY
|
|
|
|
The ssl(3) document appeared in OpenSSL 0.9.2
|
|
|
|
=cut
|
|
|