Coverage Report

Created: 2026-09-19 06:39

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