diff options
author | Dr. Stephen Henson <steve@openssl.org> | 2015-05-12 02:05:17 +0100 |
---|---|---|
committer | Dr. Stephen Henson <steve@openssl.org> | 2015-05-12 02:09:49 +0100 |
commit | 253617806da0aeb0cea1fedf6136460fb4993eae (patch) | |
tree | 4ed843f95fcfaedbc3ff4b7a383ec36d65365432 /doc | |
parent | 75ebbd9aa411c5b8b19ded6ace2b34181566b56a (diff) |
Additional X509_ALGOR documentation
Reviewed-by: Tim Hudson <tjh@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/crypto/d2i_X509_ALGOR.pod | 33 |
1 files changed, 29 insertions, 4 deletions
diff --git a/doc/crypto/d2i_X509_ALGOR.pod b/doc/crypto/d2i_X509_ALGOR.pod index 272a1388f0..09849b53c8 100644 --- a/doc/crypto/d2i_X509_ALGOR.pod +++ b/doc/crypto/d2i_X509_ALGOR.pod @@ -2,7 +2,7 @@ =head1 NAME -d2i_X509_ALGOR, i2d_X509_ALGOR - AlgorithmIdentifier functions. +d2i_X509_ALGOR, i2d_X509_ALGOR, X509_ALGOR_dup, X509_ALGOR_set0, X509_ALGOR_get0, X509_ALGOR_set_md, X509_ALGOR_cmp - AlgorithmIdentifier functions. =head1 SYNOPSIS @@ -10,15 +10,40 @@ d2i_X509_ALGOR, i2d_X509_ALGOR - AlgorithmIdentifier functions. X509_ALGOR *d2i_X509_ALGOR(X509_ALGOR **a, unsigned char **pp, long length); int i2d_X509_ALGOR(X509_ALGOR *a, unsigned char **pp); + X509_ALGOR *X509_ALGOR_dup(X509_ALGOR *alg); + int X509_ALGOR_set0(X509_ALGOR *alg, ASN1_OBJECT *aobj, int ptype, void *pval); + void X509_ALGOR_get0(ASN1_OBJECT **paobj, int *pptype, void **ppval, + X509_ALGOR *alg); + void X509_ALGOR_set_md(X509_ALGOR *alg, const EVP_MD *md); + int X509_ALGOR_cmp(const X509_ALGOR *a, const X509_ALGOR *b); =head1 DESCRIPTION -These functions decode and encode an B<X509_ALGOR> structure which is -equivalent to the B<AlgorithmIdentifier> structure. +The functions d2i_X509() and i2d_X509() decode and encode an B<X509_ALGOR> +structure which is equivalent to the B<AlgorithmIdentifier> structure. -Otherwise these behave in a similar way to d2i_X509() and i2d_X509() +Otherwise they behave in a similar way to d2i_X509() and i2d_X509() described in the L<d2i_X509(3)|d2i_X509(3)> manual page. +X509_ALGOR_dup() returns a copy of B<alg>. + +X509_ALGOR_set0() sets the algorithm OID of B<alg> to B<aobj> and the +associated parameter type to B<ptype> with value B<pval>. If B<ptype> is +B<V_ASN1_UNDEF> the parameter is omitted, otherwise B<ptype> and B<pval> have +the same meaning as the B<type> and B<value> parameters to ASN1_TYPE_set(). +All the supplied parameters are used internally so must B<NOT> be freed after +this call. + +X509_ALGOR_get0() is the inverse of X509_ALGOR_set0(): it returns the +algorithm OID in B<*paobj> and the associated parameter in B<*pptype> +and B<*ppval> from the B<AlgorithmIdentifier> B<alg>. + +X509_ALGOR_set_md() sets the B<AlgorithmIdentifier> B<alg> to appropriate +values for the message digest B<md>. + +X509_ALGOR_cmp() compares B<a> and B<b> and returns 0 if they have identical +encodings and non-zero otherwise. + =head1 SEE ALSO L<d2i_X509(3)|d2i_X509(3)> |