Coverage Report

Created: 2022-06-23 06:44

/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
110M
         {
48
110M
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
110M
         }
Botan::secure_allocator<unsigned char>::allocate(unsigned long)
Line
Count
Source
47
3.66M
         {
48
3.66M
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
3.66M
         }
Botan::secure_allocator<unsigned long>::allocate(unsigned long)
Line
Count
Source
47
106M
         {
48
106M
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
106M
         }
Botan::secure_allocator<unsigned int>::allocate(unsigned long)
Line
Count
Source
47
105k
         {
48
105k
         return static_cast<T*>(allocate_memory(n, sizeof(T)));
49
105k
         }
Unexecuted instantiation: Botan::secure_allocator<unsigned short>::allocate(unsigned long)
50
51
      void deallocate(T* p, std::size_t n)
52
110M
         {
53
110M
         deallocate_memory(p, n, sizeof(T));
54
110M
         }
Botan::secure_allocator<unsigned long>::deallocate(unsigned long*, unsigned long)
Line
Count
Source
52
106M
         {
53
106M
         deallocate_memory(p, n, sizeof(T));
54
106M
         }
Botan::secure_allocator<unsigned char>::deallocate(unsigned char*, unsigned long)
Line
Count
Source
52
3.66M
         {
53
3.66M
         deallocate_memory(p, n, sizeof(T));
54
3.66M
         }
Botan::secure_allocator<unsigned int>::deallocate(unsigned int*, unsigned long)
Line
Count
Source
52
105k
         {
53
105k
         deallocate_memory(p, n, sizeof(T));
54
105k
         }
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
481k
   { 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
481k
   { 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
616
   {
74
616
   return std::vector<T>(in.begin(), in.end());
75
616
   }
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
244k
   {
82
244k
   out.insert(out.end(), in.begin(), in.end());
83
244k
   return out;
84
244k
   }
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.07k
   {
82
2.07k
   out.insert(out.end(), in.begin(), in.end());
83
2.07k
   return out;
84
2.07k
   }
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
369
   {
82
369
   out.insert(out.end(), in.begin(), in.end());
83
369
   return out;
84
369
   }
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
239k
   {
82
239k
   out.insert(out.end(), in.begin(), in.end());
83
239k
   return out;
84
239k
   }
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
2.87k
   {
82
2.87k
   out.insert(out.end(), in.begin(), in.end());
83
2.87k
   return out;
84
2.87k
   }
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
221k
   {
97
221k
   out.insert(out.end(), in.first, in.first + in.second);
98
221k
   return out;
99
221k
   }
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
219k
   {
97
219k
   out.insert(out.end(), in.first, in.first + in.second);
98
219k
   return out;
99
219k
   }
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.04k
   {
97
2.04k
   out.insert(out.end(), in.first, in.first + in.second);
98
2.04k
   return out;
99
2.04k
   }
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
412k
   {
105
412k
   out.insert(out.end(), in.first, in.first + in.second);
106
412k
   return out;
107
412k
   }
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
631k
   {
116
631k
   clear_mem(vec.data(), vec.size());
117
631k
   }
void Botan::zeroise<unsigned long, Botan::secure_allocator<unsigned long> >(std::__1::vector<unsigned long, Botan::secure_allocator<unsigned long> >&)
Line
Count
Source
115
14
   {
116
14
   clear_mem(vec.data(), vec.size());
117
14
   }
void Botan::zeroise<unsigned int, Botan::secure_allocator<unsigned int> >(std::__1::vector<unsigned int, Botan::secure_allocator<unsigned int> >&)
Line
Count
Source
115
42.7k
   {
116
42.7k
   clear_mem(vec.data(), vec.size());
117
42.7k
   }
void Botan::zeroise<unsigned char, Botan::secure_allocator<unsigned char> >(std::__1::vector<unsigned char, Botan::secure_allocator<unsigned char> >&)
Line
Count
Source
115
587k
   {
116
587k
   clear_mem(vec.data(), vec.size());
117
587k
   }
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.05k
   {
116
1.05k
   clear_mem(vec.data(), vec.size());
117
1.05k
   }
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