X509_ALGOR_dup.pod 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. =pod
  2. =head1 NAME
  3. X509_ALGOR_dup, X509_ALGOR_set0, X509_ALGOR_get0, X509_ALGOR_set_md, X509_ALGOR_cmp - AlgorithmIdentifier functions
  4. =head1 SYNOPSIS
  5. #include <openssl/x509.h>
  6. X509_ALGOR *X509_ALGOR_dup(X509_ALGOR *alg);
  7. int X509_ALGOR_set0(X509_ALGOR *alg, ASN1_OBJECT *aobj, int ptype, void *pval);
  8. void X509_ALGOR_get0(const ASN1_OBJECT **paobj, int *pptype,
  9. const void **ppval, const X509_ALGOR *alg);
  10. void X509_ALGOR_set_md(X509_ALGOR *alg, const EVP_MD *md);
  11. int X509_ALGOR_cmp(const X509_ALGOR *a, const X509_ALGOR *b);
  12. =head1 DESCRIPTION
  13. X509_ALGOR_dup() returns a copy of B<alg>.
  14. X509_ALGOR_set0() sets the algorithm OID of B<alg> to B<aobj> and the
  15. associated parameter type to B<ptype> with value B<pval>. If B<ptype> is
  16. B<V_ASN1_UNDEF> the parameter is omitted, otherwise B<ptype> and B<pval> have
  17. the same meaning as the B<type> and B<value> parameters to ASN1_TYPE_set().
  18. All the supplied parameters are used internally so must B<NOT> be freed after
  19. this call.
  20. X509_ALGOR_get0() is the inverse of X509_ALGOR_set0(): it returns the
  21. algorithm OID in B<*paobj> and the associated parameter in B<*pptype>
  22. and B<*ppval> from the B<AlgorithmIdentifier> B<alg>.
  23. X509_ALGOR_set_md() sets the B<AlgorithmIdentifier> B<alg> to appropriate
  24. values for the message digest B<md>.
  25. X509_ALGOR_cmp() compares B<a> and B<b> and returns 0 if they have identical
  26. encodings and non-zero otherwise.
  27. =head1 RETURN VALUES
  28. X509_ALGOR_dup() returns a valid B<X509_ALGOR> structure or NULL if an error
  29. occurred.
  30. X509_ALGOR_set0() returns 1 on success or 0 on error.
  31. X509_ALGOR_get0() and X509_ALGOR_set_md() return no values.
  32. X509_ALGOR_cmp() returns 0 if the two parameters have identical encodings and
  33. non-zero otherwise.
  34. =head1 COPYRIGHT
  35. Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
  36. Licensed under the Apache License 2.0 (the "License"). You may not use
  37. this file except in compliance with the License. You can obtain a copy
  38. in the file LICENSE in the source distribution or at
  39. L<https://www.openssl.org/source/license.html>.
  40. =cut