Botan  1.10.9
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::RSA_PublicKey Class Reference

#include <rsa.h>

Inheritance diagram for Botan::RSA_PublicKey:
Botan::IF_Scheme_PublicKey Botan::Public_Key Botan::RSA_PrivateKey

Public Member Functions

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

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

Definition at line 26 of file rsa.h.

27  :
28  IF_Scheme_PublicKey(alg_id, key_bits)
29  {}
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.

Botan::RSA_PublicKey::RSA_PublicKey ( )
inlineprotected

Definition at line 41 of file rsa.h.

41 {}

Member Function Documentation

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.

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

24 { return "RSA"; }
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.

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

16  {
17  return AlgorithmIdentifier(get_oid(),
19  }
virtual OID get_oid() const
Definition: pk_keys.cpp:17
bool Botan::IF_Scheme_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
virtualinherited

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 45 of file if_algo.cpp.

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

46  {
47  if(n < 35 || n.is_even() || e < 2)
48  return false;
49  return true;
50  }
bool is_even() const
Definition: bigint.h:158
const BigInt& Botan::IF_Scheme_PublicKey::get_e ( ) const
inlineinherited
Returns
public exponent

Definition at line 44 of file if_algo.h.

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

44 { return e; }
const BigInt& Botan::IF_Scheme_PublicKey::get_n ( ) const
inlineinherited
Returns
public modulus

Definition at line 39 of file if_algo.h.

References n.

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

39 { return n; }
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.

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

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

18  {
19  try {
20  return OIDS::lookup(algo_name());
21  }
22  catch(Lookup_Error)
23  {
24  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
25  }
26  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:31
void Botan::Public_Key::load_check ( RandomNumberGenerator rng) const
protectedvirtualinherited

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().

32  {
33  if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
34  throw Invalid_Argument(algo_name() + ": Invalid public key");
35  }
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
virtual std::string algo_name() const =0
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20
RandomNumberGenerator * rng
Definition: global_rng.cpp:165
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.

References n.

46 { return (n.bits() - 1); }
size_t bits() const
Definition: bigint.cpp:253
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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 56 of file pk_keys.h.

56 { return 0; }
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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 50 of file pk_keys.h.

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

50 { return 1; }
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.

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

22  {
23  return DER_Encoder()
24  .start_cons(SEQUENCE)
25  .encode(n)
26  .encode(e)
27  .end_cons()
28  .get_contents();
29  }

Member Data Documentation

BigInt Botan::IF_Scheme_PublicKey::e
protectedinherited
BigInt Botan::IF_Scheme_PublicKey::n
protectedinherited

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