ossl_global_properties_no_mirrored.pod 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. =pod
  2. =head1 NAME
  3. ossl_property_list_to_string, ossl_global_properties_no_mirrored
  4. - internal property routines
  5. =head1 SYNOPSIS
  6. #include "internal/property.h"
  7. size_t ossl_property_list_to_string(OSSL_LIB_CTX *ctx,
  8. const OSSL_PROPERTY_LIST *list, char *buf,
  9. size_t bufsize);
  10. int ossl_global_properties_no_mirrored(OSSL_LIB_CTX *libctx);
  11. void ossl_global_properties_no_mirrored(OSSL_LIB_CTX *libctx);
  12. =head1 DESCRIPTION
  13. ossl_property_list_to_string() takes a given OSSL_PROPERTY_LIST in I<list> and
  14. converts it to a string. If I<buf> is non NULL then the string will be stored
  15. in I<buf>. The size of the buffer is provided in I<bufsize>. If I<bufsize> is
  16. too short then the string will be truncated. If I<buf> is NULL then the length
  17. of the string is still calculated and returned. If the property list has no
  18. properties in it then the empty string will be stored in I<buf>.
  19. ossl_global_properties_no_mirrored() checks whether mirroring of global
  20. properties from a parent library context is allowed for the current library
  21. context.
  22. ossl_global_properties_no_mirrored() prevents future mirroring of global
  23. properties from a parent library context for the current library context.
  24. =head1 RETURN VALUES
  25. ossl_property_list_to_string() returns the length of the string, or 0 on error.
  26. ossl_global_properties_no_mirrored() returns 1 if mirroring of global properties
  27. is not allowed, or 0 otherwise.
  28. =head1 HISTORY
  29. The functions described here were all added in OpenSSL 3.0.
  30. =head1 COPYRIGHT
  31. Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  32. Licensed under the Apache License 2.0 (the "License"). You may not use
  33. this file except in compliance with the License. You can obtain a copy
  34. in the file LICENSE in the source distribution or at
  35. L<https://www.openssl.org/source/license.html>.
  36. =cut