X509PublicKey Class Reference

encodes/decodes subjectPublicKeyInfo More...

Inheritance diagram for X509PublicKey:
ASN1CryptoMaterial< PublicKey > ASN1Object PublicKey CryptoMaterial NameValuePairs DL_KeyImpl< X509PublicKey, DL_GroupParameters_EC< EC > > DL_KeyImpl< X509PublicKey, GP > RSAFunction DL_PublicKeyImpl< DL_GroupParameters_EC< EC > > DL_PublicKeyImpl< GP > InvertibleRSAFunction RSAFunction_ISO DL_PublicKey_EC< EC > DL_PublicKey_EC< EC > DL_PublicKey_GFP< GP > InvertibleRSAFunction_ISO

List of all members.

Public Member Functions

void BERDecode (BufferedTransformation &bt)
 Decode this object from a BufferedTransformation.
void DEREncode (BufferedTransformation &bt) const
 Encode this object into a BufferedTransformation.
virtual OID GetAlgorithmID () const =0
virtual bool BERDecodeAlgorithmParameters (BufferedTransformation &bt)
virtual bool DEREncodeAlgorithmParameters (BufferedTransformation &bt) const
virtual void BERDecodePublicKey (BufferedTransformation &bt, bool parametersPresent, size_t size)=0
 decode subjectPublicKey part of subjectPublicKeyInfo, without the BIT STRING header
virtual void DEREncodePublicKey (BufferedTransformation &bt) const =0
 encode subjectPublicKey part of subjectPublicKeyInfo, without the BIT STRING header
void Save (BufferedTransformation &bt) const
 Saves a key to a BufferedTransformation.
void Load (BufferedTransformation &bt)
 Loads a key from a BufferedTransformation.
virtual void BEREncode (BufferedTransformation &bt) const
 Encode this object into a BufferedTransformation.
virtual void AssignFrom (const NameValuePairs &source)=0
 Assign values to this object.
virtual bool Validate (RandomNumberGenerator &rng, unsigned int level) const =0
 Check this object for errors.
virtual void ThrowIfInvalid (RandomNumberGenerator &rng, unsigned int level) const
 Check this object for errors.
virtual bool SupportsPrecomputation () const
 Determines whether the object supports precomputation.
virtual void Precompute (unsigned int precomputationStorage)
 Perform precomputation.
virtual void LoadPrecomputation (BufferedTransformation &storedPrecomputation)
 retrieve previously saved precomputation
virtual void SavePrecomputation (BufferedTransformation &storedPrecomputation) const
 save precomputation for later use
void DoQuickSanityCheck () const
template<class T >
bool GetThisObject (T &object) const
 Get a copy of this object or subobject.
template<class T >
bool GetThisPointer (T *&ptr) const
 Get a pointer to this object.
template<class T >
bool GetValue (const char *name, T &value) const
 Get a named value.
template<class T >
GetValueWithDefault (const char *name, T defaultValue) const
 Get a named value.
std::string GetValueNames () const
 Get a list of value names that can be retrieved.
bool GetIntValue (const char *name, int &value) const
 Get a named value with type int.
int GetIntValueWithDefault (const char *name, int defaultValue) const
 Get a named value with type int, with default.
template<class T >
void GetRequiredParameter (const char *className, const char *name, T &value) const
 Retrieves a required name/value pair.
void GetRequiredIntParameter (const char *className, const char *name, int &value) const
 Retrieves a required name/value pair.
virtual bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const =0
 Get a named value.

Static Public Member Functions

static void ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving)
 Ensures an expected name and type is present.

Detailed Description

encodes/decodes subjectPublicKeyInfo

Definition at line 265 of file asn.h.


Member Function Documentation

void X509PublicKey::BERDecode ( BufferedTransformation bt  )  [virtual]

Decode this object from a BufferedTransformation.

Parameters:
bt BufferedTransformation object

Uses Basic Encoding Rules (BER)

Implements ASN1Object.

Reimplemented in InvertibleRSAFunction.

Definition at line 524 of file asn.cpp.

References BERDecodePublicKey().

void X509PublicKey::DEREncode ( BufferedTransformation bt  )  const [virtual]

Encode this object into a BufferedTransformation.

Parameters:
bt BufferedTransformation object

Uses Distinguished Encoding Rules (DER)

Implements ASN1Object.

Reimplemented in InvertibleRSAFunction.

Definition at line 539 of file asn.cpp.

References DEREncodePublicKey(), and BufferedTransformation::Put().

void ASN1CryptoMaterial< PublicKey >::Save ( BufferedTransformation bt  )  const [inline, virtual, inherited]

Reimplemented from CryptoMaterial.

Reimplemented in InvertibleRSAFunction.

Definition at line 258 of file asn.h.

void ASN1CryptoMaterial< PublicKey >::Load ( BufferedTransformation bt  )  [inline, virtual, inherited]

Reimplemented from CryptoMaterial.

Reimplemented in InvertibleRSAFunction.

Definition at line 260 of file asn.h.

virtual void ASN1Object::BEREncode ( BufferedTransformation bt  )  const [inline, virtual, inherited]

Encode this object into a BufferedTransformation.

Parameters:
bt BufferedTransformation object

Uses Basic Encoding Rules (BER).

This may be useful if DEREncode() would be too inefficient.

Definition at line 2649 of file cryptlib.h.

virtual void CryptoMaterial::AssignFrom ( const NameValuePairs source  )  [pure virtual, inherited]
virtual bool CryptoMaterial::Validate ( RandomNumberGenerator rng,
unsigned int  level 
) const [pure virtual, inherited]

Check this object for errors.

Parameters:
rng a RandomNumberGenerator for objects which use randomized testing
level the level of thoroughness
Returns:
true if the tests succeed, false otherwise

There are four levels of thoroughness:

  • 0 - using this object won't cause a crash or exception
  • 1 - this object will probably function, and encrypt, sign, other operations correctly
  • 2 - ensure this object will function correctly, and perform reasonable security checks
  • 3 - perform reasonable security checks, and do checks that may take a long time

Level 0 does not require a RandomNumberGenerator. A NullRNG() can be used for level 0.

Level 1 may not check for weak keys and such.

Levels 2 and 3 are recommended.

Implemented in ESIGNFunction, InvertibleESIGNFunction, LUCFunction, InvertibleLUCFunction, DL_GroupParameters< T >, DL_PrivateKeyImpl< GP >, DL_PublicKeyImpl< GP >, RabinFunction, InvertibleRabinFunction, RSAFunction, InvertibleRSAFunction, RWFunction, InvertibleRWFunction, XTR_DH, DL_GroupParameters< Integer >, DL_GroupParameters< typenameEcPrecomputation< EC >::Element >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, and DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >.

virtual void CryptoMaterial::ThrowIfInvalid ( RandomNumberGenerator rng,
unsigned int  level 
) const [inline, virtual, inherited]

Check this object for errors.

Parameters:
rng a RandomNumberGenerator for objects which use randomized testing
level the level of thoroughness
Exceptions:
InvalidMaterial 

Internally, ThrowIfInvalid() calls Validate() and throws InvalidMaterial if validation fails.

Definition at line 1939 of file cryptlib.h.

virtual bool CryptoMaterial::SupportsPrecomputation (  )  const [inline, virtual, inherited]

Determines whether the object supports precomputation.

Returns:
true if the object supports precomputation, false otherwise

Reimplemented in DL_GroupParameters< T >, DL_PrivateKeyImpl< GP >, DL_PublicKeyImpl< GP >, DL_GroupParameters< Integer >, DL_GroupParameters< typenameEcPrecomputation< EC >::Element >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, and DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >.

Definition at line 1973 of file cryptlib.h.

virtual void CryptoMaterial::Precompute ( unsigned int  precomputationStorage  )  [inline, virtual, inherited]

Perform precomputation.

Parameters:
precomputationStorage the suggested number of objects for the precompute table
Exceptions:
NotImplemented 

The exact semantics of Precompute() varies, but it typically means calculate a table of n objects that can be used later to speed up computation.

If a derived class does not override Precompute, then the base class throws NotImplemented.

Reimplemented in DL_GroupParameters< T >, DL_PrivateKeyImpl< GP >, DL_PublicKeyImpl< GP >, DL_GroupParameters< Integer >, DL_GroupParameters< typenameEcPrecomputation< EC >::Element >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, and DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >.

Definition at line 1982 of file cryptlib.h.

template<class T >
bool NameValuePairs::GetThisObject ( T &  object  )  const [inline, inherited]

Get a copy of this object or subobject.

Template Parameters:
T class or type
Parameters:
object reference to a variable that receives the value

Definition at line 297 of file cryptlib.h.

Referenced by DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >::GenerateRandom().

template<class T >
bool NameValuePairs::GetThisPointer ( T *&  ptr  )  const [inline, inherited]

Get a pointer to this object.

Template Parameters:
T class or type
Parameters:
ptr reference to a pointer to a variable that receives the value

Definition at line 306 of file cryptlib.h.

template<class T >
bool NameValuePairs::GetValue ( const char *  name,
T &  value 
) const [inline, inherited]

Get a named value.

Template Parameters:
T class or type
Parameters:
name the name of the object or value to retrieve
value reference to a variable that receives the value
Returns:
true if the value was retrieved, false otherwise
See also:
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Definition at line 319 of file cryptlib.h.

Referenced by DL_GroupParameters_EC< EC >::AssignFrom(), DL_GroupParameters_IntegerBased::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), InvertibleESIGNFunction::GenerateRandom(), Inflator::IsolatedInitialize(), StringSinkTemplate< T >::IsolatedInitialize(), ArraySink::IsolatedInitialize(), FileSink::IsolatedInitialize(), and Grouper::IsolatedInitialize().

template<class T >
T NameValuePairs::GetValueWithDefault ( const char *  name,
defaultValue 
) const [inline, inherited]
std::string NameValuePairs::GetValueNames (  )  const [inline, inherited]

Get a list of value names that can be retrieved.

Returns:
a list of names available to retrieve

the items in the list are delimited with a colon.

Definition at line 344 of file cryptlib.h.

bool NameValuePairs::GetIntValue ( const char *  name,
int &  value 
) const [inline, inherited]

Get a named value with type int.

Parameters:
name the name of the value to retrieve
value the value retrieved upon success
Returns:
true if an int value was retrieved, false otherwise

GetIntValue() is used to ensure we don't accidentally try to get an unsigned int or some other type when we mean int (which is the most common case)

See also:
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Definition at line 355 of file cryptlib.h.

Referenced by InvertibleRWFunction::GenerateRandom(), InvertibleRSAFunction::GenerateRandom(), InvertibleRabinFunction::GenerateRandom(), InvertibleLUCFunction::GenerateRandom(), DL_GroupParameters_IntegerBased::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), and InvertibleESIGNFunction::GenerateRandom().

int NameValuePairs::GetIntValueWithDefault ( const char *  name,
int  defaultValue 
) const [inline, inherited]

Get a named value with type int, with default.

Parameters:
name the name of the value to retrieve
defaultValue the default value if the name does not exist
Returns:
the value retrieved on success or the default value
See also:
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Definition at line 364 of file cryptlib.h.

Referenced by DL_GroupParameters_IntegerBased::GenerateRandom(), Redirector::Initialize(), Deflator::IsolatedInitialize(), ByteQueue::IsolatedInitialize(), HashFilter::IsolatedInitialize(), Grouper::IsolatedInitialize(), Base64URLEncoder::IsolatedInitialize(), VMAC_Base::UncheckedSetKey(), SAFER::Base::UncheckedSetKey(), and Weak1::ARC4_Base::UncheckedSetKey().

static void NameValuePairs::ThrowIfTypeMismatch ( const char *  name,
const std::type_info &  stored,
const std::type_info &  retrieving 
) [inline, static, inherited]

Ensures an expected name and type is present.

Parameters:
name the name of the value
stored the type that was stored for the name
retrieving the type that is being retrieved for the name
Exceptions:
ValueTypeMismatch 

ThrowIfTypeMismatch() effectively performs a type safety check. stored and retrieving are C++ mangled names for the type.

See also:
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Definition at line 376 of file cryptlib.h.

Referenced by DL_GroupParameters_EC< EC >::GetVoidValue().

template<class T >
void NameValuePairs::GetRequiredParameter ( const char *  className,
const char *  name,
T &  value 
) const [inline, inherited]

Retrieves a required name/value pair.

Template Parameters:
T class or type
Parameters:
className the name of the class
name the name of the value
value reference to a variable to receive the value
Exceptions:
InvalidArgument 

GetRequiredParameter() throws InvalidArgument if the name is not present or not of the expected type T.

See also:
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Definition at line 390 of file cryptlib.h.

Referenced by DL_GroupParameters_EC< EC >::AssignFrom(), RandomNumberSink::IsolatedInitialize(), Grouper::IsolatedInitialize(), and BaseN_Decoder::IsolatedInitialize().

void NameValuePairs::GetRequiredIntParameter ( const char *  className,
const char *  name,
int &  value 
) const [inline, inherited]

Retrieves a required name/value pair.

Parameters:
className the name of the class
name the name of the value
value reference to a variable to receive the value
Exceptions:
InvalidArgument 

GetRequiredParameter() throws InvalidArgument if the name is not present or not of the expected type T.

See also:
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Definition at line 405 of file cryptlib.h.

Referenced by BaseN_Decoder::IsolatedInitialize().

virtual bool NameValuePairs::GetVoidValue ( const char *  name,
const std::type_info &  valueType,
void *  pValue 
) const [pure virtual, inherited]

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

Generated on 24 Mar 2016 for Crypto++ by  doxygen 1.6.1