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