Debian Codegraph @

upstream/debian-unstable/man7/ossl_store.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 7SSL"
58 .TH OSSL_STORE 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 \- Store retrieval functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 #include <openssl/store.h>
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 .SS General
71 .IX Subsection "General"
72 A STORE is a layer of functionality to retrieve a number of supported
73 objects from a repository of any kind, addressable as a filename or
74 as a URI.
75 .PP
76 The functionality supports the pattern "open a channel to the
77 repository", "loop and retrieve one object at a time", and "finish up
78 by closing the channel".
79 .PP
80 The retrieved objects are returned as a wrapper type \fBOSSL_STORE_INFO\fR,
81 from which an OpenSSL type can be retrieved.
82 .SS "URI schemes and loaders"
83 .IX Subsection "URI schemes and loaders"
84 Support for a URI scheme is called a STORE "loader", and can be added
85 dynamically from the calling application or from a loadable engine.
86 .PP
87 Support for the 'file' scheme is built into \f(CW\*(C`libcrypto\*(C'\fR.
88 See \fBossl_store\-file\fR\|(7) for more information.
89 .SS "UI_METHOD and pass phrases"
90 .IX Subsection "UI_METHOD and pass phrases"
91 The \fBOSS_STORE\fR API does nothing to enforce any specific format or
92 encoding on the pass phrase that the \fBUI_METHOD\fR provides. However,
93 the pass phrase is expected to be UTF\-8 encoded. The result of any
94 other encoding is undefined.
95 .SH EXAMPLES
96 .IX Header "EXAMPLES"
97 .SS "A generic call"
98 .IX Subsection "A generic call"
99 .Vb 2
100 \& #include <openssl/ui.h> /* for UI_get_default_method */
101 \& #include <openssl/store.h>
102 \&
103 \& OSSL_STORE_CTX *ctx = OSSL_STORE_open("file:/foo/bar/data.pem",
104 \& UI_get_default_method(), NULL, NULL, NULL);
105 \&
106 \& /*
107 \& * OSSL_STORE_eof() simulates file semantics for any repository to signal
108 \& * that no more data can be expected
109 \& */
110 \& while (!OSSL_STORE_eof(ctx)) {
111 \& OSSL_STORE_INFO *info = OSSL_STORE_load(ctx);
112 \&
113 \& /*
114 \& * Do whatever is necessary with the OSSL_STORE_INFO,
115 \& * here just one example
116 \& */
117 \& switch (OSSL_STORE_INFO_get_type(info)) {
118 \& case OSSL_STORE_INFO_CERT:
119 \& /* Print the X.509 certificate text */
120 \& X509_print_fp(stdout, OSSL_STORE_INFO_get0_CERT(info));
121 \& /* Print the X.509 certificate PEM output */
122 \& PEM_write_X509(stdout, OSSL_STORE_INFO_get0_CERT(info));
123 \& break;
124 \& }
125 \& OSSL_STORE_INFO_free(info);
126 \& }
127 \&
128 \& OSSL_STORE_close(ctx);
129 .Ve
130 .SH "SEE ALSO"
131 .IX Header "SEE ALSO"
132 \&\fBOSSL_STORE_INFO\fR\|(3), \fBOSSL_STORE_LOADER\fR\|(3),
133 \&\fBOSSL_STORE_open\fR\|(3), \fBOSSL_STORE_expect\fR\|(3),
134 \&\fBOSSL_STORE_SEARCH\fR\|(3)
135 .SH COPYRIGHT
136 .IX Header "COPYRIGHT"
137 Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved.
138 .PP
139 Licensed under the Apache License 2.0 (the "License"). You may not use
140 this file except in compliance with the License. You can obtain a copy
141 in the file LICENSE in the source distribution or at
142 <https://www.openssl.org/source/license.html>.