aboutsummaryrefslogtreecommitdiff
path: root/doc/man3/PKCS12_newpass.pod
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2019-08-16 08:34:16 -0400
committerPauli <paul.dale@oracle.com>2019-08-27 07:08:11 +1000
commit485d336137f2afa62e378bc39dcfa37dcfb222da (patch)
treea09e160c8cdc4378fb3d13a9c47989813d131904 /doc/man3/PKCS12_newpass.pod
parent6d745d740d37d680ff696486218b650512bbbbc6 (diff)
downloadopenssl-485d336137f2afa62e378bc39dcfa37dcfb222da.zip
openssl-485d336137f2afa62e378bc39dcfa37dcfb222da.tar.gz
openssl-485d336137f2afa62e378bc39dcfa37dcfb222da.tar.bz2
Do not have duplicate section heads
Change find-doc-nits to complain if a section header is repeated, within a parent header (i.e., duplicate =head2 within a =head1). In almost all cases, we just remove the duplicate header, as it was a "continuation" of the =head1 that was already in affect. In some cases, just remove "=head1 NOTES", possibly moving text around, because the "NOTES" were really important parts of the DESCRIPTION section. No =headX sections should end with a period. All =head1 labels should be in all uppercase. No sub-head (=head2, etc) should be in all uppercase. Update find-doc-nits to reject the above. Fixup an internal POD link Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Yang <kaishen.yy@antfin.com> Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/9631)
Diffstat (limited to 'doc/man3/PKCS12_newpass.pod')
-rw-r--r--doc/man3/PKCS12_newpass.pod22
1 files changed, 9 insertions, 13 deletions
diff --git a/doc/man3/PKCS12_newpass.pod b/doc/man3/PKCS12_newpass.pod
index 491fbcb..52d349e 100644
--- a/doc/man3/PKCS12_newpass.pod
+++ b/doc/man3/PKCS12_newpass.pod
@@ -17,8 +17,6 @@ PKCS12_newpass() changes the password of a PKCS12 structure.
B<p12> is a pointer to a PKCS12 structure. B<oldpass> is the existing password
and B<newpass> is the new password.
-=head1 NOTES
-
Each of B<oldpass> and B<newpass> is independently interpreted as a string in
the UTF-8 encoding. If it is not valid UTF-8, it is assumed to be ISO8859-1
instead.
@@ -29,6 +27,15 @@ use. This may include passwords from local text files, or input from
the terminal or command line. Refer to the documentation of
L<UI_OpenSSL(3)>, for example.
+If the PKCS#12 structure does not have a password, then you must use the empty
+string "" for B<oldpass>. Using NULL for B<oldpass> will result in a
+PKCS12_newpass() failure.
+
+If the wrong password is used for B<oldpass> then the function will fail,
+with a MAC verification error. In rare cases the PKCS12 structure does not
+contain a MAC: in this case it will usually fail with a decryption padding
+error.
+
=head1 RETURN VALUES
PKCS12_newpass() returns 1 on success or 0 on failure. Applications can
@@ -83,17 +90,6 @@ the result to a new file.
}
-=head1 NOTES
-
-If the PKCS#12 structure does not have a password, then you must use the empty
-string "" for B<oldpass>. Using NULL for B<oldpass> will result in a
-PKCS12_newpass() failure.
-
-If the wrong password is used for B<oldpass> then the function will fail,
-with a MAC verification error. In rare cases the PKCS12 structure does not
-contain a MAC: in this case it will usually fail with a decryption padding
-error.
-
=head1 BUGS
The password format is a NULL terminated ASCII string which is converted to