summaryrefslogtreecommitdiffstats
path: root/doc/man7/ossl_store.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2018-06-05 15:58:43 +0200
committerRichard Levitte <levitte@openssl.org>2018-06-07 13:25:03 +0200
commit0189bf2bbe30d4fa710fe7440ed7f3d8eab039c6 (patch)
tree9c26dcb74f6bb0c57cc09d4e570a7bb58a427aa7 /doc/man7/ossl_store.pod
parent10bda8f8dd359b3db39a5157be0e72afe9f05eea (diff)
Document UTF-8 expectation for pass phrases passed to OSSL_STORE
After some discussion, it was concluded that the better idea is to stipulate that the pass phrases passed to the OSSL_STORE API are expected to be UTF-8 encoded, and that all objects made accessible through OSSL_STORE URIs should adhere to this expectation (at the discretion of the loaders). Email ref: https://mta.openssl.org/pipermail/openssl-project/2018-June/000771.html Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/6416)
Diffstat (limited to 'doc/man7/ossl_store.pod')
-rw-r--r--doc/man7/ossl_store.pod7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/man7/ossl_store.pod b/doc/man7/ossl_store.pod
index efa47806c7..6e75abd314 100644
--- a/doc/man7/ossl_store.pod
+++ b/doc/man7/ossl_store.pod
@@ -33,6 +33,13 @@ dynamically from the calling application or from a loadable engine.
Support for the 'file' scheme is built into C<libcrypto>.
See L<ossl_store-file(7)> for more information.
+=head2 UI_METHOD and pass phrases
+
+The B<OSS_STORE> API does nothing to enforce any specific format or
+encoding on the pass phrase that the B<UI_METHOD> provides. However,
+the pass phrase is expected to be UTF-8 encoded. The result of any
+other encoding is undefined.
+
=head1 EXAMPLES
=head2 A generic call