Botan: Botan::NR_PrivateKey Class Reference

Botan::NR_PrivateKey::NR_PrivateKey	(	RandomNumberGenerator &	rng,
		const DL_Group &	group,
		const BigInt &	x = `0`
	)

Definition at line 33 of file nr.cpp.

References Botan::Private_Key::gen_check(), Botan::DL_Scheme_PublicKey::group, Botan::DL_Scheme_PublicKey::group_g(), Botan::DL_Scheme_PublicKey::group_p(), Botan::DL_Scheme_PublicKey::group_q(), Botan::Private_Key::load_check(), Botan::power_mod(), Botan::BigInt::random_integer(), Botan::DL_Scheme_PrivateKey::x, and Botan::DL_Scheme_PublicKey::y.

    {
    group = grp;
    x = x_arg;
 
    if(x == 0)
       x = BigInt::random_integer(rng, 2, group_q() - 1);
 
    y = power_mod(group_g(), x, group_p());
 
    if(x_arg == 0)
       gen_check(rng);
    else
       load_check(rng);
    }

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

inlinevirtualinherited

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 nr.h.

24 { return "NR"; }

AlgorithmIdentifier Botan::DL_Scheme_PublicKey::algorithm_identifier ( ) const

virtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 21 of file dl_algo.cpp.

References Botan::DL_Group::DER_encode(), Botan::Public_Key::get_oid(), Botan::DL_Scheme_PublicKey::group, and Botan::DL_Scheme_PublicKey::group_format().

    {
    return AlgorithmIdentifier(get_oid(),
                               group.DER_encode(group_format()));
    }

bool Botan::NR_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

Reimplemented from Botan::DL_Scheme_PrivateKey.

Definition at line 64 of file nr.cpp.

References Botan::DL_Scheme_PrivateKey::check_key(), Botan::DL_Scheme_PublicKey::group_q(), Botan::KeyPair::signature_consistency_check(), and Botan::DL_Scheme_PrivateKey::x.

    {
    if(!DL_Scheme_PrivateKey::check_key(rng, strong) || x >= group_q())
       return false;
 
    if(!strong)
       return true;
 
    return KeyPair::signature_consistency_check(rng, *this, "EMSA1(SHA-1)");
    }

size_t Botan::DL_Scheme_PublicKey::estimated_strength ( ) const

overridevirtualinherited

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 dl_algo.cpp.

References Botan::BigInt::bits(), Botan::dl_work_factor(), Botan::DL_Group::get_p(), and Botan::DL_Scheme_PublicKey::group.

    {
    return dl_work_factor(group.get_p().bits());
    }

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.

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

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

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

const DL_Group& Botan::DL_Scheme_PublicKey::get_domain ( ) const

inlineinherited

Get the DL domain parameters of this key.

Returns: DL domain parameters of this key

Definition at line 33 of file dl_algo.h.

33 { return group; }

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

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

const BigInt& Botan::DL_Scheme_PrivateKey::get_x ( ) const

inlineinherited

Get the secret key x.

Returns: secret key

Definition at line 97 of file dl_algo.h.

Referenced by Botan::ElGamal_Decryption_Operation::ElGamal_Decryption_Operation().

97 { return x; }

const BigInt& Botan::DL_Scheme_PublicKey::get_y ( ) const

inlineinherited

Get the public value y with y = g^x mod p where x is the secret key.

Definition at line 38 of file dl_algo.h.

Referenced by Botan::ElGamal_Encryption_Operation::ElGamal_Encryption_Operation().

38 { return y; }

DL_Group::Format Botan::NR_PublicKey::group_format ( ) const

inlinevirtualinherited

Get the underlying groups encoding format.

Returns: encoding format

Implements Botan::DL_Scheme_PublicKey.

Definition at line 26 of file nr.h.

References Botan::DL_Group::ANSI_X9_57.

26 { return DL_Group::ANSI_X9_57; }

const BigInt& Botan::DL_Scheme_PublicKey::group_g ( ) const

inlineinherited

Get the generator g of the underlying DL group.

Returns: generator g

Definition at line 56 of file dl_algo.h.

Referenced by Botan::DL_Scheme_PrivateKey::check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_Verification_Operation::DSA_Verification_Operation(), Botan::ElGamal_Encryption_Operation::ElGamal_Encryption_Operation(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), NR_PrivateKey(), and Botan::NR_Verification_Operation::NR_Verification_Operation().

56 { return group.get_g(); }

const BigInt& Botan::DL_Scheme_PublicKey::group_p ( ) const

inlineinherited

Get the prime p of the underlying DL group.

Returns: prime p

Definition at line 44 of file dl_algo.h.

Referenced by Botan::DL_Scheme_PublicKey::check_key(), Botan::DL_Scheme_PrivateKey::check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_Verification_Operation::DSA_Verification_Operation(), Botan::ElGamal_Decryption_Operation::ElGamal_Decryption_Operation(), Botan::ElGamal_Encryption_Operation::ElGamal_Encryption_Operation(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), NR_PrivateKey(), Botan::NR_Verification_Operation::NR_Verification_Operation(), and Botan::DH_PublicKey::public_value().

44 { return group.get_p(); }

const BigInt& Botan::DL_Scheme_PublicKey::group_q ( ) const

inlineinherited

Get the prime q of the underlying DL group.

Returns: prime q

Definition at line 50 of file dl_algo.h.

Referenced by check_key(), Botan::DSA_PrivateKey::check_key(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_Verification_Operation::DSA_Verification_Operation(), NR_PrivateKey(), and Botan::NR_Verification_Operation::NR_Verification_Operation().

50 { return group.get_q(); }

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.

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");
    }

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.

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

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

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

size_t Botan::NR_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 30 of file nr.h.

30 { return (group_q().bits() - 1); }

size_t Botan::NR_PublicKey::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 from Botan::Public_Key.

Definition at line 29 of file nr.h.

29 { return group_q().bytes(); }

size_t Botan::NR_PublicKey::message_parts ( ) const

inlinevirtualinherited

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

Returns: number of message parts

Reimplemented from Botan::Public_Key.

Definition at line 28 of file nr.h.

28 { return 2; }

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

Reimplemented in Botan::GOST_3410_PrivateKey.

Definition at line 109 of file pk_keys.h.

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

110 { return algorithm_identifier(); }

secure_vector< byte > Botan::DL_Scheme_PrivateKey::pkcs8_private_key ( ) const

virtualinherited

Returns: PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 41 of file dl_algo.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::get_contents(), and Botan::DL_Scheme_PrivateKey::x.

    {
    return DER_Encoder().encode(x).get_contents();
    }

std::vector< byte > Botan::DL_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 27 of file dl_algo.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::get_contents_unlocked(), and Botan::DL_Scheme_PublicKey::y.

    {
    return DER_Encoder().encode(y).get_contents_unlocked();
    }

DL_Group Botan::DL_Scheme_PublicKey::group

protectedinherited

The DL group

Definition at line 81 of file dl_algo.h.

Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::DL_Scheme_PublicKey::check_key(), Botan::DL_Scheme_PrivateKey::check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PublicKey::DH_PublicKey(), Botan::DL_Scheme_PrivateKey::DL_Scheme_PrivateKey(), Botan::DL_Scheme_PublicKey::DL_Scheme_PublicKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_PublicKey::DSA_PublicKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::ElGamal_PublicKey::ElGamal_PublicKey(), Botan::DL_Scheme_PublicKey::estimated_strength(), NR_PrivateKey(), and Botan::NR_PublicKey::NR_PublicKey().

BigInt Botan::DL_Scheme_PrivateKey::x

protectedinherited

The DL private key

Definition at line 111 of file dl_algo.h.

Referenced by check_key(), Botan::DSA_PrivateKey::check_key(), Botan::DL_Scheme_PrivateKey::check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DL_Scheme_PrivateKey::DL_Scheme_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), NR_PrivateKey(), and Botan::DL_Scheme_PrivateKey::pkcs8_private_key().

BigInt Botan::DL_Scheme_PublicKey::y

protectedinherited

The DL public key

Definition at line 76 of file dl_algo.h.

Referenced by Botan::DL_Scheme_PrivateKey::check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PublicKey::DH_PublicKey(), Botan::DL_Scheme_PublicKey::DL_Scheme_PublicKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_PublicKey::DSA_PublicKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::ElGamal_PublicKey::ElGamal_PublicKey(), NR_PrivateKey(), Botan::NR_PublicKey::NR_PublicKey(), Botan::DH_PublicKey::public_value(), and Botan::DL_Scheme_PublicKey::x509_subject_public_key().

Public Member Functions
std::string	algo_name () const

AlgorithmIdentifier	algorithm_identifier () const

bool	check_key (RandomNumberGenerator &rng, bool strong) const

size_t	estimated_strength () const override

const DL_Group &	get_domain () const

virtual OID	get_oid () const

const BigInt &	get_x () const

const BigInt &	get_y () const

DL_Group::Format	group_format () const

const BigInt &	group_g () const

const BigInt &	group_p () const

const BigInt &	group_q () const

size_t	max_input_bits () const

size_t	message_part_size () const

size_t	message_parts () const

	NR_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits, RandomNumberGenerator &rng)

	NR_PrivateKey (RandomNumberGenerator &rng, const DL_Group &group, const BigInt &x=0)

virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const

secure_vector< byte >	pkcs8_private_key () const

std::vector< byte >	x509_subject_public_key () const

Protected Member Functions
void	gen_check (RandomNumberGenerator &rng) const

virtual void	load_check (RandomNumberGenerator &rng) const

void	load_check (RandomNumberGenerator &rng) const

Botan::NR_PrivateKey::NR_PrivateKey	(	const AlgorithmIdentifier &	alg_id,
		const secure_vector< byte > &	key_bits,
		RandomNumberGenerator &	rng
	)

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation