Botan::RSA_PublicKey Class Reference

#include <rsa.h>

Inheritance diagram for Botan::RSA_PublicKey:

Public Member Functions
std::string	algo_name () const
AlgorithmIdentifier	algorithm_identifier () const
bool	check_key (RandomNumberGenerator &rng, bool) const
const BigInt &	get_e () const
const BigInt &	get_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
	RSA_PublicKey (const AlgorithmIdentifier &alg_id, const MemoryRegion< byte > &key_bits)
	RSA_PublicKey (const BigInt &n, const BigInt &e)
MemoryVector< byte >	x509_subject_public_key () const

Protected Member Functions
virtual void	load_check (RandomNumberGenerator &rng) const
	RSA_PublicKey ()

Protected Attributes
BigInt	e
BigInt	n

Detailed Description

RSA Public Key

Definition at line 21 of file rsa.h.

Constructor & Destructor Documentation

RSA_PublicKey() [1/3]

Botan::RSA_PublicKey::RSA_PublicKey ( const AlgorithmIdentifier & alg_id, const MemoryRegion< byte > & key_bits )

inline

Definition at line 26 of file rsa.h.

                                                        :
         IF_Scheme_PublicKey(alg_id, key_bits)
         {}

References Botan::IF_Scheme_PublicKey::IF_Scheme_PublicKey().

RSA_PublicKey() [2/3]

Botan::RSA_PublicKey::RSA_PublicKey ( const BigInt & n, const BigInt & e )

inline

Create a RSA_PublicKey

• n the modulus
• e the exponent

Definition at line 36 of file rsa.h.

                                                      :
         IF_Scheme_PublicKey(n, e)
         {}

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

RSA_PublicKey() [3/3]

Botan::RSA_PublicKey::RSA_PublicKey ( )

inlineprotected

Definition at line 41 of file rsa.h.

{}

Referenced by Botan::Server_Key_Exchange::key(), and Botan::make_public_key().

Member Function Documentation

algo_name()

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

inlinevirtual

Get the name of the underlying public key scheme.

Returns

name of the public key scheme

Implements Botan::Public_Key.

Definition at line 24 of file rsa.h.

{ return "RSA"; }

Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey().

algorithm_identifier()

AlgorithmIdentifier Botan::IF_Scheme_PublicKey::algorithm_identifier ( ) const

virtualinherited

Returns

X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 15 of file if_algo.cpp.

   {
   return AlgorithmIdentifier(get_oid(),
                              AlgorithmIdentifier::USE_NULL_PARAM);
   }

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

check_key()

bool Botan::IF_Scheme_PublicKey::check_key ( RandomNumberGenerator & rng, bool strong ) const

virtualinherited

Test the key values for consistency.

Parameters

rng	rng to use
strong	whether to perform strong and lengthy version of the test

Returns

true if the test is passed

Implements Botan::Public_Key.

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

Definition at line 45 of file if_algo.cpp.

   {
   if(n < 35 || n.is_even() || e < 2)
      return false;
   return true;
   }

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

get_e()

const BigInt & Botan::IF_Scheme_PublicKey::get_e ( ) const

inlineinherited

Returns

public exponent

Definition at line 44 of file if_algo.h.

{ return e; }

References e.

Referenced by Botan::Server_Key_Exchange::Server_Key_Exchange().

get_n()

const BigInt & Botan::IF_Scheme_PublicKey::get_n ( ) const

inlineinherited

Returns

public modulus

Definition at line 39 of file if_algo.h.

{ return n; }

References n.

Referenced by Botan::Server_Key_Exchange::Server_Key_Exchange().

get_oid()

OID Botan::Public_Key::get_oid ( ) const

virtualinherited

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.

   {
   try {
      return OIDS::lookup(algo_name());
      }
   catch(Lookup_Error)
      {
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
      }
   }

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

Referenced by algo_name(), Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), and Botan::IF_Scheme_PublicKey::algorithm_identifier().

load_check()

void Botan::Public_Key::load_check ( RandomNumberGenerator & rng ) const

protectedvirtualinherited

Self-test after loading a key

Parameters

rng	a random number generator

Reimplemented in Botan::Private_Key.

Definition at line 31 of file pk_keys.cpp.

   {
   if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
      throw Invalid_Argument(algo_name() + ": Invalid public key");
   }

References algo_name(), and check_key().

max_input_bits()

size_t Botan::IF_Scheme_PublicKey::max_input_bits ( ) const

inlinevirtualinherited

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.

{ return (n.bits() - 1); }

References n.

message_part_size()

virtual size_t Botan::Public_Key::message_part_size ( ) const

inlinevirtualinherited

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

Returns

size of the message parts in bits

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

Definition at line 56 of file pk_keys.h.

{ return 0; }

message_parts()

virtual size_t Botan::Public_Key::message_parts ( ) const

inlinevirtualinherited

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

Returns

number of message parts

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

Definition at line 50 of file pk_keys.h.

{ return 1; }

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

x509_subject_public_key()

MemoryVector< byte > Botan::IF_Scheme_PublicKey::x509_subject_public_key ( ) const

virtualinherited

Returns

X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Definition at line 21 of file if_algo.cpp.

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

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

Member Data Documentation

e

BigInt Botan::IF_Scheme_PublicKey::e

protectedinherited

Definition at line 51 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::check_key(), check_key(), Botan::RSA_PrivateKey::check_key(), Botan::RW_PrivateKey::check_key(), get_e(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), IF_Scheme_PublicKey(), IF_Scheme_PublicKey(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PublicKey::RSA_PublicKey(), Botan::RW_PrivateKey::RW_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and x509_subject_public_key().

n

BigInt Botan::IF_Scheme_PublicKey::n

protectedinherited

Definition at line 51 of file if_algo.h.

Referenced by Botan::IF_Scheme_PrivateKey::check_key(), check_key(), get_n(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), IF_Scheme_PublicKey(), IF_Scheme_PublicKey(), max_input_bits(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PublicKey::RSA_PublicKey(), Botan::RW_PrivateKey::RW_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and x509_subject_public_key().

---

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

• src/pubkey/rsa/rsa.h