1OSSL_STORE-FILE(7ossl)              OpenSSL             OSSL_STORE-FILE(7ossl)
2
3
4

NAME

6       ossl_store-file - The store 'file' scheme loader
7

SYNOPSIS

9       #include <openssl/store.h>
10

DESCRIPTION

12       Support for the 'file' scheme is built into "libcrypto".  Since files
13       come in all kinds of formats and content types, the 'file' scheme has
14       its own layer of functionality called "file handlers", which are used
15       to try to decode diverse types of file contents.
16
17       In case a file is formatted as PEM, each called file handler receives
18       the PEM name (everything following any '"-----BEGIN "') as well as
19       possible PEM headers, together with the decoded PEM body.  Since PEM
20       formatted files can contain more than one object, the file handlers are
21       called upon for each such object.
22
23       If the file isn't determined to be formatted as PEM, the content is
24       loaded in raw form in its entirety and passed to the available file
25       handlers as is, with no PEM name or headers.
26
27       Each file handler is expected to handle PEM and non-PEM content as
28       appropriate.  Some may refuse non-PEM content for the sake of
29       determinism (for example, there are keys out in the wild that are
30       represented as an ASN.1 OCTET STRING.  In raw form, it's not easily
31       possible to distinguish those from any other data coming as an ASN.1
32       OCTET STRING, so such keys would naturally be accepted as PEM files
33       only).
34

NOTES

36       When needed, the 'file' scheme loader will require a pass phrase by
37       using the UI_METHOD that was passed via OSSL_STORE_open().  This pass
38       phrase is expected to be UTF-8 encoded, anything else will give an
39       undefined result.  The files made accessible through this loader are
40       expected to be standard compliant with regards to pass phrase encoding.
41       Files that aren't should be re-generated with a correctly encoded pass
42       phrase.  See passphrase-encoding(7) for more information.
43

SEE ALSO

45       ossl_store(7), passphrase-encoding(7)
46

48       Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
49
50       Licensed under the Apache License 2.0 (the "License").  You may not use
51       this file except in compliance with the License.  You can obtain a copy
52       in the file LICENSE in the source distribution or at
53       <https://www.openssl.org/source/license.html>.
54
55
56
573.0.9                             2023-07-27            OSSL_STORE-FILE(7ossl)
Impressum