Fix errors found by new find-doc-nits
[openssl.git] / doc / man3 / X509_ALGOR_dup.pod
1 =pod
2
3 =head1 NAME
4
5 X509_ALGOR_dup, X509_ALGOR_set0, X509_ALGOR_get0, X509_ALGOR_set_md, X509_ALGOR_cmp - 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
18 =head1 DESCRIPTION
19
20 X509_ALGOR_dup() returns a copy of B<alg>.
21
22 X509_ALGOR_set0() sets the algorithm OID of B<alg> to B<aobj> and the
23 associated parameter type to B<ptype> with value B<pval>. If B<ptype> is
24 B<V_ASN1_UNDEF> the parameter is omitted, otherwise B<ptype> and B<pval> have
25 the same meaning as the B<type> and B<value> parameters to ASN1_TYPE_set().
26 All the supplied parameters are used internally so must B<NOT> be freed after
27 this call.
28
29 X509_ALGOR_get0() is the inverse of X509_ALGOR_set0(): it returns the
30 algorithm OID in B<*paobj> and the associated parameter in B<*pptype>
31 and B<*ppval> from the B<AlgorithmIdentifier> B<alg>.
32
33 X509_ALGOR_set_md() sets the B<AlgorithmIdentifier> B<alg> to appropriate
34 values for the message digest B<md>.
35
36 X509_ALGOR_cmp() compares B<a> and B<b> and returns 0 if they have identical
37 encodings and nonzero otherwise.
38
39 =head1 RETURN VALUES
40
41 X509_ALGOR_dup() returns a valid B<X509_ALGOR> structure or NULL if an error
42 occurred.
43
44 X509_ALGOR_set0() returns 1 on success or 0 on error.
45
46 X509_ALGOR_get0() and X509_ALGOR_set_md() return no values.
47
48 X509_ALGOR_cmp() returns 0 if the two parameters have identical encodings and
49 nonzero otherwise.
50
51 =head1 COPYRIGHT
52
53 Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
54
55 Licensed under the Apache License 2.0 (the "License").  You may not use
56 this file except in compliance with the License.  You can obtain a copy
57 in the file LICENSE in the source distribution or at
58 L<https://www.openssl.org/source/license.html>.
59
60 =cut