blob: cc89bf998ff6ce7b407cec8f44b150016cb8b574 (
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/*
* SCAN Name Abstraction
* (C) 2008,2015 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
#ifndef BOTAN_SCAN_NAME_H__
#define BOTAN_SCAN_NAME_H__
#include <botan/types.h>
#include <string>
#include <vector>
#include <mutex>
#include <map>
namespace Botan {
/**
A class encapsulating a SCAN name (similar to JCE conventions)
http://www.users.zetnet.co.uk/hopwood/crypto/scan/
*/
class BOTAN_DLL SCAN_Name
{
public:
/**
* @param algo_spec A SCAN-format name
*/
SCAN_Name(const char* algo_spec);
/**
* @param algo_spec A SCAN-format name
*/
SCAN_Name(std::string algo_spec);
/**
* @param algo_spec A SCAN-format name
*/
SCAN_Name(std::string algo_spec, const std::string& extra);
/**
* @return original input string
*/
const std::string& as_string() const { return orig_algo_spec; }
/**
* @return algorithm name
*/
const std::string& algo_name() const { return alg_name; }
/**
* @return algorithm name plus any arguments
*/
std::string algo_name_and_args() const { return algo_name() + all_arguments(); }
/**
* @return all arguments
*/
std::string all_arguments() const;
/**
* @return number of arguments
*/
size_t arg_count() const { return args.size(); }
/**
* @param lower is the lower bound
* @param upper is the upper bound
* @return if the number of arguments is between lower and upper
*/
bool arg_count_between(size_t lower, size_t upper) const
{ return ((arg_count() >= lower) && (arg_count() <= upper)); }
/**
* @param i which argument
* @return ith argument
*/
std::string arg(size_t i) const;
/**
* @param i which argument
* @param def_value the default value
* @return ith argument or the default value
*/
std::string arg(size_t i, const std::string& def_value) const;
/**
* @param i which argument
* @param def_value the default value
* @return ith argument as an integer, or the default value
*/
size_t arg_as_integer(size_t i, size_t def_value) const;
/**
* @return cipher mode (if any)
*/
std::string cipher_mode() const
{ return (mode_info.size() >= 1) ? mode_info[0] : ""; }
/**
* @return cipher mode padding (if any)
*/
std::string cipher_mode_pad() const
{ return (mode_info.size() >= 2) ? mode_info[1] : ""; }
static void add_alias(const std::string& alias, const std::string& basename);
static std::string deref_alias(const std::string& alias);
private:
static std::mutex g_alias_map_mutex;
static std::map<std::string, std::string> g_alias_map;
std::string orig_algo_spec;
std::string alg_name;
std::vector<std::string> args;
std::vector<std::string> mode_info;
};
}
#endif
|