OLD | NEW |
(Empty) | |
| 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 |
| 3 // found in the LICENSE file. |
| 4 |
| 5 #include "net/android/keystore_openssl.h" |
| 6 |
| 7 #include <jni.h> |
| 8 #include <openssl/bn.h> |
| 9 // This include is required to get the ECDSA_METHOD structure definition |
| 10 // which isn't currently part of the OpenSSL official ABI. This should |
| 11 // not be a concern for Chromium which always links against its own |
| 12 // version of the library on Android. |
| 13 #include <openssl/crypto/ecdsa/ecs_locl.h> |
| 14 // And this one is needed for the EC_GROUP definition. |
| 15 #include <openssl/crypto/ec/ec_lcl.h> |
| 16 #include <openssl/dsa.h> |
| 17 #include <openssl/ec.h> |
| 18 #include <openssl/engine.h> |
| 19 #include <openssl/evp.h> |
| 20 #include <openssl/rsa.h> |
| 21 |
| 22 #include "base/android/build_info.h" |
| 23 #include "base/android/jni_android.h" |
| 24 #include "base/android/scoped_java_ref.h" |
| 25 #include "base/basictypes.h" |
| 26 #include "base/lazy_instance.h" |
| 27 #include "base/logging.h" |
| 28 #include "crypto/openssl_util.h" |
| 29 #include "net/android/keystore.h" |
| 30 #include "net/base/ssl_client_cert_type.h" |
| 31 |
| 32 // IMPORTANT NOTE: The following code will currently only work when used |
| 33 // to implement client certificate support with OpenSSL. That's because |
| 34 // only the signing operations used in this use case are implemented here. |
| 35 // |
| 36 // Generally speaking, OpenSSL provides many different ways to sign |
| 37 // digests. This code doesn't support all these cases, only the ones that |
| 38 // are required to sign the MAC during the OpenSSL handshake for TLS < 1.2. |
| 39 // |
| 40 // The OpenSSL EVP_PKEY type is a generic wrapper around key pairs. |
| 41 // Internally, it can hold a pointer to a RSA, DSA or ECDSA structure, |
| 42 // which model keypair implementations of each respective crypto |
| 43 // algorithm. |
| 44 // |
| 45 // The RSA type has a 'method' field pointer to a vtable-like structure |
| 46 // called a RSA_METHOD. This contains several function pointers that |
| 47 // correspond to operations on RSA keys (e.g. decode/encode with public |
| 48 // key, decode/encode with private key, signing, validation), as well as |
| 49 // a few flags. |
| 50 // |
| 51 // For example, the RSA_sign() function will call "method->rsa_sign()" if |
| 52 // method->rsa_sign is not NULL, otherwise, it will perform a regular |
| 53 // signing operation using the other fields in the RSA structure (which |
| 54 // are used to hold the typical modulus / exponent / parameters for the |
| 55 // key pair). |
| 56 // |
| 57 // This source file thus defines a custom RSA_METHOD structure, which |
| 58 // fields points to static methods used to implement the corresponding |
| 59 // RSA operation using platform Android APIs. |
| 60 // |
| 61 // However, the platform APIs require a jobject JNI reference to work. |
| 62 // It must be stored in the RSA instance, or made accessible when the |
| 63 // custom RSA methods are called. This is done by using RSA_set_app_data() |
| 64 // and RSA_get_app_data(). |
| 65 // |
| 66 // One can thus _directly_ create a new EVP_PKEY that uses a custom RSA |
| 67 // object with the following: |
| 68 // |
| 69 // RSA* rsa = RSA_new() |
| 70 // RSA_set_method(&custom_rsa_method); |
| 71 // RSA_set_app_data(rsa, jni_private_key); |
| 72 // |
| 73 // EVP_PKEY* pkey = EVP_PKEY_new(); |
| 74 // EVP_PKEY_assign_RSA(pkey, rsa); |
| 75 // |
| 76 // Note that because EVP_PKEY_assign_RSA() is used, instead of |
| 77 // EVP_PKEY_set1_RSA(), the new EVP_PKEY now owns the RSA object, and |
| 78 // will destroy it when it is itself destroyed. |
| 79 // |
| 80 // Unfortunately, such objects cannot be used with RSA_size(), which |
| 81 // totally ignores the RSA_METHOD pointers. Instead, it is necessary |
| 82 // to manually setup the modulus field (n) in the RSA object, with a |
| 83 // value that matches the wrapped PrivateKey object. See GetRsaPkeyWrapper |
| 84 // for full details. |
| 85 // |
| 86 // Similarly, custom DSA_METHOD and ECDSA_METHOD are defined by this source |
| 87 // file, and appropriate field setups are performed to ensure that |
| 88 // DSA_size() and ECDSA_size() work properly with the wrapper EVP_PKEY. |
| 89 // |
| 90 // Note that there is no need to define an OpenSSL ENGINE here. These |
| 91 // are objects that can be used to expose custom methods (i.e. either |
| 92 // RSA_METHOD, DSA_METHOD, ECDSA_METHOD, and a large number of other ones |
| 93 // for types not related to this source file), and make them used by |
| 94 // default for a lot of operations. Very fortunately, this is not needed |
| 95 // here, which saves a lot of complexity. |
| 96 |
| 97 using base::android::ScopedJavaGlobalRef; |
| 98 |
| 99 namespace net { |
| 100 namespace android { |
| 101 |
| 102 namespace { |
| 103 |
| 104 typedef crypto::ScopedOpenSSL<EVP_PKEY, EVP_PKEY_free> ScopedEVP_PKEY; |
| 105 typedef crypto::ScopedOpenSSL<RSA, RSA_free> ScopedRSA; |
| 106 typedef crypto::ScopedOpenSSL<DSA, DSA_free> ScopedDSA; |
| 107 typedef crypto::ScopedOpenSSL<EC_KEY, EC_KEY_free> ScopedEC_KEY; |
| 108 typedef crypto::ScopedOpenSSL<EC_GROUP, EC_GROUP_free> ScopedEC_GROUP; |
| 109 |
| 110 // Custom RSA_METHOD that uses the platform APIs. |
| 111 // Note that for now, only signing through RSA_sign() is really supported. |
| 112 // all other method pointers are either stubs returning errors, or no-ops. |
| 113 // See <openssl/rsa.h> for exact declaration of RSA_METHOD. |
| 114 |
| 115 int RsaMethodPubEnc(int flen, |
| 116 const unsigned char* from, |
| 117 unsigned char* to, |
| 118 RSA* rsa, |
| 119 int padding) { |
| 120 NOTIMPLEMENTED(); |
| 121 RSAerr(RSA_F_RSA_PUBLIC_ENCRYPT, RSA_R_RSA_OPERATIONS_NOT_SUPPORTED); |
| 122 return -1; |
| 123 } |
| 124 |
| 125 int RsaMethodPubDec(int flen, |
| 126 const unsigned char* from, |
| 127 unsigned char* to, |
| 128 RSA* rsa, |
| 129 int padding) { |
| 130 NOTIMPLEMENTED(); |
| 131 RSAerr(RSA_F_RSA_PUBLIC_DECRYPT, RSA_R_RSA_OPERATIONS_NOT_SUPPORTED); |
| 132 return -1; |
| 133 } |
| 134 |
| 135 int RsaMethodPrivEnc(int flen, |
| 136 const unsigned char *from, |
| 137 unsigned char *to, |
| 138 RSA *rsa, |
| 139 int padding) { |
| 140 NOTIMPLEMENTED(); |
| 141 RSAerr(RSA_F_RSA_PRIVATE_ENCRYPT, RSA_R_RSA_OPERATIONS_NOT_SUPPORTED); |
| 142 return -1; |
| 143 } |
| 144 |
| 145 int RsaMethodPrivDec(int flen, |
| 146 const unsigned char* from, |
| 147 unsigned char* to, |
| 148 RSA* rsa, |
| 149 int padding) { |
| 150 NOTIMPLEMENTED(); |
| 151 RSAerr(RSA_F_RSA_PRIVATE_DECRYPT, RSA_R_RSA_OPERATIONS_NOT_SUPPORTED); |
| 152 return -1; |
| 153 } |
| 154 |
| 155 int RsaMethodInit(RSA* rsa) { |
| 156 // Required to ensure that RsaMethodSign will be called. |
| 157 rsa->flags |= RSA_FLAG_SIGN_VER; |
| 158 return 0; |
| 159 } |
| 160 |
| 161 int RsaMethodFinish(RSA* rsa) { |
| 162 // Ensure the global JNI reference created with this wrapper is |
| 163 // properly destroyed with it. |
| 164 jobject key = reinterpret_cast<jobject>(RSA_get_app_data(rsa)); |
| 165 if (key != NULL) { |
| 166 RSA_set_app_data(rsa, NULL); |
| 167 JNIEnv* env = base::android::AttachCurrentThread(); |
| 168 env->DeleteGlobalRef(key); |
| 169 } |
| 170 // Actual return value is ignored by OpenSSL. There are no docs |
| 171 // explaining what this is supposed to be. |
| 172 return 0; |
| 173 } |
| 174 |
| 175 int RsaMethodSign(int type, |
| 176 const unsigned char* message, |
| 177 unsigned int message_len, |
| 178 unsigned char* signature, |
| 179 unsigned int* signature_len, |
| 180 const RSA* rsa) { |
| 181 // This is only used for client certificate support, which |
| 182 // will always pass the NID_md5_sha1 |type| value. |
| 183 DCHECK_EQ(NID_md5_sha1, type); |
| 184 if (type != NID_md5_sha1) { |
| 185 RSAerr(RSA_F_RSA_SIGN, RSA_R_UNKNOWN_ALGORITHM_TYPE); |
| 186 return 0; |
| 187 } |
| 188 // Retrieve private key JNI reference. |
| 189 jobject private_key = reinterpret_cast<jobject>(RSA_get_app_data(rsa)); |
| 190 if (!private_key) { |
| 191 LOG(WARNING) << "Null JNI reference passed to RsaMethodSign!"; |
| 192 return 0; |
| 193 } |
| 194 // Sign message with it through JNI. |
| 195 base::StringPiece message_piece(reinterpret_cast<const char*>(message), |
| 196 static_cast<size_t>(message_len)); |
| 197 std::vector<uint8> result; |
| 198 |
| 199 if (!RawSignDigestWithPrivateKey( |
| 200 private_key, message_piece, &result)) { |
| 201 LOG(WARNING) << "Could not sign message in RsaMethodSign!"; |
| 202 return 0; |
| 203 } |
| 204 |
| 205 size_t expected_size = static_cast<size_t>(RSA_size(rsa)); |
| 206 if (result.size() > expected_size) { |
| 207 LOG(ERROR) << "RSA Signature size mismatch, actual: " |
| 208 << result.size() << ", expected <= " << expected_size; |
| 209 return 0; |
| 210 } |
| 211 |
| 212 // Copy result to OpenSSL-provided buffer |
| 213 memcpy(signature, &result[0], result.size()); |
| 214 *signature_len = static_cast<unsigned int>(result.size()); |
| 215 return 1; |
| 216 } |
| 217 |
| 218 const RSA_METHOD android_rsa_method = { |
| 219 /* .name = */ "Android signing-only RSA method", |
| 220 /* .rsa_pub_enc = */ RsaMethodPubEnc, |
| 221 /* .rsa_pub_dec = */ RsaMethodPubDec, |
| 222 /* .rsa_priv_enc = */ RsaMethodPrivEnc, |
| 223 /* .rsa_priv_dec = */ RsaMethodPrivDec, |
| 224 /* .rsa_mod_exp = */ NULL, |
| 225 /* .bn_mod_exp = */ NULL, |
| 226 /* .init = */ RsaMethodInit, |
| 227 /* .finish = */ RsaMethodFinish, |
| 228 // This flag is necessary to tell OpenSSL to avoid checking the content |
| 229 // (i.e. internal fields) of the private key. Otherwise, it will complain |
| 230 // it's not valid for the certificate. |
| 231 /* .flags = */ RSA_METHOD_FLAG_NO_CHECK, |
| 232 /* .app_data = */ NULL, |
| 233 /* .rsa_sign = */ RsaMethodSign, |
| 234 /* .rsa_verify = */ NULL, |
| 235 /* .rsa_keygen = */ NULL, |
| 236 }; |
| 237 |
| 238 // Copy the contents of an encoded big integer into an existing BIGNUM. |
| 239 // This function modifies |*num| in-place. |
| 240 // |new_bytes| is the byte encoding of the new value. |
| 241 // |num| points to the BIGNUM which will be assigned with the new value. |
| 242 // Returns true on success, false otherwise. On failure, |*num| is |
| 243 // not modified. |
| 244 bool CopyBigNumFromBytes(const std::vector<uint8>& new_bytes, |
| 245 BIGNUM* num) { |
| 246 BIGNUM* ret = BN_bin2bn( |
| 247 reinterpret_cast<const unsigned char*>(&new_bytes[0]), |
| 248 static_cast<int>(new_bytes.size()), |
| 249 num); |
| 250 return (ret != NULL); |
| 251 } |
| 252 |
| 253 // Decode the contents of an encoded big integer and either create a new |
| 254 // BIGNUM object (if |*num_ptr| is NULL on input) or copy it (if |
| 255 // |*num_ptr| is not NULL). |
| 256 // |new_bytes| is the byte encoding of the new value. |
| 257 // |num_ptr| is the address of a BIGNUM pointer. |*num_ptr| can be NULL. |
| 258 // Returns true on success, false otherwise. On failure, |*num_ptr| is |
| 259 // not modified. On success, |*num_ptr| will always be non-NULL and |
| 260 // point to a valid BIGNUM object. |
| 261 bool SwapBigNumPtrFromBytes(const std::vector<uint8>& new_bytes, |
| 262 BIGNUM** num_ptr) { |
| 263 BIGNUM* old_num = *num_ptr; |
| 264 BIGNUM* new_num = BN_bin2bn( |
| 265 reinterpret_cast<const unsigned char*>(&new_bytes[0]), |
| 266 static_cast<int>(new_bytes.size()), |
| 267 old_num); |
| 268 if (new_num == NULL) |
| 269 return false; |
| 270 |
| 271 if (old_num == NULL) |
| 272 *num_ptr = new_num; |
| 273 return true; |
| 274 } |
| 275 |
| 276 // Setup an EVP_PKEY to wrap an existing platform RSA PrivateKey object. |
| 277 // |private_key| is the JNI reference (local or global) to the object. |
| 278 // |pkey| is the EVP_PKEY to setup as a wrapper. |
| 279 // Returns true on success, false otherwise. |
| 280 // On success, this creates a new global JNI reference to the object |
| 281 // that is owned by and destroyed with the EVP_PKEY. I.e. caller can |
| 282 // free |private_key| after the call. |
| 283 // IMPORTANT: The EVP_PKEY will *only* work on Android >= 4.2. For older |
| 284 // platforms, use GetRsaLegacyKey() instead. |
| 285 bool GetRsaPkeyWrapper(jobject private_key, EVP_PKEY* pkey) { |
| 286 ScopedRSA rsa(RSA_new()); |
| 287 RSA_set_method(rsa.get(), &android_rsa_method); |
| 288 |
| 289 // HACK: RSA_size() doesn't work with custom RSA_METHODs. To ensure that |
| 290 // it will return the right value, set the 'n' field of the RSA object |
| 291 // to match the private key's modulus. |
| 292 std::vector<uint8> modulus; |
| 293 if (!GetRSAKeyModulus(private_key, &modulus)) { |
| 294 LOG(ERROR) << "Failed to get private key modulus"; |
| 295 return false; |
| 296 } |
| 297 if (!SwapBigNumPtrFromBytes(modulus, &rsa.get()->n)) { |
| 298 LOG(ERROR) << "Failed to decode private key modulus"; |
| 299 return false; |
| 300 } |
| 301 |
| 302 ScopedJavaGlobalRef<jobject> global_key; |
| 303 global_key.Reset(NULL, private_key); |
| 304 if (global_key.is_null()) { |
| 305 LOG(ERROR) << "Could not create global JNI reference"; |
| 306 return false; |
| 307 } |
| 308 RSA_set_app_data(rsa.get(), global_key.Release()); |
| 309 EVP_PKEY_assign_RSA(pkey, rsa.release()); |
| 310 return true; |
| 311 } |
| 312 |
| 313 // Setup an EVP_PKEY to wrap an existing platform RSA PrivateKey object |
| 314 // for Android 4.0 to 4.1.x. Must only be used on Android < 4.2. |
| 315 // |private_key| is a JNI reference (local or global) to the object. |
| 316 // |pkey| is the EVP_PKEY to setup as a wrapper. |
| 317 // Returns true on success, false otherwise. |
| 318 EVP_PKEY* GetRsaLegacyKey(jobject private_key) { |
| 319 EVP_PKEY* sys_pkey = |
| 320 GetOpenSSLSystemHandleForPrivateKey(private_key); |
| 321 if (sys_pkey != NULL) { |
| 322 CRYPTO_add(&sys_pkey->references, 1, CRYPTO_LOCK_EVP_PKEY); |
| 323 } else { |
| 324 // GetOpenSSLSystemHandleForPrivateKey() will fail on Android |
| 325 // 4.0.3 and earlier. However, it is possible to get the key |
| 326 // content with PrivateKey.getEncoded() on these platforms. |
| 327 // Note that this method may return NULL on 4.0.4 and later. |
| 328 std::vector<uint8> encoded; |
| 329 if (!GetPrivateKeyEncodedBytes(private_key, &encoded)) { |
| 330 LOG(ERROR) << "Can't get private key data!"; |
| 331 return NULL; |
| 332 } |
| 333 const unsigned char* p = |
| 334 reinterpret_cast<const unsigned char*>(&encoded[0]); |
| 335 int len = static_cast<int>(encoded.size()); |
| 336 sys_pkey = d2i_AutoPrivateKey(NULL, &p, len); |
| 337 if (sys_pkey == NULL) { |
| 338 LOG(ERROR) << "Can't convert private key data!"; |
| 339 return NULL; |
| 340 } |
| 341 } |
| 342 return sys_pkey; |
| 343 } |
| 344 |
| 345 // Custom DSA_METHOD that uses the platform APIs. |
| 346 // Note that for now, only signing through DSA_sign() is really supported. |
| 347 // all other method pointers are either stubs returning errors, or no-ops. |
| 348 // See <openssl/dsa.h> for exact declaration of DSA_METHOD. |
| 349 // |
| 350 // Note: There is no DSA_set_app_data() and DSA_get_app_data() functions, |
| 351 // but RSA_set_app_data() is defined as a simple macro that calls |
| 352 // RSA_set_ex_data() with a hard-coded index of 0, so this code |
| 353 // does the same thing here. |
| 354 |
| 355 DSA_SIG* DsaMethodDoSign(const unsigned char* dgst, |
| 356 int dlen, |
| 357 DSA* dsa) { |
| 358 // Extract the JNI reference to the PrivateKey object. |
| 359 jobject private_key = reinterpret_cast<jobject>(DSA_get_ex_data(dsa, 0)); |
| 360 if (private_key == NULL) |
| 361 return NULL; |
| 362 |
| 363 // Sign the message with it, calling platform APIs. |
| 364 std::vector<uint8> signature; |
| 365 if (!RawSignDigestWithPrivateKey( |
| 366 private_key, |
| 367 base::StringPiece( |
| 368 reinterpret_cast<const char*>(dgst), |
| 369 static_cast<size_t>(dlen)), |
| 370 &signature)) { |
| 371 return NULL; |
| 372 } |
| 373 |
| 374 // Note: With DSA, the actual signature might be smaller than DSA_size(). |
| 375 size_t max_expected_size = static_cast<size_t>(DSA_size(dsa)); |
| 376 if (signature.size() > max_expected_size) { |
| 377 LOG(ERROR) << "DSA Signature size mismatch, actual: " |
| 378 << signature.size() << ", expected <= " |
| 379 << max_expected_size; |
| 380 return NULL; |
| 381 } |
| 382 |
| 383 // Convert the signature into a DSA_SIG object. |
| 384 const unsigned char* sigbuf = |
| 385 reinterpret_cast<const unsigned char*>(&signature[0]); |
| 386 int siglen = static_cast<size_t>(signature.size()); |
| 387 DSA_SIG* dsa_sig = d2i_DSA_SIG(NULL, &sigbuf, siglen); |
| 388 return dsa_sig; |
| 389 } |
| 390 |
| 391 int DsaMethodSignSetup(DSA* dsa, |
| 392 BN_CTX* ctx_in, |
| 393 BIGNUM** kinvp, |
| 394 BIGNUM** rp) { |
| 395 NOTIMPLEMENTED(); |
| 396 DSAerr(DSA_F_DSA_SIGN_SETUP, DSA_R_INVALID_DIGEST_TYPE); |
| 397 return -1; |
| 398 } |
| 399 |
| 400 int DsaMethodDoVerify(const unsigned char* dgst, |
| 401 int dgst_len, |
| 402 DSA_SIG* sig, |
| 403 DSA* dsa) { |
| 404 NOTIMPLEMENTED(); |
| 405 DSAerr(DSA_F_DSA_DO_VERIFY, DSA_R_INVALID_DIGEST_TYPE); |
| 406 return -1; |
| 407 } |
| 408 |
| 409 int DsaMethodFinish(DSA* dsa) { |
| 410 // Free the global JNI reference that was created with this |
| 411 // wrapper key. |
| 412 jobject key = reinterpret_cast<jobject>(DSA_get_ex_data(dsa,0)); |
| 413 if (key != NULL) { |
| 414 DSA_set_ex_data(dsa, 0, NULL); |
| 415 JNIEnv* env = base::android::AttachCurrentThread(); |
| 416 env->DeleteGlobalRef(key); |
| 417 } |
| 418 // Actual return value is ignored by OpenSSL. There are no docs |
| 419 // explaining what this is supposed to be. |
| 420 return 0; |
| 421 } |
| 422 |
| 423 const DSA_METHOD android_dsa_method = { |
| 424 /* .name = */ "Android signing-only DSA method", |
| 425 /* .dsa_do_sign = */ DsaMethodDoSign, |
| 426 /* .dsa_sign_setup = */ DsaMethodSignSetup, |
| 427 /* .dsa_do_verify = */ DsaMethodDoVerify, |
| 428 /* .dsa_mod_exp = */ NULL, |
| 429 /* .bn_mod_exp = */ NULL, |
| 430 /* .init = */ NULL, // nothing to do here. |
| 431 /* .finish = */ DsaMethodFinish, |
| 432 /* .flags = */ 0, |
| 433 /* .app_data = */ NULL, |
| 434 /* .dsa_paramgem = */ NULL, |
| 435 /* .dsa_keygen = */ NULL |
| 436 }; |
| 437 |
| 438 // Setup an EVP_PKEY to wrap an existing DSA platform PrivateKey object. |
| 439 // |private_key| is a JNI reference (local or global) to the object. |
| 440 // |pkey| is the EVP_PKEY to setup as a wrapper. |
| 441 // Returns true on success, false otherwise. |
| 442 // On success, this creates a global JNI reference to the same object |
| 443 // that will be owned by and destroyed with the EVP_PKEY. |
| 444 bool GetDsaPkeyWrapper(jobject private_key, EVP_PKEY* pkey) { |
| 445 ScopedDSA dsa(DSA_new()); |
| 446 DSA_set_method(dsa.get(), &android_dsa_method); |
| 447 |
| 448 // DSA_size() doesn't work with custom DSA_METHODs. To ensure it |
| 449 // returns the right value, set the 'q' field in the DSA object to |
| 450 // match the parameter from the platform key. |
| 451 std::vector<uint8> q; |
| 452 if (!GetDSAKeyParamQ(private_key, &q)) { |
| 453 LOG(ERROR) << "Can't extract Q parameter from DSA private key"; |
| 454 return false; |
| 455 } |
| 456 if (!SwapBigNumPtrFromBytes(q, &dsa.get()->q)) { |
| 457 LOG(ERROR) << "Can't decode Q parameter from DSA private key"; |
| 458 return false; |
| 459 } |
| 460 |
| 461 ScopedJavaGlobalRef<jobject> global_key; |
| 462 global_key.Reset(NULL, private_key); |
| 463 if (global_key.is_null()) { |
| 464 LOG(ERROR) << "Could not create global JNI reference"; |
| 465 return false; |
| 466 } |
| 467 DSA_set_ex_data(dsa.get(), 0, global_key.Release()); |
| 468 EVP_PKEY_assign_DSA(pkey, dsa.release()); |
| 469 return true; |
| 470 } |
| 471 |
| 472 // Custom ECDSA_METHOD that uses the platform APIs. |
| 473 // Note that for now, only signing through ECDSA_sign() is really supported. |
| 474 // all other method pointers are either stubs returning errors, or no-ops. |
| 475 // |
| 476 // Note: The ECDSA_METHOD structure doesn't have init/finish |
| 477 // methods. As such, the only way to to ensure the global |
| 478 // JNI reference is properly released when the EVP_PKEY is |
| 479 // destroyed is to use a custom EX_DATA type. |
| 480 |
| 481 // Used to ensure that the global JNI reference associated with a custom |
| 482 // EC_KEY + ECDSA_METHOD wrapper is released when its EX_DATA is destroyed |
| 483 // (this function is called when EVP_PKEY_free() is called on the wrapper). |
| 484 void ExDataFree(void* parent, |
| 485 void* ptr, |
| 486 CRYPTO_EX_DATA* ad, |
| 487 int idx, |
| 488 long argl, |
| 489 void* argp) { |
| 490 jobject private_key = reinterpret_cast<jobject>(ptr); |
| 491 if (private_key == NULL) |
| 492 return; |
| 493 |
| 494 CRYPTO_set_ex_data(ad, idx, NULL); |
| 495 |
| 496 JNIEnv* env = base::android::AttachCurrentThread(); |
| 497 env->DeleteGlobalRef(private_key); |
| 498 } |
| 499 |
| 500 int ExDataDup(CRYPTO_EX_DATA* to, |
| 501 CRYPTO_EX_DATA* from, |
| 502 void* from_d, |
| 503 int idx, |
| 504 long argl, |
| 505 void* argp) { |
| 506 // This callback shall never be called with the current OpenSSL |
| 507 // implementation (the library only ever duplicates EX_DATA items |
| 508 // for SSL and BIO objects). But provide this to catch regressions |
| 509 // in the future. |
| 510 CHECK(false) << "ExDataDup was called for ECDSA custom key !?"; |
| 511 // Return value is currently ignored by OpenSSL. |
| 512 return 0; |
| 513 } |
| 514 |
| 515 class EcdsaExDataIndex { |
| 516 public: |
| 517 int ex_data_index() { return ex_data_index_; } |
| 518 |
| 519 EcdsaExDataIndex() { |
| 520 ex_data_index_ = ECDSA_get_ex_new_index(0, // argl |
| 521 NULL, // argp |
| 522 NULL, // new_func |
| 523 ExDataDup, // dup_func |
| 524 ExDataFree); // free_func |
| 525 } |
| 526 |
| 527 private: |
| 528 int ex_data_index_; |
| 529 }; |
| 530 |
| 531 // Returns the index of the custom EX_DATA used to store the JNI reference. |
| 532 int EcdsaGetExDataIndex(void) { |
| 533 // Use a LazyInstance to perform thread-safe lazy initialization. |
| 534 // Use a leaky one, since OpenSSL doesn't provide a way to release |
| 535 // allocated EX_DATA indices. |
| 536 static base::LazyInstance<EcdsaExDataIndex>::Leaky s_instance = |
| 537 LAZY_INSTANCE_INITIALIZER; |
| 538 return s_instance.Get().ex_data_index(); |
| 539 } |
| 540 |
| 541 ECDSA_SIG* EcdsaMethodDoSign(const unsigned char* dgst, |
| 542 int dgst_len, |
| 543 const BIGNUM* inv, |
| 544 const BIGNUM* rp, |
| 545 EC_KEY* eckey) { |
| 546 // Retrieve private key JNI reference. |
| 547 jobject private_key = reinterpret_cast<jobject>( |
| 548 ECDSA_get_ex_data(eckey, EcdsaGetExDataIndex())); |
| 549 if (!private_key) { |
| 550 LOG(WARNING) << "Null JNI reference passed to EcdsaMethodDoSign!"; |
| 551 return NULL; |
| 552 } |
| 553 // Sign message with it through JNI. |
| 554 std::vector<uint8> signature; |
| 555 base::StringPiece digest( |
| 556 reinterpret_cast<const char*>(dgst), |
| 557 static_cast<size_t>(dgst_len)); |
| 558 if (!RawSignDigestWithPrivateKey( |
| 559 private_key, digest, &signature)) { |
| 560 LOG(WARNING) << "Could not sign message in EcdsaMethodDoSign!"; |
| 561 return NULL; |
| 562 } |
| 563 |
| 564 // Note: With ECDSA, the actual signature may be smaller than |
| 565 // ECDSA_size(). |
| 566 size_t max_expected_size = static_cast<size_t>(ECDSA_size(eckey)); |
| 567 if (signature.size() > max_expected_size) { |
| 568 LOG(ERROR) << "ECDSA Signature size mismatch, actual: " |
| 569 << signature.size() << ", expected <= " |
| 570 << max_expected_size; |
| 571 return NULL; |
| 572 } |
| 573 |
| 574 // Convert signature to ECDSA_SIG object |
| 575 const unsigned char* sigbuf = |
| 576 reinterpret_cast<const unsigned char*>(&signature[0]); |
| 577 long siglen = static_cast<long>(signature.size()); |
| 578 return d2i_ECDSA_SIG(NULL, &sigbuf, siglen); |
| 579 } |
| 580 |
| 581 int EcdsaMethodSignSetup(EC_KEY* eckey, |
| 582 BN_CTX* ctx, |
| 583 BIGNUM** kinv, |
| 584 BIGNUM** r) { |
| 585 NOTIMPLEMENTED(); |
| 586 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ECDSA_R_ERR_EC_LIB); |
| 587 return -1; |
| 588 } |
| 589 |
| 590 int EcdsaMethodDoVerify(const unsigned char* dgst, |
| 591 int dgst_len, |
| 592 const ECDSA_SIG* sig, |
| 593 EC_KEY* eckey) { |
| 594 NOTIMPLEMENTED(); |
| 595 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ECDSA_R_ERR_EC_LIB); |
| 596 return -1; |
| 597 } |
| 598 |
| 599 const ECDSA_METHOD android_ecdsa_method = { |
| 600 /* .name = */ "Android signing-only ECDSA method", |
| 601 /* .ecdsa_do_sign = */ EcdsaMethodDoSign, |
| 602 /* .ecdsa_sign_setup = */ EcdsaMethodSignSetup, |
| 603 /* .ecdsa_do_verify = */ EcdsaMethodDoVerify, |
| 604 /* .flags = */ 0, |
| 605 /* .app_data = */ NULL, |
| 606 }; |
| 607 |
| 608 // Setup an EVP_PKEY to wrap an existing platform PrivateKey object. |
| 609 // |private_key| is the JNI reference (local or global) to the object. |
| 610 // |pkey| is the EVP_PKEY to setup as a wrapper. |
| 611 // Returns true on success, false otherwise. |
| 612 // On success, this creates a global JNI reference to the object that |
| 613 // is owned by and destroyed with the EVP_PKEY. I.e. the caller shall |
| 614 // always free |private_key| after the call. |
| 615 bool GetEcdsaPkeyWrapper(jobject private_key, EVP_PKEY* pkey) { |
| 616 ScopedEC_KEY eckey(EC_KEY_new()); |
| 617 ECDSA_set_method(eckey.get(), &android_ecdsa_method); |
| 618 |
| 619 // To ensure that ECDSA_size() works properly, craft a custom EC_GROUP |
| 620 // that has the same order than the private key. |
| 621 std::vector<uint8> order; |
| 622 if (!GetECKeyOrder(private_key, &order)) { |
| 623 LOG(ERROR) << "Can't extract order parameter from EC private key"; |
| 624 return false; |
| 625 } |
| 626 ScopedEC_GROUP group(EC_GROUP_new(EC_GFp_nist_method())); |
| 627 if (!group.get()) { |
| 628 LOG(ERROR) << "Can't create new EC_GROUP"; |
| 629 return false; |
| 630 } |
| 631 if (!CopyBigNumFromBytes(order, &group.get()->order)) { |
| 632 LOG(ERROR) << "Can't decode order from PrivateKey"; |
| 633 return false; |
| 634 } |
| 635 EC_KEY_set_group(eckey.get(), group.release()); |
| 636 |
| 637 ScopedJavaGlobalRef<jobject> global_key; |
| 638 global_key.Reset(NULL, private_key); |
| 639 if (global_key.is_null()) { |
| 640 LOG(ERROR) << "Can't create global JNI reference"; |
| 641 return false; |
| 642 } |
| 643 ECDSA_set_ex_data(eckey.get(), |
| 644 EcdsaGetExDataIndex(), |
| 645 global_key.Release()); |
| 646 |
| 647 EVP_PKEY_assign_EC_KEY(pkey, eckey.release()); |
| 648 return true; |
| 649 } |
| 650 |
| 651 } // namespace |
| 652 |
| 653 EVP_PKEY* GetOpenSSLPrivateKeyWrapper(jobject private_key) { |
| 654 // Create new empty EVP_PKEY instance. |
| 655 ScopedEVP_PKEY pkey(EVP_PKEY_new()); |
| 656 if (!pkey.get()) |
| 657 return NULL; |
| 658 |
| 659 // Create sub key type, depending on private key's algorithm type. |
| 660 PrivateKeyType key_type = GetPrivateKeyType(private_key); |
| 661 switch (key_type) { |
| 662 case PRIVATE_KEY_TYPE_RSA: |
| 663 { |
| 664 // Route around platform bug: if Android < 4.2, then |
| 665 // base::android::RawSignDigestWithPrivateKey() cannot work, so |
| 666 // instead, obtain a raw EVP_PKEY* to the system object |
| 667 // backing this PrivateKey object. |
| 668 const int kAndroid42ApiLevel = 17; |
| 669 if (base::android::BuildInfo::GetInstance()->sdk_int() < |
| 670 kAndroid42ApiLevel) { |
| 671 EVP_PKEY* legacy_key = GetRsaLegacyKey(private_key); |
| 672 if (legacy_key == NULL) |
| 673 return NULL; |
| 674 pkey.reset(legacy_key); |
| 675 } else { |
| 676 // Running on Android 4.2. |
| 677 if (!GetRsaPkeyWrapper(private_key, pkey.get())) |
| 678 return NULL; |
| 679 } |
| 680 } |
| 681 break; |
| 682 case PRIVATE_KEY_TYPE_DSA: |
| 683 if (!GetDsaPkeyWrapper(private_key, pkey.get())) |
| 684 return NULL; |
| 685 break; |
| 686 case PRIVATE_KEY_TYPE_ECDSA: |
| 687 if (!GetEcdsaPkeyWrapper(private_key, pkey.get())) |
| 688 return NULL; |
| 689 break; |
| 690 default: |
| 691 LOG(WARNING) |
| 692 << "GetOpenSSLPrivateKeyWrapper() called with invalid key type"; |
| 693 return NULL; |
| 694 } |
| 695 return pkey.release(); |
| 696 } |
| 697 |
| 698 } // namespace android |
| 699 } // namespace net |
OLD | NEW |