Asposecpplib
System::Security::Cryptography::DSA Class Referenceabstract

Base class for implementations of DSA 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::DSACryptoServiceProvider.

Public Member Functions

virtual ASPOSECPP_SHARED_API ByteArrayPtr CreateSignature (ByteArrayPtr rgb_hash)=0
 Create DSA signature for the specified data. More...
 
virtual ASPOSECPP_SHARED_API bool VerifySignature (ByteArrayPtr rgb_hash, ByteArrayPtr rgb_signature)=0
 Verify DSA signature for the specified data. More...
 
virtual ASPOSECPP_SHARED_API DSAParameters ExportParameters (bool include_private_parameters)=0
 Exports all parameters. More...
 
virtual ASPOSECPP_SHARED_API void ImportParameters (DSAParameters parameters)=0
 Imports all parameters from data structure. More...
 
virtual ASPOSECPP_SHARED_API void FromXmlString (String xml_string) override
 Initializes object using XML-encoded parameters. More...
 
virtual ASPOSECPP_SHARED_API String ToXmlString (bool include_private_parameters) override
 Exports all parameters in XML format. More...
 
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...
 
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...
 
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 void set_KeySize (int32_t value)
 Sets 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...
 
virtual ASPOSECPP_SHARED_API String get_SignatureAlgorithm ()
 Gets signature algorithm to use. More...
 
virtual ASPOSECPP_SHARED_API String get_KeyExchangeAlgorithm ()
 Gets key exchange algorithm to use. 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...
 
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 refernce 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 int 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 TypeInfoGetType () 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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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 ASPOSECPP_SHARED_API SharedPtr< DSACreate ()
 Creates default DSA aglorithm implementation. More...
 
static ASPOSECPP_SHARED_API SharedPtr< DSACreate (const String &alg_name)
 Creates default DSA algorithm implementation. More...
 
static ASPOSECPP_SHARED_API SharedPtr< DSACreate (int32_t key_size_in_bits)
 Creates default DSA algorithm implementation with specifed key size. More...
 
static ASPOSECPP_SHARED_API SharedPtr< DSACreate (const DSAParameters &parameters)
 Creates default DSA algorithm implementation with specifed parameters. More...
 
static ASPOSECPP_SHARED_API SharedPtr< DSACreateFromXmlString (const String &xml_string)
 Creates default DSA algorithm implementation with specifed XML-encoded parameters. More...
 
- Static Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
static ASPOSECPP_SHARED_API SharedPtr< AsymmetricAlgorithmCreate ()
 Creates a default algorithm. Not implemented. More...
 
static ASPOSECPP_SHARED_API 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 ()
 Impleemnts 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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Detailed Description

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

Member Function Documentation

◆ Create() [1/4]

static ASPOSECPP_SHARED_API SharedPtr<DSA> System::Security::Cryptography::DSA::Create ( )
static

Creates default DSA aglorithm implementation.

Returns
DSA algorithm object.

◆ Create() [2/4]

static ASPOSECPP_SHARED_API SharedPtr<DSA> System::Security::Cryptography::DSA::Create ( const DSAParameters parameters)
static

Creates default DSA algorithm implementation with specifed parameters.

Parameters
parametersThe parameters for the DSA algorithm.

◆ Create() [3/4]

static ASPOSECPP_SHARED_API SharedPtr<DSA> System::Security::Cryptography::DSA::Create ( const String alg_name)
static

Creates default DSA algorithm implementation.

Parameters
alg_nameMust be "System.Security.Cryptography.DSACryptoServiceProvider".
Returns
DSA algorithm object.

◆ Create() [4/4]

static ASPOSECPP_SHARED_API SharedPtr<DSA> System::Security::Cryptography::DSA::Create ( int32_t  key_size_in_bits)
static

Creates default DSA algorithm implementation with specifed key size.

Parameters
key_size_in_bitsThe key size, in bits.

◆ CreateFromXmlString()

static ASPOSECPP_SHARED_API SharedPtr<DSA> System::Security::Cryptography::DSA::CreateFromXmlString ( const String xml_string)
static

Creates default DSA algorithm implementation with specifed XML-encoded parameters.

Parameters
xml_stringThe parameters for the DSA algorithm.

◆ CreateSignature()

virtual ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::DSA::CreateSignature ( ByteArrayPtr  rgb_hash)
pure virtual

Create DSA signature for the specified data.

Parameters
rgb_hashData to be signed.
Returns
DSA signature.

Implemented in System::Security::Cryptography::DSACryptoServiceProvider.

◆ ExportParameters()

virtual ASPOSECPP_SHARED_API DSAParameters System::Security::Cryptography::DSA::ExportParameters ( bool  include_private_parameters)
pure virtual

Exports all parameters.

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

Implemented in System::Security::Cryptography::DSACryptoServiceProvider.

◆ FromXmlString()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::DSA::FromXmlString ( String  xml_string)
overridevirtual

Initializes object using XML-encoded parameters.

Parameters
xml_stringParameters in XML format.

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

◆ ImportParameters()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::DSA::ImportParameters ( DSAParameters  parameters)
pure virtual

Imports all parameters from data structure.

Parameters
parametersStructure to import parameters from.

Implemented in System::Security::Cryptography::DSACryptoServiceProvider.

◆ SignData() [1/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::DSA::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.

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

◆ SignData() [2/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::DSA::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.

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

◆ SignData() [3/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::DSA::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.

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

◆ ToXmlString()

virtual ASPOSECPP_SHARED_API String System::Security::Cryptography::DSA::ToXmlString ( bool  include_private_parameters)
overridevirtual

Exports all parameters in XML format.

Parameters
include_private_parametersTrue to export both private and public parameters, false to export public parameters only.
Returns
XML-encoded parameters.

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

◆ VerifyData() [1/3]

ASPOSECPP_SHARED_API bool System::Security::Cryptography::DSA::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]

ASPOSECPP_SHARED_API bool System::Security::Cryptography::DSA::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]

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

◆ VerifySignature()

virtual ASPOSECPP_SHARED_API bool System::Security::Cryptography::DSA::VerifySignature ( ByteArrayPtr  rgb_hash,
ByteArrayPtr  rgb_signature 
)
pure virtual

Verify DSA signature for the specified data.

Parameters
rgb_hashData signed with rgb_signature.
rgb_signatureDSA signature.
Returns
true - if rgb_signature matches the DSA signature computed on rgb_hash, otherwise - false.

Implemented in System::Security::Cryptography::DSACryptoServiceProvider.