X-Git-Url: https://git.openssl.org/?a=blobdiff_plain;f=doc%2Fssl%2Fssl.pod;h=421d50066da96f532c33c1a28831984b5a98dab5;hb=87d9cafa332bd006086b56dc645c03fe7cfed654;hp=1471e0312e521cb23f96dea9c951902e5c52de69;hpb=02b7ec88bb798326d2bdae41c549bebeabc8759f;p=openssl.git diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod index 1471e0312e..421d50066d 100644 --- a/doc/ssl/ssl.pod +++ b/doc/ssl/ssl.pod @@ -14,25 +14,25 @@ Transport Layer Security (TLS v1) protocols. It provides a rich API which is documented here. At first the library must be initialized; see -L. +L. Then an B object is created as a framework to establish -TLS/SSL enabled connections (see L). +TLS/SSL enabled connections (see L). Various options regarding certificates, algorithms etc. can be set in this object. When a network connection has been created, it can be assigned to an B object. After the B object has been created using -L, L or -L can be used to associate the network +L, L or +L can be used to associate the network connection with the object. Then the TLS/SSL handshake is performed using -L or L +L or L respectively. -L and L are used +L and L are used to read and write data on the TLS/SSL connection. -L can be used to shut down the +L can be used to shut down the TLS/SSL connection. =head1 DATA STRUCTURES @@ -45,8 +45,8 @@ structures: =item B (SSL Method) That's a dispatch structure describing the internal B library -methods/functions which implement the various protocol versions (SSLv1, SSLv2 -and TLSv1). It's needed to create an B. +methods/functions which implement the various protocol versions (SSLv3 +TLSv1, ...). It's needed to create an B. =item B (SSL Cipher) @@ -93,9 +93,7 @@ inside this header file. =item B -That's the sub header file dealing with the SSLv2 protocol only. -I. +Unused. Present for backwards compatibility only. =item B @@ -103,13 +101,6 @@ That's the sub header file dealing with the SSLv3 protocol only. I. -=item B - -That's the sub header file dealing with the combined use of the SSLv2 and -SSLv3 protocols. -I. - =item B That's the sub header file dealing with the TLSv1 protocol only. @@ -130,39 +121,27 @@ protocol methods defined in B structures. =over 4 -=item SSL_METHOD *B(void); - -Constructor for the SSLv2 SSL_METHOD structure for a dedicated client. - -=item SSL_METHOD *B(void); - -Constructor for the SSLv2 SSL_METHOD structure for a dedicated server. - -=item SSL_METHOD *B(void); - -Constructor for the SSLv2 SSL_METHOD structure for combined client and server. - -=item SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); Constructor for the SSLv3 SSL_METHOD structure for a dedicated client. -=item SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); Constructor for the SSLv3 SSL_METHOD structure for a dedicated server. -=item SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); Constructor for the SSLv3 SSL_METHOD structure for combined client and server. -=item SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); Constructor for the TLSv1 SSL_METHOD structure for a dedicated client. -=item SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); Constructor for the TLSv1 SSL_METHOD structure for a dedicated server. -=item SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); Constructor for the TLSv1 SSL_METHOD structure for combined client and server. @@ -189,12 +168,12 @@ I) and the bits which are actually used (the return value). =item const char *B(SSL_CIPHER *cipher); Return the internal name of I as a string. These are the various -strings defined by the I, I and I +strings defined by the I and I definitions in the header files. =item char *B(SSL_CIPHER *cipher); -Returns a string like "C" or "C" which indicates the +Returns a string like "C" or "C" which indicates the SSL/TLS protocol version to which I belongs (i.e. where it was defined in the specification the first time). @@ -213,7 +192,7 @@ protocol context defined in the B structure. =item int B(SSL_CTX *ctx, SSL_SESSION *c); -=item int B(SSL_CTX *ctx); +=item int B(const SSL_CTX *ctx); =item long B(SSL_CTX *ctx, int cmd, long larg, char *parg); @@ -225,23 +204,27 @@ protocol context defined in the B structure. =item X509_STORE *B(SSL_CTX *ctx); -=item STACK *B(SSL_CTX *ctx); +=item STACK *B(const SSL_CTX *ctx); =item int (*B(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey); -=item char *B(SSL_CTX *s, int idx); +=item void B(SSL_CTX *ctx); + +=item char *B(const SSL_CTX *s, int idx); =item int B(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void)) =item void (*B(SSL_CTX *ctx))(SSL *ssl, int cb, int ret); -=item int B(SSL_CTX *ctx); +=item int B(const SSL_CTX *ctx); + +=item void B(SSL_CTX *ctx); =item int B(SSL_CTX *ctx); -=item long B(SSL_CTX *ctx); +=item long B(const SSL_CTX *ctx); -=item int (*B(SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx); +=item int (*B(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx); =item int B(SSL_CTX *ctx); @@ -249,7 +232,7 @@ protocol context defined in the B structure. =item long B(SSL_CTX *ctx); -=item SSL_CTX *B(SSL_METHOD *meth); +=item SSL_CTX *B(const SSL_METHOD *meth); =item int B(SSL_CTX *ctx, SSL_SESSION *c); @@ -313,6 +296,17 @@ protocol context defined in the B structure. =item int B(SSL_CTX *ctx); +Use the default paths to locate trusted CA certificates. There is one default +directory path and one default file path. Both are set via this call. + +=item int B(SSL_CTX *ctx) + +Use the default directory path to locate trusted CA certficates. + +=item int B(SSL_CTX *ctx) + +Use the file path to locate trusted CA certficates. + =item int B(SSL_CTX *s, int idx, char *arg); =item void B(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret)); @@ -325,9 +319,11 @@ protocol context defined in the B structure. =item void B(SSL_CTX *ctx, int mode); +=item void B(SSL_CTX *ctx, int m); + =item void B(SSL_CTX *ctx, int mode); -=item int B(SSL_CTX *ctx, SSL_METHOD *meth); +=item int B(SSL_CTX *ctx, const SSL_METHOD *meth); =item void B(SSL_CTX *ctx, long t); @@ -351,7 +347,7 @@ appropriate size (using ???) and return it. long B(SSL *ssl, RSA *(*cb)(SSL *ssl, int export, int keylength)); -The same as L<"SSL_CTX_set_tmp_rsa_callback">, except it operates on an SSL +The same as B, except it operates on an SSL session instead of a context. =item void B(SSL_CTX *ctx, int mode, int (*cb);(void)) @@ -374,6 +370,19 @@ session instead of a context. =item int B(SSL_CTX *ctx, char *file, int type); +=item X509 *B(const SSL_CTX *ctx); + +=item EVP_PKEY *B(const SSL_CTX *ctx); + +=item void B(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)); + +=item int B(SSL_CTX *ctx, const char *hint); + +=item void B(SSL_CTX *ctx, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len)); + + + + =back =head2 DEALING WITH SESSIONS @@ -383,27 +392,27 @@ sessions defined in the B structures. =over 4 -=item int B(SSL_SESSION *a, SSL_SESSION *b); +=item int B(const SSL_SESSION *a, const SSL_SESSION *b); =item void B(SSL_SESSION *ss); =item char *B(SSL_SESSION *s); -=item char *B(SSL_SESSION *s, int idx); +=item char *B(const SSL_SESSION *s, int idx); =item int B(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void)) -=item long B(SSL_SESSION *s); +=item long B(const SSL_SESSION *s); -=item long B(SSL_SESSION *s); +=item long B(const SSL_SESSION *s); -=item unsigned long B(SSL_SESSION *a); +=item unsigned long B(const SSL_SESSION *a); =item SSL_SESSION *B(void); -=item int B(BIO *bp, SSL_SESSION *x); +=item int B(BIO *bp, const SSL_SESSION *x); -=item int B(FILE *fp, SSL_SESSION *x); +=item int B(FILE *fp, const SSL_SESSION *x); =item void B(SSL_SESSION *s, char *a); @@ -438,7 +447,7 @@ connection defined in the B structure. =item char *B(int value); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); =item void B(SSL *ssl); @@ -446,7 +455,10 @@ connection defined in the B structure. =item int B(SSL *ssl); -=item void B(SSL *t, SSL *f); +=item int B(SSL *t, const SSL *f); + +Sets the session details for B to be the same as in B. Returns 1 on +success or 0 on failure. =item long B(SSL *ssl, int cmd, long larg, char *parg); @@ -458,77 +470,77 @@ connection defined in the B structure. =item void B(SSL *ssl); -=item SSL_CTX *B(SSL *ssl); +=item SSL_CTX *B(const SSL *ssl); =item char *B(SSL *ssl); -=item X509 *B(SSL *ssl); +=item X509 *B(const SSL *ssl); -=item const char *B(SSL *ssl); +=item const char *B(const SSL *ssl); -=item int B(SSL *ssl, int *alg_bits); +=item int B(const SSL *ssl, int *alg_bits); -=item char *B(SSL *ssl, int n); +=item char *B(const SSL *ssl, int n); -=item char *B(SSL *ssl); +=item char *B(const SSL *ssl); -=item char *B(SSL *ssl); +=item char *B(const SSL *ssl); -=item STACK *B(SSL *ssl); +=item STACK *B(const SSL *ssl); -=item STACK *B(SSL *ssl); +=item STACK *B(const SSL *ssl); =item SSL_CIPHER *B(SSL *ssl); -=item long B(SSL *ssl); +=item long B(const SSL *ssl); -=item int B(SSL *ssl, int i); +=item int B(const SSL *ssl, int i); -=item char *B(SSL *ssl, int idx); +=item char *B(const SSL *ssl, int idx); =item int B(void); =item int B(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void)) -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item void (*B(SSL *ssl);)(void) +=item void (*B(const SSL *ssl);)() -=item STACK *B(SSL *ssl); +=item STACK *B(const SSL *ssl); -=item X509 *B(SSL *ssl); +=item X509 *B(const SSL *ssl); -=item EVP_PKEY *B(SSL *ssl); +=item EVP_PKEY *B(const SSL *ssl); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item BIO *B(SSL *ssl); +=item BIO *B(const SSL *ssl); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item SSL_SESSION *B(SSL *ssl); +=item SSL_SESSION *B(const SSL *ssl); -=item char *B(SSL *ssl, char *buf, int len); +=item char *B(const SSL *ssl, char *buf, int len); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item SSL_METHOD *B(SSL *ssl); +=item const SSL_METHOD *B(SSL *ssl); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item long B(SSL *ssl); +=item long B(const SSL *ssl); -=item long B(SSL *ssl); +=item long B(const SSL *ssl); -=item int (*B(SSL *ssl);)(void) +=item int (*B(const SSL *ssl))(int,X509_STORE_CTX *) -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item long B(SSL *ssl); +=item long B(const SSL *ssl); -=item char *B(SSL *ssl); +=item char *B(const SSL *ssl); -=item BIO *B(SSL *ssl); +=item BIO *B(const SSL *ssl); =item int B(SSL *ssl); @@ -550,7 +562,7 @@ connection defined in the B structure. =item int B(SSL *ssl, void *buf, int num); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); =item int B(SSL *ssl, void *buf, int num); @@ -596,7 +608,7 @@ connection defined in the B structure. =item void B(SSL *ssl, int mode); -=item int B(SSL *ssl, SSL_METHOD *meth); +=item int B(SSL *ssl, const SSL_METHOD *meth); =item void B(SSL *ssl, long t); @@ -610,11 +622,13 @@ connection defined in the B structure. =item int B(SSL *ssl); -=item int B(SSL *ssl); +=item OSSL_HANDSHAKE_STATE B(const SSL *ssl); + +Returns the current handshake state. -=item char *B(SSL *ssl); +=item char *B(const SSL *ssl); -=item char *B(SSL *ssl); +=item char *B(const SSL *ssl); =item long B(SSL *ssl); @@ -636,101 +650,120 @@ connection defined in the B structure. =item int B(SSL *ssl, char *file, int type); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item int B(SSL *ssl); +=item int B(const SSL *ssl); -=item int B(s); +=item int B(const SSL *ssl); =item int B(SSL *ssl, const void *buf, int num); +=item void B(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)); + +=item int B(SSL *ssl, const char *hint); + +=item void B(SSL *ssl, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len)); + +=item const char *B(SSL *ssl); + +=item const char *B(SSL *ssl); + =back =head1 SEE ALSO -L, L, -L, L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L +L, L, +L, L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L =head1 HISTORY -The L document appeared in OpenSSL 0.9.2 +B, B and B where removed +in OpenSSL 1.1.0. + +The return type of B was changed from void to int in +OpenSSL 1.1.0. =cut