xref: /freebsd/secure/lib/libcrypto/man/man7/ossl_store-file.7 (revision 02e9120893770924227138ba49df1edb3896112a)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OSSL_STORE-FILE 7ossl"
OSSL_STORE-FILE 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
ossl_store-file - The store 'file' scheme loader
"SYNOPSIS"
Header "SYNOPSIS" #include <openssl/store.h>
"DESCRIPTION"
Header "DESCRIPTION" Support for the 'file' scheme is built into \*(C`libcrypto\*(C'. Since files come in all kinds of formats and content types, the 'file' scheme has its own layer of functionality called \*(L"file handlers\*(R", which are used to try to decode diverse types of file contents.

In case a file is formatted as \s-1PEM,\s0 each called file handler receives the \s-1PEM\s0 name (everything following any '\*(C`-----BEGIN \*(C'') as well as possible \s-1PEM\s0 headers, together with the decoded \s-1PEM\s0 body. Since \s-1PEM\s0 formatted files can contain more than one object, the file handlers are called upon for each such object.

If the file isn't determined to be formatted as \s-1PEM,\s0 the content is loaded in raw form in its entirety and passed to the available file handlers as is, with no \s-1PEM\s0 name or headers.

Each file handler is expected to handle \s-1PEM\s0 and non-PEM content as appropriate. Some may refuse non-PEM content for the sake of determinism (for example, there are keys out in the wild that are represented as an \s-1ASN.1 OCTET STRING.\s0 In raw form, it's not easily possible to distinguish those from any other data coming as an \s-1ASN.1 OCTET STRING,\s0 so such keys would naturally be accepted as \s-1PEM\s0 files only).

"NOTES"
Header "NOTES" When needed, the 'file' scheme loader will require a pass phrase by using the \s-1UI_METHOD\s0 that was passed via OSSL_STORE_open(). This pass phrase is expected to be \s-1UTF-8\s0 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 passphrase-encoding\|(7) for more information.
"SEE ALSO"
Header "SEE ALSO" \fBossl_store\|(7), passphrase-encoding\|(7)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.