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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/* $Id: SecretKeyStore.cpp $ */
/** @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
*/
#include <VBox/err.h>
#include <VBox/log.h>
#include <iprt/assert.h>
#include <iprt/asm.h>
#include <iprt/memsafer.h>
#include "SecretKeyStore.h"
SecretKey::SecretKey(const uint8_t *pbKey, size_t cbKey, bool fKeyBufNonPageable)
{
m_cRefs = 0;
m_fRemoveOnSuspend = false;
m_cUsers = 0;
m_cbKey = cbKey;
int vrc = RTMemSaferAllocZEx((void **)&this->m_pbKey, cbKey,
fKeyBufNonPageable ? RTMEMSAFER_F_REQUIRE_NOT_PAGABLE : 0);
if (RT_SUCCESS(vrc))
{
memcpy(this->m_pbKey, pbKey, cbKey);
/* Scramble content to make retrieving the key more difficult. */
vrc = RTMemSaferScramble(this->m_pbKey, cbKey);
}
else
throw vrc;
}
SecretKey::~SecretKey()
{
Assert(!m_cRefs);
RTMemSaferFree(m_pbKey, m_cbKey);
m_cRefs = 0;
m_pbKey = NULL;
m_cbKey = 0;
m_fRemoveOnSuspend = false;
m_cUsers = 0;
}
uint32_t SecretKey::retain()
{
uint32_t cRefs = ASMAtomicIncU32(&m_cRefs);
if (cRefs == 1)
{
int vrc = RTMemSaferUnscramble(m_pbKey, m_cbKey);
AssertRC(vrc);
}
return cRefs;
}
uint32_t SecretKey::release()
{
uint32_t cRefs = ASMAtomicDecU32(&m_cRefs);
if (!cRefs)
{
int vrc = RTMemSaferScramble(m_pbKey, m_cbKey);
AssertRC(vrc);
}
return cRefs;
}
uint32_t SecretKey::refCount()
{
return m_cRefs;
}
int SecretKey::setUsers(uint32_t cUsers)
{
m_cUsers = cUsers;
return VINF_SUCCESS;
}
uint32_t SecretKey::getUsers()
{
return m_cUsers;
}
int SecretKey::setRemoveOnSuspend(bool fRemoveOnSuspend)
{
m_fRemoveOnSuspend = fRemoveOnSuspend;
return VINF_SUCCESS;
}
bool SecretKey::getRemoveOnSuspend()
{
return m_fRemoveOnSuspend;
}
const void *SecretKey::getKeyBuffer()
{
AssertReturn(m_cRefs > 0, NULL);
return m_pbKey;
}
size_t SecretKey::getKeySize()
{
return m_cbKey;
}
SecretKeyStore::SecretKeyStore(bool fKeyBufNonPageable)
{
m_fKeyBufNonPageable = fKeyBufNonPageable;
}
SecretKeyStore::~SecretKeyStore()
{
int vrc = deleteAllSecretKeys(false /* fSuspend */, true /* fForce */);
AssertRC(vrc);
}
int SecretKeyStore::addSecretKey(const com::Utf8Str &strKeyId, const uint8_t *pbKey, size_t cbKey)
{
/* Check that the ID is not existing already. */
SecretKeyMap::const_iterator it = m_mapSecretKeys.find(strKeyId);
if (it != m_mapSecretKeys.end())
return VERR_ALREADY_EXISTS;
SecretKey *pKey = NULL;
try
{
pKey = new SecretKey(pbKey, cbKey, m_fKeyBufNonPageable);
m_mapSecretKeys.insert(std::make_pair(strKeyId, pKey));
}
catch (int vrc)
{
return vrc;
}
catch (std::bad_alloc &)
{
if (pKey)
delete pKey;
return VERR_NO_MEMORY;
}
return VINF_SUCCESS;
}
int SecretKeyStore::deleteSecretKey(const com::Utf8Str &strKeyId)
{
SecretKeyMap::iterator it = m_mapSecretKeys.find(strKeyId);
if (it == m_mapSecretKeys.end())
return VERR_NOT_FOUND;
SecretKey *pKey = it->second;
if (pKey->refCount() != 0)
return VERR_RESOURCE_IN_USE;
m_mapSecretKeys.erase(it);
delete pKey;
return VINF_SUCCESS;
}
int SecretKeyStore::retainSecretKey(const com::Utf8Str &strKeyId, SecretKey **ppKey)
{
SecretKeyMap::const_iterator it = m_mapSecretKeys.find(strKeyId);
if (it == m_mapSecretKeys.end())
return VERR_NOT_FOUND;
SecretKey *pKey = it->second;
pKey->retain();
*ppKey = pKey;
return VINF_SUCCESS;
}
int SecretKeyStore::releaseSecretKey(const com::Utf8Str &strKeyId)
{
SecretKeyMap::const_iterator it = m_mapSecretKeys.find(strKeyId);
if (it == m_mapSecretKeys.end())
return VERR_NOT_FOUND;
SecretKey *pKey = it->second;
pKey->release();
return VINF_SUCCESS;
}
int SecretKeyStore::deleteAllSecretKeys(bool fSuspend, bool fForce)
{
/* First check whether a key is still in use. */
if (!fForce)
{
for (SecretKeyMap::iterator it = m_mapSecretKeys.begin();
it != m_mapSecretKeys.end();
++it)
{
SecretKey *pKey = it->second;
if ( pKey->refCount()
&& ( ( pKey->getRemoveOnSuspend()
&& fSuspend)
|| !fSuspend))
return VERR_RESOURCE_IN_USE;
}
}
SecretKeyMap::iterator it = m_mapSecretKeys.begin();
while (it != m_mapSecretKeys.end())
{
SecretKey *pKey = it->second;
if ( pKey->getRemoveOnSuspend()
|| !fSuspend)
{
AssertMsg(!pKey->refCount(), ("No one should access the stored key at this point anymore!\n"));
delete pKey;
SecretKeyMap::iterator itNext = it;
++itNext;
m_mapSecretKeys.erase(it);
it = itNext;
}
else
++it;
}
return VINF_SUCCESS;
}
|
