2
0

SSL_get_ex_new_index.pod 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. =pod
  2. =head1 NAME
  3. SSL_get_ex_new_index, SSL_set_ex_data, SSL_get_ex_data - internal application specific data functions
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. int SSL_get_ex_new_index(long argl, void *argp,
  7. CRYPTO_EX_new *new_func,
  8. CRYPTO_EX_dup *dup_func,
  9. CRYPTO_EX_free *free_func);
  10. int SSL_set_ex_data(SSL *ssl, int idx, void *arg);
  11. void *SSL_get_ex_data(const SSL *ssl, int idx);
  12. typedef int new_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
  13. int idx, long argl, void *argp);
  14. typedef void free_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
  15. int idx, long argl, void *argp);
  16. typedef int dup_func(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
  17. int idx, long argl, void *argp);
  18. =head1 DESCRIPTION
  19. Several OpenSSL structures can have application specific data attached to them.
  20. These functions are used internally by OpenSSL to manipulate application
  21. specific data attached to a specific structure.
  22. SSL_get_ex_new_index() is used to register a new index for application
  23. specific data.
  24. SSL_set_ex_data() is used to store application data at B<arg> for B<idx> into
  25. the B<ssl> object.
  26. SSL_get_ex_data() is used to retrieve the information for B<idx> from
  27. B<ssl>.
  28. A detailed description for the B<*_get_ex_new_index()> functionality
  29. can be found in L<RSA_get_ex_new_index(3)|RSA_get_ex_new_index(3)>.
  30. The B<*_get_ex_data()> and B<*_set_ex_data()> functionality is described in
  31. L<CRYPTO_set_ex_data(3)|CRYPTO_set_ex_data(3)>.
  32. =head1 EXAMPLES
  33. An example on how to use the functionality is included in the example
  34. verify_callback() in L<SSL_CTX_set_verify(3)|SSL_CTX_set_verify(3)>.
  35. =head1 SEE ALSO
  36. L<ssl(3)|ssl(3)>,
  37. L<RSA_get_ex_new_index(3)|RSA_get_ex_new_index(3)>,
  38. L<CRYPTO_set_ex_data(3)|CRYPTO_set_ex_data(3)>,
  39. L<SSL_CTX_set_verify(3)|SSL_CTX_set_verify(3)>
  40. =cut