blob: faebfe4a51edee391b25d782d292d58cf92dc4fa (
plain)
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/* $Id: SecretKeyStore.h $ */
/** @file
* Main - Secret key interface.
*/
/*
* Copyright (C) 2015-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* 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 for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_SecretKeyStore_h
#define MAIN_INCLUDED_SecretKeyStore_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include "VirtualBoxBase.h"
#include "VBox/com/array.h"
class SecretKey
{
public:
/**
* Constructor for a secret key.
*
* @param pbKey The key buffer.
* @param cbKey Size of the key.
* @param fKeyBufNonPageable Flag whether the key buffer should be non pageable.
*/
SecretKey(const uint8_t *pbKey, size_t cbKey, bool fKeyBufNonPageable);
/**
* Secret key destructor.
*/
~SecretKey();
/**
* Increments the reference counter of the key.
*
* @returns The new reference count.
*/
uint32_t retain();
/**
* Releases a reference of the key.
* If the reference counter reaches 0 the key buffer might be protected
* against further access or the data will become scrambled.
*
* @returns The new reference count.
*/
uint32_t release();
/**
* Returns the reference count of the secret key.
*/
uint32_t refCount();
/**
* Sets the possible number of users for this key.
*
* @returns VBox status code.
* @param cUsers The possible number of user for this key.
*/
int setUsers(uint32_t cUsers);
/**
* Returns the possible amount of users.
*
* @returns Possible amount of users.
*/
uint32_t getUsers();
/**
* Sets the remove on suspend flag.
*
* @returns VBox status code.
* @param fRemoveOnSuspend Flag whether to remove the key on host suspend.
*/
int setRemoveOnSuspend(bool fRemoveOnSuspend);
/**
* Returns whether the key should be destroyed on suspend.
*/
bool getRemoveOnSuspend();
/**
* Returns the buffer to the key.
*/
const void *getKeyBuffer();
/**
* Returns the size of the key.
*/
size_t getKeySize();
private:
/** Reference counter of the key. */
volatile uint32_t m_cRefs;
/** Key material. */
uint8_t *m_pbKey;
/** Size of the key in bytes. */
size_t m_cbKey;
/** Flag whether to remove the key on suspend. */
bool m_fRemoveOnSuspend;
/** Number of entities which will use this key. */
uint32_t m_cUsers;
};
class SecretKeyStore
{
public:
typedef std::map<com::Utf8Str, SecretKey *> SecretKeyMap;
/**
* Constructor for a secret key store.
*
* @param fKeyBufNonPageable Flag whether the key buffer is required to
* be non pageable.
*/
SecretKeyStore(bool fKeyBufNonPageable);
/**
* Destructor of a secret key store. This will free all stored secret keys
* inluding the key buffers. Make sure there no one accesses one of the keys
* stored.
*/
~SecretKeyStore();
/**
* Add a secret key to the store.
*
* @returns VBox status code.
* @param strKeyId The key identifier.
* @param pbKey The key to store.
* @param cbKey Size of the key.
*/
int addSecretKey(const com::Utf8Str &strKeyId, const uint8_t *pbKey, size_t cbKey);
/**
* Deletes a key from the key store associated with the given identifier.
*
* @returns VBox status code.
* @param strKeyId The key identifier.
*/
int deleteSecretKey(const com::Utf8Str &strKeyId);
/**
* Returns the secret key object associated with the given identifier.
* This increments the reference counter of the secret key object.
*
* @returns VBox status code.
* @param strKeyId The key identifier.
* @param ppKey Where to store the secret key object on success.
*/
int retainSecretKey(const com::Utf8Str &strKeyId, SecretKey **ppKey);
/**
* Releases a reference to the secret key object.
*
* @returns VBox status code.
* @param strKeyId The key identifier.
*/
int releaseSecretKey(const com::Utf8Str &strKeyId);
/**
* Deletes all secret keys from the key store.
*
* @returns VBox status code.
* @param fSuspend Flag whether to delete only keys which are
* marked for deletion during a suspend.
* @param fForce Flag whether to force deletion if some keys
* are still in use. Otherwise an error is returned.
*/
int deleteAllSecretKeys(bool fSuspend, bool fForce);
/**
* Iterators for enumerating keys
*/
SecretKeyMap::iterator begin()
{
return m_mapSecretKeys.begin();
}
SecretKeyMap::iterator end()
{
return m_mapSecretKeys.end();
}
private:
/** The map to map key identifers to secret keys. */
SecretKeyMap m_mapSecretKeys;
/** Flag whether key buffers should be non pagable. */
bool m_fKeyBufNonPageable;
};
#endif /* !MAIN_INCLUDED_SecretKeyStore_h */
|
