/usr/include/botan/sym_algo.h is in libbotan1.8-dev 1.8.13-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | /**
* 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.
* @deprecated use maximum_keylength()
*/
const u32bit MAXIMUM_KEYLENGTH;
/**
* The minimal allowed key length.
* @deprecated use minimum_keylength()
*/
const u32bit MINIMUM_KEYLENGTH;
/**
* A valid keylength is a multiple of this value.
* @deprecated
*/
const u32bit KEYLENGTH_MULTIPLE;
/**
* @return minimum allowed key length
*/
size_t maximum_keylength() const
{
return MAXIMUM_KEYLENGTH;
}
/**
* @return maxmium allowed key length
*/
size_t minimum_keylength() const
{
return MINIMUM_KEYLENGTH;
}
/**
* The name of the algorithm.
* @return the 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) throw(Invalid_Key_Length)
{ set_key(key.begin(), key.length()); }
/**
* Set the symmetric key of this object.
* @param key the to be set as a byte array.
* @param the length of the byte array.
*/
void set_key(const byte key[], u32bit length) throw(Invalid_Key_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:
virtual void key_schedule(const byte[], u32bit) = 0;
};
/**
* The two possible directions for cipher filters, determining whether they
* actually perform encryption or decryption.
*/
enum Cipher_Dir { ENCRYPTION, DECRYPTION };
}
#endif
|