openssl_util.h revision 21d179b334e59e9a3bfcaed4c4430bef1bc5759d
1513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// Copyright (c) 2010 The Chromium Authors. All rights reserved. 2513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// Use of this source code is governed by a BSD-style license that can be 3513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// found in the LICENSE file. 4513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 54a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch#ifndef BASE_OPENSSL_UTIL_H_ 64a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch#define BASE_OPENSSL_UTIL_H_ 7513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch#pragma once 8513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 9513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch#include "base/basictypes.h" 104a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch#include "base/tracked.h" 11513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 12513209b27ff55e2841eac0e4120199c23acce758Ben Murdochnamespace base { 13513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 144a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch// A helper class that takes care of destroying OpenSSL objects when it goes out 154a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch// of scope. 164a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdochtemplate <typename T, void (*destructor)(T*)> 174a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdochclass ScopedOpenSSL { 184a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch public: 19201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch ScopedOpenSSL() : ptr_(NULL) { } 20201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch explicit ScopedOpenSSL(T* ptr) : ptr_(ptr) { } 2121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen ~ScopedOpenSSL() { 2221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen reset(NULL); 2321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen } 244a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch 254a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch T* get() const { return ptr_; } 26201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch void reset(T* ptr) { 27201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch if (ptr != ptr_) { 28201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch if (ptr_) (*destructor)(ptr_); 29201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch ptr_ = ptr; 30201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch } 31201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch } 324a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch 334a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch private: 344a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch T* ptr_; 35201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch 36201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch DISALLOW_COPY_AND_ASSIGN(ScopedOpenSSL); 374a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch}; 384a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch 39513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// Provides a buffer of at least MIN_SIZE bytes, for use when calling OpenSSL's 40513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// SHA256, HMAC, etc functions, adapting the buffer sizing rules to meet those 41513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// of the our base wrapper APIs. 42513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// This allows the library to write directly to the caller's buffer if it is of 43513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// sufficient size, but if not it will write to temporary |min_sized_buffer_| 44513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// of required size and then its content is automatically copied out on 45513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch// destruction, with truncation as appropriate. 46513209b27ff55e2841eac0e4120199c23acce758Ben Murdochtemplate<int MIN_SIZE> 47513209b27ff55e2841eac0e4120199c23acce758Ben Murdochclass ScopedOpenSSLSafeSizeBuffer { 48513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch public: 49513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch ScopedOpenSSLSafeSizeBuffer(unsigned char* output, size_t output_len) 50513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch : output_(output), 51513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch output_len_(output_len) { 52513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch } 53513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 54513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch ~ScopedOpenSSLSafeSizeBuffer() { 55513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch if (output_len_ < MIN_SIZE) { 56513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch // Copy the temporary buffer out, truncating as needed. 57513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch memcpy(output_, min_sized_buffer_, output_len_); 58513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch } 59513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch // else... any writing already happened directly into |output_|. 60513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch } 61513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 62513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch unsigned char* safe_buffer() { 63513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch return output_len_ < MIN_SIZE ? min_sized_buffer_ : output_; 64513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch } 65513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 66513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch private: 67513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch // Pointer to the caller's data area and it's associated size, where data 68513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch // written via safe_buffer() will [eventually] end up. 69513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch unsigned char* output_; 70513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch size_t output_len_; 71513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 72513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch // Temporary buffer writen into in the case where the caller's 73513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch // buffer is not of sufficient size. 74513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch unsigned char min_sized_buffer_[MIN_SIZE]; 754a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch 764a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch DISALLOW_COPY_AND_ASSIGN(ScopedOpenSSLSafeSizeBuffer); 77513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch}; 78513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 794a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch// Initialize OpenSSL if it isn't already initialized. This must be called 804a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch// before any other OpenSSL functions. 814a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch// This function is thread-safe, and OpenSSL will only ever be initialized once. 824a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch// OpenSSL will be properly shut down on program exit. 834a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdochvoid EnsureOpenSSLInit(); 844a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch 854a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch// Drains the OpenSSL ERR_get_error stack. On a debug build the error codes 86201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch// are send to VLOG(1), on a release build they are disregarded. In most 87201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch// cases you should pass FROM_HERE as the |location|. 88201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdochvoid ClearOpenSSLERRStack(const tracked_objects::Location& location); 89201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch 90201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch// Place an instance of this class on the call stack to automatically clear 91201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch// the OpenSSL error stack on function exit. 92201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdochclass OpenSSLErrStackTracer { 93201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch public: 94201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch // Pass FROM_HERE as |location|, to help track the source of OpenSSL error 95201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch // messages. Note any diagnostic emitted will be tagged with the location of 96201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch // the constructor call as it's not possible to trace a destructor's callsite. 97201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch explicit OpenSSLErrStackTracer(const tracked_objects::Location& location) 98201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch : location_(location) { 99201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch EnsureOpenSSLInit(); 100201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch } 101201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch ~OpenSSLErrStackTracer() { 102201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch ClearOpenSSLERRStack(location_); 103201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch } 104201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch 105201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch private: 106201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch const tracked_objects::Location location_; 107201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch 108201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch DISALLOW_IMPLICIT_CONSTRUCTORS(OpenSSLErrStackTracer); 109201ade2fbba22bfb27ae029f4d23fca6ded109a0Ben Murdoch}; 1104a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch 111513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch} // namespace base 112513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 1134a5e2dc747d50c653511c68ccb2cfbfb740bd5a7Ben Murdoch#endif // BASE_OPENSSL_UTIL_H_ 114