Coverage Report

Created: 2022-09-23 06:05

/src/botan/build/include/botan/secmem.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
* Secure Memory Buffers
3
* (C) 1999-2007,2012 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7
8
#ifndef BOTAN_SECURE_MEMORY_BUFFERS_H_
9
#define BOTAN_SECURE_MEMORY_BUFFERS_H_
10
11
#include <botan/types.h> // IWYU pragma: export
12
#include <botan/mem_ops.h> // IWYU pragma: export
13
#include <vector> // IWYU pragma: export
14
#include <algorithm>
15
#include <deque>
16
#include <type_traits>
17
18
namespace Botan {
19
20
template<typename T>
21
class secure_allocator
22
   {
23
   public:
24
      /*
25
      * Assert exists to prevent someone from doing something that will
26
      * probably crash anyway (like secure_vector<non_POD_t> where ~non_POD_t
27
      * deletes a member pointer which was zeroed before it ran).
28
      * MSVC in debug mode uses non-integral proxy types in container types
29
      * like std::vector, thus we disable the check there.
30
      */
31
#if !defined(_ITERATOR_DEBUG_LEVEL) || _ITERATOR_DEBUG_LEVEL == 0
32
      static_assert(std::is_integral<T>::value, "secure_allocator supports only integer types");
33
#endif
34
35
      typedef T          value_type;
36
      typedef std::size_t size_type;
37
38
      secure_allocator() noexcept = default;
39
      secure_allocator(const secure_allocator&) noexcept = default;
40
      secure_allocator& operator=(const secure_allocator&) noexcept = default;
41
      ~secure_allocator() noexcept = default;
42
43
      template<typename U>
44
      secure_allocator(const secure_allocator<U>&) noexcept {}
45
46
      T* allocate(std::size_t n)
47
127M
         {
48
127M
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
127M
         }
Botan::secure_allocator<unsigned char>::allocate(unsigned long)
Line
Count
Source
47
4.12M
         {
48
4.12M
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
4.12M
         }
Botan::secure_allocator<unsigned long>::allocate(unsigned long)
Line
Count
Source
47
123M
         {
48
123M
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
123M
         }
Botan::secure_allocator<unsigned int>::allocate(unsigned long)
Line
Count
Source
47
122k
         {
48
122k
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
122k
         }
Unexecuted instantiation: Botan::secure_allocator<unsigned short>::allocate(unsigned long)
50
51
      void deallocate(T* p, std::size_t n)
52
127M
         {
53
127M
         deallocate_memory(p, n, sizeof(T));
54
127M
         }
Botan::secure_allocator<unsigned char>::deallocate(unsigned char*, unsigned long)
Line
Count
Source
52
4.12M
         {
53
4.12M
         deallocate_memory(p, n, sizeof(T));
54
4.12M
         }
Botan::secure_allocator<unsigned long>::deallocate(unsigned long*, unsigned long)
Line
Count
Source
52
123M
         {
53
123M
         deallocate_memory(p, n, sizeof(T));
54
123M
         }
Botan::secure_allocator<unsigned int>::deallocate(unsigned int*, unsigned long)
Line
Count
Source
52
122k
         {
53
122k
         deallocate_memory(p, n, sizeof(T));
54
122k
         }
Unexecuted instantiation: Botan::secure_allocator<unsigned short>::deallocate(unsigned short*, unsigned long)
55
   };
56
57
template<typename T, typename U> inline bool
58
operator==(const secure_allocator<T>&, const secure_allocator<U>&)
59
   { return true; }
60
61
template<typename T, typename U> inline bool
62
operator!=(const secure_allocator<T>&, const secure_allocator<U>&)
63
576k
   { return false; }
bool Botan::operator!=<unsigned char, unsigned char>(Botan::secure_allocator<unsigned char> const&, Botan::secure_allocator<unsigned char> const&)
Line
Count
Source
63
576k
   { return false; }
Unexecuted instantiation: bool Botan::operator!=<unsigned short, unsigned short>(Botan::secure_allocator<unsigned short> const&, Botan::secure_allocator<unsigned short> const&)
64
65
template<typename T> using secure_vector = std::vector<T, secure_allocator<T>>;
66
template<typename T> using secure_deque = std::deque<T, secure_allocator<T>>;
67
68
// For better compatibility with 1.10 API
69
template<typename T> using SecureVector = secure_vector<T>;
70
71
template<typename T>
72
std::vector<T> unlock(const secure_vector<T>& in)
73
674
   {
74
674
   return std::vector<T>(in.begin(), in.end());
75
674
   }
76
77
template<typename T, typename Alloc, typename Alloc2>
78
std::vector<T, Alloc>&
79
operator+=(std::vector<T, Alloc>& out,
80
           const std::vector<T, Alloc2>& in)
81
269k
   {
82
269k
   out.insert(out.end(), in.begin(), in.end());
83
269k
   return out;
84
269k
   }
std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >& Botan::operator+=<unsigned char, Botan::secure_allocator<unsigned char>, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> > const&)
Line
Count
Source
81
2.13k
   {
82
2.13k
   out.insert(out.end(), in.begin(), in.end());
83
2.13k
   return out;
84
2.13k
   }
std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >& Botan::operator+=<unsigned char, Botan::secure_allocator<unsigned char>, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > const&)
Line
Count
Source
81
375
   {
82
375
   out.insert(out.end(), in.begin(), in.end());
83
375
   return out;
84
375
   }
std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >& Botan::operator+=<unsigned char, std::__1::allocator<unsigned char>, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> > const&)
Line
Count
Source
81
3.31k
   {
82
3.31k
   out.insert(out.end(), in.begin(), in.end());
83
3.31k
   return out;
84
3.31k
   }
std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >& Botan::operator+=<unsigned char, std::__1::allocator<unsigned char>, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, std::__1::vector<unsigned char, std::__1::allocator<unsigned char> > const&)
Line
Count
Source
81
263k
   {
82
263k
   out.insert(out.end(), in.begin(), in.end());
83
263k
   return out;
84
263k
   }
85
86
template<typename T, typename Alloc>
87
std::vector<T, Alloc>& operator+=(std::vector<T, Alloc>& out, T in)
88
   {
89
   out.push_back(in);
90
   return out;
91
   }
92
93
template<typename T, typename Alloc, typename L>
94
std::vector<T, Alloc>& operator+=(std::vector<T, Alloc>& out,
95
                                  const std::pair<const T*, L>& in)
96
261k
   {
97
261k
   out.insert(out.end(), in.first, in.first + in.second);
98
261k
   return out;
99
261k
   }
std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >& Botan::operator+=<unsigned char, Botan::secure_allocator<unsigned char>, unsigned long>(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&, std::__1::pair<unsigned char const*, unsigned long> const&)
Line
Count
Source
96
259k
   {
97
259k
   out.insert(out.end(), in.first, in.first + in.second);
98
259k
   return out;
99
259k
   }
std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >& Botan::operator+=<unsigned char, std::__1::allocator<unsigned char>, unsigned long>(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&, std::__1::pair<unsigned char const*, unsigned long> const&)
Line
Count
Source
96
2.34k
   {
97
2.34k
   out.insert(out.end(), in.first, in.first + in.second);
98
2.34k
   return out;
99
2.34k
   }
100
101
template<typename T, typename Alloc, typename L>
102
std::vector<T, Alloc>& operator+=(std::vector<T, Alloc>& out,
103
                                  const std::pair<T*, L>& in)
104
447k
   {
105
447k
   out.insert(out.end(), in.first, in.first + in.second);
106
447k
   return out;
107
447k
   }
108
109
/**
110
* Zeroise the values; length remains unchanged
111
* @param vec the vector to zeroise
112
*/
113
template<typename T, typename Alloc>
114
void zeroise(std::vector<T, Alloc>& vec)
115
719k
   {
116
719k
   clear_mem(vec.data(), vec.size());
117
719k
   }
void Botan::zeroise<unsigned long, Botan::secure_allocator<unsigned long> >(std::__1::vector<unsigned long, Botan::secure_allocator<unsigned long> >&)
Line
Count
Source
115
150
   {
116
150
   clear_mem(vec.data(), vec.size());
117
150
   }
void Botan::zeroise<unsigned int, Botan::secure_allocator<unsigned int> >(std::__1::vector<unsigned int, Botan::secure_allocator<unsigned int> >&)
Line
Count
Source
115
50.9k
   {
116
50.9k
   clear_mem(vec.data(), vec.size());
117
50.9k
   }
void Botan::zeroise<unsigned char, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&)
Line
Count
Source
115
667k
   {
116
667k
   clear_mem(vec.data(), vec.size());
117
667k
   }
Unexecuted instantiation: void Botan::zeroise<unsigned short, Botan::secure_allocator<unsigned short> >(std::__1::vector<unsigned short, Botan::secure_allocator<unsigned short> >&)
void Botan::zeroise<unsigned char, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&)
Line
Count
Source
115
1.20k
   {
116
1.20k
   clear_mem(vec.data(), vec.size());
117
1.20k
   }
118
119
/**
120
* Zeroise the values then free the memory
121
* @param vec the vector to zeroise and free
122
*/
123
template<typename T, typename Alloc>
124
void zap(std::vector<T, Alloc>& vec)
125
0
   {
126
0
   zeroise(vec);
127
0
   vec.clear();
128
0
   vec.shrink_to_fit();
129
0
   }
Unexecuted instantiation: void Botan::zap<unsigned long, Botan::secure_allocator<unsigned long> >(std::__1::vector<unsigned long, Botan::secure_allocator<unsigned long> >&)
Unexecuted instantiation: void Botan::zap<unsigned int, Botan::secure_allocator<unsigned int> >(std::__1::vector<unsigned int, Botan::secure_allocator<unsigned int> >&)
Unexecuted instantiation: void Botan::zap<unsigned char, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&)
Unexecuted instantiation: void Botan::zap<unsigned short, Botan::secure_allocator<unsigned short> >(std::__1::vector<unsigned short, Botan::secure_allocator<unsigned short> >&)
Unexecuted instantiation: void Botan::zap<unsigned char, std::__1::allocator<unsigned char> >(std::__1::vector<unsigned char, std::__1::allocator<unsigned char> >&)
130
131
}
132
133
#endif