Coverage Report

Created: 2023-06-07 06:59

/src/botan/build/include/botan/secmem.h
Line
Count
Source
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/mem_ops.h>  // IWYU pragma: export
12
#include <botan/types.h>    // IWYU pragma: export
13
#include <algorithm>
14
#include <deque>
15
#include <type_traits>
16
#include <vector>  // IWYU pragma: export
17
18
namespace Botan {
19
20
template <typename T>
21
#if !defined(_ITERATOR_DEBUG_LEVEL) || _ITERATOR_DEBUG_LEVEL == 0
22
/*
23
  * Assert exists to prevent someone from doing something that will
24
  * probably crash anyway (like secure_vector<non_POD_t> where ~non_POD_t
25
  * deletes a member pointer which was zeroed before it ran).
26
  * MSVC in debug mode uses non-integral proxy types in container types
27
  * like std::vector, thus we disable the check there.
28
 */
29
   requires std::is_integral<T>::value
30
#endif
31
class secure_allocator {
32
33
   public:
34
      typedef T value_type;
35
      typedef std::size_t size_type;
36
37
      secure_allocator() noexcept = default;
38
      secure_allocator(const secure_allocator&) noexcept = default;
39
      secure_allocator& operator=(const secure_allocator&) noexcept = default;
40
      ~secure_allocator() noexcept = default;
41
42
      template <typename U>
43
      secure_allocator(const secure_allocator<U>&) noexcept {}
44
45
2.12k
      T* allocate(std::size_t n) { return static_cast<T*>(allocate_memory(n, sizeof(T))); }
Botan::secure_allocator<unsigned char>::allocate(unsigned long)
Line
Count
Source
45
3
      T* allocate(std::size_t n) { return static_cast<T*>(allocate_memory(n, sizeof(T))); }
Botan::secure_allocator<unsigned long>::allocate(unsigned long)
Line
Count
Source
45
2.11k
      T* allocate(std::size_t n) { return static_cast<T*>(allocate_memory(n, sizeof(T))); }
46
47
2.12k
      void deallocate(T* p, std::size_t n) { deallocate_memory(p, n, sizeof(T)); }
Botan::secure_allocator<unsigned long>::deallocate(unsigned long*, unsigned long)
Line
Count
Source
47
2.11k
      void deallocate(T* p, std::size_t n) { deallocate_memory(p, n, sizeof(T)); }
Botan::secure_allocator<unsigned char>::deallocate(unsigned char*, unsigned long)
Line
Count
Source
47
3
      void deallocate(T* p, std::size_t n) { deallocate_memory(p, n, sizeof(T)); }
48
};
49
50
template <typename T, typename U>
51
inline bool operator==(const secure_allocator<T>&, const secure_allocator<U>&) {
52
   return true;
53
}
54
55
template <typename T, typename U>
56
1
inline bool operator!=(const secure_allocator<T>&, const secure_allocator<U>&) {
57
1
   return false;
58
1
}
59
60
template <typename T>
61
using secure_vector = std::vector<T, secure_allocator<T>>;
62
template <typename T>
63
using secure_deque = std::deque<T, secure_allocator<T>>;
64
65
// For better compatibility with 1.10 API
66
template <typename T>
67
using SecureVector = secure_vector<T>;
68
69
template <typename T>
70
secure_vector<T> lock(const std::vector<T>& in) {
71
   return secure_vector<T>(in.begin(), in.end());
72
}
73
74
template <typename T>
75
std::vector<T> unlock(const secure_vector<T>& in) {
76
   return std::vector<T>(in.begin(), in.end());
77
}
78
79
template <typename T, typename Alloc, typename Alloc2>
80
1
std::vector<T, Alloc>& operator+=(std::vector<T, Alloc>& out, const std::vector<T, Alloc2>& in) {
81
1
   out.insert(out.end(), in.begin(), in.end());
82
1
   return out;
83
1
}
84
85
template <typename T, typename Alloc>
86
std::vector<T, Alloc>& operator+=(std::vector<T, Alloc>& out, T in) {
87
   out.push_back(in);
88
   return out;
89
}
90
91
template <typename T, typename Alloc, typename L>
92
std::vector<T, Alloc>& operator+=(std::vector<T, Alloc>& out, const std::pair<const T*, L>& in) {
93
   out.insert(out.end(), in.first, in.first + in.second);
94
   return out;
95
}
96
97
template <typename T, typename Alloc, typename L>
98
std::vector<T, Alloc>& operator+=(std::vector<T, Alloc>& out, const std::pair<T*, L>& in) {
99
   out.insert(out.end(), in.first, in.first + in.second);
100
   return out;
101
}
102
103
/**
104
* Zeroise the values; length remains unchanged
105
* @param vec the vector to zeroise
106
*/
107
template <typename T, typename Alloc>
108
void zeroise(std::vector<T, Alloc>& vec) {
109
   clear_mem(vec.data(), vec.size());
110
}
111
112
/**
113
* Zeroise the values then free the memory
114
* @param vec the vector to zeroise and free
115
*/
116
template <typename T, typename Alloc>
117
void zap(std::vector<T, Alloc>& vec) {
118
   zeroise(vec);
119
   vec.clear();
120
   vec.shrink_to_fit();
121
}
122
123
}  // namespace Botan
124
125
#endif