diff options
| author | Richard Levitte <levitte@openssl.org> | 2017-07-05 16:08:19 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2017-08-15 21:37:04 +0200 |
| commit | 1fcb6a3daa3da1f6baa4cc5b4092642c6bf5103c (patch) | |
| tree | 68d25c090885355b12a1163219786be5aba768b9 /doc | |
| parent | 330242959d5efdffd2aed378ea96cc7aa5cb9bde (diff) | |
| download | openssl-1fcb6a3daa3da1f6baa4cc5b4092642c6bf5103c.tar.gz | |
STORE: Add documentation on the expectations for returned names
Returned OSSL_STORE_INFO_NAME typed infos are supposed to be a
canonical URI for the corresponding object. For example, when using
the 'file' scheme loader, the file name is returned, possibly prefixed
with 'file://'
Reviewed-by: Ben Kaduk <kaduk@mit.edu>
(Merged from https://github.com/openssl/openssl/pull/3856)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OSSL_STORE_INFO.pod | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/man3/OSSL_STORE_INFO.pod b/doc/man3/OSSL_STORE_INFO.pod index cda1be921f..20d41ac534 100644 --- a/doc/man3/OSSL_STORE_INFO.pod +++ b/doc/man3/OSSL_STORE_INFO.pod @@ -122,6 +122,14 @@ returned name will be the path of each object, so if C</foo/bar> was given and that path has the file C<cookie.pem>, the name C</foo/bar/cookie.pem> will be returned. +The returned URI is considered canonical and must be unique and permanent +for the storage where the object (or collection of objects) resides. +Each loader is responsible for ensuring that it only returns canonical +URIs. +However, it's possible that certain schemes allow an object (or collection +thereof) to be reached with alternative URIs; just because one URI is +canonical doesn't mean that other variants can't be used. + At the discretion of the loader that was used to get these names, an extra description may be attached as well. |