From ea1c349f7d53cea2d167deba5624b725a576a8ff Mon Sep 17 00:00:00 2001 From: Ingo Schwarze Date: Wed, 28 Dec 2016 14:06:07 +0000 Subject: Minor cleanup: Improve the one-line description. Use the standard wordings in some places. Complete the RETURN VALUES section. --- lib/libcrypto/man/X509_PUBKEY_new.3 | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/lib/libcrypto/man/X509_PUBKEY_new.3 b/lib/libcrypto/man/X509_PUBKEY_new.3 index 0475fe65b22..7ed3e68b2ed 100644 --- a/lib/libcrypto/man/X509_PUBKEY_new.3 +++ b/lib/libcrypto/man/X509_PUBKEY_new.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: X509_PUBKEY_new.3,v 1.4 2016/12/25 22:15:10 schwarze Exp $ +.\" $OpenBSD: X509_PUBKEY_new.3,v 1.5 2016/12/28 14:06:06 schwarze Exp $ .\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 .\" .\" This file was written by Dr. Stephen Henson . @@ -48,7 +48,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: December 25 2016 $ +.Dd $Mdocdate: December 28 2016 $ .Dt X509_PUBKEY_NEW 3 .Os .Sh NAME @@ -64,7 +64,7 @@ .Nm i2d_PUBKEY_bio , .Nm X509_PUBKEY_set0_param , .Nm X509_PUBKEY_get0_param -.Nd SubjectPublicKeyInfo public key functions +.Nd X.509 SubjectPublicKeyInfo structure .Sh SYNOPSIS .In openssl/x509.h .Ft X509_PUBKEY * @@ -152,7 +152,7 @@ If .Fa a is a .Dv NULL -pointer, nothing is done. +pointer, no action occurs. .Pp .Fn X509_PUBKEY_set sets the public key in @@ -183,19 +183,14 @@ decode and encode an structure using .Vt SubjectPublicKeyInfo format. -They otherwise follow the conventions of other ASN.1 functions such as -.Xr d2i_X509 3 . -.Pp +For details about the semantics, examples, caveats, and bugs, see +.Xr ASN1_item_d2i 3 . .Fn d2i_PUBKEY_bio , .Fn d2i_PUBKEY_fp , .Fn i2d_PUBKEY_bio and .Fn i2d_PUBKEY_fp -are similar to -.Fn d2i_PUBKEY -and -.Fn i2d_PUBKEY -except they decode or encode using a +are similar except they decode or encode using a .Vt BIO or .Vt FILE @@ -243,22 +238,29 @@ returns .Dv NULL and sets an error code that can be obtained by .Xr ERR_get_error 3 . -.Pp Otherwise it returns a pointer to the newly allocated structure. .Pp -.Fn X509_PUBKEY_get0 +.Fn X509_PUBKEY_get , +.Fn d2i_PUBKEY , +.Fn d2i_PUBKEY_bio , and -.Fn X509_PUBKEY_get +.Fn d2i_PUBKEY_fp return a pointer to an .Vt EVP_PKEY structure or .Dv NULL if an error occurs. .Pp +.Fn i2d_PUBKEY +returns the number of bytes successfully encoded or a negative value +if an error occurs. +.Pp .Fn X509_PUBKEY_set , -.Fn X509_PUBKEY_set0_param +.Fn X509_PUBKEY_set0_param , +.Fn X509_PUBKEY_get0_param , +.Fn i2d_PUBKEY_fp , and -.Fn X509_PUBKEY_get0_param +.Fn i2d_PUBKEY_bio return 1 for success and 0 if an error occurred. .Sh SEE ALSO .Xr d2i_X509 3 , -- cgit v1.2.3