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