ECDsa algorithm in Botan form. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include "ec_dsa_botan.h"

Inherits System::Security::Cryptography::ECDsa.

Public Member Functions
ASPOSECPP_SHARED_API	ECDsaBotan ()
	Constructor. Uses default parameters. More...

ASPOSECPP_SHARED_API	ECDsaBotan (const ECParameters &parameters)
	Constructor. More...

ASPOSECPP_SHARED_API	ECDsaBotan (const ECCurve &curve)
	Constructor. More...

ASPOSECPP_SHARED_API	ECDsaBotan (int32_t key_size)
	Constructor. More...

ASPOSECPP_SHARED_API	ECDsaBotan (const Botan::ECDSA_PublicKey &key)
	Constructor. More...

ASPOSECPP_SHARED_API	ECDsaBotan (const Botan::ECDSA_PrivateKey &key)
	Constructor. More...

ASPOSECPP_SHARED_API void	set_KeySize (int32_t value) override
	Sets key size. More...

ASPOSECPP_SHARED_API HashAlgorithmName	get_HashAlgorithm () const
	Gets hash algortihm. More...

ASPOSECPP_SHARED_API void	set_HashAlgorithm (const HashAlgorithmName &value)
	Sets hash algortihm. More...

ASPOSECPP_SHARED_API ECParameters	ExportExplicitParameters (bool include_private_parameters) override
	Exports explicit parameters. More...

ASPOSECPP_SHARED_API ECParameters	ExportParameters (bool include_private_parameters) override
	Exports named or explicit parameters. More...

ASPOSECPP_SHARED_API void	FromXmlString (String xml_string) override
	Initializes object using XML-encoded parameters. Not implemented. More...

ASPOSECPP_SHARED_API void	FromXmlString (const String &xml_string, ECKeyXmlFormat format)
	Initializes object using XML-encoded parameters. Not implemented. More...

ASPOSECPP_SHARED_API void	GenerateKey (const ECCurve &curve) override
	Generates a new public/private key pair for the specified curve. More...

ASPOSECPP_SHARED_API ByteArrayPtr	HashData (ByteArrayPtr data, int32_t offset, int32_t count, HashAlgorithmName hash_algorithm) override
	Computes the hash value of the specified data array using the specified hash algorithm. More...

ASPOSECPP_SHARED_API ByteArrayPtr	HashData (StreamPtr stream, HashAlgorithmName hash_algorithm) override
	Computes the hash value of the specified binary stream using the specified hash algorithm. More...

ASPOSECPP_SHARED_API void	ImportParameters (const ECParameters &parameters) override
	Imports all parameters from data structure. More...

ASPOSECPP_SHARED_API ByteArrayPtr	SignData (const ByteArrayPtr &data)
	Computes the hash value of the specified data array, and signs the result. More...

ASPOSECPP_SHARED_API ByteArrayPtr	SignData (const ByteArrayPtr &data, int32_t offset, int32_t count)
	Computes the hash value of the specified data array, and signs the result. More...

ASPOSECPP_SHARED_API ByteArrayPtr	SignData (const StreamPtr &stream)
	Computes the hash value of the specified binary stream, and signs the result. More...

ASPOSECPP_SHARED_API ByteArrayPtr	SignHash (const ByteArrayPtr &hash) override
	Computes the signature of specified input value. More...

ASPOSECPP_SHARED_API String	ToXmlString (bool include_private_parameters) override
	Exports all parameters in XML format. Not implemented. More...

ASPOSECPP_SHARED_API String	ToXmlString (ECKeyXmlFormat format)
	Exports all parameters in XML format. More...

ASPOSECPP_SHARED_API bool	VerifyData (const ByteArrayPtr &data, const ByteArrayPtr &signature)
	Verifies that the signature of the specified data is valid. More...

ASPOSECPP_SHARED_API bool	VerifyData (const ByteArrayPtr &data, int32_t offset, int32_t count, const ByteArrayPtr &signature)
	Verifies that the signature of the specified data is valid. More...

ASPOSECPP_SHARED_API bool	VerifyData (const StreamPtr &stream, const ByteArrayPtr &signature)
	Verifies that the signature of the specified binary stream is valid. More...

ASPOSECPP_SHARED_API bool	VerifyHash (ByteArrayPtr hash, ByteArrayPtr signature) override
	Checks data signature. More...

Public Member Functions inherited from System::Security::Cryptography::ECDsa
ASPOSECPP_SHARED_API String	get_KeyExchangeAlgorithm () override
	Gets key exchange algorithm to use. More...

ASPOSECPP_SHARED_API String	get_SignatureAlgorithm () override
	Gets signature algorithm to use. More...

virtual ASPOSECPP_SHARED_API ByteArrayPtr	SignData (const ByteArrayPtr &data, const HashAlgorithmName &hash_algorithm)
	Computes the hash value of the specified data array using the specified hash algorithm, and signs the result. More...

virtual ASPOSECPP_SHARED_API ByteArrayPtr	SignData (const ByteArrayPtr &data, int32_t offset, int32_t count, const HashAlgorithmName &hash_algorithm)
	Computes the hash value of the specified data array using the specified hash algorithm, and signs the result. More...

virtual ASPOSECPP_SHARED_API ByteArrayPtr	SignData (const StreamPtr &stream, const HashAlgorithmName &hash_algorithm)
	Computes the hash value of the specified binary stream using the specified hash algorithm, and signs the result. More...

ASPOSECPP_SHARED_API bool	VerifyData (const ByteArrayPtr &data, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm)
	Verifies that the signature of the specified data is valid. More...

ASPOSECPP_SHARED_API bool	VerifyData (const ByteArrayPtr &data, int32_t offset, int32_t count, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm)
	Verifies that the signature of the specified data is valid. More...

ASPOSECPP_SHARED_API bool	VerifyData (const StreamPtr &stream, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm)
	Verifies that the signature of the specified binary stream is valid. More...

Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
virtual ASPOSECPP_SHARED_API int32_t	get_KeySize ()
	Gets key size. More...

virtual ASPOSECPP_SHARED_API ArrayPtr< SharedPtr< KeySizes > >	get_LegalKeySizes ()
	Gets array of allowed key sizes. More...

ASPOSECPP_SHARED_API void	Clear ()
	Releases all resources. More...

ASPOSECPP_SHARED_API void	Dispose () override
	Releases resources owned by the current object. More...

Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API	Object ()
	Creates object. Initializes all internal data structures. More...

virtual ASPOSECPP_SHARED_API	~Object ()
	Destroys object. Frees all internal data structures. More...

ASPOSECPP_SHARED_API	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

ASPOSECPP_SHARED_API void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

ASPOSECPP_SHARED_API void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual ASPOSECPP_SHARED_API bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual ASPOSECPP_SHARED_API int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual ASPOSECPP_SHARED_API String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ASPOSECPP_SHARED_API ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual ASPOSECPP_SHARED_API const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual ASPOSECPP_SHARED_API bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual ASPOSECPP_SHARED_API void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual ASPOSECPP_SHARED_API bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Protected Member Functions
virtual ASPOSECPP_SHARED_API void	Dispose (bool disposing)
	Frees data associated with object. More...

Protected Member Functions inherited from System::Security::Cryptography::ECDsa
ASPOSECPP_SHARED_API	ECDsa ()

Protected Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
ASPOSECPP_SHARED_API	AsymmetricAlgorithm ()
	Constructor. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Static Public Member Functions inherited from System::Security::Cryptography::ECDsa
static ASPOSECPP_SHARED_API SharedPtr< ECDsa >	Create ()
	Creates default ECDSA aglorithm implementation. More...

static ASPOSECPP_SHARED_API SharedPtr< ECDsa >	Create (const ECCurve &curve)
	Creates default ECDSA aglorithm implementation with newly created key over the specified curve. More...

static ASPOSECPP_SHARED_API SharedPtr< ECDsa >	Create (const ECParameters &parameters)
	Creates default ECDSA aglorithm implementation using the specified parameters. More...

static ASPOSECPP_SHARED_API SharedPtr< ECDsa >	Create (const String &algorithm)
	Creates specified ECDSA aglorithm implementation. More...

Static Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
static ASPOSECPP_SHARED_API SharedPtr< AsymmetricAlgorithm >	Create ()
	Creates a default algorithm. Not implemented. More...

static ASPOSECPP_SHARED_API SharedPtr< AsymmetricAlgorithm >	Create (const String &alg_name)
	Creates algorithm by name. Not implemented. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Protected Attributes inherited from System::Security::Cryptography::AsymmetricAlgorithm
int32_t	KeySizeValue
	Key size associated with algorithm. More...

ArrayPtr< SharedPtr< KeySizes > >	LegalKeySizesValue
	Enabled key sizes. More...

Detailed Description

ECDsa algorithm in Botan form. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ ECDsaBotan() [1/6]

ASPOSECPP_SHARED_API System::Security::Cryptography::ECDsaBotan::ECDsaBotan ( )

Constructor. Uses default parameters.

◆ ECDsaBotan() [2/6]

ASPOSECPP_SHARED_API System::Security::Cryptography::ECDsaBotan::ECDsaBotan ( const ECParameters & parameters )

Constructor.

Parameters

parameters Algorithm parameters.

◆ ECDsaBotan() [3/6]

ASPOSECPP_SHARED_API System::Security::Cryptography::ECDsaBotan::ECDsaBotan ( const ECCurve & curve )

Constructor.

Parameters

curve Curve used to create the public/private key pair.

◆ ECDsaBotan() [4/6]

ASPOSECPP_SHARED_API System::Security::Cryptography::ECDsaBotan::ECDsaBotan ( int32_t key_size )

Constructor.

Parameters

key_size Key size in bits.

◆ ECDsaBotan() [5/6]

ASPOSECPP_SHARED_API System::Security::Cryptography::ECDsaBotan::ECDsaBotan ( const Botan::ECDSA_PublicKey & key )

Constructor.

Parameters

key	Botan public key.

◆ ECDsaBotan() [6/6]

ASPOSECPP_SHARED_API System::Security::Cryptography::ECDsaBotan::ECDsaBotan ( const Botan::ECDSA_PrivateKey & key )

Constructor.

Parameters

key	Botan private key.

Member Function Documentation

◆ Dispose()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::ECDsaBotan::Dispose ( bool disposing )

protectedvirtual

Frees data associated with object.

Parameters

disposing True if called from disposing procedure, false otherwise.

◆ ExportExplicitParameters()

ASPOSECPP_SHARED_API ECParameters System::Security::Cryptography::ECDsaBotan::ExportExplicitParameters ( bool include_private_parameters )

overridevirtual

Exports explicit parameters.

Parameters

include_private_parameters True to export both private and public parameters, false to export public parameters only.

Returns: Exported parameters structure.

Reimplemented from System::Security::Cryptography::ECDsa.

◆ ExportParameters()

ASPOSECPP_SHARED_API ECParameters System::Security::Cryptography::ECDsaBotan::ExportParameters ( bool include_private_parameters )

overridevirtual

Exports named or explicit parameters.

Parameters

include_private_parameters True to export both private and public parameters, false to export public parameters only.

Returns: Exported parameters structure.

Reimplemented from System::Security::Cryptography::ECDsa.

◆ FromXmlString() [1/2]

ASPOSECPP_SHARED_API void System::Security::Cryptography::ECDsaBotan::FromXmlString ( String xml_string )

overridevirtual

Initializes object using XML-encoded parameters. Not implemented.

Parameters

xml_string Parameters in XML format.

Reimplemented from System::Security::Cryptography::AsymmetricAlgorithm.

◆ FromXmlString() [2/2]

ASPOSECPP_SHARED_API void System::Security::Cryptography::ECDsaBotan::FromXmlString	(	const String &	xml_string,
		ECKeyXmlFormat	format
	)

Initializes object using XML-encoded parameters. Not implemented.

Parameters

xml_string	Parameters in XML format.
format	Format of the XML string.

◆ GenerateKey()

ASPOSECPP_SHARED_API void System::Security::Cryptography::ECDsaBotan::GenerateKey ( const ECCurve & curve )

overridevirtual

Generates a new public/private key pair for the specified curve.

Parameters

curve Curve to use to generate the keys.

Reimplemented from System::Security::Cryptography::ECDsa.

◆ get_HashAlgorithm()

ASPOSECPP_SHARED_API HashAlgorithmName System::Security::Cryptography::ECDsaBotan::get_HashAlgorithm ( ) const

Gets hash algortihm.

Returns: Hash algorithm name.

◆ HashData() [1/2]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::ECDsaBotan::HashData	(	ByteArrayPtr	data,
		int32_t	offset,
		int32_t	count,
		HashAlgorithmName	hash_algorithm
	)

overridevirtual

Computes the hash value of the specified data array using the specified hash algorithm.

Parameters

data	Data to hash.
offset	Offset in `data`.
count	Number of bytes to hash.
hash_algorithm	Hash algorithm.

Returns: Hashed data.

Reimplemented from System::Security::Cryptography::ECDsa.

◆ HashData() [2/2]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::ECDsaBotan::HashData	(	StreamPtr	stream,
		HashAlgorithmName	hash_algorithm
	)

overridevirtual

Computes the hash value of the specified binary stream using the specified hash algorithm.

Parameters

stream	Bynary stream to hashed.
hash_algorithm	Hash algorithm.

Returns: Hashed data.

Reimplemented from System::Security::Cryptography::ECDsa.

◆ ImportParameters()

ASPOSECPP_SHARED_API void System::Security::Cryptography::ECDsaBotan::ImportParameters ( const ECParameters & parameters )

overridevirtual

Imports all parameters from data structure.

Parameters

parameters Structure to import parameters from.

Reimplemented from System::Security::Cryptography::ECDsa.

◆ set_HashAlgorithm()

ASPOSECPP_SHARED_API void System::Security::Cryptography::ECDsaBotan::set_HashAlgorithm ( const HashAlgorithmName & value )

Sets hash algortihm.

Parameters

value Hash algorithm name.

◆ set_KeySize()

ASPOSECPP_SHARED_API void System::Security::Cryptography::ECDsaBotan::set_KeySize ( int32_t value )

overridevirtual

Sets key size.

Parameters

value Size of the key to use.

Reimplemented from System::Security::Cryptography::AsymmetricAlgorithm.

◆ SignData() [1/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::ECDsaBotan::SignData ( const ByteArrayPtr & data )

Computes the hash value of the specified data array, and signs the result.

Parameters

data	Input data array. return ECDSA signature for the input data.

◆ SignData() [2/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::ECDsaBotan::SignData	(	const ByteArrayPtr &	data,
		int32_t	offset,
		int32_t	count
	)

Computes the hash value of the specified data array, and signs the result.

Parameters

data	Input data array.
offset	Offset in `data`.
count	Number of bytes to use as input data. return ECDSA signature for the input data.

◆ SignData() [3/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::ECDsaBotan::SignData ( const StreamPtr & stream )

Computes the hash value of the specified binary stream, and signs the result.

Parameters

stream Binary stream. return ECDSA signature for the input data.

◆ SignHash()

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::ECDsaBotan::SignHash ( const ByteArrayPtr & hash )

overridevirtual

Computes the signature of specified input value.

Parameters

hash	Hash value of data to be signed.

Returns: ECDSA signature for specified hash.

Implements System::Security::Cryptography::ECDsa.

◆ ToXmlString() [1/2]

ASPOSECPP_SHARED_API String System::Security::Cryptography::ECDsaBotan::ToXmlString ( bool include_private_parameters )

overridevirtual

Exports all parameters in XML format. Not implemented.

Parameters

include_private_parameters True to export both private and public parameters, false to export public parameters only.

Returns: XML-encoded parameters.

Reimplemented from System::Security::Cryptography::AsymmetricAlgorithm.

◆ ToXmlString() [2/2]

ASPOSECPP_SHARED_API String System::Security::Cryptography::ECDsaBotan::ToXmlString ( ECKeyXmlFormat format )

Exports all parameters in XML format.

Parameters

format Format of the result XML string.

Returns: XML-encoded parameters.

◆ VerifyData() [1/3]

ASPOSECPP_SHARED_API bool System::Security::Cryptography::ECDsaBotan::VerifyData	(	const ByteArrayPtr &	data,
		const ByteArrayPtr &	signature
	)

Verifies that the signature of the specified data is valid.

Parameters

data	Signed data.
signature	Signature data. return true if signature is valid, otherwise - false.

◆ VerifyData() [2/3]

ASPOSECPP_SHARED_API bool System::Security::Cryptography::ECDsaBotan::VerifyData	(	const ByteArrayPtr &	data,
		int32_t	offset,
		int32_t	count,
		const ByteArrayPtr &	signature
	)

Verifies that the signature of the specified data is valid.

Parameters

data	Signed data.
offset	Offset in `data`.
count	Number of bytes to hash.
signature	Signature data. return true if signature is valid, otherwise - false.

◆ VerifyData() [3/3]

ASPOSECPP_SHARED_API bool System::Security::Cryptography::ECDsaBotan::VerifyData	(	const StreamPtr &	stream,
		const ByteArrayPtr &	signature
	)

Verifies that the signature of the specified binary stream is valid.

Parameters

stream	Signed data.
signature	Signature data. return true if signature is valid, otherwise - false.

◆ VerifyHash()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::ECDsaBotan::VerifyHash	(	ByteArrayPtr	hash,
		ByteArrayPtr	signature
	)

overridevirtual

Checks data signature.

Parameters

hash	Hash calculated for received data.
signature	Signature as received.

Returns: True if signature is valid, false otherwise.

Implements System::Security::Cryptography::ECDsa.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ECDsaBotan() [1/6]

◆ ECDsaBotan() [2/6]

◆ ECDsaBotan() [3/6]

◆ ECDsaBotan() [4/6]

◆ ECDsaBotan() [5/6]

◆ ECDsaBotan() [6/6]

Member Function Documentation

◆ Dispose()

◆ ExportExplicitParameters()

◆ ExportParameters()

◆ FromXmlString() [1/2]

◆ FromXmlString() [2/2]

◆ GenerateKey()

◆ get_HashAlgorithm()

◆ HashData() [1/2]

◆ HashData() [2/2]

◆ ImportParameters()

◆ set_HashAlgorithm()

◆ set_KeySize()

◆ SignData() [1/3]

◆ SignData() [2/3]

◆ SignData() [3/3]

◆ SignHash()

◆ ToXmlString() [1/2]

◆ ToXmlString() [2/2]

◆ VerifyData() [1/3]

◆ VerifyData() [2/3]

◆ VerifyData() [3/3]

◆ VerifyHash()