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
18namespace 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.
23template <typename Type, void (*Destroyer)(Type*)>
24struct OpenSSLDestroyer {
25  void operator()(Type* ptr) const { Destroyer(ptr); }
26};
27
28template <typename PointerType, void (*Destroyer)(PointerType*)>
29struct ScopedOpenSSL {
30  typedef scoped_ptr<PointerType, OpenSSLDestroyer<PointerType, Destroyer> >
31      Type;
32};
33
34struct OpenSSLFree {
35  void operator()(uint8_t* ptr) const { OPENSSL_free(ptr); }
36};
37
38// Several typedefs are provided for crypto-specific primitives, for
39// short-hand and prevalence. Note that OpenSSL types related to X.509 are
40// intentionally not included, as crypto/ does not generally deal with
41// certificates or PKI.
42typedef ScopedOpenSSL<BIGNUM, BN_free>::Type ScopedBIGNUM;
43typedef ScopedOpenSSL<EC_KEY, EC_KEY_free>::Type ScopedEC_KEY;
44typedef ScopedOpenSSL<BIO, BIO_free_all>::Type ScopedBIO;
45typedef ScopedOpenSSL<DSA, DSA_free>::Type ScopedDSA;
46typedef ScopedOpenSSL<ECDSA_SIG, ECDSA_SIG_free>::Type ScopedECDSA_SIG;
47typedef ScopedOpenSSL<EC_KEY, EC_KEY_free>::Type ScopedEC_KEY;
48typedef ScopedOpenSSL<EVP_MD_CTX, EVP_MD_CTX_destroy>::Type ScopedEVP_MD_CTX;
49typedef ScopedOpenSSL<EVP_PKEY, EVP_PKEY_free>::Type ScopedEVP_PKEY;
50typedef ScopedOpenSSL<EVP_PKEY_CTX, EVP_PKEY_CTX_free>::Type ScopedEVP_PKEY_CTX;
51typedef ScopedOpenSSL<RSA, RSA_free>::Type ScopedRSA;
52
53// The bytes must have been allocated with OPENSSL_malloc.
54typedef scoped_ptr<uint8_t, OpenSSLFree> ScopedOpenSSLBytes;
55
56}  // namespace crypto
57
58#endif  // CRYPTO_SCOPED_OPENSSL_TYPES_H_
59