Commit 84814344 authored by Richard Levitte's avatar Richard Levitte
Browse files

Link in passphrase-encoding(7) in relevant documentation

parent 491c3532
Loading
Loading
Loading
Loading
+3 −0
Original line number Original line Diff line number Diff line
@@ -439,6 +439,9 @@ password argument is given and a password is required then the user is
prompted to enter one: this will typically be read from the current
prompted to enter one: this will typically be read from the current
terminal with echoing turned off.
terminal with echoing turned off.


Note that character encoding may be relevant, please see
L<passphrase-encoding(7)>.

=over 4
=over 4


=item B<pass:password>
=item B<pass:password>
+10 −1
Original line number Original line Diff line number Diff line
@@ -112,6 +112,14 @@ URI, or if it's a different error (such as memory allocation
failures); if the URI was parsable but the scheme unregistered, the
failures); if the URI was parsable but the scheme unregistered, the
top error will have the reason C<OSSL_STORE_R_UNREGISTERED_SCHEME>.
top error will have the reason C<OSSL_STORE_R_UNREGISTERED_SCHEME>.


These functions make no direct assumption regarding the pass phrase received
from the password callback.
The loaders may make assumptions, however.
For example, the B<file:> scheme loader inherits the assumptions made by
OpenSSL functionality that handles the different file types; this is mostly
relevant for PKCS#12 objects.
See L<passphrase-encoding(7)> for further information.

=head1 RETURN VALUES
=head1 RETURN VALUES


OSSL_STORE_open() returns a pointer to a B<OSSL_STORE_CTX> on success, or
OSSL_STORE_open() returns a pointer to a B<OSSL_STORE_CTX> on success, or
@@ -132,7 +140,8 @@ OSSL_STORE_ctrl() and OSSL_STORE_close() returns 1 on success, or 0 on failure.


=head1 SEE ALSO
=head1 SEE ALSO


L<ossl_store(7)>, L<OSSL_STORE_INFO(3)>, L<OSSL_STORE_register_loader(3)>
L<ossl_store(7)>, L<OSSL_STORE_INFO(3)>, L<OSSL_STORE_register_loader(3)>,
L<passphrase-encoding(7)>


=head1 HISTORY
=head1 HISTORY


+6 −1
Original line number Original line Diff line number Diff line
@@ -55,6 +55,10 @@ use of BIO_s_file() indicates the use of the operating system stdio
functionality, which includes buffering as a feature; BIO_s_fd() is likely
functionality, which includes buffering as a feature; BIO_s_fd() is likely
to be more appropriate in such cases.
to be more appropriate in such cases.


These functions make no assumption regarding the pass phrase received from the
password callback.
It will simply be treated as a byte sequence.

=head1 RETURN VALUES
=head1 RETURN VALUES


PEM_bytes_read_bio() and PEM_bytes_read_bio_secmem() return 1 for success or
PEM_bytes_read_bio() and PEM_bytes_read_bio_secmem() return 1 for success or
@@ -63,7 +67,8 @@ PEM_bytes_read_bio() and PEM_bytes_read_bio_secmem() return 1 for success or
=head1 SEE ALSO
=head1 SEE ALSO


L<PEM(3)>,
L<PEM(3)>,
L<PEM_read_bio_ex(3)>
L<PEM_read_bio_ex(3)>,
L<passphrase-encoding(7)>


=head1 HISTORY
=head1 HISTORY


+6 −1
Original line number Original line Diff line number Diff line
@@ -110,10 +110,15 @@ Instead, private keys should be stored in PKCS#8 form, with a strong PKCS#5
v2.0 PBE.
v2.0 PBE.
See L<PEM_write_PrivateKey(3)> and L<d2i_PKCS8PrivateKey_bio(3)>.
See L<PEM_write_PrivateKey(3)> and L<d2i_PKCS8PrivateKey_bio(3)>.


PEM_do_header() makes no assumption regarding the pass phrase received from the
password callback.
It will simply be treated as a byte sequence.

=head1 SEE ALSO
=head1 SEE ALSO


L<ERR_peek_last_error(3)>, L<ERR_GET_LIB(3)>,
L<ERR_peek_last_error(3)>, L<ERR_GET_LIB(3)>,
L<d2i_PKCS8PrivateKey_bio(3)>.
L<d2i_PKCS8PrivateKey_bio(3)>,
L<passphrase-encoding(7)>


=head1 COPYRIGHT
=head1 COPYRIGHT


+8 −1
Original line number Original line Diff line number Diff line
@@ -73,6 +73,12 @@ PEM_write_TYPE() writes the PEM encoding of the object B<a> to the file B<fp>.


PEM_write_bio_TYPE() similarly writes to the BIO B<bp>.
PEM_write_bio_TYPE() similarly writes to the BIO B<bp>.


=head1 NOTES

These functions make no assumption regarding the pass phrase received from the
password callback.
It will simply be treated as a byte sequence.

=head1 RETURN VALUES
=head1 RETURN VALUES


PEM_read_TYPE() and PEM_read_bio_TYPE() return a pointer to an allocated
PEM_read_TYPE() and PEM_read_bio_TYPE() return a pointer to an allocated
@@ -83,7 +89,8 @@ or zero on error.


=head1 SEE ALSO
=head1 SEE ALSO


L<PEM_read(3)>
L<PEM_read(3)>,
L<passphrase-encoding(7)>


=head1 COPYRIGHT
=head1 COPYRIGHT


Loading