Botan::SCAN_Name Class Reference

#include <scan_name.h>

Public Member Functions
std::string	algo_name () const
std::string	algo_name_and_args () const
std::string	arg (size_t i) const
std::string	arg (size_t i, const std::string &def_value) const
size_t	arg_as_integer (size_t i, size_t def_value) const
size_t	arg_count () const
bool	arg_count_between (size_t lower, size_t upper) const
std::string	as_string () const
std::string	cipher_mode () const
std::string	cipher_mode_pad () const
	SCAN_Name (std::string algo_spec)

Detailed Description

A class encapsulating a SCAN name (similar to JCE conventions) http://www.users.zetnet.co.uk/hopwood/crypto/scan/

Definition at line 21 of file scan_name.h.

Constructor & Destructor Documentation

SCAN_Name()

Botan::SCAN_Name::SCAN_Name

(

std::string

algo_spec

)

Parameters

algo_spec

A SCAN-format name

Definition at line 66 of file scan_name.cpp.

   {
   orig_algo_spec = algo_spec;
 
   std::vector<std::pair<size_t, std::string> > name;
   size_t level = 0;
   std::pair<size_t, std::string> accum = std::make_pair(level, "");
 
   std::string decoding_error = "Bad SCAN name '" + algo_spec + "': ";
 
   algo_spec = global_state().deref_alias(algo_spec);
 
   for(size_t i = 0; i != algo_spec.size(); ++i)
      {
      char c = algo_spec[i];
 
      if(c == '/' || c == ',' || c == '(' || c == ')')
         {
         if(c == '(')
            ++level;
         else if(c == ')')
            {
            if(level == 0)
               throw Decoding_Error(decoding_error + "Mismatched parens");
            --level;
            }
 
         if(c == '/' && level > 0)
            accum.second.push_back(c);
         else
            {
            if(accum.second != "")
               name.push_back(deref_aliases(accum));
            accum = std::make_pair(level, "");
            }
         }
      else
         accum.second.push_back(c);
      }
 
   if(accum.second != "")
      name.push_back(deref_aliases(accum));
 
   if(level != 0)
      throw Decoding_Error(decoding_error + "Missing close paren");
 
   if(name.size() == 0)
      throw Decoding_Error(decoding_error + "Empty name");
 
   alg_name = name[0].second;
 
   bool in_modes = false;
 
   for(size_t i = 1; i != name.size(); ++i)
      {
      if(name[i].first == 0)
         {
         mode_info.push_back(make_arg(name, i));
         in_modes = true;
         }
      else if(name[i].first == 1 && !in_modes)
         args.push_back(make_arg(name, i));
      }
   }

References Botan::Decoding_Error::Decoding_Error(), Botan::Library_State::deref_alias(), and Botan::global_state().

Member Function Documentation

algo_name()

std::string Botan::SCAN_Name::algo_name ( ) const

inline

Returns

algorithm name

Definition at line 37 of file scan_name.h.

{ return alg_name; }

Referenced by algo_name_and_args(), Botan::AES_ISA_Engine::find_block_cipher(), Botan::Assembler_Engine::find_block_cipher(), Botan::Core_Engine::find_block_cipher(), Botan::OpenSSL_Engine::find_block_cipher(), Botan::SIMD_Engine::find_block_cipher(), Botan::Assembler_Engine::find_hash(), Botan::Core_Engine::find_hash(), Botan::OpenSSL_Engine::find_hash(), Botan::SIMD_Engine::find_hash(), Botan::Core_Engine::find_mac(), Botan::Core_Engine::find_pbkdf(), Botan::Core_Engine::find_stream_cipher(), Botan::OpenSSL_Engine::find_stream_cipher(), Botan::get_eme(), Botan::get_emsa(), Botan::get_kdf(), Botan::get_pbe(), and Botan::get_pbe().

algo_name_and_args()

std::string Botan::SCAN_Name::algo_name_and_args

(

)

const

Returns

algorithm name plus any arguments

Definition at line 131 of file scan_name.cpp.

   {
   std::string out;
 
   out = algo_name();
 
   if(arg_count())
      {
      out += '(';
      for(size_t i = 0; i != arg_count(); ++i)
         {
         out += arg(i);
         if(i != arg_count() - 1)
            out += ',';
         }
      out += ')';
 
      }
 
   return out;
   }

References algo_name(), arg(), and arg_count().

Referenced by Botan::algorithm_kat().

arg() [1/2]

std::string Botan::SCAN_Name::arg

(

size_t

i

)

const

Parameters

i	which argument

Returns

ith argument

Definition at line 153 of file scan_name.cpp.

   {
   if(i >= arg_count())
      throw std::range_error("SCAN_Name::argument - i out of range");
   return args[i];
   }

References arg_count().

Referenced by algo_name_and_args(), Botan::Core_Engine::find_block_cipher(), Botan::Core_Engine::find_hash(), Botan::Core_Engine::find_mac(), Botan::Core_Engine::find_pbkdf(), Botan::get_eme(), Botan::get_emsa(), Botan::get_kdf(), Botan::get_pbe(), and Botan::get_pbe().

arg() [2/2]

std::string Botan::SCAN_Name::arg	(	size_t	i,
		const std::string &	def_value ) const

Parameters

i	which argument
def_value	the default value

Returns

ith argument or the default value

Definition at line 160 of file scan_name.cpp.

   {
   if(i >= arg_count())
      return def_value;
   return args[i];
   }

References arg_count().

arg_as_integer()

size_t Botan::SCAN_Name::arg_as_integer	(	size_t	i,
		size_t	def_value ) const

Parameters

i	which argument
def_value	the default value

Returns

ith argument as an integer, or the default value

Definition at line 167 of file scan_name.cpp.

   {
   if(i >= arg_count())
      return def_value;
   return to_u32bit(args[i]);
   }

References arg_count(), and Botan::to_u32bit().

Referenced by Botan::Core_Engine::find_block_cipher(), Botan::OpenSSL_Engine::find_block_cipher(), Botan::Core_Engine::find_hash(), Botan::Core_Engine::find_stream_cipher(), Botan::OpenSSL_Engine::find_stream_cipher(), and Botan::get_emsa().

arg_count()

size_t Botan::SCAN_Name::arg_count ( ) const

inline

Returns

number of arguments

Definition at line 47 of file scan_name.h.

{ return args.size(); }

Referenced by algo_name_and_args(), arg(), arg(), arg_as_integer(), arg_count_between(), Botan::Core_Engine::find_block_cipher(), Botan::Core_Engine::find_hash(), Botan::Core_Engine::find_mac(), Botan::Core_Engine::find_pbkdf(), Botan::get_eme(), Botan::get_emsa(), Botan::get_kdf(), Botan::get_pbe(), and Botan::get_pbe().

arg_count_between()

bool Botan::SCAN_Name::arg_count_between ( size_t lower, size_t upper ) const

inline

Parameters

lower	is the lower bound
upper	is the upper bound

Returns

if the number of arguments is between lower and upper

Definition at line 54 of file scan_name.h.

         { return ((arg_count() >= lower) && (arg_count() <= upper)); }

References arg_count().

Referenced by Botan::Core_Engine::find_block_cipher(), Botan::get_eme(), and Botan::get_emsa().

as_string()

std::string Botan::SCAN_Name::as_string ( ) const

inline

Returns

original input string

Definition at line 32 of file scan_name.h.

{ return orig_algo_spec; }

Referenced by Botan::get_pbe().

cipher_mode()

std::string Botan::SCAN_Name::cipher_mode ( ) const

inline

Returns

cipher mode (if any)

Definition at line 80 of file scan_name.h.

         { return (mode_info.size() >= 1) ? mode_info[0] : ""; }

Referenced by Botan::algorithm_kat().

cipher_mode_pad()

std::string Botan::SCAN_Name::cipher_mode_pad ( ) const

inline

Returns

cipher mode padding (if any)

Definition at line 86 of file scan_name.h.

         { return (mode_info.size() >= 2) ? mode_info[1] : ""; }

Referenced by Botan::algorithm_kat().

---

The documentation for this class was generated from the following files:

• src/libstate/scan_name.h
• src/libstate/scan_name.cpp