mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-02-17 14:32:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix style problems with this man page

Browse Source 
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14642)
This commit is contained in:
Pauli 2021-03-26 10:05:08 +10:00
parent e7aa284e68
commit 7f2fa88519
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/man3/X509_PUBKEY_new.pod
View File

@ -49,14 +49,14 @@ X509_PUBKEY_new() allocates and initializes an B<X509_PUBKEY> structure.
X509_PUBKEY_dup() creates a duplicate copy of the B<X509_PUBKEY> object
specified by I<a>.
X509_PUBKEY_free() frees up B<X509_PUBKEY> structure B<a>. If B<a> is NULL
X509_PUBKEY_free() frees up B<X509_PUBKEY> structure I<a>. If I<a> is NULL
nothing is done.
X509_PUBKEY_set() sets the public key in B<*x> to the public key contained
in the B<EVP_PKEY> structure B<pkey>. If B<*x> is not NULL any existing
X509_PUBKEY_set() sets the public key in I<*x> to the public key contained
in the B<EVP_PKEY> structure I<pkey>. If I<*x> is not NULL any existing
public key structure will be freed.
X509_PUBKEY_get0() returns the public key contained in B<key>. The returned
X509_PUBKEY_get0() returns the public key contained in I<key>. The returned
value is an internal pointer which B<MUST NOT> be freed after use.
X509_PUBKEY_get() is similar to X509_PUBKEY_get0() except the reference
@ -77,19 +77,19 @@ d2i_PUBKEY_bio(), d2i_PUBKEY_fp(), i2d_PUBKEY_bio() and i2d_PUBKEY_fp() are
similar to d2i_PUBKEY() and i2d_PUBKEY() except they decode or encode using a
B<BIO> or B<FILE> pointer.
X509_PUBKEY_set0_param() sets the public key parameters of B<pub>. The
OID associated with the algorithm is set to B<aobj>. The type of the
algorithm parameters is set to B<type> using the structure B<pval>.
The encoding of the public key itself is set to the B<penclen>
bytes contained in buffer B<penc>. On success ownership of all the supplied
parameters is passed to B<pub> so they must not be freed after the
X509_PUBKEY_set0_param() sets the public key parameters of I<pub>. The
OID associated with the algorithm is set to I<aobj>. The type of the
algorithm parameters is set to I<type> using the structure I<pval>.
The encoding of the public key itself is set to the I<penclen>
bytes contained in buffer I<penc>. On success ownership of all the supplied
parameters is passed to I<pub> so they must not be freed after the
call.
X509_PUBKEY_get0_param() retrieves the public key parameters from B<pub>,
B<*ppkalg> is set to the associated OID and the encoding consists of
B<*ppklen> bytes at B<*pk>, B<*pa> is set to the associated
X509_PUBKEY_get0_param() retrieves the public key parameters from I<pub>,
I<*ppkalg> is set to the associated OID and the encoding consists of
I<*ppklen> bytes at I<*pk>, I<*pa> is set to the associated
AlgorithmIdentifier for the public key. If the value of any of these
parameters is not required it can be set to B<NULL>. All of the
parameters is not required it can be set to NULL. All of the
retrieved pointers are internal and must not be freed after the
call.
@ -106,13 +106,13 @@ directly: they will instead call wrapper functions such as X509_get0_pubkey().
=head1 RETURN VALUES
If the allocation fails, X509_PUBKEY_new() and X509_PUBKEY_dup() return
B<NULL> and set an error code that can be obtained by L<ERR_get_error(3)>.
NULL and set an error code that can be obtained by L<ERR_get_error(3)>.
Otherwise they return a pointer to the newly allocated structure.
X509_PUBKEY_free() does not return a value.
X509_PUBKEY_get0() and X509_PUBKEY_get() return a pointer to an B<EVP_PKEY>
structure or B<NULL> if an error occurs.
structure or NULL if an error occurs.
X509_PUBKEY_set(), X509_PUBKEY_set0_param() and X509_PUBKEY_get0_param()
return 1 for success and 0 if an error occurred.