Botan::SCAN_Name Class Reference

#include <scan_name.h>

Public Member Functions
const std::string &	algo_name () const
std::string	algo_name_and_args () const
std::string	all_arguments () 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
const std::string &	as_string () const
std::string	cipher_mode () const
std::string	cipher_mode_pad () const
	SCAN_Name (const char *algo_spec)
	SCAN_Name (std::string algo_spec)
	SCAN_Name (std::string algo_spec, const std::string &extra)

Static Public Member Functions
static void	add_alias (const std::string &alias, const std::string &basename)
static std::string	deref_alias (const std::string &alias)

Detailed Description

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

Definition at line 23 of file scan_name.h.

Constructor & Destructor Documentation

Botan::SCAN_Name::SCAN_Name ( const char *  algo_spec )

explicit

Parameters

algo_spec

A SCAN-format name

Definition at line 69 of file scan_name.cpp.

                                          : SCAN_Name(std::string(algo_spec))
   {
   }

Botan::SCAN_Name::SCAN_Name ( std::string  algo_spec )

explicit

Parameters

algo_spec

A SCAN-format name

Definition at line 73 of file scan_name.cpp.

References deref_alias().

                                        : m_orig_algo_spec(algo_spec), m_alg_name(), m_args(), m_mode_info()
   {
   std::vector<std::pair<size_t, std::string> > name;
   size_t level = 0;
   std::pair<size_t, std::string> accum = std::make_pair(level, "");

   const std::string decoding_error = "Bad SCAN name '" + algo_spec + "': ";

   algo_spec = SCAN_Name::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");

   m_alg_name = name[0].second;

   bool in_modes = false;

   for(size_t i = 1; i != name.size(); ++i)
      {
      if(name[i].first == 0)
         {
         m_mode_info.push_back(make_arg(name, i));
         in_modes = true;
         }
      else if(name[i].first == 1 && !in_modes)
         m_args.push_back(make_arg(name, i));
      }
   }

Botan::SCAN_Name::SCAN_Name	(	std::string	algo_spec,
		const std::string &	extra
	)

Parameters

algo_spec

A SCAN-format name

Definition at line 64 of file scan_name.cpp.

                                                                : SCAN_Name(algo_spec)
   {
   m_alg_name += extra;
   }

Member Function Documentation

void Botan::SCAN_Name::add_alias ( const std::string &  alias, const std::string &  basename  )

static

Definition at line 198 of file scan_name.cpp.

   {
   std::lock_guard<std::mutex> lock(g_alias_map_mutex);

   if(g_alias_map.find(alias) == g_alias_map.end())
      g_alias_map[alias] = basename;
   }

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

inline

Returns

algorithm name

Definition at line 49 of file scan_name.h.

Referenced by Botan::get_eme(), Botan::get_kdf(), Botan::OAEP::make(), Botan::RC4::make(), Botan::CTR_BE::make(), Botan::OFB::make(), and Botan::PKCS8::PEM_encode().

{ return m_alg_name; }

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

inline

Returns

algorithm name plus any arguments

Definition at line 54 of file scan_name.h.

{ return algo_name() + all_arguments(); }

std::string Botan::SCAN_Name::all_arguments

(

)

const

Returns

all arguments

Definition at line 136 of file scan_name.cpp.

References arg(), and arg_count().

   {
   std::string out;
   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;
   }

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.

References arg_count(), as_string(), and Botan::ASN1::to_string().

Referenced by all_arguments(), Botan::PKCS11::MechanismWrapper::create_ecdh_mechanism(), Botan::hash_for_emsa(), Botan::OAEP::make(), Botan::EMSA_PKCS1v15::make(), Botan::HKDF::make(), Botan::Comb4P::make(), Botan::Skein_512::make(), Botan::Cascade_Cipher::make(), Botan::Parallel::make(), Botan::PSSR::make(), Botan::CBC_MAC::make(), Botan::HMAC::make(), Botan::OFB::make(), Botan::CTR_BE::make(), Botan::Lion::make(), Botan::CMAC::make(), Botan::SP800_108_Counter::make(), Botan::SP800_56C::make(), Botan::PKCS5_PBKDF2::make(), Botan::TLS_12_PRF::make(), Botan::SP800_108_Feedback::make(), Botan::SP800_108_Pipeline::make(), Botan::make_block_cipher_mode(), Botan::make_block_cipher_mode_len(), Botan::make_block_cipher_mode_len2(), and Botan::PKCS8::PEM_encode().

   {
   if(i >= arg_count())
      throw Invalid_Argument("SCAN_Name::arg " + std::to_string(i) +
                             " out of range for '" + as_string() + "'");
   return m_args[i];
   }

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 161 of file scan_name.cpp.

References arg_count().

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

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 168 of file scan_name.cpp.

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

Referenced by Botan::Skein_512::make(), Botan::RC4::make(), Botan::PSSR::make(), Botan::Blake2b::make(), Botan::Lion::make(), Botan::make_block_cipher_mode_len(), and Botan::make_block_cipher_mode_len2().

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

size_t Botan::SCAN_Name::arg_count ( ) const

inline

Returns

number of arguments

Definition at line 64 of file scan_name.h.

Referenced by all_arguments(), arg(), arg_as_integer(), Botan::PKCS11::MechanismWrapper::create_ecdh_mechanism(), Botan::hash_for_emsa(), Botan::OAEP::make(), Botan::Comb4P::make(), Botan::Parallel::make(), Botan::CBC_MAC::make(), Botan::HMAC::make(), Botan::CTR_BE::make(), Botan::OFB::make(), Botan::CMAC::make(), and Botan::PKCS8::PEM_encode().

{ return m_args.size(); }

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 71 of file scan_name.h.

Referenced by Botan::OAEP::make(), and Botan::Lion::make().

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

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

inline

Returns

original input string

Definition at line 44 of file scan_name.h.

Referenced by arg().

{ return m_orig_algo_spec; }

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

inline

Returns

cipher mode (if any)

Definition at line 97 of file scan_name.h.

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

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

inline

Returns

cipher mode padding (if any)

Definition at line 103 of file scan_name.h.

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

std::string Botan::SCAN_Name::deref_alias ( const std::string &  alias )

static

Definition at line 206 of file scan_name.cpp.

Referenced by SCAN_Name().

   {
   std::lock_guard<std::mutex> lock(g_alias_map_mutex);

   std::string name = alias;

   for(auto i = g_alias_map.find(name); i != g_alias_map.end(); i = g_alias_map.find(name))
      name = i->second;

   return name;
   }

---

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

• src/lib/base/scan_name.h
• src/lib/base/scan_name.cpp