Coverage Report

Created: 2023-09-25 06:34

/src/botan/src/lib/stream/rc4/rc4.cpp
Line
Count
Source (jump to first uncovered line)
1
/*
2
* RC4
3
* (C) 1999-2007 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7
8
#include <botan/internal/rc4.h>
9
10
#include <botan/exceptn.h>
11
12
namespace Botan {
13
14
/*
15
* Combine cipher stream with message
16
*/
17
0
void RC4::cipher_bytes(const uint8_t in[], uint8_t out[], size_t length) {
18
0
   assert_key_material_set();
19
20
0
   while(length >= m_buffer.size() - m_position) {
21
0
      xor_buf(out, in, &m_buffer[m_position], m_buffer.size() - m_position);
22
0
      length -= (m_buffer.size() - m_position);
23
0
      in += (m_buffer.size() - m_position);
24
0
      out += (m_buffer.size() - m_position);
25
0
      generate();
26
0
   }
27
0
   xor_buf(out, in, &m_buffer[m_position], length);
28
0
   m_position += length;
29
0
}
30
31
0
std::unique_ptr<StreamCipher> RC4::new_object() const {
32
0
   return std::make_unique<RC4>(m_SKIP);
33
0
}
34
35
0
size_t RC4::buffer_size() const {
36
0
   return 256;
37
0
}
38
39
0
Key_Length_Specification RC4::key_spec() const {
40
0
   return Key_Length_Specification(1, 256);
41
0
}
42
43
0
void RC4::set_iv_bytes(const uint8_t* /*iv*/, size_t length) {
44
0
   if(length > 0) {
45
0
      throw Invalid_IV_Length("RC4", length);
46
0
   }
47
0
}
48
49
/*
50
* Generate cipher stream
51
*/
52
0
void RC4::generate() {
53
0
   uint8_t SX, SY;
54
0
   for(size_t i = 0; i != m_buffer.size(); i += 4) {
55
0
      SX = m_state[m_X + 1];
56
0
      m_Y = (m_Y + SX) % 256;
57
0
      SY = m_state[m_Y];
58
0
      m_state[m_X + 1] = SY;
59
0
      m_state[m_Y] = SX;
60
0
      m_buffer[i] = m_state[(SX + SY) % 256];
61
62
0
      SX = m_state[m_X + 2];
63
0
      m_Y = (m_Y + SX) % 256;
64
0
      SY = m_state[m_Y];
65
0
      m_state[m_X + 2] = SY;
66
0
      m_state[m_Y] = SX;
67
0
      m_buffer[i + 1] = m_state[(SX + SY) % 256];
68
69
0
      SX = m_state[m_X + 3];
70
0
      m_Y = (m_Y + SX) % 256;
71
0
      SY = m_state[m_Y];
72
0
      m_state[m_X + 3] = SY;
73
0
      m_state[m_Y] = SX;
74
0
      m_buffer[i + 2] = m_state[(SX + SY) % 256];
75
76
0
      m_X = (m_X + 4) % 256;
77
0
      SX = m_state[m_X];
78
0
      m_Y = (m_Y + SX) % 256;
79
0
      SY = m_state[m_Y];
80
0
      m_state[m_X] = SY;
81
0
      m_state[m_Y] = SX;
82
0
      m_buffer[i + 3] = m_state[(SX + SY) % 256];
83
0
   }
84
0
   m_position = 0;
85
0
}
86
87
0
bool RC4::has_keying_material() const {
88
0
   return !m_state.empty();
89
0
}
90
91
/*
92
* RC4 Key Schedule
93
*/
94
0
void RC4::key_schedule(std::span<const uint8_t> key) {
95
0
   m_state.resize(256);
96
0
   m_buffer.resize(256);
97
98
0
   m_position = m_X = m_Y = 0;
99
100
0
   for(size_t i = 0; i != 256; ++i) {
101
0
      m_state[i] = static_cast<uint8_t>(i);
102
0
   }
103
104
0
   for(size_t i = 0, state_index = 0; i != 256; ++i) {
105
0
      state_index = (state_index + key[i % key.size()] + m_state[i]) % 256;
106
0
      std::swap(m_state[i], m_state[state_index]);
107
0
   }
108
109
0
   for(size_t i = 0; i <= m_SKIP; i += m_buffer.size()) {
110
0
      generate();
111
0
   }
112
113
0
   m_position += (m_SKIP % m_buffer.size());
114
0
}
115
116
/*
117
* Return the name of this type
118
*/
119
0
std::string RC4::name() const {
120
0
   if(m_SKIP == 0) {
121
0
      return "RC4";
122
0
   } else if(m_SKIP == 256) {
123
0
      return "MARK-4";
124
0
   } else {
125
0
      return "RC4(" + std::to_string(m_SKIP) + ")";
126
0
   }
127
0
}
128
129
/*
130
* Clear memory of sensitive data
131
*/
132
0
void RC4::clear() {
133
0
   zap(m_state);
134
0
   zap(m_buffer);
135
0
   m_position = m_X = m_Y = 0;
136
0
}
137
138
/*
139
* RC4 Constructor
140
*/
141
0
RC4::RC4(size_t s) : m_SKIP(s) {}
142
143
0
void RC4::seek(uint64_t /*offset*/) {
144
0
   throw Not_Implemented("RC4 does not support seeking");
145
0
}
146
}  // namespace Botan