| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | X509_ALGOR_dup,
|
|---|
| 6 | X509_ALGOR_set0, X509_ALGOR_get0,
|
|---|
| 7 | X509_ALGOR_set_md, X509_ALGOR_cmp,
|
|---|
| 8 | X509_ALGOR_copy - AlgorithmIdentifier functions
|
|---|
| 9 |
|
|---|
| 10 | =head1 SYNOPSIS
|
|---|
| 11 |
|
|---|
| 12 | #include <openssl/x509.h>
|
|---|
| 13 |
|
|---|
| 14 | X509_ALGOR *X509_ALGOR_dup(X509_ALGOR *alg);
|
|---|
| 15 | int X509_ALGOR_set0(X509_ALGOR *alg, ASN1_OBJECT *aobj, int ptype, void *pval);
|
|---|
| 16 | void X509_ALGOR_get0(const ASN1_OBJECT **paobj, int *pptype,
|
|---|
| 17 | const void **ppval, const X509_ALGOR *alg);
|
|---|
| 18 | void X509_ALGOR_set_md(X509_ALGOR *alg, const EVP_MD *md);
|
|---|
| 19 | int X509_ALGOR_cmp(const X509_ALGOR *a, const X509_ALGOR *b);
|
|---|
| 20 | int X509_ALGOR_copy(X509_ALGOR *dest, const X509_ALGOR *src);
|
|---|
| 21 |
|
|---|
| 22 | =head1 DESCRIPTION
|
|---|
| 23 |
|
|---|
| 24 | X509_ALGOR_dup() returns a copy of I<alg>.
|
|---|
| 25 |
|
|---|
| 26 | X509_ALGOR_set0() sets the algorithm OID of I<alg> to I<aobj> and the
|
|---|
| 27 | associated parameter type to I<ptype> with value I<pval>. If I<ptype> is
|
|---|
| 28 | B<V_ASN1_UNDEF> the parameter is omitted, otherwise I<ptype> and I<pval> have
|
|---|
| 29 | the same meaning as the I<type> and I<value> parameters to ASN1_TYPE_set().
|
|---|
| 30 | All the supplied parameters are used internally so must B<NOT> be freed after
|
|---|
| 31 | this call succeeded;
|
|---|
| 32 | otherwise ownership remains with the caller and I<alg> remains untouched.
|
|---|
| 33 |
|
|---|
| 34 | X509_ALGOR_get0() is the inverse of X509_ALGOR_set0(): it returns the
|
|---|
| 35 | algorithm OID in I<*paobj> and the associated parameter in I<*pptype>
|
|---|
| 36 | and I<*ppval> from the B<AlgorithmIdentifier> I<alg>.
|
|---|
| 37 |
|
|---|
| 38 | X509_ALGOR_set_md() sets the B<AlgorithmIdentifier> I<alg> to appropriate
|
|---|
| 39 | values for the message digest I<md>.
|
|---|
| 40 |
|
|---|
| 41 | X509_ALGOR_cmp() compares I<a> and I<b> and returns 0 if they have identical
|
|---|
| 42 | encodings and nonzero otherwise.
|
|---|
| 43 |
|
|---|
| 44 | X509_ALGOR_copy() copies the source values into the dest structs; making
|
|---|
| 45 | a duplicate of each (and free any thing pointed to from within *dest).
|
|---|
| 46 |
|
|---|
| 47 | =head1 RETURN VALUES
|
|---|
| 48 |
|
|---|
| 49 | X509_ALGOR_dup() returns a valid B<X509_ALGOR> structure or NULL if an error
|
|---|
| 50 | occurred.
|
|---|
| 51 |
|
|---|
| 52 | X509_ALGOR_set0() and X509_ALGOR_copy() return 1 on success or 0 on error.
|
|---|
| 53 |
|
|---|
| 54 | X509_ALGOR_get0() and X509_ALGOR_set_md() return no values.
|
|---|
| 55 |
|
|---|
| 56 | X509_ALGOR_cmp() returns 0 if the two parameters have identical encodings and
|
|---|
| 57 | nonzero otherwise.
|
|---|
| 58 |
|
|---|
| 59 | =head1 HISTORY
|
|---|
| 60 |
|
|---|
| 61 | The X509_ALGOR_copy() was added in 1.1.1e.
|
|---|
| 62 |
|
|---|
| 63 | =head1 COPYRIGHT
|
|---|
| 64 |
|
|---|
| 65 | Copyright 2002-2022 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 66 |
|
|---|
| 67 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 68 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 69 | in the file LICENSE in the source distribution or at
|
|---|
| 70 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 71 |
|
|---|
| 72 | =cut
|
|---|
