Catch up to the removal of OSSL_STORE_open_file()
[openssl.git] / doc / man3 / OSSL_STORE_INFO.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_STORE_INFO, OSSL_STORE_INFO_get_type, OSSL_STORE_INFO_get0_NAME,
6 OSSL_STORE_INFO_get0_NAME_description, OSSL_STORE_INFO_get0_PARAMS,
7 OSSL_STORE_INFO_get0_PKEY, OSSL_STORE_INFO_get0_CERT, OSSL_STORE_INFO_get0_CRL,
8 OSSL_STORE_INFO_get1_NAME, OSSL_STORE_INFO_get1_NAME_description,
9 OSSL_STORE_INFO_get1_PARAMS, OSSL_STORE_INFO_get1_PKEY,
10 OSSL_STORE_INFO_get1_CERT,
11 OSSL_STORE_INFO_get1_CRL, OSSL_STORE_INFO_type_string, OSSL_STORE_INFO_free, 
12 OSSL_STORE_INFO_new_NAME, OSSL_STORE_INFO_set0_NAME_description,
13 OSSL_STORE_INFO_new_PARAMS, OSSL_STORE_INFO_new_PKEY, OSSL_STORE_INFO_new_CERT,
14 OSSL_STORE_INFO_new_CRL - Functions to manipulate OSSL_STORE_INFO objects 
15
16 =head1 SYNOPSIS
17
18  #include <openssl/store.h>
19
20  typedef struct ossl_store_info_st OSSL_STORE_INFO;
21
22  int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *store_info);
23  const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *store_info);
24  char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *store_info);
25  const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO
26                                                    *store_info);
27  char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *store_info);
28  EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *store_info);
29  EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *store_info);
30  EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *store_info);
31  EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *store_info);
32  X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *store_info);
33  X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *store_info);
34  X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *store_info);
35  X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *store_info);
36
37  const char *OSSL_STORE_INFO_type_string(int type);
38
39  void OSSL_STORE_INFO_free(OSSL_STORE_INFO *store_info);
40
41  OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name);
42  int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc);
43  OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(DSA *dsa_params);
44  OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey);
45  OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509);
46  OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl);
47
48 =head1 DESCRIPTION
49
50 These functions are primarly useful for applications to retrieve
51 supported objects from B<OSSL_STORE_INFO> objects and for scheme specific
52 loaders to create B<OSSL_STORE_INFO> holders.
53
54 =head2 Types
55
56 B<OSSL_STORE_INFO> is an opaque type that's just an intermediary holder for
57 the objects that have been retrieved by OSSL_STORE_load() and similar
58 functions.
59 Supported OpenSSL type object can be extracted using one of
60 STORE_INFO_get0_TYPE().
61 The life time of this extracted object is as long as the life time of
62 the B<OSSL_STORE_INFO> it was extracted from, so care should be taken not
63 to free the latter too early.
64 As an alternative, STORE_INFO_get1_TYPE() extracts a duplicate (or the
65 same object with its reference count increased), which can be used
66 after the containing B<OSSL_STORE_INFO> has been freed.
67 The object returned by STORE_INFO_get1_TYPE() must be freed separately
68 by the caller.
69 See L</SUPPORTED OBJECTS> for more information on the types that are
70 supported.
71
72 =head2 Functions
73
74 OSSL_STORE_INFO_get_type() takes a B<OSSL_STORE_INFO> and returns the STORE
75 type number for the object inside.
76 STORE_INFO_get_type_string() takes a STORE type number and returns a
77 short string describing it.
78
79 OSSL_STORE_INFO_get0_NAME(), OSSL_STORE_INFO_get0_NAME_description(),
80 OSSL_STORE_INFO_get0_PARAMS(), OSSL_STORE_INFO_get0_PKEY(),
81 OSSL_STORE_INFO_get0_CERT() and OSSL_STORE_INFO_get0_CRL() all take a
82 B<OSSL_STORE_INFO> and return the held object of the appropriate OpenSSL
83 type provided that's what's held.
84
85 OSSL_STORE_INFO_get1_NAME(), OSSL_STORE_INFO_get1_NAME_description(),
86 OSSL_STORE_INFO_get1_PARAMS(), OSSL_STORE_INFO_get1_PKEY(),
87 OSSL_STORE_INFO_get1_CERT() and OSSL_STORE_INFO_get1_CRL() all take a
88 B<OSSL_STORE_INFO> and return a duplicate of the held object of the
89 appropriate OpenSSL type provided that's what's held.
90
91 OSSL_STORE_INFO_free() frees a B<OSSL_STORE_INFO> and its contained type.
92
93 OSSL_STORE_INFO_new_NAME() , OSSL_STORE_INFO_new_PARAMS(),
94 OSSL_STORE_INFO_new_PKEY(), OSSL_STORE_INFO_new_CERT() and
95 OSSL_STORE_INFO_new_CRL() create a B<OSSL_STORE_INFO>
96 object to hold the given input object.
97 Additionally, for B<OSSL_STORE_INFO_NAME>` objects,
98 OSSL_STORE_INFO_set0_NAME_description() can be used to add an extra
99 description.
100 This description is meant to be human readable and should be used for
101 information printout.
102
103 =head1 SUPPORTED OBJECTS
104
105 Currently supported object types are:
106
107 =over 4
108
109 =item OSSL_STORE_INFO_NAME
110
111 A name is exactly that, a name.
112 It's like a name in a directory, but formatted as a complete URI.
113 For example, the path in URI C<file:/foo/bar/> could include a file
114 named C<cookie.pem>, and in that case, the returned B<OSSL_STORE_INFO_NAME>
115 object would have the URI C<file:/foo/bar/cookie.pem>, which can be
116 used by the application to get the objects in that file.
117 This can be applied to all schemes that can somehow support a listing
118 of object URIs.
119
120 For C<file:> URIs that are used without the explicit scheme, the
121 returned name will be the path of each object, so if C</foo/bar> was
122 given and that path has the file C<cookie.pem>, the name
123 C</foo/bar/cookie.pem> will be returned.
124
125 At the discretion of the loader that was used to get these names, an
126 extra description may be attached as well.
127
128 =item OSSL_STORE_INFO_PARAMS
129
130 Key parameters.
131
132 =item OSSL_STORE_INFO_PKEY
133
134 A private/public key of some sort.
135
136 =item OSSL_STORE_INFO_CERT
137
138 An X.509 certificate.
139
140 =item OSSL_STORE_INFO_CRL
141
142 A X.509 certificate reocation list.
143
144 =back
145
146 =head1 RETURN VALUES
147
148 OSSL_STORE_INFO_get_type() returns the STORE type number of the given
149 B<OSSL_STORE_INFO>.
150 There is no error value.
151
152 OSSL_STORE_INFO_get0_NAME(), OSSL_STORE_INFO_get0_NAME_description(),
153 OSSL_STORE_INFO_get0_PARAMS(), OSSL_STORE_INFO_get0_PKEY(),
154 OSSL_STORE_INFO_get0_CERT() and OSSL_STORE_INFO_get0_CRL() all return
155 a pointer to the OpenSSL object on success, NULL otherwise.
156
157 OSSL_STORE_INFO_get0_NAME(), OSSL_STORE_INFO_get0_NAME_description(),
158 OSSL_STORE_INFO_get0_PARAMS(), OSSL_STORE_INFO_get0_PKEY(),
159 OSSL_STORE_INFO_get0_CERT() and OSSL_STORE_INFO_get0_CRL() all return
160 a pointer to a duplicate of the OpenSSL object on success, NULL otherwise.
161
162 OSSL_STORE_INFO_type_string() returns a string on success, or B<NULL> on
163 failure.
164
165 OSSL_STORE_INFO_new_NAME(), OSSL_STORE_INFO_new_PARAMS(),
166 OSSL_STORE_INFO_new_PKEY(), OSSL_STORE_INFO_new_CERT() and
167 OSSL_STORE_INFO_new_CRL() return a B<OSSL_STORE_INFO>
168 pointer on success, or B<NULL> on failure.
169
170 OSSL_STORE_INFO_set0_NAME_description() returns 1 on success, or 0 on
171 failure.
172
173 =head1 SEE ALSO
174
175 L<ossl_store(7)>, L<OSSL_STORE_open(3)>, L<OSSL_STORE_register_loader(3)>
176
177 =head1 HISTORY
178
179 OSSL_STORE_INFO(), OSSL_STORE_INFO_get_type(), OSSL_STORE_INFO_get0_NAME(),
180 OSSL_STORE_INFO_get0_PARAMS(), OSSL_STORE_INFO_get0_PKEY(),
181 OSSL_STORE_INFO_get0_CERT(), OSSL_STORE_INFO_get0_CRL(),
182 OSSL_STORE_INFO_type_string(), OSSL_STORE_INFO_free(), OSSL_STORE_INFO_new_NAME(),
183 OSSL_STORE_INFO_new_PARAMS(), OSSL_STORE_INFO_new_PKEY(),
184 OSSL_STORE_INFO_new_CERT() and OSSL_STORE_INFO_new_CRL()
185 were added to OpenSSL 1.1.1.
186
187 =head1 COPYRIGHT
188
189 Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
190
191 Licensed under the OpenSSL license (the "License").  You may not use
192 this file except in compliance with the License.  You can obtain a copy
193 in the file LICENSE in the source distribution or at
194 L<https://www.openssl.org/source/license.html>.
195
196 =cut