Asposecpplib
System::Security::Cryptography::DSACryptoServiceProvider Class Referencefinal

DSA algorithm in CSP 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...

Inherits System::Security::Cryptography::DSA, and System::Security::Cryptography::ICspAsymmetricAlgorithm.

Public Member Functions

 DSACryptoServiceProvider ()
 Constructor. Uses default parameters. More...
 
 DSACryptoServiceProvider (const DSAParameters &parameters)
 Constructor. More...
 
 DSACryptoServiceProvider (const SharedPtr< CspParameters > &parameters)
 Constructor. Not implemented. More...
 
 DSACryptoServiceProvider (int32_t key_size)
 Constructor. More...
 
 DSACryptoServiceProvider (int32_t key_size, const SharedPtr< CspParameters > &parameters)
 Constructor. Not implemented. More...
 
SharedPtr< CspKeyContainerInfoget_CspKeyContainerInfo () override
 Gets a CspKeyContainerInfo object. More...
 
bool get_PersistKeyInCsp () const
 Checks whether key is persisted in CSP object. More...
 
void set_PersistKeyInCsp (bool value)
 Defines whether key is persisted in CSP object. More...
 
bool get_PublicOnly () const
 Checks if public key only is present in CSP object. More...
 
String get_KeyExchangeAlgorithm () override
 Checks key exchange algorithm associated with object. More...
 
int32_t get_KeySize () override
 Gets key size. More...
 
String get_SignatureAlgorithm () override
 Gets signature algorithm to use. More...
 
ByteArrayPtr CreateSignature (ByteArrayPtr rgb_hash) override
 Create DSA signature for the specified data. More...
 
bool VerifySignature (ByteArrayPtr rgb_hash, ByteArrayPtr rgb_signature) override
 Verify DSA signature for the specified data. More...
 
ByteArrayPtr ExportCspBlob (bool include_private_parameters) override
 Exports blob with information on key. Not implemented. More...
 
DSAParameters ExportParameters (bool include_private_parameters) override
 Exports CSP parameters. More...
 
void ImportCspBlob (ByteArrayPtr key_blob) override
 Imports blob with information on key. Not implemented. More...
 
void ImportParameters (DSAParameters parameters) override
 Imports all parameters from data structure. More...
 
ByteArrayPtr SignData (const ByteArrayPtr &buffer)
 Computes the signature of specified input value. More...
 
ByteArrayPtr SignData (const SharedPtr< IO::Stream > &input_stream)
 Computes the signature of specified input value. More...
 
ByteArrayPtr SignData (const ByteArrayPtr &buffer, int32_t offset, int32_t count)
 Computes the signature of specified input value. More...
 
ByteArrayPtr SignHash (const ByteArrayPtr &rgb_hash, const String &str)
 Computes the signature of specified input value. More...
 
bool VerifyData (const ByteArrayPtr &buffer, const ByteArrayPtr &signature)
 Checks data signature. More...
 
bool VerifyHash (const ByteArrayPtr &rgb_hash, const String &str, const ByteArrayPtr &rgb_signature)
 Checks data signature. More...
 
void Dispose () override
 Frees data associated with object. More...
 
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...
 
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...
 
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...
 
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...
 
- Public Member Functions inherited from System::Security::Cryptography::DSA
virtual void FromXmlString (String xml_string) override
 Initializes object using XML-encoded parameters. More...
 
virtual String ToXmlString (bool include_private_parameters) override
 Exports all parameters in XML format. More...
 
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...
 
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...
 
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...
 
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...
 
- Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
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...
 
- 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 bool get_UseMachineKeyStore ()
 Checks whether the key persists in machine store instead of user store. More...
 
static void set_UseMachineKeyStore (bool value)
 Defines whether the key persists in machine store instead of user store. More...
 
- Static Public Member Functions inherited from System::Security::Cryptography::DSA
static SharedPtr< DSACreate ()
 Creates default DSA aglorithm implementation. More...
 
static SharedPtr< DSACreate (const String &alg_name)
 Creates default DSA algorithm implementation. More...
 
static SharedPtr< DSACreate (int32_t key_size_in_bits)
 Creates default DSA algorithm implementation with specifed key size. More...
 
static SharedPtr< DSACreate (const DSAParameters &parameters)
 Creates default DSA algorithm implementation with specifed parameters. More...
 
static 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 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

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...
 
ByteArrayPtr HashData (StreamPtr stream, HashAlgorithmName hash_algorithm) override
 Computes the hash value of the specified binary stream using the specified hash algorithm. More...
 
- Protected Member Functions inherited from System::Security::Cryptography::DSA
 DSA ()
 
 ~DSA ()
 
- 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

DSA algorithm in CSP 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

◆ DSACryptoServiceProvider() [1/5]

System::Security::Cryptography::DSACryptoServiceProvider::DSACryptoServiceProvider ( )

Constructor. Uses default parameters.

◆ DSACryptoServiceProvider() [2/5]

System::Security::Cryptography::DSACryptoServiceProvider::DSACryptoServiceProvider ( const DSAParameters parameters)

Constructor.

Parameters
parametersAlgorithm parameters.

◆ DSACryptoServiceProvider() [3/5]

System::Security::Cryptography::DSACryptoServiceProvider::DSACryptoServiceProvider ( const SharedPtr< CspParameters > &  parameters)

Constructor. Not implemented.

Parameters
parametersAlgorithm parameters.

◆ DSACryptoServiceProvider() [4/5]

System::Security::Cryptography::DSACryptoServiceProvider::DSACryptoServiceProvider ( int32_t  key_size)

Constructor.

Parameters
key_sizeKey size in bits.

◆ DSACryptoServiceProvider() [5/5]

System::Security::Cryptography::DSACryptoServiceProvider::DSACryptoServiceProvider ( int32_t  key_size,
const SharedPtr< CspParameters > &  parameters 
)

Constructor. Not implemented.

Parameters
key_sizeKey size in bits.
parametersAlgorithm parameters.

Member Function Documentation

◆ CreateSignature()

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::CreateSignature ( ByteArrayPtr  rgb_hash)
overridevirtual

Create DSA signature for the specified data.

Parameters
rgb_hashData to be signed.
Returns
DSA signature.

Implements System::Security::Cryptography::DSA.

◆ Dispose()

void System::Security::Cryptography::DSACryptoServiceProvider::Dispose ( )
overridevirtual

Frees data associated with object.

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

◆ ExportCspBlob()

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::ExportCspBlob ( bool  include_private_parameters)
overridevirtual

Exports blob with information on key. Not implemented.

Parameters
include_private_parametersWhether to include private key parameters in blob.
Returns
Blob with key information.

Implements System::Security::Cryptography::ICspAsymmetricAlgorithm.

◆ ExportParameters()

DSAParameters System::Security::Cryptography::DSACryptoServiceProvider::ExportParameters ( bool  include_private_parameters)
overridevirtual

Exports CSP parameters.

Parameters
include_private_parametersWhether to include private key parameters in blob.
Returns
Data structure with CSP parameters.

Implements System::Security::Cryptography::DSA.

◆ get_CspKeyContainerInfo()

SharedPtr<CspKeyContainerInfo> System::Security::Cryptography::DSACryptoServiceProvider::get_CspKeyContainerInfo ( )
overridevirtual

◆ get_KeyExchangeAlgorithm()

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

Checks key exchange algorithm associated with object.

Returns
Key exchange algorithm name.

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

◆ get_KeySize()

int32_t System::Security::Cryptography::DSACryptoServiceProvider::get_KeySize ( )
overridevirtual

Gets key size.

Returns
Size of the key to use.

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

◆ get_PersistKeyInCsp()

bool System::Security::Cryptography::DSACryptoServiceProvider::get_PersistKeyInCsp ( ) const

Checks whether key is persisted in CSP object.

Returns
True if key is persisted, false otherwise.

◆ get_PublicOnly()

bool System::Security::Cryptography::DSACryptoServiceProvider::get_PublicOnly ( ) const

Checks if public key only is present in CSP object.

Returns
True if public key is present and private one is not, false otherwise.

◆ get_SignatureAlgorithm()

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

Gets signature algorithm to use.

Returns
Algorithm name.

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

◆ get_UseMachineKeyStore()

static bool System::Security::Cryptography::DSACryptoServiceProvider::get_UseMachineKeyStore ( )
static

Checks whether the key persists in machine store instead of user store.

Returns
True if the key should be persisted in machine store, false if it should be persisted in user store.

◆ HashData() [1/2]

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::HashData ( ByteArrayPtr  data,
int32_t  offset,
int32_t  count,
HashAlgorithmName  hash_algorithm 
)
overrideprotectedvirtual

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

◆ HashData() [2/2]

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::HashData ( StreamPtr  stream,
HashAlgorithmName  hash_algorithm 
)
overrideprotectedvirtual

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

◆ ImportCspBlob()

void System::Security::Cryptography::DSACryptoServiceProvider::ImportCspBlob ( ByteArrayPtr  key_blob)
overridevirtual

Imports blob with information on key. Not implemented.

Parameters
key_blobPreviously exported blob with key information.

Implements System::Security::Cryptography::ICspAsymmetricAlgorithm.

◆ ImportParameters()

void System::Security::Cryptography::DSACryptoServiceProvider::ImportParameters ( DSAParameters  parameters)
overridevirtual

Imports all parameters from data structure.

Parameters
parametersStructure to import parameters from.

Implements System::Security::Cryptography::DSA.

◆ set_PersistKeyInCsp()

void System::Security::Cryptography::DSACryptoServiceProvider::set_PersistKeyInCsp ( bool  value)

Defines whether key is persisted in CSP object.

Parameters
valueTrue to persist the key, false otherwise.

◆ set_UseMachineKeyStore()

static void System::Security::Cryptography::DSACryptoServiceProvider::set_UseMachineKeyStore ( bool  value)
static

Defines whether the key persists in machine store instead of user store.

Parameters
valueTrue if the key should be persisted in machine store, false if it should be persisted in user store.

◆ SignData() [1/6]

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::SignData ( const ByteArrayPtr buffer)

Computes the signature of specified input value.

Parameters
bufferBuffer to read input data from.
Returns
DSA signature for specified data.

◆ SignData() [2/6]

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::SignData ( const ByteArrayPtr buffer,
int32_t  offset,
int32_t  count 
)

Computes the signature of specified input value.

Parameters
bufferBuffer to read input data from.
offsetInput buffer slice beginning index.
countInput buffer slice size.
Returns
DSA signature for specified data.

◆ SignData() [3/6]

ByteArrayPtr System::Security::Cryptography::DSA::SignData

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() [4/6]

ByteArrayPtr System::Security::Cryptography::DSA::SignData

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() [5/6]

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::SignData ( const SharedPtr< IO::Stream > &  input_stream)

Computes the signature of specified input value.

Parameters
input_streamStream to read data being signed from.
Returns
DSA signature for specified data.

◆ SignData() [6/6]

ByteArrayPtr System::Security::Cryptography::DSA::SignData

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.

◆ SignHash()

ByteArrayPtr System::Security::Cryptography::DSACryptoServiceProvider::SignHash ( const ByteArrayPtr rgb_hash,
const String str 
)

Computes the signature of specified input value.

Parameters
rgb_hashHash value of data to be signed.
strHash algorithm identifier used to create the hash.
Returns
DSA signature for specified data.

◆ VerifyData() [1/4]

bool System::Security::Cryptography::DSACryptoServiceProvider::VerifyData ( const ByteArrayPtr buffer,
const ByteArrayPtr signature 
)

Checks data signature.

Parameters
bufferData to check signature for.
signatureSignature as received.
Returns
True if signature is valid, false otherwise.

◆ VerifyData() [2/4]

bool System::Security::Cryptography::DSA::VerifyData

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() [3/4]

bool System::Security::Cryptography::DSA::VerifyData

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() [4/4]

bool System::Security::Cryptography::DSA::VerifyData

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

bool System::Security::Cryptography::DSACryptoServiceProvider::VerifyHash ( const ByteArrayPtr rgb_hash,
const String str,
const ByteArrayPtr rgb_signature 
)

Checks data signature.

Parameters
rgb_hashHash calculated for received data.
strName of hash algorithm used.
rgb_signatureSignature as received.
Returns
True if signature is valid, false otherwise.

◆ VerifySignature()

bool System::Security::Cryptography::DSACryptoServiceProvider::VerifySignature ( ByteArrayPtr  rgb_hash,
ByteArrayPtr  rgb_signature 
)
overridevirtual

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.

Implements System::Security::Cryptography::DSA.