1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/* Copyright (c) 2021, 2025, Oracle and/or its affiliates.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License, version 2.0, for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
#ifndef KEYRING_FILE_BACKEND_INCLUDED
#define KEYRING_FILE_BACKEND_INCLUDED
#include <string>
#include <components/keyrings/common/json_data/json_writer.h>
#include <components/keyrings/common/memstore/iterator.h>
#include <components/keyrings/common/operations/operations.h>
namespace keyring_file {
namespace backend {
class Keyring_file_backend final {
public:
explicit Keyring_file_backend(const std::string keyring_file_name,
bool read_only);
~Keyring_file_backend() = default;
/**
Fetch data
@param [in] metadata Key
@param [out] data Value
@returns Status of find operation
@retval false Entry found. Check data.
@retval true Entry missing.
*/
bool get(const keyring_common::meta::Metadata &metadata,
keyring_common::data::Data &data) const;
/**
Store data
@param [in] metadata Key
@param [in, out] data Value
@returns Status of store operation
@retval false Entry stored successfully
@retval true Failure
*/
bool store(const keyring_common::meta::Metadata &metadata,
keyring_common::data::Data &data);
/**
Erase data located at given key
@param [in] metadata Key
@param [in] data Value - not used.
@returns Status of erase operation
@retval false Data deleted
@retval true Could not find or delete data
*/
bool erase(const keyring_common::meta::Metadata &metadata,
keyring_common::data::Data &data);
/**
Generate random data and store it
@param [in] metadata Key
@param [out] data Generated value
@param [in] length Length of data to be generated
@returns Status of generate + store operation
@retval false Data generated and stored successfully
@retval true Error
*/
bool generate(const keyring_common::meta::Metadata &metadata,
keyring_common::data::Data &data, size_t length);
/**
Populate cache
@param [in] operations Handle to operations class
@returns status of cache insertion
@retval false Success
@retval true Failure
*/
bool load_cache(
keyring_common::operations::Keyring_operations<Keyring_file_backend>
&operations);
/** Maximum data length supported */
size_t maximum_data_length() const { return 16384; }
/** Get number of elements stored in backend */
size_t size() const { return json_writer_.num_elements(); }
/** Validity */
bool valid() const { return valid_; }
private:
/**
Write existing data to file.
This function overwrites existing data stored in the file.
@returns Status of write operation.
@retval false Successfully written data to file
@retval true Error writing data to file
*/
bool write_to_file();
/** Create data file if missing */
void create_file_if_missing(std::string file_name);
private:
/** Keyring file */
std::string keyring_file_name_;
/** Read only flag */
bool read_only_;
/** In memory cache for keyring data */
keyring_common::json_data::Json_writer json_writer_;
/** Validity */
bool valid_;
};
} // namespace backend
} // namespace keyring_file
#endif // !KEYRING_FILE_BACKEND_INCLUDED
|
