From cf4462daaf5360483bec601f4dfb2fd1630db0c0 Mon Sep 17 00:00:00 2001 From: "Dr. Stephen Henson" Date: Sat, 6 Feb 2016 16:42:22 +0000 Subject: [PATCH] Add documenation for X509_chain_up_ref() Reviewed-by: Viktor Dukhovni --- doc/crypto/X509_new.pod | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/crypto/X509_new.pod b/doc/crypto/X509_new.pod index d6c365fc49..8db6cdb245 100644 --- a/doc/crypto/X509_new.pod +++ b/doc/crypto/X509_new.pod @@ -11,6 +11,7 @@ X509_new, X509_free, X509_up_ref - X509 certificate ASN1 allocation functions X509 *X509_new(void); void X509_free(X509 *a); void X509_up_ref(X509 *a); + STACK_OF(X509) *X509_chain_up_ref(STACK_OF(X509) *x); =head1 DESCRIPTION @@ -25,12 +26,20 @@ frees it up if the reference count is zero. If B is NULL nothing is done. X509_up_ref() increments the reference count of B. +X509_chain_up_ref() increases the reference count of all certificates in +chain B and returns a copy of the stack. + =head1 NOTES The function X509_up_ref() if useful if a certificate structure is being used by several different operations each of which will free it up after use: this avoids the need to duplicate the entire certificate structure. +The function X509_chain_up_ref() doesn't just up the reference count of +each certificate it also returns a copy of the stack, using sk_X509_dup(), +but it serves a similar purpose: the returned chain persists after the +original has been freed. + =head1 RETURN VALUES If the allocation fails, X509_new() returns B and sets an error @@ -39,6 +48,9 @@ Otherwise it returns a pointer to the newly allocated structure. X509_free() and X509_up_ref() do not return a value. +X509_chain_up_ref() returns a copy of the stack or B if an error +occurred. + =head1 SEE ALSO L, -- 2.34.1