Botan::SCAN_Name Class Reference

#include <scan_name.h>

Public Member Functions
const std::string &	algo_name () const
std::string	arg (size_t i) const
std::string	arg (size_t i, std::string_view def_value) const
size_t	arg_as_integer (size_t i) 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	cipher_mode () const
std::string	cipher_mode_pad () const
	SCAN_Name (const char *algo_spec)
	SCAN_Name (std::string_view algo_spec)
const std::string &	to_string () const

Detailed Description

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

Definition at line 22 of file scan_name.h.

Constructor & Destructor Documentation

SCAN_Name() [1/2]

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

explicit

Create a SCAN_Name

Parameters

algo_spec

A SCAN-format name

Definition at line 56 of file scan_name.cpp.

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

SCAN_Name() [2/2]

Botan::SCAN_Name::SCAN_Name ( std::string_view algo_spec )

explicit

Create a SCAN_Name

Parameters

algo_spec

A SCAN-format name

Definition at line 58 of file scan_name.cpp.

                                             : m_orig_algo_spec(algo_spec), m_alg_name(), m_args(), m_mode_info() {
   if(algo_spec.empty()) {
      throw Invalid_Argument("Expected algorithm name, got empty string");
   }
 
   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 '" + m_orig_algo_spec + "': ";
 
   for(char c : algo_spec) {
      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.empty()) {
               name.push_back(accum);
            }
            accum = std::make_pair(level, "");
         }
      } else {
         accum.second.push_back(c);
      }
   }
 
   if(!accum.second.empty()) {
      name.push_back(accum);
   }
 
   if(level != 0) {
      throw Decoding_Error(decoding_error + "Missing close paren");
   }
 
   if(name.empty()) {
      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));
      }
   }
}

References name.

Member Function Documentation

algo_name()

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

inline

Returns

algorithm name

Definition at line 44 of file scan_name.h.

{ return m_alg_name; }

Referenced by Botan::TPM2::cipher_botan_to_tss2(), Botan::commoncrypto_opts_from_algo(), Botan::AEAD_Mode::create(), Botan::BlockCipher::create(), Botan::Cipher_Mode::create(), Botan::EME::create(), Botan::EMSA::create(), Botan::HashFunction::create(), Botan::KDF::create(), Botan::MessageAuthenticationCode::create(), Botan::PasswordHashFamily::create(), Botan::PBKDF::create(), Botan::StreamCipher::create(), Botan::XOF::create(), Botan::PKCS11::MechanismWrapper::create_ecdsa_mechanism(), Botan::PSS_Params::from_emsa_name(), Botan::HSS_LMS_Params::HSS_LMS_Params(), Botan::TPM2::rsa_encryption_scheme_botan_to_tss2(), and Botan::TPM2::rsa_signature_scheme_botan_to_tss2().

arg() [1/2]

std::string Botan::SCAN_Name::arg

(

size_t

i

)

const

Parameters

i	which argument

Returns

ith argument

Definition at line 119 of file scan_name.cpp.

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

Referenced by Botan::TPM2::cipher_botan_to_tss2(), Botan::AEAD_Mode::create(), Botan::BlockCipher::create(), Botan::Cipher_Mode::create(), Botan::EME::create(), Botan::EMSA::create(), Botan::HashFunction::create(), Botan::KDF::create(), Botan::MessageAuthenticationCode::create(), Botan::PasswordHashFamily::create(), Botan::PBKDF::create(), Botan::StreamCipher::create(), Botan::PKCS11::MechanismWrapper::create_ecdh_mechanism(), Botan::PKCS11::MechanismWrapper::create_ecdsa_mechanism(), Botan::PSS_Params::from_emsa_name(), Botan::HSS_LMS_Params::HSS_LMS_Params(), Botan::TPM2::rsa_encryption_scheme_botan_to_tss2(), and Botan::TPM2::rsa_signature_scheme_botan_to_tss2().

arg() [2/2]

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

Parameters

i	which argument
def_value	the default value

Returns

ith argument or the default value

Definition at line 126 of file scan_name.cpp.

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

arg_as_integer() [1/2]

size_t Botan::SCAN_Name::arg_as_integer

(

size_t

i

)

const

Parameters

i	which argument

Returns

ith argument as an integer

Definition at line 140 of file scan_name.cpp.

                                               {
   return to_u32bit(arg(i));
}

References Botan::to_u32bit().

arg_as_integer() [2/2]

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

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

References Botan::to_u32bit().

Referenced by Botan::AEAD_Mode::create(), Botan::BlockCipher::create(), Botan::Cipher_Mode::create(), Botan::EMSA::create(), Botan::HashFunction::create(), Botan::KDF::create(), Botan::MessageAuthenticationCode::create(), Botan::StreamCipher::create(), Botan::PSS_Params::from_emsa_name(), and Botan::HSS_LMS_Params::HSS_LMS_Params().

arg_count()

size_t Botan::SCAN_Name::arg_count ( ) const

inline

Returns

number of arguments

Definition at line 49 of file scan_name.h.

{ return m_args.size(); }

Referenced by arg_count_between(), Botan::TPM2::cipher_botan_to_tss2(), Botan::AEAD_Mode::create(), Botan::BlockCipher::create(), Botan::Cipher_Mode::create(), Botan::EME::create(), Botan::EMSA::create(), Botan::HashFunction::create(), Botan::KDF::create(), Botan::MessageAuthenticationCode::create(), Botan::PasswordHashFamily::create(), Botan::PBKDF::create(), Botan::StreamCipher::create(), Botan::XOF::create(), Botan::PKCS11::MechanismWrapper::create_ecdh_mechanism(), Botan::PKCS11::MechanismWrapper::create_ecdsa_mechanism(), Botan::PSS_Params::from_emsa_name(), Botan::HSS_LMS_Params::HSS_LMS_Params(), Botan::TPM2::rsa_encryption_scheme_botan_to_tss2(), and Botan::TPM2::rsa_signature_scheme_botan_to_tss2().

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

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

References arg_count().

Referenced by Botan::BlockCipher::create(), Botan::EMSA::create(), Botan::KDF::create(), and Botan::StreamCipher::create().

cipher_mode()

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

inline

Returns

cipher mode (if any)

Definition at line 89 of file scan_name.h.

{ return (!m_mode_info.empty()) ? m_mode_info[0] : ""; }

Referenced by Botan::commoncrypto_opts_from_algo().

cipher_mode_pad()

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

inline

Returns

cipher mode padding (if any)

Definition at line 94 of file scan_name.h.

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

Referenced by Botan::commoncrypto_opts_from_algo().

to_string()

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

inline

Returns

original input string

Definition at line 39 of file scan_name.h.

{ return m_orig_algo_spec; }

---

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

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