diff options
author | Ulf Möller <ulf@openssl.org> | 2000-01-30 22:16:47 +0000 |
---|---|---|
committer | Ulf Möller <ulf@openssl.org> | 2000-01-30 22:16:47 +0000 |
commit | 74235cc9ec3123ee7f51211ea054632ca0cf7c91 (patch) | |
tree | 6a7ca2fe3814d00dd127a3170e40242ac7364e69 /doc/openssl.txt | |
parent | da0fc5bf0f25ee488838845a66f47b444f8c7b70 (diff) |
Update docs: corrections, turn buffer docs into manpage, fold SHA1
pages into one for improved readability, add lhash manpage
Diffstat (limited to 'doc/openssl.txt')
-rw-r--r-- | doc/openssl.txt | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/doc/openssl.txt b/doc/openssl.txt index 73272509c0..e92f9fd205 100644 --- a/doc/openssl.txt +++ b/doc/openssl.txt @@ -2,54 +2,6 @@ This is some preliminary documentation for OpenSSL. ============================================================================== - BUFFER Library -============================================================================== - -The buffer library handles simple character arrays. Buffers are used for -various purposes in the library, most notably memory BIOs. - -The library uses the BUF_MEM structure defined in buffer.h: - -typedef struct buf_mem_st -{ - int length; /* current number of bytes */ - char *data; - int max; /* size of buffer */ -} BUF_MEM; - -'length' is the current size of the buffer in bytes, 'max' is the amount of -memory allocated to the buffer. There are three functions which handle these -and one "miscellaneous" function. - -BUF_MEM *BUF_MEM_new() - -This allocates a new buffer of zero size. Returns the buffer or NULL on error. - -void BUF_MEM_free(BUF_MEM *a) - -This frees up an already existing buffer. The data is zeroed before freeing -up in case the buffer contains sensitive data. - -int BUF_MEM_grow(BUF_MEM *str, int len) - -This changes the size of an already existing buffer. It returns zero on error -or the new size (i.e. 'len'). Any data already in the buffer is preserved if -it increases in size. - -char * BUF_strdup(char *str) - -This is the previously mentioned strdup function: like the standard library -strdup() it copies a null terminated string into a block of allocated memory -and returns a pointer to the allocated block. - -Unlike the standard C library strdup() this function uses Malloc() and so -should be used in preference to the standard library strdup() because it can -be used for memory leak checking or replacing the malloc() function. - -The memory allocated from BUF_strdup() should be freed up using the Free() -function. - -============================================================================== OpenSSL X509V3 extension configuration ============================================================================== |