From fcc6c7199b9dd36d09440700de2e58c6a2484bb1 Mon Sep 17 00:00:00 2001 From: "Ralf S. Engelschall" Date: Thu, 31 Dec 1998 10:33:17 +0000 Subject: Puhhh... now we've documented the prototypes of all 214 API "functions". This 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... --- doc/ssl.pod | 302 +++++++++++++++++++++++++----------------------------------- 1 file changed, 127 insertions(+), 175 deletions(-) (limited to 'doc') diff --git a/doc/ssl.pod b/doc/ssl.pod index 558d0b5bbd..d992117ffc 100644 --- a/doc/ssl.pod +++ b/doc/ssl.pod @@ -52,25 +52,11 @@ a server or client per established connection. =head1 FUNCTIONS -Currently the OpenSSL B library exports 143 API functions. +Currently the OpenSSL B library exports 214 API functions. They are documented in the following: =over 4 -=item [MACRO] B(SSL_kEDH|SSL_aNULL); - -=item [MACRO] B(SSL_ST_ACCEPT|SSL_CB_EXIT); - -=item [MACRO] B(SSL_ST_ACCEPT|SSL_CB_LOOP); - -=item [MACRO] B(SSL_ST_CONNECT|SSL_CB_EXIT); - -=item [MACRO] B(SSL_ST_CONNECT|SSL_CB_LOOP); - -=item [MACRO] B(SSL_CB_ALERT|SSL_CB_READ); - -=item [MACRO] B(SSL_CB_ALERT|SSL_CB_WRITE); - =item char *B(SSL_CIPHER *cipher, char *buf, int len); =item int B(SSL_CIPHER *c, int *alg_bits); @@ -81,7 +67,7 @@ They are documented in the following: =item int B(SSL_CTX *ctx, X509 *x); -=item [MACRO] B(ctx,x509); +=item long B(SSL_CTX *ctx, X509 *x509); =item int B(SSL_CTX *ctx, SSL_SESSION *c); @@ -93,123 +79,119 @@ They are documented in the following: =item void B(SSL_CTX *a); -=item [MACRO] B(ctx); +=item char *B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item X509_STORE *B(SSL_CTX *ctx); =item STACK *B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int (*B(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey); =item char *B(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 [MACRO] B(ctx); +=item void (*B(SSL_CTX *ctx))(SSL *ssl, int cb, int ret); =item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item long B(SSL_CTX *ctx); -=item int (*B(SSL_CTX *ctx);)(void) +=item int (*B(SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx); =item int B(SSL_CTX *ctx); =item int B(SSL_CTX *ctx, char *CAfile, char *CApath); -=item [MACRO] B(ctx); +=item long B(SSL_CTX *ctx); =item SSL_CTX *B(SSL_METHOD *meth); =item int B(SSL_CTX *ctx, SSL_SESSION *c); -=item [MACRO] B(ctx); - -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item SSL_SESSION *(*B(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy); -=item [MACRO] B(ctx); +=item int (*B(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess); -=item [MACRO] B(ctx); +=item void (*B(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx,t); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx,cb); +=item void B(SSL_CTX *ctx,t); -=item [MACRO] B(ctx,cb); +=item void B(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy)); -=item [MACRO] B(ctx,cb); +=item void B(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess)); -=item [MACRO] B(ctx); +=item void B(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess)); -=item [MACRO] B(ctx); +=item int B(SSL_CTX *ctx); -=item [MACRO] B(ctx,arg); +=item LHASH *B(SSL_CTX *ctx); -=item [MACRO] B(ctx,cs); +=item void B(SSL_CTX *ctx, void *arg); -=item [MACRO] B(a,b,c); +=item void B(SSL_CTX *ctx, X509_STORE *cs); -=item void B(SSL_CTX *ctx, int (*cb);(void), char *arg) +=item void B(SSL_CTX *ctx, int (*cb)(SSL_CTX *), char *arg) =item int B(SSL_CTX *ctx, char *str); =item void B(SSL_CTX *ctx, STACK *list); -=item [MACRO] B(ctx,cb); +=item void B(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey)); =item void B(SSL_CTX *ctx, int (*cb);(void)) -=item [MACRO] B(ctx,m); - -=item [MACRO] B(a,b,c); +=item void B(SSL_CTX *ctx, int m); =item int B(SSL_CTX *ctx); =item int B(SSL_CTX *s, int idx, char *arg); -=item [MACRO] B(ctx,cb); +=item void B(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret)); -=item [MACRO] B(ctx,op); +=item void B(SSL_CTX *ctx, unsigned long op); =item void B(SSL_CTX *ctx, int mode); -=item [MACRO] B(ctx,m); +=item void B(SSL_CTX *ctx, int mode); =item int B(SSL_CTX *ctx, SSL_METHOD *meth); -=item [MACRO] B(ctx,t); +=item void B(SSL_CTX *ctx, long t); -=item [MACRO] B(ctx,dh); +=item long B(SSL_CTX* ctx, DH *dh); -=item [MACRO] B(ctx,dh); +=item long B(SSL_CTX *ctx, DH *(*cb)(void)); -=item [MACRO] B(ctx,rsa); +=item long B(SSL_CTX *ctx, RSA *rsa); -=item [MACRO] B(ctx,cb); +=item long B(SSL_CTX *ctx, RSA *(*cb)(void)); =item void B(SSL_CTX *ctx, int mode, int (*cb);(void)) @@ -231,25 +213,11 @@ They are documented in the following: =item int B(SSL_CTX *ctx, char *file, int type); -=item [MACRO] B(SSL_kDHr|SSL_kDHd|SSL_kEDH); - -=item [MACRO] B(SSL_kEDH|(SSL_AUTH_MASK^SSL_aNULL); - -=item [MACRO] B(SSL_aFZA|SSL_kFZA|SSL_eFZA); - -=item [MACRO] B(512/8); - -=item [MACRO] B(SSL_eNULL); - -=item [MACRO] B(SSL_kRSA|SSL_aRSA); - -=item [MACRO] B(1024*20); - =item int B(SSL_SESSION *a, SSL_SESSION *b); =item void B(SSL_SESSION *ss); -=item [MACRO] B(s); +=item char *B(SSL_SESSION *s); =item char *B(SSL_SESSION *s, int idx); @@ -267,7 +235,7 @@ They are documented in the following: =item int B(FILE *fp, SSL_SESSION *x); -=item [MACRO] B(s,a); +=item void B(SSL_SESSION *s, char *a); =item int B(SSL_SESSION *s, int idx, char *arg); @@ -275,20 +243,10 @@ They are documented in the following: =item long B(SSL_SESSION *s, long t); -=item [MACRO] B(SSL_SESS_CACHE_CLIENT|SSL_SESS_CACHE_SERVER); - -=item [MACRO] B(SSL_SHA1); - -=item [MACRO] B(SSL_ST_CONNECT|SSL_ST_ACCEPT); - -=item [MACRO] B(0x04|SSL_ST_INIT); - -=item int B(SSL *s); +=item int B(SSL *ssl); =item int B(SSL *ssl, X509 *x); -=item [MACRO] B(a,b); - =item char *B(int value); =item char *B(int value); @@ -299,107 +257,105 @@ They are documented in the following: =item int B(SSL *ssl); -=item void B(SSL *s); +=item void B(SSL *ssl); -=item [MACRO] B(ssl); +=item long B(SSL *ssl); -=item int B(SSL *s); +=item int B(SSL *ssl); =item void B(SSL *t, SSL *f); -=item long B(SSL *s, int cmd, long larg, char *parg); +=item long B(SSL *ssl, int cmd, long larg, char *parg); -=item int B(SSL *s); +=item int B(SSL *ssl); -=item SSL *B(SSL *s); +=item SSL *B(SSL *ssl); =item STACK *B(STACK *sk); -=item [MACRO] B(a,b); - -=item void B(SSL *s); +=item void B(SSL *ssl); =item SSL_CTX *B(SSL *ssl); -=item [MACRO] B(s); +=item char *B(SSL *ssl); -=item X509 *B(SSL *s); +=item X509 *B(SSL *ssl); -=item [MACRO] B(s); +=item SSL_CIPHER *B(SSL *ssl); -=item [MACRO] B(s,np); +=item int B(SSL *ssl, int *alg_bits); -=item char *B(SSL *s, int n); +=item char *B(SSL *ssl, int n); -=item [MACRO] B(s); +=item char *B(SSL *ssl); -=item [MACRO] B(s); +=item char *B(SSL *ssl); -=item STACK *B(SSL *s); +=item STACK *B(SSL *ssl); -=item STACK *B(SSL *s); +=item STACK *B(SSL *ssl); -=item SSL_CIPHER *B(SSL *s); +=item SSL_CIPHER *B(SSL *ssl); -=item long B(SSL *s); +=item long B(SSL *ssl); -=item int B(SSL *s, int i); +=item int B(SSL *ssl, int i); -=item char *B(SSL *s, int idx); +=item char *B(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 *s); +=item int B(SSL *ssl); =item void (*B(SSL *ssl);)(void) -=item STACK *B(SSL *s); +=item STACK *B(SSL *ssl); -=item X509 *B(SSL *s); +=item X509 *B(SSL *ssl); -=item EVP_PKEY *B(SSL *s); +=item EVP_PKEY *B(SSL *ssl); -=item int B(SSL *s); +=item int B(SSL *ssl); -=item BIO *B(SSL *s); +=item BIO *B(SSL *ssl); -=item int B(SSL *s); +=item int B(SSL *ssl); =item SSL_SESSION *B(SSL *ssl); -=item char *B(SSL *s, char *buf, int len); +=item char *B(SSL *ssl, char *buf, int len); -=item int B(SSL *s); +=item int B(SSL *ssl); -=item SSL_METHOD *B(SSL *s); +=item SSL_METHOD *B(SSL *ssl); -=item [MACRO] B(a); +=item int B(SSL *ssl); -=item [MACRO] B(a); +=item long B(SSL *ssl); -=item [MACRO] B(a); +=item long B(SSL *ssl); -=item int (*B(SSL *s);)(void) +=item int (*B(SSL *ssl);)(void) -=item int B(SSL *s); +=item int B(SSL *ssl); =item long B(SSL *ssl); -=item char *B(SSL *s); +=item char *B(SSL *ssl); -=item BIO *B(SSL *s); +=item BIO *B(SSL *ssl); -=item [MACRO] B(a); +=item int B(SSL *ssl); -=item [MACRO] B(a); +=item int B(SSL *ssl); -=item [MACRO] B(a); +=item int B(SSL *ssl); -=item [MACRO] B(a); +=item int B(SSL *ssl); -=item [MACRO] B(a); +=item int B(SSL *ssl); =item STACK *B(char *file); @@ -407,77 +363,73 @@ They are documented in the following: =item SSL *B(SSL_CTX *ctx); -=item [MACRO] B(ssl); - -=item int B(SSL *s, char *buf, int num); +=item long B(SSL *ssl); -=item int B(SSL *s); +=item int B(SSL *ssl, char *buf, int num); -=item int B(SSL *s, char *buf, int num); +=item int B(SSL *ssl); -=item [MACRO] B(a,b); +=item int B(SSL *ssl, char *buf, int num); -=item int B(SSL *s); +=item int B(SSL *ssl); -=item char *B(SSL *s); +=item char *B(SSL *ssl); -=item char *B(SSL *s); +=item char *B(SSL *ssl); -=item [MACRO] B(ssl); +=item long B(SSL *ssl); -=item void B(SSL *s); +=item void B(SSL *ssl); -=item [MACRO] B(s,arg); +=item void B(SSL *ssl, char *arg); -=item void B(SSL *s, BIO *rbio, BIO *wbio); +=item void B(SSL *ssl, BIO *rbio, BIO *wbio); -=item int B(SSL *s, char *str); +=item int B(SSL *ssl, char *str); -=item void B(SSL *s, STACK *list); +=item void B(SSL *ssl, STACK *list); -=item void B(SSL *s); +=item void B(SSL *ssl); -=item int B(SSL *s, int idx, char *arg); +=item int B(SSL *ssl, int idx, char *arg); -=item int B(SSL *s, int fd); +=item int B(SSL *ssl, int fd); =item void B(SSL *ssl, void (*cb);(void)) -=item [MACRO] B(ssl,op); - -=item [MACRO] B(c,n); +=item void B(SSL *ssl, unsigned long op); -=item void B(SSL *s, int mode); +=item void B(SSL *ssl, int mode); -=item void B(SSL *s, int yes); +=item void B(SSL *ssl, int yes); -=item int B(SSL *s, int fd); +=item int B(SSL *ssl, int fd); -=item int B(SSL *s, SSL_SESSION *session); +=item int B(SSL *ssl, SSL_SESSION *session); -=item void B(SSL *s, int mode); +=item void B(SSL *ssl, int mode); -=item int B(SSL *s, SSL_METHOD *meth); +=item int B(SSL *ssl, SSL_METHOD *meth); -=item [MACRO] B(a,b); +=item void B(SSL *ssl, long t); -=item [MACRO] B(a,b); +=item void B(SSL *ssl, long t); -=item void B(SSL *s, int mode, int (*callback);(void)) +=item void B(SSL *ssl, int mode, int (*callback);(void)) =item void B(SSL *ssl, long arg); -=item int B(SSL *s, int fd); +=item int B(SSL *ssl, int fd); -=item int B(SSL *s); +=item int B(SSL *ssl); =item int B(SSL *ssl); -=item char *B(SSL *s); +=item char *B(SSL *ssl); -=item char *B(SSL *s); +=item char *B(SSL *ssl); -=item [MACRO] B(ssl); +=item long B(SSL *ssl); =item int B(SSL *ssl, EVP_PKEY *pkey); @@ -497,19 +449,19 @@ They are documented in the following: =item int B(SSL *ssl, char *file, int type); -=item int B(SSL *s); +=item int B(SSL *ssl); -=item [MACRO] B(s); +=item int B(SSL *ssl); -=item [MACRO] B(s); +=item int B(SSL *ssl); -=item [MACRO] B(s); +=item int B(SSL *ssl); -=item [MACRO] B(s); +=item int B(SSL *ssl); -=item [MACRO] B(s); +=item int B(s); -=item int B(SSL *s, char *buf, int num); +=item int B(SSL *ssl, char *buf, int num); =item SSL_METHOD *B(void); -- cgit v1.2.3