Botan::IF_Scheme_PrivateKey Class Reference

#include <if_algo.h>

Inheritance diagram for Botan::IF_Scheme_PrivateKey:

Public Member Functions
virtual std::string	algo_name () const =0
AlgorithmIdentifier	algorithm_identifier () const
bool	check_key (RandomNumberGenerator &rng, bool) const
const BigInt &	get_c () const
const BigInt &	get_d () const
const BigInt &	get_d1 () const
const BigInt &	get_d2 () const
const BigInt &	get_e () const
const BigInt &	get_n () const
virtual OID	get_oid () const
const BigInt &	get_p () const
const BigInt &	get_q () const
	IF_Scheme_PrivateKey (RandomNumberGenerator &rng, const AlgorithmIdentifier &alg_id, const MemoryRegion< byte > &key_bits)
	IF_Scheme_PrivateKey (RandomNumberGenerator &rng, const BigInt &prime1, const BigInt &prime2, const BigInt &exp, const BigInt &d_exp, const BigInt &mod)
size_t	max_input_bits () const
virtual size_t	message_part_size () const
virtual size_t	message_parts () const
virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const
MemoryVector< byte >	pkcs8_private_key () const
MemoryVector< byte >	x509_subject_public_key () const

Protected Member Functions
void	gen_check (RandomNumberGenerator &rng) const
	IF_Scheme_PrivateKey ()
void	load_check (RandomNumberGenerator &rng) const

Protected Attributes
BigInt	c
BigInt	d
BigInt	d1
BigInt	d2
BigInt	e
BigInt	n
BigInt	p
BigInt	q

Detailed Description

This class represents public keys of integer factorization based (IF) public key schemes.

Definition at line 58 of file if_algo.h.

Constructor & Destructor Documentation

IF_Scheme_PrivateKey() [1/3]

Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey	(	RandomNumberGenerator &	rng,
		const BigInt &	prime1,
		const BigInt &	prime2,
		const BigInt &	exp,
		const BigInt &	d_exp,
		const BigInt &	mod )

Definition at line 89 of file if_algo.cpp.

   {
   p = prime1;
   q = prime2;
   e = exp;
   d = d_exp;
   n = mod.is_nonzero() ? mod : p * q;
 
   if(d == 0)
      {
      BigInt inv_for_d = lcm(p - 1, q - 1);
      if(e.is_even())
         inv_for_d >>= 1;
 
      d = inverse_mod(e, inv_for_d);
      }
 
   d1 = d % (p - 1);
   d2 = d % (q - 1);
   c = inverse_mod(q, p);
 
   load_check(rng);
   }

References c, d, d1, d2, Botan::IF_Scheme_PublicKey::e, Botan::inverse_mod(), Botan::BigInt::is_even(), Botan::BigInt::is_nonzero(), Botan::lcm(), Botan::Private_Key::load_check(), Botan::IF_Scheme_PublicKey::n, p, and q.

Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

IF_Scheme_PrivateKey() [2/3]

Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey	(	RandomNumberGenerator &	rng,
		const AlgorithmIdentifier &	alg_id,
		const MemoryRegion< byte > &	key_bits )

Definition at line 69 of file if_algo.cpp.

   {
   BER_Decoder(key_bits)
      .start_cons(SEQUENCE)
         .decode_and_check<size_t>(0, "Unknown PKCS #1 key format version")
         .decode(n)
         .decode(e)
         .decode(d)
         .decode(p)
         .decode(q)
         .decode(d1)
         .decode(d2)
         .decode(c)
      .end_cons();
 
   load_check(rng);
   }

References Botan::BER_Decoder::BER_Decoder(), c, d, d1, d2, Botan::IF_Scheme_PublicKey::e, Botan::Private_Key::load_check(), Botan::IF_Scheme_PublicKey::n, p, q, and Botan::SEQUENCE.

IF_Scheme_PrivateKey() [3/3]

Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey ( )

inlineprotected

Definition at line 99 of file if_algo.h.

{}

Member Function Documentation

algo_name()

virtual std::string Botan::Public_Key::algo_name ( ) const

pure virtualinherited

Get the name of the underlying public key scheme.

Returns

name of the public key scheme

Implemented in Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ElGamal_PublicKey, Botan::NR_PublicKey, Botan::RSA_PublicKey, and Botan::RW_PublicKey.

References get_oid().

Referenced by Botan::Certificate_Verify::Certificate_Verify(), Botan::EAC_Signed_Object::check_signature(), Botan::X509_Object::check_signature(), Botan::choose_sig_format(), Botan::X509::find_constraints(), Botan::Private_Key::gen_check(), get_oid(), Botan::Private_Key::load_check(), load_check(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::Server_Hello::Server_Hello(), Botan::Server_Key_Exchange::Server_Key_Exchange(), and Botan::CMS_Encoder::sign().

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_PrivateKey::check_key ( RandomNumberGenerator & rng, bool strong ) const

virtual

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

   {
   if(n < 35 || n.is_even() || e < 2 || d < 2 || p < 3 || q < 3 || p*q != n)
      return false;
 
   if(!strong)
      return true;
 
   if(d1 != d % (p - 1) || d2 != d % (q - 1) || c != inverse_mod(q, p))
      return false;
   if(!check_prime(p, rng) || !check_prime(q, rng))
      return false;
   return true;
   }

References c, Botan::check_prime(), d, d1, d2, Botan::IF_Scheme_PublicKey::e, Botan::inverse_mod(), Botan::BigInt::is_even(), Botan::IF_Scheme_PublicKey::n, p, and q.

Referenced by Botan::RSA_PrivateKey::check_key(), and Botan::RW_PrivateKey::check_key().

gen_check()

void Botan::Private_Key::gen_check ( RandomNumberGenerator & rng ) const

protectedinherited

Self-test after generating a key

Parameters

rng	a random number generator

Definition at line 49 of file pk_keys.cpp.

   {
   if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_GENERATE))
      throw Self_Test_Failure(algo_name() + " private key generation failed");
   }

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

Referenced by Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

get_c()

const BigInt & Botan::IF_Scheme_PrivateKey::get_c ( ) const

inline

Definition at line 92 of file if_algo.h.

{ return c; }

References c.

get_d()

const BigInt & Botan::IF_Scheme_PrivateKey::get_d ( ) const

inline

Get d with exp * d = 1 mod (p - 1, q - 1).

Returns

d

Definition at line 90 of file if_algo.h.

{ return d; }

References d.

get_d1()

const BigInt & Botan::IF_Scheme_PrivateKey::get_d1 ( ) const

inline

Definition at line 93 of file if_algo.h.

{ return d1; }

References d1.

get_d2()

const BigInt & Botan::IF_Scheme_PrivateKey::get_d2 ( ) const

inline

Definition at line 94 of file if_algo.h.

{ return d2; }

References d2.

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

get_p()

const BigInt & Botan::IF_Scheme_PrivateKey::get_p ( ) const

inline

Get the first prime p.

Returns

prime p

Definition at line 78 of file if_algo.h.

{ return p; }

References p.

get_q()

const BigInt & Botan::IF_Scheme_PrivateKey::get_q ( ) const

inline

Get the second prime q.

Returns

prime q

Definition at line 84 of file if_algo.h.

{ return q; }

References q.

load_check()

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

protectedvirtualinherited

Self-test after loading a key

Parameters

rng	a random number generator

Reimplemented from Botan::Public_Key.

Definition at line 40 of file pk_keys.cpp.

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

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

Referenced by Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), and Botan::NR_PrivateKey::NR_PrivateKey().

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

pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const

inlinevirtualinherited

Returns

PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Definition at line 98 of file pk_keys.h.

         { return algorithm_identifier(); }

References Botan::Public_Key::algorithm_identifier().

Referenced by Botan::PKCS8::BER_encode().

pkcs8_private_key()

MemoryVector< byte > Botan::IF_Scheme_PrivateKey::pkcs8_private_key ( ) const

virtual

Returns

PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 52 of file if_algo.cpp.

   {
   return DER_Encoder()
      .start_cons(SEQUENCE)
         .encode(static_cast<size_t>(0))
         .encode(n)
         .encode(e)
         .encode(d)
         .encode(p)
         .encode(q)
         .encode(d1)
         .encode(d2)
         .encode(c)
      .end_cons()
   .get_contents();
   }

References c, d, d1, d2, Botan::IF_Scheme_PublicKey::e, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::IF_Scheme_PublicKey::n, p, q, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

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

c

BigInt Botan::IF_Scheme_PrivateKey::c

protected

Definition at line 101 of file if_algo.h.

Referenced by check_key(), get_c(), IF_Scheme_PrivateKey(), IF_Scheme_PrivateKey(), pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

d

BigInt Botan::IF_Scheme_PrivateKey::d

protected

Definition at line 101 of file if_algo.h.

Referenced by check_key(), Botan::RSA_PrivateKey::check_key(), Botan::RW_PrivateKey::check_key(), get_d(), IF_Scheme_PrivateKey(), IF_Scheme_PrivateKey(), pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

d1

BigInt Botan::IF_Scheme_PrivateKey::d1

protected

Definition at line 101 of file if_algo.h.

Referenced by check_key(), get_d1(), IF_Scheme_PrivateKey(), IF_Scheme_PrivateKey(), pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

d2

BigInt Botan::IF_Scheme_PrivateKey::d2

protected

Definition at line 101 of file if_algo.h.

Referenced by check_key(), get_d2(), IF_Scheme_PrivateKey(), IF_Scheme_PrivateKey(), pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

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

p

BigInt Botan::IF_Scheme_PrivateKey::p

protected

Definition at line 101 of file if_algo.h.

Referenced by check_key(), Botan::RSA_PrivateKey::check_key(), Botan::RW_PrivateKey::check_key(), get_p(), IF_Scheme_PrivateKey(), IF_Scheme_PrivateKey(), pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

q

BigInt Botan::IF_Scheme_PrivateKey::q

protected

Definition at line 101 of file if_algo.h.

Referenced by check_key(), Botan::RSA_PrivateKey::check_key(), Botan::RW_PrivateKey::check_key(), get_q(), IF_Scheme_PrivateKey(), IF_Scheme_PrivateKey(), pkcs8_private_key(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RW_PrivateKey::RW_PrivateKey(), and Botan::RW_PrivateKey::RW_PrivateKey().

---

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

• src/pubkey/if_algo/if_algo.h
• src/pubkey/if_algo/if_algo.cpp