doc/man3/EVP_set_default_properties.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_set_default_properties
   6 - Set default properties for future algorithm fetches
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/evp.h>
  11
  12  int EVP_set_default_properties(OPENSSL_CTX *libctx, const char *propq);
  13
  14 =head1 DESCRIPTION
  15
  16 EVP_set_default_properties() sets the default properties for all
  17 future EVP algorithm fetches, implicit as well as explicit.
  18
  19 =for comment TODO(3.0) We should consider having an EVP document in
  20 section 7 that details everything about implicit vs explicit fetches
  21 and how they relate to properties.
  22
  23 EVP_set_default_properties stores the properties given with the string
  24 I<propq> among the EVP data that's been stored in the library context
  25 given with I<libctx> (NULL signifies the default library context).
  26
  27 Any previous default property for the specified library context will
  28 be dropped.
  29
  30 =head1 RETURN VALUES
  31
  32 EVP_set_default_properties() returns 1 on success, or 0 on failure.
  33 The latter adds an error on the error stack.
  34
  35 =head1 SEE ALSO
  36
  37 L<EVP_MD_fetch>
  38
  39 =head1 HISTORY
  40
  41 The functions described here were added in OpenSSL 3.0.
  42
  43 =head1 COPYRIGHT
  44
  45 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  46
  47 Licensed under the Apache License 2.0 (the "License").  You may not use
  48 this file except in compliance with the License.  You can obtain a copy
  49 in the file LICENSE in the source distribution or at
  50 L<https://www.openssl.org/source/license.html>.
  51
  52 =cut