| OLD | NEW |
| 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #include "net/quic/crypto/aes_128_gcm_12_encrypter.h" | 5 #include "net/quic/crypto/aes_128_gcm_12_encrypter.h" |
| 6 | 6 |
| 7 #include <nss.h> | |
| 8 #include <pk11pub.h> | 7 #include <pk11pub.h> |
| 9 #include <secerr.h> | 8 #include <secerr.h> |
| 10 | 9 |
| 11 #include "base/lazy_instance.h" | 10 #include "base/lazy_instance.h" |
| 12 #include "base/memory/scoped_ptr.h" | |
| 13 #include "crypto/ghash.h" | 11 #include "crypto/ghash.h" |
| 14 #include "crypto/scoped_nss_types.h" | 12 #include "crypto/scoped_nss_types.h" |
| 15 | 13 |
| 16 #if defined(USE_NSS) | 14 #if defined(USE_NSS) |
| 17 #include <dlfcn.h> | 15 #include <dlfcn.h> |
| 18 #endif | 16 #endif |
| 19 | 17 |
| 20 using base::StringPiece; | 18 using base::StringPiece; |
| 21 | 19 |
| 22 namespace net { | 20 namespace net { |
| 23 | 21 |
| 24 namespace { | 22 namespace { |
| 25 | 23 |
| 26 // The pkcs11t.h header in NSS versions older than 3.14 does not have the CTR | 24 const size_t kKeySize = 16; |
| 27 // and GCM types, so define them here. | 25 const size_t kNoncePrefixSize = 4; |
| 28 #if !defined(CKM_AES_CTR) | |
| 29 #define CKM_AES_CTR 0x00001086 | |
| 30 #define CKM_AES_GCM 0x00001087 | |
| 31 | |
| 32 struct CK_AES_CTR_PARAMS { | |
| 33 CK_ULONG ulCounterBits; | |
| 34 CK_BYTE cb[16]; | |
| 35 }; | |
| 36 | |
| 37 struct CK_GCM_PARAMS { | |
| 38 CK_BYTE_PTR pIv; | |
| 39 CK_ULONG ulIvLen; | |
| 40 CK_BYTE_PTR pAAD; | |
| 41 CK_ULONG ulAADLen; | |
| 42 CK_ULONG ulTagBits; | |
| 43 }; | |
| 44 #endif // CKM_AES_CTR | |
| 45 | |
| 46 typedef SECStatus | |
| 47 (*PK11_EncryptFunction)( | |
| 48 PK11SymKey* symKey, CK_MECHANISM_TYPE mechanism, SECItem* param, | |
| 49 unsigned char* out, unsigned int* outLen, unsigned int maxLen, | |
| 50 const unsigned char* data, unsigned int dataLen); | |
| 51 | 26 |
| 52 // On Linux, dynamically link against the system version of libnss3.so. In | 27 // On Linux, dynamically link against the system version of libnss3.so. In |
| 53 // order to continue working on systems without up-to-date versions of NSS, | 28 // order to continue working on systems without up-to-date versions of NSS, |
| 54 // lookup PK11_Encrypt with dlsym. | 29 // lookup PK11_Encrypt with dlsym. |
| 55 | 30 |
| 56 // GcmSupportChecker is a singleton which caches the results of runtime symbol | 31 // GcmSupportChecker is a singleton which caches the results of runtime symbol |
| 57 // resolution of PK11_Encrypt. | 32 // resolution of PK11_Encrypt. |
| 58 class GcmSupportChecker { | 33 class GcmSupportChecker { |
| 59 public: | 34 public: |
| 60 static PK11_EncryptFunction pk11_encrypt_func() { | 35 static PK11_EncryptFunction pk11_encrypt_func() { |
| 61 return pk11_encrypt_func_; | 36 return pk11_encrypt_func_; |
| 62 } | 37 } |
| 63 | 38 |
| 64 static CK_MECHANISM_TYPE aes_key_mechanism() { | |
| 65 return aes_key_mechanism_; | |
| 66 } | |
| 67 | |
| 68 private: | 39 private: |
| 69 friend struct base::DefaultLazyInstanceTraits<GcmSupportChecker>; | 40 friend struct base::DefaultLazyInstanceTraits<GcmSupportChecker>; |
| 70 | 41 |
| 71 GcmSupportChecker() { | 42 GcmSupportChecker() { |
| 72 #if !defined(USE_NSS) | 43 #if !defined(USE_NSS) |
| 73 // Using a bundled version of NSS that is guaranteed to have this symbol. | 44 // Using a bundled version of NSS that is guaranteed to have this symbol. |
| 74 pk11_encrypt_func_ = PK11_Encrypt; | 45 pk11_encrypt_func_ = PK11_Encrypt; |
| 75 #else | 46 #else |
| 76 // Using system NSS libraries and PCKS #11 modules, which may not have the | 47 // Using system NSS libraries and PCKS #11 modules, which may not have the |
| 77 // necessary function (PK11_Encrypt) or mechanism support (CKM_AES_GCM). | 48 // necessary function (PK11_Encrypt) or mechanism support (CKM_AES_GCM). |
| 78 | 49 |
| 79 // If PK11_Encrypt() was successfully resolved, then NSS will support | 50 // If PK11_Encrypt() was successfully resolved, then NSS will support |
| 80 // AES-GCM directly. This was introduced in NSS 3.15. | 51 // AES-GCM directly. This was introduced in NSS 3.15. |
| 81 pk11_encrypt_func_ = (PK11_EncryptFunction)dlsym(RTLD_DEFAULT, | 52 pk11_encrypt_func_ = (PK11_EncryptFunction)dlsym(RTLD_DEFAULT, |
| 82 "PK11_Encrypt"); | 53 "PK11_Encrypt"); |
| 83 if (pk11_encrypt_func_ == NULL) { | |
| 84 aes_key_mechanism_ = CKM_AES_ECB; | |
| 85 } | |
| 86 #endif | 54 #endif |
| 87 } | 55 } |
| 88 | 56 |
| 89 // |pk11_encrypt_func_| stores the runtime symbol resolution of PK11_Encrypt. | 57 // |pk11_encrypt_func_| stores the runtime symbol resolution of PK11_Encrypt. |
| 90 static PK11_EncryptFunction pk11_encrypt_func_; | 58 static PK11_EncryptFunction pk11_encrypt_func_; |
| 91 | |
| 92 // The correct value for |aes_key_mechanism_| is CKM_AES_GCM, but because of | |
| 93 // NSS bug https://bugzilla.mozilla.org/show_bug.cgi?id=853285 (to be fixed in | |
| 94 // NSS 3.15), use CKM_AES_ECB for NSS versions older than 3.15. | |
| 95 static CK_MECHANISM_TYPE aes_key_mechanism_; | |
| 96 }; | 59 }; |
| 97 | 60 |
| 98 // static | 61 // static |
| 99 PK11_EncryptFunction GcmSupportChecker::pk11_encrypt_func_ = NULL; | 62 PK11_EncryptFunction GcmSupportChecker::pk11_encrypt_func_ = NULL; |
| 100 | 63 |
| 101 // static | |
| 102 CK_MECHANISM_TYPE GcmSupportChecker::aes_key_mechanism_ = CKM_AES_GCM; | |
| 103 | |
| 104 base::LazyInstance<GcmSupportChecker>::Leaky g_gcm_support_checker = | 64 base::LazyInstance<GcmSupportChecker>::Leaky g_gcm_support_checker = |
| 105 LAZY_INSTANCE_INITIALIZER; | 65 LAZY_INSTANCE_INITIALIZER; |
| 106 | 66 |
| 107 const size_t kKeySize = 16; | |
| 108 const size_t kNoncePrefixSize = 4; | |
| 109 const size_t kAESNonceSize = 12; | |
| 110 | |
| 111 // Calls PK11_Encrypt if it's available. Otherwise, emulates CKM_AES_GCM using | 67 // Calls PK11_Encrypt if it's available. Otherwise, emulates CKM_AES_GCM using |
| 112 // CKM_AES_CTR and the GaloisHash class. | 68 // CKM_AES_CTR and the GaloisHash class. |
| 113 SECStatus My_Encrypt(PK11SymKey* key, | 69 SECStatus My_Encrypt(PK11SymKey* key, |
| 114 CK_MECHANISM_TYPE mechanism, | 70 CK_MECHANISM_TYPE mechanism, |
| 115 SECItem* param, | 71 SECItem* param, |
| 116 unsigned char* out, | 72 unsigned char* out, |
| 117 unsigned int* out_len, | 73 unsigned int* out_len, |
| 118 unsigned int max_len, | 74 unsigned int max_len, |
| 119 const unsigned char* data, | 75 const unsigned char* data, |
| 120 unsigned int data_len) { | 76 unsigned int data_len) { |
| (...skipping 122 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 243 for (unsigned int i = 0; i < Aes128Gcm12Encrypter::kAuthTagSize; i++) { | 199 for (unsigned int i = 0; i < Aes128Gcm12Encrypter::kAuthTagSize; i++) { |
| 244 out[output_len + i] ^= tag_mask[i]; | 200 out[output_len + i] ^= tag_mask[i]; |
| 245 } | 201 } |
| 246 | 202 |
| 247 *out_len = output_len + Aes128Gcm12Encrypter::kAuthTagSize; | 203 *out_len = output_len + Aes128Gcm12Encrypter::kAuthTagSize; |
| 248 return SECSuccess; | 204 return SECSuccess; |
| 249 } | 205 } |
| 250 | 206 |
| 251 } // namespace | 207 } // namespace |
| 252 | 208 |
| 253 Aes128Gcm12Encrypter::Aes128Gcm12Encrypter() { | 209 Aes128Gcm12Encrypter::Aes128Gcm12Encrypter() |
| 210 : AeadBaseEncrypter(CKM_AES_GCM, My_Encrypt, kKeySize, kAuthTagSize, |
| 211 kNoncePrefixSize) { |
| 212 COMPILE_ASSERT(kKeySize <= kMaxKeySize, key_size_too_big); |
| 213 COMPILE_ASSERT(kNoncePrefixSize <= kMaxNoncePrefixSize, |
| 214 nonce_prefix_size_too_big); |
| 254 ignore_result(g_gcm_support_checker.Get()); | 215 ignore_result(g_gcm_support_checker.Get()); |
| 255 } | 216 } |
| 256 | 217 |
| 257 Aes128Gcm12Encrypter::~Aes128Gcm12Encrypter() {} | 218 Aes128Gcm12Encrypter::~Aes128Gcm12Encrypter() {} |
| 258 | 219 |
| 259 bool Aes128Gcm12Encrypter::SetKey(StringPiece key) { | 220 void Aes128Gcm12Encrypter::FillAeadParams(StringPiece nonce, |
| 260 DCHECK_EQ(key.size(), sizeof(key_)); | 221 StringPiece associated_data, |
| 261 if (key.size() != sizeof(key_)) { | 222 size_t auth_tag_size, |
| 262 return false; | 223 AeadParams* aead_params) const { |
| 263 } | 224 aead_params->len = sizeof(aead_params->data.gcm_params); |
| 264 memcpy(key_, key.data(), key.size()); | 225 CK_GCM_PARAMS* gcm_params = &aead_params->data.gcm_params; |
| 265 return true; | 226 gcm_params->pIv = |
| 266 } | |
| 267 | |
| 268 bool Aes128Gcm12Encrypter::SetNoncePrefix(StringPiece nonce_prefix) { | |
| 269 DCHECK_EQ(nonce_prefix.size(), kNoncePrefixSize); | |
| 270 if (nonce_prefix.size() != kNoncePrefixSize) { | |
| 271 return false; | |
| 272 } | |
| 273 COMPILE_ASSERT(sizeof(nonce_prefix_) == kNoncePrefixSize, bad_nonce_length); | |
| 274 memcpy(nonce_prefix_, nonce_prefix.data(), nonce_prefix.size()); | |
| 275 return true; | |
| 276 } | |
| 277 | |
| 278 bool Aes128Gcm12Encrypter::Encrypt(StringPiece nonce, | |
| 279 StringPiece associated_data, | |
| 280 StringPiece plaintext, | |
| 281 unsigned char* output) { | |
| 282 if (nonce.size() != kNoncePrefixSize + sizeof(QuicPacketSequenceNumber)) { | |
| 283 return false; | |
| 284 } | |
| 285 | |
| 286 size_t ciphertext_size = GetCiphertextSize(plaintext.length()); | |
| 287 | |
| 288 // Import key_ into NSS. | |
| 289 SECItem key_item; | |
| 290 key_item.type = siBuffer; | |
| 291 key_item.data = key_; | |
| 292 key_item.len = sizeof(key_); | |
| 293 PK11SlotInfo* slot = PK11_GetInternalSlot(); | |
| 294 // The exact value of the |origin| argument doesn't matter to NSS as long as | |
| 295 // it's not PK11_OriginFortezzaHack, so we pass PK11_OriginUnwrap as a | |
| 296 // placeholder. | |
| 297 crypto::ScopedPK11SymKey aes_key(PK11_ImportSymKey( | |
| 298 slot, GcmSupportChecker::aes_key_mechanism(), PK11_OriginUnwrap, | |
| 299 CKA_ENCRYPT, &key_item, NULL)); | |
| 300 PK11_FreeSlot(slot); | |
| 301 slot = NULL; | |
| 302 if (!aes_key) { | |
| 303 DVLOG(1) << "PK11_ImportSymKey failed"; | |
| 304 return false; | |
| 305 } | |
| 306 | |
| 307 CK_GCM_PARAMS gcm_params = {0}; | |
| 308 gcm_params.pIv = | |
| 309 reinterpret_cast<CK_BYTE*>(const_cast<char*>(nonce.data())); | 227 reinterpret_cast<CK_BYTE*>(const_cast<char*>(nonce.data())); |
| 310 gcm_params.ulIvLen = nonce.size(); | 228 gcm_params->ulIvLen = nonce.size(); |
| 311 gcm_params.pAAD = | 229 gcm_params->pAAD = |
| 312 reinterpret_cast<CK_BYTE*>(const_cast<char*>(associated_data.data())); | 230 reinterpret_cast<CK_BYTE*>(const_cast<char*>(associated_data.data())); |
| 313 gcm_params.ulAADLen = associated_data.size(); | 231 gcm_params->ulAADLen = associated_data.size(); |
| 314 gcm_params.ulTagBits = kAuthTagSize * 8; | 232 gcm_params->ulTagBits = auth_tag_size * 8; |
| 315 | |
| 316 SECItem param; | |
| 317 param.type = siBuffer; | |
| 318 param.data = reinterpret_cast<unsigned char*>(&gcm_params); | |
| 319 param.len = sizeof(gcm_params); | |
| 320 | |
| 321 unsigned int output_len; | |
| 322 if (My_Encrypt(aes_key.get(), CKM_AES_GCM, ¶m, | |
| 323 output, &output_len, ciphertext_size, | |
| 324 reinterpret_cast<const unsigned char*>(plaintext.data()), | |
| 325 plaintext.size()) != SECSuccess) { | |
| 326 DVLOG(1) << "My_Encrypt failed"; | |
| 327 return false; | |
| 328 } | |
| 329 | |
| 330 if (output_len != ciphertext_size) { | |
| 331 DVLOG(1) << "Wrong output length"; | |
| 332 return false; | |
| 333 } | |
| 334 | |
| 335 return true; | |
| 336 } | |
| 337 | |
| 338 QuicData* Aes128Gcm12Encrypter::EncryptPacket( | |
| 339 QuicPacketSequenceNumber sequence_number, | |
| 340 StringPiece associated_data, | |
| 341 StringPiece plaintext) { | |
| 342 size_t ciphertext_size = GetCiphertextSize(plaintext.length()); | |
| 343 scoped_ptr<char[]> ciphertext(new char[ciphertext_size]); | |
| 344 | |
| 345 // TODO(ianswett): Introduce a check to ensure that we don't encrypt with the | |
| 346 // same sequence number twice. | |
| 347 uint8 nonce[kNoncePrefixSize + sizeof(sequence_number)]; | |
| 348 COMPILE_ASSERT(sizeof(nonce) == kAESNonceSize, bad_sequence_number_size); | |
| 349 memcpy(nonce, nonce_prefix_, kNoncePrefixSize); | |
| 350 memcpy(nonce + kNoncePrefixSize, &sequence_number, sizeof(sequence_number)); | |
| 351 if (!Encrypt(StringPiece(reinterpret_cast<char*>(nonce), sizeof(nonce)), | |
| 352 associated_data, plaintext, | |
| 353 reinterpret_cast<unsigned char*>(ciphertext.get()))) { | |
| 354 return NULL; | |
| 355 } | |
| 356 | |
| 357 return new QuicData(ciphertext.release(), ciphertext_size, true); | |
| 358 } | |
| 359 | |
| 360 size_t Aes128Gcm12Encrypter::GetKeySize() const { return kKeySize; } | |
| 361 | |
| 362 size_t Aes128Gcm12Encrypter::GetNoncePrefixSize() const { | |
| 363 return kNoncePrefixSize; | |
| 364 } | |
| 365 | |
| 366 size_t Aes128Gcm12Encrypter::GetMaxPlaintextSize(size_t ciphertext_size) const { | |
| 367 return ciphertext_size - kAuthTagSize; | |
| 368 } | |
| 369 | |
| 370 // An AEAD_AES_128_GCM_12 ciphertext is exactly 12 bytes longer than its | |
| 371 // corresponding plaintext. | |
| 372 size_t Aes128Gcm12Encrypter::GetCiphertextSize(size_t plaintext_size) const { | |
| 373 return plaintext_size + kAuthTagSize; | |
| 374 } | |
| 375 | |
| 376 StringPiece Aes128Gcm12Encrypter::GetKey() const { | |
| 377 return StringPiece(reinterpret_cast<const char*>(key_), sizeof(key_)); | |
| 378 } | |
| 379 | |
| 380 StringPiece Aes128Gcm12Encrypter::GetNoncePrefix() const { | |
| 381 return StringPiece(reinterpret_cast<const char*>(nonce_prefix_), | |
| 382 kNoncePrefixSize); | |
| 383 } | 233 } |
| 384 | 234 |
| 385 } // namespace net | 235 } // namespace net |
| OLD | NEW |