blob: 60180de90c9d64a8c37930db613df678cf1233e6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*
* Symmetric Algorithm Base Class
* (C) 1999-2007 Jack Lloyd
*
* Distributed under the terms of the Botan license
*/
#ifndef BOTAN_SYMMETRIC_ALGORITHM_H__
#define BOTAN_SYMMETRIC_ALGORITHM_H__
#include <botan/types.h>
#include <botan/exceptn.h>
#include <botan/symkey.h>
namespace Botan {
/**
* This class represents a symmetric algorithm object.
*/
class BOTAN_DLL SymmetricAlgorithm
{
public:
/**
* The maximum allowed key length.
*/
const u32bit MAXIMUM_KEYLENGTH;
/**
* The minimal allowed key length.
*/
const u32bit MINIMUM_KEYLENGTH;
/**
* A valid keylength is a multiple of this value.
*/
const u32bit KEYLENGTH_MULTIPLE;
/**
* The name of the algorithm.
* @return name of the algorithm
*/
virtual std::string name() const = 0;
/**
* Set the symmetric key of this object.
* @param key the SymmetricKey to be set.
*/
void set_key(const SymmetricKey& key)
{ set_key(key.begin(), key.length()); }
/**
* Set the symmetric key of this object.
* @param key the to be set as a byte array.
* @param length in bytes of key param
*/
void set_key(const byte key[], u32bit length)
{
if(!valid_keylength(length))
throw Invalid_Key_Length(name(), length);
key_schedule(key, length);
}
/**
* Check whether a given key length is valid for this algorithm.
* @param length the key length to be checked.
* @return true if the key length is valid.
*/
bool valid_keylength(u32bit length) const
{
return ((length >= MINIMUM_KEYLENGTH) &&
(length <= MAXIMUM_KEYLENGTH) &&
(length % KEYLENGTH_MULTIPLE == 0));
}
/**
* Construct a SymmetricAlgorithm.
* @param key_min the minimum allowed key length
* @param key_max the maximum allowed key length
* @param key_mod any valid key length must be a multiple of this value
*/
SymmetricAlgorithm(u32bit key_min, u32bit key_max, u32bit key_mod) :
MAXIMUM_KEYLENGTH(key_max ? key_max : key_min),
MINIMUM_KEYLENGTH(key_min),
KEYLENGTH_MULTIPLE(key_mod)
{}
virtual ~SymmetricAlgorithm() {}
private:
/**
* Run the key schedule
* @param key the key
* @param length of key
*/
virtual void key_schedule(const byte key[], u32bit length) = 0;
};
/**
* The two possible directions for cipher filters, determining whether they
* actually perform encryption or decryption.
*/
enum Cipher_Dir { ENCRYPTION, DECRYPTION };
}
#endif
|
