summaryrefslogtreecommitdiff
path: root/src/lib/libssl/src/doc/ssleay.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libssl/src/doc/ssleay.txt')
-rw-r--r--src/lib/libssl/src/doc/ssleay.txt26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/lib/libssl/src/doc/ssleay.txt b/src/lib/libssl/src/doc/ssleay.txt
index a8b04d7059..4d2e714868 100644
--- a/src/lib/libssl/src/doc/ssleay.txt
+++ b/src/lib/libssl/src/doc/ssleay.txt
@@ -20,7 +20,7 @@ don't do that.
20==== readme ======================================================== 20==== readme ========================================================
21 21
22This is the old 0.6.6 docuementation. Most of the cipher stuff is still 22This is the old 0.6.6 docuementation. Most of the cipher stuff is still
23relevent but I'm working (very slowly) on new docuemtation. 23relevent but I'm working (very slowly) on new documentation.
24The current version can be found online at 24The current version can be found online at
25 25
26http://www.cryptsoft.com/ssleay/doc 26http://www.cryptsoft.com/ssleay/doc
@@ -548,8 +548,8 @@ application, ssleay. This one program is composed of many programs that
548can all be compiled independantly. 548can all be compiled independantly.
549 549
550ssleay has 3 modes of operation. 550ssleay has 3 modes of operation.
5511) If the ssleay binaray has the name of one of its component programs, it 5511) If the ssleay binary has the name of one of its component programs, it
552executes that program and then exits. This can be achieve by using hard or 552executes that program and then exits. This can be achieved by using hard or
553symbolic links, or failing that, just renaming the binary. 553symbolic links, or failing that, just renaming the binary.
5542) If the first argument to ssleay is the name of one of the component 5542) If the first argument to ssleay is the name of one of the component
555programs, that program runs that program and then exits. 555programs, that program runs that program and then exits.
@@ -1185,7 +1185,7 @@ typedef struct bio_st
1185 example is for BIO_s_sock(). A socket needs to be 1185 example is for BIO_s_sock(). A socket needs to be
1186 assigned to the BIO before it can be used. 1186 assigned to the BIO before it can be used.
1187- 'shutdown', this flag indicates if the underlying 1187- 'shutdown', this flag indicates if the underlying
1188 comunication primative being used should be closed/freed 1188 communication primitive being used should be closed/freed
1189 when the BIO is closed. 1189 when the BIO is closed.
1190- 'flags' is used to hold extra state. It is primarily used 1190- 'flags' is used to hold extra state. It is primarily used
1191 to hold information about why a non-blocking operation 1191 to hold information about why a non-blocking operation
@@ -1799,7 +1799,7 @@ int BN_set_word(BIGNUM *a, unsigned long w);
1799 1799
1800unsigned long BN_get_word(BIGNUM *a); 1800unsigned long BN_get_word(BIGNUM *a);
1801 Returns 'a' in an unsigned long. Not remarkably, often 'a' will 1801 Returns 'a' in an unsigned long. Not remarkably, often 'a' will
1802 be biger than a word, in which case 0xffffffffL is returned. 1802 be bigger than a word, in which case 0xffffffffL is returned.
1803 1803
1804Word Operations 1804Word Operations
1805These functions are much more efficient that the normal bignum arithmetic 1805These functions are much more efficient that the normal bignum arithmetic
@@ -2058,7 +2058,7 @@ Now you will notice that macros like
2058 PEM_ASN1_write((int (*)())i2d_X509,PEM_STRING_X509,fp, \ 2058 PEM_ASN1_write((int (*)())i2d_X509,PEM_STRING_X509,fp, \
2059 (char *)x, NULL,NULL,0,NULL) 2059 (char *)x, NULL,NULL,0,NULL)
2060Don't do encryption normally. If you want to PEM encrypt your X509 structure, 2060Don't do encryption normally. If you want to PEM encrypt your X509 structure,
2061either just call PEM_ASN1_write directly or just define you own 2061either just call PEM_ASN1_write directly or just define your own
2062macro variant. As you can see, this macro just sets all encryption related 2062macro variant. As you can see, this macro just sets all encryption related
2063parameters to NULL. 2063parameters to NULL.
2064 2064
@@ -5566,7 +5566,7 @@ These 2 functions create and destroy SSL_CTX structures
5566 5566
5567The SSL_CTX has a session_cache_mode which is by default, 5567The SSL_CTX has a session_cache_mode which is by default,
5568in SSL_SESS_CACHE_SERVER mode. What this means is that the library 5568in SSL_SESS_CACHE_SERVER mode. What this means is that the library
5569will automatically add new session-id's to the cache apon sucsessful 5569will automatically add new session-id's to the cache upon successful
5570SSL_accept() calls. 5570SSL_accept() calls.
5571If SSL_SESS_CACHE_CLIENT is set, then client certificates are also added 5571If SSL_SESS_CACHE_CLIENT is set, then client certificates are also added
5572to the cache. 5572to the cache.
@@ -5580,12 +5580,12 @@ SSL_SESS_NO_CACHE_BOTH - Either SSL_accept() or SSL_connect().
5580If SSL_SESS_CACHE_NO_AUTO_CLEAR is set, old timed out sessions are 5580If SSL_SESS_CACHE_NO_AUTO_CLEAR is set, old timed out sessions are
5581not automatically removed each 255, SSL_connect()s or SSL_accept()s. 5581not automatically removed each 255, SSL_connect()s or SSL_accept()s.
5582 5582
5583By default, apon every 255 successful SSL_connect() or SSL_accept()s, 5583By default, upon every 255 successful SSL_connect() or SSL_accept()s,
5584the cache is flush. Please note that this could be expensive on 5584the cache is flush. Please note that this could be expensive on
5585a heavily loaded SSL server, in which case, turn this off and 5585a heavily loaded SSL server, in which case, turn this off and
5586clear the cache of old entries 'manually' (with one of the functions 5586clear the cache of old entries 'manually' (with one of the functions
5587listed below) every few hours. Perhaps I should up this number, it is hard 5587listed below) every few hours. Perhaps I should up this number, it is hard
5588to say. Remember, the '255' new calls is just a mechanims to get called 5588to say. Remember, the '255' new calls is just a mechanism to get called
5589every now and then, in theory at most 255 new session-id's will have been 5589every now and then, in theory at most 255 new session-id's will have been
5590added but if 100 are added every minute, you would still have 5590added but if 100 are added every minute, you would still have
5591500 in the cache before any would start being flushed (assuming a 3 minute 5591500 in the cache before any would start being flushed (assuming a 3 minute
@@ -5628,10 +5628,10 @@ if copy is 1. Otherwise, the reference count is not modified.
5628void SSL_CTX_sess_set_get_cb(ctx,cb) sets the callback and 5628void SSL_CTX_sess_set_get_cb(ctx,cb) sets the callback and
5629int (*cb)()SSL_CTX_sess_get_get_cb(ctx) returns the callback. 5629int (*cb)()SSL_CTX_sess_get_get_cb(ctx) returns the callback.
5630 5630
5631These callbacks are basically indended to be used by processes to 5631These callbacks are basically intended to be used by processes to
5632send their session-id's to other processes. I currently have not implemented 5632send their session-id's to other processes. I currently have not implemented
5633non-blocking semantics for these callbacks, it is upto the appication 5633non-blocking semantics for these callbacks, it is upto the application
5634to make the callbacks effiecent if they require blocking (perhaps 5634to make the callbacks efficient if they require blocking (perhaps
5635by 'saving' them and then 'posting them' when control returns from 5635by 'saving' them and then 'posting them' when control returns from
5636the SSL_accept(). 5636the SSL_accept().
5637 5637
@@ -6589,7 +6589,7 @@ This information can be used to recall the functions when the 'error'
6589condition has dissapeared. 6589condition has dissapeared.
6590 6590
6591After the connection has been made, information can be retrived about the 6591After the connection has been made, information can be retrived about the
6592SSL session and the session-id values that have been decided apon. 6592SSL session and the session-id values that have been decided upon.
6593The 'peer' certificate can be retrieved. 6593The 'peer' certificate can be retrieved.
6594 6594
6595The session-id values include 6595The session-id values include