System::Security::Cryptography::RSACryptoServiceProvider Class Referencefinal

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

Public Member Functions

ASPOSECPP_SHARED_API RSACryptoServiceProvider ()
 Constructor. Uses default parameters. More...
 
ASPOSECPP_SHARED_API RSACryptoServiceProvider (const SharedPtr< CspParameters > &parameters)
 
ASPOSECPP_SHARED_API RSACryptoServiceProvider (const RSAParameters &parameters)
 
ASPOSECPP_SHARED_API RSACryptoServiceProvider (int32_t key_size)
 
ASPOSECPP_SHARED_API RSACryptoServiceProvider (int32_t key_size, const SharedPtr< CspParameters > &parameters)
 
ASPOSECPP_SHARED_API SharedPtr< CspKeyContainerInfoget_CspKeyContainerInfo () override
 Gets a CspKeyContainerInfo object. More...
 
ASPOSECPP_SHARED_API String get_KeyExchangeAlgorithm () override
 
ASPOSECPP_SHARED_API int32_t get_KeySize () override
 
ASPOSECPP_SHARED_API bool get_PersistKeyInCsp () const
 
ASPOSECPP_SHARED_API void set_PersistKeyInCsp (bool value)
 
ASPOSECPP_SHARED_API bool get_PublicOnly () const
 
ASPOSECPP_SHARED_API String get_SignatureAlgorithm () override
 
ASPOSECPP_SHARED_API ByteArrayPtr Decrypt (const ByteArrayPtr &rgb, bool use_oaep)
 
ASPOSECPP_SHARED_API ByteArrayPtr Decrypt (ByteArrayPtr data, SharedPtr< RSAEncryptionPadding > padding) override
 
ASPOSECPP_SHARED_API ByteArrayPtr Encrypt (const ByteArrayPtr &rgb, bool use_oaep)
 
ASPOSECPP_SHARED_API ByteArrayPtr Encrypt (ByteArrayPtr data, SharedPtr< RSAEncryptionPadding > padding) override
 
ASPOSECPP_SHARED_API ByteArrayPtr ExportCspBlob (bool include_private_parameters) override
 
ASPOSECPP_SHARED_API RSAParameters ExportParameters (bool include_private_parameters) override
 
ASPOSECPP_SHARED_API void ImportCspBlob (ByteArrayPtr key_blob) override
 
ASPOSECPP_SHARED_API void ImportParameters (RSAParameters parameters) override
 
ASPOSECPP_SHARED_API ByteArrayPtr SignData (const ByteArrayPtr &buffer, const SharedPtr< Object > &halg)
 
ASPOSECPP_SHARED_API ByteArrayPtr SignData (const SharedPtr< IO::Stream > &input_stream, const SharedPtr< Object > &halg)
 
ASPOSECPP_SHARED_API ByteArrayPtr SignData (const ByteArrayPtr &buffer, int32_t offset, int32_t count, const SharedPtr< Object > &halg)
 
ASPOSECPP_SHARED_API ByteArrayPtr SignHash (ByteArrayPtr hash, HashAlgorithmName hash_algorithm, SharedPtr< RSASignaturePadding > padding) override
 
ASPOSECPP_SHARED_API ByteArrayPtr SignHash (const ByteArrayPtr &rgb_hash, const String &str)
 
ASPOSECPP_SHARED_API bool VerifyData (const ByteArrayPtr &buffer, const SharedPtr< Object > &halg, const ByteArrayPtr &signature)
 
ASPOSECPP_SHARED_API bool VerifyHash (const ByteArrayPtr &rgb_hash, const String &str, const ByteArrayPtr &rgb_signature)
 
ASPOSECPP_SHARED_API bool VerifyHash (ByteArrayPtr hash, ByteArrayPtr signature, const HashAlgorithmName &hash_algorithm, SharedPtr< RSASignaturePadding > padding) override
 
ASPOSECPP_SHARED_API void Dispose () override
 Frees data associated with object. More...
 
- Public Member Functions inherited from System::Security::Cryptography::RSA
virtual ASPOSECPP_SHARED_API ByteArrayPtr DecryptValue (ByteArrayPtr rgb)
 
virtual ASPOSECPP_SHARED_API ByteArrayPtr EncryptValue (ByteArrayPtr rgb)
 
ASPOSECPP_SHARED_API void FromXmlString (String xml_string) override
 
ASPOSECPP_SHARED_API String ToXmlString (bool include_private_parameters) override
 
ASPOSECPP_SHARED_API ByteArrayPtr SignData (const ByteArrayPtr &data, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
 
ASPOSECPP_SHARED_API ByteArrayPtr SignData (const ByteArrayPtr &data, int32_t offset, int32_t count, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
 
ASPOSECPP_SHARED_API ByteArrayPtr SignData (const StreamPtr &stream, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
 
ASPOSECPP_SHARED_API bool VerifyData (const ByteArrayPtr &data, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
 
ASPOSECPP_SHARED_API bool VerifyData (const ByteArrayPtr &data, int32_t offset, int32_t count, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
 
ASPOSECPP_SHARED_API bool VerifyData (const StreamPtr &stream, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
 
- Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
virtual ASPOSECPP_SHARED_API void set_KeySize (int32_t value)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< SharedPtr< KeySizes > > get_LegalKeySizes ()
 
ASPOSECPP_SHARED_API void Clear ()
 Releases all resources. 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 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 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 (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)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Static Public Member Functions

static ASPOSECPP_SHARED_API bool get_UseMachineKeyStore ()
 
static ASPOSECPP_SHARED_API void set_UseMachineKeyStore (bool value)
 
- Static Public Member Functions inherited from System::Security::Cryptography::RSA
static ASPOSECPP_SHARED_API SharedPtr< RSACreate ()
 Creates default RSA aglorithm implementation. More...
 
static ASPOSECPP_SHARED_API SharedPtr< RSACreate (const String &alg_name)
 
static ASPOSECPP_SHARED_API SharedPtr< RSACreate (int32_t key_size_in_bits)
 
static ASPOSECPP_SHARED_API SharedPtr< RSACreate (const RSAParameters &parameters)
 
static ASPOSECPP_SHARED_API SharedPtr< RSACreateFromXmlString (const String &xml_string)
 
- Static Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
static ASPOSECPP_SHARED_API SharedPtr< AsymmetricAlgorithmCreate ()
 
static ASPOSECPP_SHARED_API SharedPtr< AsymmetricAlgorithmCreate (const String &alg_name)
 
- 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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

RSA 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

◆ RSACryptoServiceProvider() [1/5]

ASPOSECPP_SHARED_API System::Security::Cryptography::RSACryptoServiceProvider::RSACryptoServiceProvider ( )

Constructor. Uses default parameters.

◆ RSACryptoServiceProvider() [2/5]

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

Constructor. Not implemented.

Parameters
parametersAlgorithm parameters.

◆ RSACryptoServiceProvider() [3/5]

ASPOSECPP_SHARED_API System::Security::Cryptography::RSACryptoServiceProvider::RSACryptoServiceProvider ( const RSAParameters parameters)

Constructor.

Parameters
parametersAlgorithm parameters.

◆ RSACryptoServiceProvider() [4/5]

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

Constructor.

Parameters
key_sizeKey size in bits.

◆ RSACryptoServiceProvider() [5/5]

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

Constructor. Not implemented.

Parameters
key_sizeKey size in bits.
parametersAlgorithm parameters.

Member Function Documentation

◆ Decrypt() [1/2]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::Decrypt ( const ByteArrayPtr rgb,
bool  use_oaep 
)

Decrypts message. Not implemented.

Parameters
rgbData to decrypt.
use_oaepTrue to use OAEP padding, false to use PKCS#1 v1.5 padding.
Returns
Decrypted data array.

◆ Decrypt() [2/2]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::Decrypt ( ByteArrayPtr  data,
SharedPtr< RSAEncryptionPadding padding 
)
overridevirtual

Decrypts input data using the specified padding mode.

Parameters
dataByte array to decrypt.
paddingPadding mode.
Returns
Decrypted data in byte array format.

Reimplemented from System::Security::Cryptography::RSA.

◆ Dispose()

ASPOSECPP_SHARED_API void System::Security::Cryptography::RSACryptoServiceProvider::Dispose ( )
overridevirtual

Frees data associated with object.

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

◆ Encrypt() [1/2]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::Encrypt ( const ByteArrayPtr rgb,
bool  use_oaep 
)

Encrypts message. Not implemented.

Parameters
rgbData to encrypt.
use_oaepTrue to use OAEP padding, false to use PKCS#1 v1.5 padding.
Returns
Encrypted data array.

◆ Encrypt() [2/2]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::Encrypt ( ByteArrayPtr  data,
SharedPtr< RSAEncryptionPadding padding 
)
overridevirtual

Encrypts input data using the specified padding mode.

Parameters
dataByte array to encrypt.
paddingPadding mode.
Returns
Encrypted data in byte array format.

Reimplemented from System::Security::Cryptography::RSA.

◆ ExportCspBlob()

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::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()

ASPOSECPP_SHARED_API RSAParameters System::Security::Cryptography::RSACryptoServiceProvider::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::RSA.

◆ get_CspKeyContainerInfo()

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

◆ get_KeyExchangeAlgorithm()

ASPOSECPP_SHARED_API String System::Security::Cryptography::RSACryptoServiceProvider::get_KeyExchangeAlgorithm ( )
overridevirtual

Checks key exchange algorithm associated with object.

Returns
Key exchange algorithm name.

Reimplemented from System::Security::Cryptography::RSA.

◆ get_KeySize()

ASPOSECPP_SHARED_API int32_t System::Security::Cryptography::RSACryptoServiceProvider::get_KeySize ( )
overridevirtual

Gets key size used by algorithm.

Returns
Key size in bits.

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

◆ get_PersistKeyInCsp()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::RSACryptoServiceProvider::get_PersistKeyInCsp ( ) const

Checks whether key is persisted in CSP object.

Returns
True if key is persisted, false otherwise.

◆ get_PublicOnly()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::RSACryptoServiceProvider::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()

ASPOSECPP_SHARED_API String System::Security::Cryptography::RSACryptoServiceProvider::get_SignatureAlgorithm ( )
overridevirtual

Gets signature algorithm associated with CSP object.

Returns
Signature algorithm name.

Reimplemented from System::Security::Cryptography::RSA.

◆ get_UseMachineKeyStore()

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

◆ ImportCspBlob()

ASPOSECPP_SHARED_API void System::Security::Cryptography::RSACryptoServiceProvider::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()

ASPOSECPP_SHARED_API void System::Security::Cryptography::RSACryptoServiceProvider::ImportParameters ( RSAParameters  parameters)
overridevirtual

Imports CSP parameters.

Parameters
parametersData structure with CSP parameters.

Implements System::Security::Cryptography::RSA.

◆ set_PersistKeyInCsp()

ASPOSECPP_SHARED_API void System::Security::Cryptography::RSACryptoServiceProvider::set_PersistKeyInCsp ( bool  value)

Defines whether key is persisted in CSP object.

Parameters
valueTrue to persist the key, false otherwise.

◆ set_UseMachineKeyStore()

static ASPOSECPP_SHARED_API void System::Security::Cryptography::RSACryptoServiceProvider::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/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::SignData ( const ByteArrayPtr buffer,
const SharedPtr< Object > &  halg 
)

Computes the signature of specified input value.

Parameters
bufferBuffer to read input data from.
halgHash algorithm to use.
Returns
RSA signature for specified data.

◆ SignData() [2/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::SignData ( const SharedPtr< IO::Stream > &  input_stream,
const SharedPtr< Object > &  halg 
)

Computes the signature of specified input value.

Parameters
input_streamStream to read data being signed from.
halgHash algorithm to use.
Returns
RSA signature for specified data.

◆ SignData() [3/3]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::SignData ( const ByteArrayPtr buffer,
int32_t  offset,
int32_t  count,
const SharedPtr< Object > &  halg 
)

Computes the signature of specified input value.

Parameters
bufferBuffer to read input data from.
offsetInput buffer slice beginning index.
countInput buffer slice size.
halgHash algorithm to use.
Returns
RSA signature for specified data.

◆ SignHash() [1/2]

ASPOSECPP_SHARED_API ByteArrayPtr System::Security::Cryptography::RSACryptoServiceProvider::SignHash ( ByteArrayPtr  hash,
HashAlgorithmName  hash_algorithm,
SharedPtr< RSASignaturePadding padding 
)
overridevirtual

Computes the signature for the specified hash value.

Parameters
hashHash value.
hash_algorithmHash algorithm.
paddingPadding mode. return RSA signature for the specified hash.

Reimplemented from System::Security::Cryptography::RSA.

◆ SignHash() [2/2]

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

Computes the signature of specified input value. Not implemented.

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

◆ VerifyData()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::RSACryptoServiceProvider::VerifyData ( const ByteArrayPtr buffer,
const SharedPtr< Object > &  halg,
const ByteArrayPtr signature 
)

Checks data signature.

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

◆ VerifyHash() [1/2]

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

◆ VerifyHash() [2/2]

ASPOSECPP_SHARED_API bool System::Security::Cryptography::RSACryptoServiceProvider::VerifyHash ( ByteArrayPtr  hash,
ByteArrayPtr  signature,
const HashAlgorithmName hash_algorithm,
SharedPtr< RSASignaturePadding padding 
)
overridevirtual

Verifies that the signature of the specified hash is valid.

Parameters
hashHash value of the signed data.
signatureSignature data.
hash_algorithmHash algorithm.
paddingPadding mode. return true if signature is valid, otherwise - false.

Reimplemented from System::Security::Cryptography::RSA.