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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "NSSKeyStore.h"
#include "ScopedNSSTypes.h"
#include "mozilla/AbstractThread.h"
#include "mozilla/Base64.h"
#include "mozilla/Logging.h"
#include "mozilla/SyncRunnable.h"
#include "nsIThread.h"
#include "nsNSSComponent.h"
#include "nsPK11TokenDB.h"
#include "nsXULAppAPI.h"
/* Implementing OSKeyStore when there is no platform specific one.
* This key store instead puts the keys into the NSS DB.
*/
using namespace mozilla;
using mozilla::SyncRunnable;
LazyLogModule gNSSKeyStoreLog("nsskeystore");
NSSKeyStore::NSSKeyStore() {
MOZ_ASSERT(XRE_IsParentProcess());
if (!XRE_IsParentProcess()) {
// This shouldn't happen as this is only initialised when creating the
// OSKeyStore, which is ParentProcessOnly.
return;
}
(void)EnsureNSSInitializedChromeOrContent();
(void)InitToken();
}
NSSKeyStore::~NSSKeyStore() = default;
nsresult NSSKeyStore::InitToken() {
if (!mSlot) {
mSlot = UniquePK11SlotInfo(PK11_GetInternalKeySlot());
if (!mSlot) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug,
("Error getting internal key slot"));
return NS_ERROR_NOT_AVAILABLE;
}
}
return NS_OK;
}
nsresult NSSKeyStore::StoreSecret(const nsACString& aSecret,
const nsACString& aLabel) {
NS_ENSURE_STATE(mSlot);
// It is possible for multiple keys to have the same nickname in NSS. To
// prevent the problem of not knowing which key to use in the future, simply
// delete all keys with this nickname before storing a new one.
nsresult rv = DeleteSecret(aLabel);
if (NS_FAILED(rv)) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug,
("DeleteSecret before StoreSecret failed"));
return rv;
}
uint8_t* p = BitwiseCast<uint8_t*, const char*>(aSecret.BeginReading());
UniqueSECItem key(SECITEM_AllocItem(nullptr, nullptr, aSecret.Length()));
if (!key) {
return NS_ERROR_OUT_OF_MEMORY;
}
key->type = siBuffer;
memcpy(key->data, p, aSecret.Length());
key->len = aSecret.Length();
UniquePK11SymKey symKey(
PK11_ImportSymKey(mSlot.get(), CKM_AES_GCM, PK11_OriginUnwrap,
CKA_DECRYPT | CKA_ENCRYPT, key.get(), nullptr));
if (!symKey) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug, ("Error creating NSS SymKey"));
return NS_ERROR_FAILURE;
}
UniquePK11SymKey storedKey(
PK11_ConvertSessionSymKeyToTokenSymKey(symKey.get(), nullptr));
if (!storedKey) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug,
("Error storing NSS SymKey in DB"));
return NS_ERROR_FAILURE;
}
SECStatus srv =
PK11_SetSymKeyNickname(storedKey.get(), PromiseFlatCString(aLabel).get());
if (srv != SECSuccess) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug, ("Error naming NSS SymKey"));
(void)PK11_DeleteTokenSymKey(storedKey.get());
return NS_ERROR_FAILURE;
}
return NS_OK;
}
nsresult NSSKeyStore::DeleteSecret(const nsACString& aLabel) {
NS_ENSURE_STATE(mSlot);
UniquePK11SymKey symKey(PK11_ListFixedKeysInSlot(
mSlot.get(), const_cast<char*>(PromiseFlatCString(aLabel).get()),
nullptr));
if (!symKey) {
// Couldn't find the key or something is wrong. Be nice.
return NS_OK;
}
for (PK11SymKey* tmp = symKey.get(); tmp; tmp = PK11_GetNextSymKey(tmp)) {
SECStatus srv = PK11_DeleteTokenSymKey(tmp);
if (srv != SECSuccess) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug, ("Error deleting NSS SymKey"));
return NS_ERROR_FAILURE;
}
}
return NS_OK;
}
nsresult NSSKeyStore::SecretAvailable(const nsACString& aLabel) {
if (!mSlot) {
return NS_ERROR_NOT_AVAILABLE;
}
UniquePK11SymKey symKey(PK11_ListFixedKeysInSlot(
mSlot.get(), const_cast<char*>(PromiseFlatCString(aLabel).get()),
nullptr));
if (!symKey) {
return NS_ERROR_NOT_AVAILABLE;
}
return NS_OK;
}
nsresult NSSKeyStore::EncryptDecrypt(const nsACString& aLabel,
const std::vector<uint8_t>& inBytes,
std::vector<uint8_t>& outBytes,
bool encrypt) {
NS_ENSURE_STATE(mSlot);
UniquePK11SymKey symKey(PK11_ListFixedKeysInSlot(
mSlot.get(), const_cast<char*>(PromiseFlatCString(aLabel).get()),
nullptr));
if (!symKey) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug,
("Error finding key for given label"));
return NS_ERROR_FAILURE;
}
return DoCipher(symKey, inBytes, outBytes, encrypt);
}
nsresult NSSKeyStore::RetrieveSecret(const nsACString& aLabel,
/* out */ nsACString& aSecret) {
NS_ENSURE_STATE(mSlot);
UniquePK11SymKey symKey(PK11_ListFixedKeysInSlot(
mSlot.get(), const_cast<char*>(PromiseFlatCString(aLabel).get()),
nullptr));
if (!symKey) {
MOZ_LOG(gNSSKeyStoreLog, LogLevel::Debug,
("Error finding key for given label"));
return NS_ERROR_FAILURE;
}
// Unfortunately we can't use PK11_ExtractKeyValue(symKey.get()) here because
// softoken marks all token objects of type CKO_SECRET_KEY as sensitive. So
// we have to wrap and unwrap symKey to obtain a non-sensitive copy of symKey
// as a session object.
const CK_MECHANISM_TYPE mechanism = CKM_AES_KEY_WRAP_KWP;
UniquePK11SymKey wrappingKey(
PK11_KeyGen(mSlot.get(), CKM_AES_KEY_GEN, nullptr, 16, nullptr));
if (!wrappingKey) {
return mozilla::psm::GetXPCOMFromNSSError(PR_GetError());
}
SECItem wrapLen = {siBuffer, nullptr, 0};
nsresult rv = MapSECStatus(PK11_WrapSymKey(
mechanism, nullptr, wrappingKey.get(), symKey.get(), &wrapLen));
NS_ENSURE_SUCCESS(rv, rv);
if (wrapLen.len > INT_MAX - 8) { /* PK11_UnwrapSymKey takes an int keySize */
return NS_ERROR_FAILURE;
}
// Allocate an extra 8 bytes for CKM_AES_KEY_WRAP_KWP overhead.
UniqueSECItem wrappedKey(
SECITEM_AllocItem(nullptr, nullptr, wrapLen.len + 8));
if (!wrappedKey) {
return NS_ERROR_FAILURE;
}
rv = MapSECStatus(PK11_WrapSymKey(mechanism, nullptr, wrappingKey.get(),
symKey.get(), wrappedKey.get()));
NS_ENSURE_SUCCESS(rv, rv);
UniquePK11SymKey unwrappedKey(PK11_UnwrapSymKey(
wrappingKey.get(), mechanism, nullptr, wrappedKey.get(), CKM_AES_GCM,
CKA_DECRYPT, static_cast<int>(wrapLen.len)));
if (!unwrappedKey) {
return mozilla::psm::GetXPCOMFromNSSError(PR_GetError());
}
rv = MapSECStatus(PK11_ExtractKeyValue(unwrappedKey.get()));
NS_ENSURE_SUCCESS(rv, rv);
const SECItem* keyData = PK11_GetKeyData(unwrappedKey.get()); /* weak ref */
if (!keyData) {
return NS_ERROR_FAILURE;
}
aSecret.Assign(reinterpret_cast<char*>(keyData->data), keyData->len);
return NS_OK;
}
|
