crypto/scoped_openssl_types.h

   1 // Copyright 2014 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 #ifndef CRYPTO_SCOPED_OPENSSL_TYPES_H_
   6 #define CRYPTO_SCOPED_OPENSSL_TYPES_H_
   7
   8 #include <openssl/bio.h>
   9 #include <openssl/bn.h>
  10 #include <openssl/dsa.h>
  11 #include <openssl/ec.h>
  12 #include <openssl/ecdsa.h>
  13 #include <openssl/evp.h>
  14 #include <openssl/rsa.h>
  15
  16 #include "base/memory/scoped_ptr.h"
  17
  18 namespace crypto {
  19
  20 // Simplistic helper that wraps a call to a deleter function. In a C++11 world,
  21 // this would be std::function<>. An alternative would be to re-use
  22 // base::internal::RunnableAdapter<>, but that's far too heavy weight.
  23 template <typename Type, void (*Destroyer)(Type*)>
  24 struct OpenSSLDestroyer {
  25   using AllowSelfReset = void;
  26   void operator()(Type* ptr) const { Destroyer(ptr); }
  27 };
  28
  29 template <typename PointerType, void (*Destroyer)(PointerType*)>
  30 using ScopedOpenSSL =
  31     scoped_ptr<PointerType, OpenSSLDestroyer<PointerType, Destroyer>>;
  32
  33 struct OpenSSLFree {
  34   void operator()(uint8_t* ptr) const { OPENSSL_free(ptr); }
  35 };
  36
  37 // Several typedefs are provided for crypto-specific primitives, for
  38 // short-hand and prevalence. Note that OpenSSL types related to X.509 are
  39 // intentionally not included, as crypto/ does not generally deal with
  40 // certificates or PKI.
  41 using ScopedBIGNUM = ScopedOpenSSL<BIGNUM, BN_free>;
  42 using ScopedEC_Key = ScopedOpenSSL<EC_KEY, EC_KEY_free>;
  43 using ScopedBIO = ScopedOpenSSL<BIO, BIO_free_all>;
  44 using ScopedDSA = ScopedOpenSSL<DSA, DSA_free>;
  45 using ScopedECDSA_SIG = ScopedOpenSSL<ECDSA_SIG, ECDSA_SIG_free>;
  46 using ScopedEC_GROUP = ScopedOpenSSL<EC_GROUP, EC_GROUP_free>;
  47 using ScopedEC_KEY = ScopedOpenSSL<EC_KEY, EC_KEY_free>;
  48 using ScopedEC_POINT = ScopedOpenSSL<EC_POINT, EC_POINT_free>;
  49 using ScopedEVP_MD_CTX = ScopedOpenSSL<EVP_MD_CTX, EVP_MD_CTX_destroy>;
  50 using ScopedEVP_PKEY = ScopedOpenSSL<EVP_PKEY, EVP_PKEY_free>;
  51 using ScopedEVP_PKEY_CTX = ScopedOpenSSL<EVP_PKEY_CTX, EVP_PKEY_CTX_free>;
  52 using ScopedRSA = ScopedOpenSSL<RSA, RSA_free>;
  53
  54 // The bytes must have been allocated with OPENSSL_malloc.
  55 using ScopedOpenSSLBytes = scoped_ptr<uint8_t, OpenSSLFree>;
  56
  57 }  // namespace crypto
  58
  59 #endif  // CRYPTO_SCOPED_OPENSSL_TYPES_H_