Debian Codegraph @

upstream/debian-unstable/man7/ossl_store-file.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_STORE-FILE 7SSL"
58 .TH OSSL_STORE-FILE 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 ossl_store\-file \- The store 'file' scheme loader
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 #include <openssl/store.h>
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Support for the 'file' scheme is built into \f(CW\*(C`libcrypto\*(C'\fR.
71 Since files come in all kinds of formats and content types, the 'file'
72 scheme has its own layer of functionality called "file handlers",
73 which are used to try to decode diverse types of file contents.
74 .PP
75 In case a file is formatted as PEM, each called file handler receives
76 the PEM name (everything following any '\f(CW\*(C`\-\-\-\-\-BEGIN \*(C'\fR') as well as
77 possible PEM headers, together with the decoded PEM body. Since PEM
78 formatted files can contain more than one object, the file handlers
79 are called upon for each such object.
80 .PP
81 If the file isn't determined to be formatted as PEM, the content is
82 loaded in raw form in its entirety and passed to the available file
83 handlers as is, with no PEM name or headers.
84 .PP
85 Each file handler is expected to handle PEM and non-PEM content as
86 appropriate. Some may refuse non-PEM content for the sake of
87 determinism (for example, there are keys out in the wild that are
88 represented as an ASN.1 OCTET STRING. In raw form, it's not easily
89 possible to distinguish those from any other data coming as an ASN.1
90 OCTET STRING, so such keys would naturally be accepted as PEM files
91 only).
92 .SH NOTES
93 .IX Header "NOTES"
94 When needed, the 'file' scheme loader will require a pass phrase by
95 using the \fBUI_METHOD\fR that was passed via \fBOSSL_STORE_open()\fR.
96 This pass phrase is expected to be UTF\-8 encoded, anything else will
97 give an undefined result.
98 The files made accessible through this loader are expected to be
99 standard compliant with regards to pass phrase encoding.
100 Files that aren't should be re-generated with a correctly encoded pass
101 phrase.
102 See \fBpassphrase\-encoding\fR\|(7) for more information.
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 \&\fBossl_store\fR\|(7), \fBpassphrase\-encoding\fR\|(7)
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
109 .PP
110 Licensed under the Apache License 2.0 (the "License"). You may not use
111 this file except in compliance with the License. You can obtain a copy
112 in the file LICENSE in the source distribution or at
113 <https://www.openssl.org/source/license.html>.