diff --git a/doc/man7/ossl_store-file.pod b/doc/man7/ossl_store-file.pod index 13784276b1d5bdfcaf3d09feaf5bdce28c77c2a5..996043b0fb853c69cf839f78e12a173dddb4e1fb 100644 --- a/doc/man7/ossl_store-file.pod +++ b/doc/man7/ossl_store-file.pod @@ -47,17 +47,14 @@ only). When needed, the 'file' scheme loader will require a pass phrase by using the C that was passed via OSSL_STORE_open(). -This pass phrase is used as it is, which may present some challenge -when the file that's loaded contains a PKCS#12 object. +This pass phrase is expected to be UTF-8 encoded, anything else will +give an undefined result. +The files made accessible through this loader are expected to be +standard compliant with regards to pass phrase encoding. +Files that aren't should be re-generated with a correctly encoded pass +phrase. See L for more information. -=begin comment - -The treatment of pass phrases is currently being worked on and may -change. - -=end comment - =head1 SEE ALSO L, L diff --git a/doc/man7/ossl_store.pod b/doc/man7/ossl_store.pod index efa47806c7f9d0d31f97f2bef68d3fbe54afe61e..6e75abd314b70380e7031cd7d0489aeb6a51368a 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. See L for more information. +=head2 UI_METHOD and pass phrases + +The B API does nothing to enforce any specific format or +encoding on the pass phrase that the B 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 diff --git a/doc/man7/passphrase-encoding.pod b/doc/man7/passphrase-encoding.pod index bc777c90c69bd7df820b5af0c6ea415bc7206e11..d5c9d1e6f61ebb4e0bc2cf20828e0e6d3f0a01c0 100644 --- a/doc/man7/passphrase-encoding.pod +++ b/doc/man7/passphrase-encoding.pod @@ -80,13 +80,11 @@ than 1.1.0 was misinterpreted as ISO-8859-1 sequences. L acts as a general interface to access all kinds of objects, potentially protected with a pass phrase, a PIN or something else. -This API currently doesn't stipulate any specific encoding of pass phrases, but -uses the underlying routines with their behaviours. -This means that when using the built-in C scheme loader, the pass phrase -to unlock a PKCS#12 file will be treated as described for PKCS#12 above, and -the pass phrase for a PEM files will be treated as the general case described -above, since that loader uses the same underlying routines. -I. +This API stipulates that pass phrases should be UTF-8 encoded, and that any +other pass phrase encoding may give undefined results. +This API relies on the application to ensure UTF-8 encoding, and doesn't check +that this is the case, so what it gets, it will also pass to the underlying +loader. =head1 RECOMMENDATIONS