Asposecpplib
System::Security::Cryptography::ECDsa Class Referenceabstract

Base class for implementations of ECDsa algorithm. 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...

Inherits System::Security::Cryptography::AsymmetricAlgorithm.

Inherited by System::Security::Cryptography::ECDsaBotan.

Public Member Functions

String get_KeyExchangeAlgorithm () override
 Gets key exchange algorithm to use. More...
 
String get_SignatureAlgorithm () override
 Gets signature algorithm to use. More...
 
virtual ECParameters ExportExplicitParameters (bool include_private_parameters)
 Exports explicit parameters. More...
 
virtual ECParameters ExportParameters (bool include_private_parameters)
 Exports named or explicit parameters. More...
 
virtual void GenerateKey (const ECCurve &curve)
 Generates a new public/private key pair for the specified curve. More...
 
virtual void ImportParameters (const ECParameters &parameters)
 Imports all parameters from data structure. More...
 
virtual 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 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 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...
 
virtual ByteArrayPtr SignHash (const ByteArrayPtr &hash)=0
 Computes the signature of specified input value. More...
 
bool VerifyData (const ByteArrayPtr &data, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm)
 Verifies that the signature of the specified data is valid. More...
 
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...
 
bool VerifyData (const StreamPtr &stream, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm)
 Verifies that the signature of the specified binary stream is valid. More...
 
virtual bool VerifyHash (ByteArrayPtr hash, ByteArrayPtr signature)=0
 Checks data signature. More...
 
- Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
virtual int32_t get_KeySize ()
 Gets key size. More...
 
virtual void set_KeySize (int32_t value)
 Sets key size. More...
 
virtual ArrayPtr< SharedPtr< KeySizes > > get_LegalKeySizes ()
 Gets array of allowed key sizes. More...
 
void Clear ()
 Releases all resources. More...
 
virtual void FromXmlString (String xmlString)
 Reads algorithm parameters from XML string. More...
 
virtual String ToXmlString (bool include_private_parameters)
 Writes algorithm parameters to XML string. More...
 
void Dispose () override
 Releases resources owned by the current object. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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 bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 

Static Public Member Functions

static SharedPtr< ECDsaCreate ()
 Creates default ECDSA aglorithm implementation. More...
 
static SharedPtr< ECDsaCreate (const ECCurve &curve)
 Creates default ECDSA aglorithm implementation with newly created key over the specified curve. More...
 
static SharedPtr< ECDsaCreate (const ECParameters &parameters)
 Creates default ECDSA aglorithm implementation using the specified parameters. More...
 
static SharedPtr< ECDsaCreate (const String &algorithm)
 Creates specified ECDSA aglorithm implementation. More...
 
- Static Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
static SharedPtr< AsymmetricAlgorithmCreate ()
 Creates a default algorithm. Not implemented. More...
 
static SharedPtr< AsymmetricAlgorithmCreate (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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. 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...
 

Protected Member Functions

 ECDsa ()
 
virtual ByteArrayPtr HashData (ByteArrayPtr data, int32_t offset, int32_t count, HashAlgorithmName hash_algorithm)
 Computes the hash value of the specified data array using the specified hash algorithm. More...
 
virtual ByteArrayPtr HashData (StreamPtr stream, HashAlgorithmName hash_algorithm)
 Computes the hash value of the specified binary stream using the specified hash algorithm. More...
 
- Protected Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
 AsymmetricAlgorithm ()
 Constructor. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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

Base class for implementations of ECDsa algorithm. 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

◆ ECDsa()

System::Security::Cryptography::ECDsa::ECDsa ( )
protected

Member Function Documentation

◆ Create() [1/4]

static SharedPtr<ECDsa> System::Security::Cryptography::ECDsa::Create ( )
static

Creates default ECDSA aglorithm implementation.

Returns
ECDSA algorithm object.

◆ Create() [2/4]

static SharedPtr<ECDsa> System::Security::Cryptography::ECDsa::Create ( const ECCurve curve)
static

Creates default ECDSA aglorithm implementation with newly created key over the specified curve.

Parameters
curveCurve to use for key creation.
Returns
ECDSA algorithm object.

◆ Create() [3/4]

static SharedPtr<ECDsa> System::Security::Cryptography::ECDsa::Create ( const ECParameters parameters)
static

Creates default ECDSA aglorithm implementation using the specified parameters.

Parameters
parametersParameters representing the key.
Returns
ECDSA algorithm object.

◆ Create() [4/4]

static SharedPtr<ECDsa> System::Security::Cryptography::ECDsa::Create ( const String algorithm)
static

Creates specified ECDSA aglorithm implementation.

Parameters
algorithmAlgorithm name.
Returns
ECDSA algorithm object.

◆ ExportExplicitParameters()

virtual ECParameters System::Security::Cryptography::ECDsa::ExportExplicitParameters ( bool  include_private_parameters)
virtual

Exports explicit parameters.

Parameters
include_private_parametersTrue to export both private and public parameters, false to export public parameters only.
Returns
Exported parameters structure.

Reimplemented in System::Security::Cryptography::ECDsaBotan.

◆ ExportParameters()

virtual ECParameters System::Security::Cryptography::ECDsa::ExportParameters ( bool  include_private_parameters)
virtual

Exports named or explicit parameters.

Parameters
include_private_parametersTrue to export both private and public parameters, false to export public parameters only.
Returns
Exported parameters structure.

Reimplemented in System::Security::Cryptography::ECDsaBotan.

◆ GenerateKey()

virtual void System::Security::Cryptography::ECDsa::GenerateKey ( const ECCurve curve)
virtual

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

Parameters
curveCurve to use to generate the keys.

Reimplemented in System::Security::Cryptography::ECDsaBotan.

◆ get_KeyExchangeAlgorithm()

String System::Security::Cryptography::ECDsa::get_KeyExchangeAlgorithm ( )
overridevirtual

Gets key exchange algorithm to use.

Returns
Algorithm name.

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

◆ get_SignatureAlgorithm()

String System::Security::Cryptography::ECDsa::get_SignatureAlgorithm ( )
overridevirtual

Gets signature algorithm to use.

Returns
Algorithm name.

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

◆ HashData() [1/2]

virtual ByteArrayPtr System::Security::Cryptography::ECDsa::HashData ( ByteArrayPtr  data,
int32_t  offset,
int32_t  count,
HashAlgorithmName  hash_algorithm 
)
protectedvirtual

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

Parameters
dataData to hash.
offsetOffset in data.
countNumber of bytes to hash.
hash_algorithmHash algorithm.
Returns
Hashed data.

Reimplemented in System::Security::Cryptography::ECDsaBotan.

◆ HashData() [2/2]

virtual ByteArrayPtr System::Security::Cryptography::ECDsa::HashData ( StreamPtr  stream,
HashAlgorithmName  hash_algorithm 
)
protectedvirtual

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

Parameters
streamBynary stream to hashed.
hash_algorithmHash algorithm.
Returns
Hashed data.

Reimplemented in System::Security::Cryptography::ECDsaBotan.

◆ ImportParameters()

virtual void System::Security::Cryptography::ECDsa::ImportParameters ( const ECParameters parameters)
virtual

Imports all parameters from data structure.

Parameters
parametersStructure to import parameters from.

Reimplemented in System::Security::Cryptography::ECDsaBotan.

◆ SignData() [1/3]

virtual ByteArrayPtr System::Security::Cryptography::ECDsa::SignData ( const ByteArrayPtr data,
const HashAlgorithmName hash_algorithm 
)
virtual

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

Parameters
dataInput data array.
hash_algorithmHash algorithm. return ECDSA signature for the input data.

◆ SignData() [2/3]

virtual ByteArrayPtr System::Security::Cryptography::ECDsa::SignData ( const ByteArrayPtr data,
int32_t  offset,
int32_t  count,
const HashAlgorithmName hash_algorithm 
)
virtual

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

Parameters
dataInput data array.
offsetOffset in data.
countNumber of bytes to use as input data.
hash_algorithmHash algorithm. return ECDSA signature for the input data.

◆ SignData() [3/3]

virtual ByteArrayPtr System::Security::Cryptography::ECDsa::SignData ( const StreamPtr stream,
const HashAlgorithmName hash_algorithm 
)
virtual

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

Parameters
streamBinary stream.
hash_algorithmHash algorithm. return ECDSA signature for the input data.

◆ SignHash()

virtual ByteArrayPtr System::Security::Cryptography::ECDsa::SignHash ( const ByteArrayPtr hash)
pure virtual

Computes the signature of specified input value.

Parameters
hashHash value of data to be signed.
Returns
ECDSA signature for specified hash.

Implemented in System::Security::Cryptography::ECDsaBotan.

◆ VerifyData() [1/3]

bool System::Security::Cryptography::ECDsa::VerifyData ( const ByteArrayPtr data,
const ByteArrayPtr signature,
const HashAlgorithmName hash_algorithm 
)

Verifies that the signature of the specified data is valid.

Parameters
dataSigned data.
signatureSignature data.
hash_algorithmHash algorithm. return true if signature is valid, otherwise - false.

◆ VerifyData() [2/3]

bool System::Security::Cryptography::ECDsa::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.

Parameters
dataSigned data.
offsetOffset in data.
countNumber of bytes to hash.
signatureSignature data.
hash_algorithmHash algorithm. return true if signature is valid, otherwise - false.

◆ VerifyData() [3/3]

bool System::Security::Cryptography::ECDsa::VerifyData ( const StreamPtr stream,
const ByteArrayPtr signature,
const HashAlgorithmName hash_algorithm 
)

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

Parameters
streamSigned data.
signatureSignature data.
hash_algorithmHash algorithm. return true if signature is valid, otherwise - false.

◆ VerifyHash()

virtual bool System::Security::Cryptography::ECDsa::VerifyHash ( ByteArrayPtr  hash,
ByteArrayPtr  signature 
)
pure virtual

Checks data signature.

Parameters
hashHash calculated for received data.
signatureSignature as received.
Returns
True if signature is valid, false otherwise.

Implemented in System::Security::Cryptography::ECDsaBotan.