Botan  1.11.15
Public Member Functions | Protected Member Functions | Protected Attributes
Botan::RW_PublicKey Class Reference

#include <rw.h>

Inheritance diagram for Botan::RW_PublicKey:
Botan::IF_Scheme_PublicKey Botan::Public_Key Botan::RW_PrivateKey

List of all members.

Public Member Functions

std::string algo_name () const
AlgorithmIdentifier algorithm_identifier () const
bool check_key (RandomNumberGenerator &rng, bool) const
size_t estimated_strength () const override
const BigIntget_e () const
const BigIntget_n () const
virtual OID get_oid () const
size_t max_input_bits () const
virtual size_t message_part_size () const
virtual size_t message_parts () const
 RW_PublicKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)
 RW_PublicKey (const BigInt &mod, const BigInt &exponent)
std::vector< bytex509_subject_public_key () const

Protected Member Functions

virtual void load_check (RandomNumberGenerator &rng) const
 RW_PublicKey ()

Protected Attributes

BigInt e
BigInt n

Detailed Description

Rabin-Williams Public Key

Definition at line 18 of file rw.h.


Constructor & Destructor Documentation

Botan::RW_PublicKey::RW_PublicKey ( const AlgorithmIdentifier alg_id,
const secure_vector< byte > &  key_bits 
) [inline]

Definition at line 23 of file rw.h.

                                                        :
         IF_Scheme_PublicKey(alg_id, key_bits)
         {}
Botan::RW_PublicKey::RW_PublicKey ( const BigInt mod,
const BigInt exponent 
) [inline]

Definition at line 28 of file rw.h.

                                                              :
         IF_Scheme_PublicKey(mod, exponent)
         {}
Botan::RW_PublicKey::RW_PublicKey ( ) [inline, protected]

Definition at line 33 of file rw.h.

{}

Member Function Documentation

std::string Botan::RW_PublicKey::algo_name ( ) const [inline, virtual]

Get the name of the underlying public key scheme.

Returns:
name of the public key scheme

Implements Botan::Public_Key.

Definition at line 21 of file rw.h.

Referenced by Botan::RW_PrivateKey::RW_PrivateKey().

{ return "RW"; }
Returns:
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 21 of file if_algo.cpp.

References Botan::Public_Key::get_oid(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

   {
   return AlgorithmIdentifier(get_oid(),
                              AlgorithmIdentifier::USE_NULL_PARAM);
   }
bool Botan::IF_Scheme_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const [virtual, inherited]

Test the key values for consistency.

Parameters:
rngrng to use
strongwhether to perform strong and lengthy version of the test
Returns:
true if the test is passed

Implements Botan::Public_Key.

Reimplemented in Botan::IF_Scheme_PrivateKey, Botan::RW_PrivateKey, and Botan::RSA_PrivateKey.

Definition at line 51 of file if_algo.cpp.

References Botan::IF_Scheme_PublicKey::e, Botan::BigInt::is_even(), and Botan::IF_Scheme_PublicKey::n.

   {
   if(n < 35 || n.is_even() || e < 2)
      return false;
   return true;
   }
size_t Botan::IF_Scheme_PublicKey::estimated_strength ( ) const [override, virtual, inherited]

Return the estimated strength of the underlying key against the best currently known attack. Note that this ignores anything but pure attacks against the key itself and do not take into account padding schemes, usage mistakes, etc which might reduce the strength. However it does suffice to provide an upper bound.

Returns:
estimated strength in bits

Implements Botan::Public_Key.

Definition at line 16 of file if_algo.cpp.

References Botan::BigInt::bits(), Botan::dl_work_factor(), and Botan::IF_Scheme_PublicKey::n.

   {
   return dl_work_factor(n.bits());
   }
const BigInt& Botan::IF_Scheme_PublicKey::get_e ( ) const [inline, inherited]
Returns:
public exponent

Definition at line 44 of file if_algo.h.

References e.

{ return e; }
const BigInt& Botan::IF_Scheme_PublicKey::get_n ( ) const [inline, inherited]
Returns:
public modulus

Definition at line 39 of file if_algo.h.

References n.

{ return n; }
OID Botan::Public_Key::get_oid ( ) const [virtual, inherited]

Get the OID of the underlying public key scheme.

Returns:
OID of the public key scheme

Definition at line 17 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::OIDS::lookup().

Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::IF_Scheme_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), and Botan::McEliece_PublicKey::algorithm_identifier().

   {
   try {
      return OIDS::lookup(algo_name());
      }
   catch(Lookup_Error)
      {
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
      }
   }
void Botan::Public_Key::load_check ( RandomNumberGenerator rng) const [protected, virtual, inherited]

Self-test after loading a key

Parameters:
rnga random number generator

Reimplemented in Botan::Private_Key.

Definition at line 31 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::Public_Key::check_key().

   {
   if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
      throw Invalid_Argument(algo_name() + ": Invalid public key");
   }
size_t Botan::IF_Scheme_PublicKey::max_input_bits ( ) const [inline, virtual, inherited]

Get the maximum message size in bits supported by this public key.

Returns:
maximum message size in bits

Implements Botan::Public_Key.

Definition at line 46 of file if_algo.h.

References n.

{ return (n.bits() - 1); }
virtual size_t Botan::Public_Key::message_part_size ( ) const [inline, virtual, inherited]

Find out the message part size supported by this scheme/key.

Returns:
size of the message parts in bits

Reimplemented in Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 67 of file pk_keys.h.

{ return 0; }
virtual size_t Botan::Public_Key::message_parts ( ) const [inline, virtual, inherited]

Find out the number of message parts supported by this scheme.

Returns:
number of message parts

Reimplemented in Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 61 of file pk_keys.h.

Referenced by Botan::EAC_Signed_Object::check_signature(), Botan::X509_Object::check_signature(), and Botan::choose_sig_format().

{ return 1; }
std::vector< byte > Botan::IF_Scheme_PublicKey::x509_subject_public_key ( ) const [virtual, inherited]
Returns:
X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Definition at line 27 of file if_algo.cpp.

References Botan::IF_Scheme_PublicKey::e, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents_unlocked(), Botan::IF_Scheme_PublicKey::n, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

   {
   return DER_Encoder()
      .start_cons(SEQUENCE)
         .encode(n)
         .encode(e)
      .end_cons()
      .get_contents_unlocked();
   }

Member Data Documentation

BigInt Botan::IF_Scheme_PublicKey::e [protected, inherited]
BigInt Botan::IF_Scheme_PublicKey::n [protected, inherited]

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