aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDr. Stephen Henson <steve@openssl.org>2016-08-17 17:27:05 +0100
committerDr. Stephen Henson <steve@openssl.org>2016-08-17 17:48:43 +0100
commit59b4da05b4072df79e85b5f8bbf4cf049431b9b6 (patch)
tree155db4d78c61608b24d072f6a925b9031e3c98db /doc
parentd6073e27ebdbab63bf0add13fa0f66dcaa6e39e8 (diff)
downloadopenssl-59b4da05b4072df79e85b5f8bbf4cf049431b9b6.tar.gz
Constify X509_SIG.
Constify X509_SIG_get0() and order arguments to mactch new standard. Add X509_SIG_get0_mutable() to support modification or initialisation of an X509_SIG structure. Reviewed-by: Matt Caswell <matt@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/X509_SIG_get0.pod12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/crypto/X509_SIG_get0.pod b/doc/crypto/X509_SIG_get0.pod
index 1d61497c1c..a47ae448cc 100644
--- a/doc/crypto/X509_SIG_get0.pod
+++ b/doc/crypto/X509_SIG_get0.pod
@@ -2,19 +2,23 @@
=head1 NAME
-X509_SIG_get0 - Get DigestInfo functions
+X509_SIG_get0, X509_SIG_get0_mutable - DigestInfo functions
=head1 SYNOPSIS
#include <openssl/x509.h>
- void X509_SIG_get0(X509_ALGOR **palg, ASN1_OCTET_STRING **pdigest,
- X509_SIG *sig);
+ void X509_SIG_get0(const X509_SIG *sig, const X509_ALGOR **palg,
+ const ASN1_OCTET_STRING **pdigest);
+ void X509_SIG_get0_mutable(X509_SIG *sig, X509_ALGOR **palg,
+ ASN1_OCTET_STRING **pdigest,
=head1 DESCRIPTION
X509_SIG_get0() returns pointers to the algorithm identifier and digest
-value in B<sig>. These values can then be examined or initialised.
+value in B<sig>. X509_SIG_get0_mutable() is identical to X509_SIG_get0()
+except the pointers returned are not constant and can be modified:
+for example to initialise them.
=head1 SEE ALSO