diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_ex_new_index.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_get_ex_new_index.3 | 76 |
1 files changed, 0 insertions, 76 deletions
diff --git a/src/lib/libssl/doc/SSL_get_ex_new_index.3 b/src/lib/libssl/doc/SSL_get_ex_new_index.3 deleted file mode 100644 index d4613a6210..0000000000 --- a/src/lib/libssl/doc/SSL_get_ex_new_index.3 +++ /dev/null | |||
| @@ -1,76 +0,0 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_get_ex_new_index.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: December 2 2014 $ | ||
| 5 | .Dt SSL_GET_EX_NEW_INDEX 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_get_ex_new_index , | ||
| 9 | .Nm SSL_set_ex_data , | ||
| 10 | .Nm SSL_get_ex_data | ||
| 11 | .Nd internal application specific data functions | ||
| 12 | .Sh SYNOPSIS | ||
| 13 | .In openssl/ssl.h | ||
| 14 | .Ft int | ||
| 15 | .Fo SSL_get_ex_new_index | ||
| 16 | .Fa "long argl" | ||
| 17 | .Fa "void *argp" | ||
| 18 | .Fa "CRYPTO_EX_new *new_func" | ||
| 19 | .Fa "CRYPTO_EX_dup *dup_func" | ||
| 20 | .Fa "CRYPTO_EX_free *free_func" | ||
| 21 | .Fc | ||
| 22 | .Ft int | ||
| 23 | .Fn SSL_set_ex_data "SSL *ssl" "int idx" "void *arg" | ||
| 24 | .Ft void * | ||
| 25 | .Fn SSL_get_ex_data "const SSL *ssl" "int idx" | ||
| 26 | .Bd -literal | ||
| 27 | typedef int new_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad, | ||
| 28 | int idx, long argl, void *argp); | ||
| 29 | typedef void free_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad, | ||
| 30 | int idx, long argl, void *argp); | ||
| 31 | typedef int dup_func(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, | ||
| 32 | int idx, long argl, void *argp); | ||
| 33 | .Ed | ||
| 34 | .Sh DESCRIPTION | ||
| 35 | Several OpenSSL structures can have application specific data attached to them. | ||
| 36 | These functions are used internally by OpenSSL to manipulate application | ||
| 37 | specific data attached to a specific structure. | ||
| 38 | .Pp | ||
| 39 | .Fn SSL_get_ex_new_index | ||
| 40 | is used to register a new index for application specific data. | ||
| 41 | .Pp | ||
| 42 | .Fn SSL_set_ex_data | ||
| 43 | is used to store application data at | ||
| 44 | .Fa arg | ||
| 45 | for | ||
| 46 | .Fa idx | ||
| 47 | into the | ||
| 48 | .Fa ssl | ||
| 49 | object. | ||
| 50 | .Pp | ||
| 51 | .Fn SSL_get_ex_data | ||
| 52 | is used to retrieve the information for | ||
| 53 | .Fa idx | ||
| 54 | from | ||
| 55 | .Fa ssl . | ||
| 56 | .Pp | ||
| 57 | A detailed description for the | ||
| 58 | .Fn *_get_ex_new_index | ||
| 59 | functionality can be found in | ||
| 60 | .Xr RSA_get_ex_new_index 3 . | ||
| 61 | The | ||
| 62 | .Fn *_get_ex_data | ||
| 63 | and | ||
| 64 | .Fn *_set_ex_data | ||
| 65 | functionality is described in | ||
| 66 | .Xr CRYPTO_set_ex_data 3 . | ||
| 67 | .Sh EXAMPLES | ||
| 68 | An example of how to use the functionality is included in the example | ||
| 69 | .Fn verify_callback | ||
| 70 | in | ||
| 71 | .Xr SSL_CTX_set_verify 3 . | ||
| 72 | .Sh SEE ALSO | ||
| 73 | .Xr CRYPTO_set_ex_data 3 , | ||
| 74 | .Xr RSA_get_ex_new_index 3 , | ||
| 75 | .Xr ssl 3 , | ||
| 76 | .Xr SSL_CTX_set_verify 3 | ||
