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

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. More...

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 System::SharedPtr< CspParameters > &parameters)
 Constructor. Not implemented. More...
 
ASPOSECPP_SHARED_API RSACryptoServiceProvider (int dwKeySize)
 Constructor. More...
 
ASPOSECPP_SHARED_API RSACryptoServiceProvider (int dwKeySize, const System::SharedPtr< CspParameters > &parameters)
 Constructor. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API System::String get_KeyExchangeAlgorithm () override
 Checks key exchange algorithm associated with object. More...
 
virtual ASPOSECPP_SHARED_API int get_KeySize () override
 Gets key size used by algorithm. More...
 
ASPOSECPP_SHARED_API bool get_PersistKeyInCsp ()
 Checks whether key is persisted in CSP object. More...
 
ASPOSECPP_SHARED_API void set_PersistKeyInCsp (bool value)
 Defines whether key is persisted in CSP object. More...
 
ASPOSECPP_SHARED_API bool get_PublicOnly ()
 Checks if public key only is present in CSP object. More...
 
virtual ASPOSECPP_SHARED_API System::String get_SignatureAlgorithm () override
 Gets signature algorithm associated with CSP object. More...
 
ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > Decrypt (const System::ArrayPtr< uint8_t > &rgb, bool fOAEP)
 Decrypts message. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > DecryptValue (System::ArrayPtr< uint8_t > rgb) override
 Decrypts message. Not implemented. More...
 
ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > Encrypt (const System::ArrayPtr< uint8_t > &rgb, bool fOAEP)
 Encrypts message. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > EncryptValue (System::ArrayPtr< uint8_t > rgb) override
 Encrypts message. Not implemented. More...
 
ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > ExportCspBlob (bool includePrivateParameters) override
 Exports blob with information on key. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API RSAParameters ExportParameters (bool includePrivateParameters) override
 Exports CSP parameters. More...
 
ASPOSECPP_SHARED_API void ImportCspBlob (System::ArrayPtr< uint8_t > keyBlob) override
 Imports blob with information on key. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API void ImportParameters (RSAParameters parameters) override
 Imports CSP parameters. More...
 
ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > SignData (const System::ArrayPtr< uint8_t > &buffer, const System::SharedPtr< System::Object > &halg)
 Computes the signature of specified input value. Not implemented. More...
 
ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > SignData (const System::SharedPtr< System::IO::Stream > &inputStream, const System::SharedPtr< System::Object > &halg)
 Computes the signature of specified input value. Not implemented. More...
 
ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > SignData (const System::ArrayPtr< uint8_t > &buffer, int offset, int count, const System::SharedPtr< System::Object > &halg)
 Computes the signature of specified input value. Not implemented. More...
 
ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > SignHash (const System::ArrayPtr< uint8_t > &rgbHash, const System::String &str)
 Computes the signature of specified input value. Not implemented. More...
 
ASPOSECPP_SHARED_API bool VerifyData (const System::ArrayPtr< uint8_t > &buffer, const System::SharedPtr< System::Object > &halg, const System::ArrayPtr< uint8_t > &signature)
 Checks data signature. Not implemented. More...
 
ASPOSECPP_SHARED_API bool VerifyHash (const System::ArrayPtr< uint8_t > &rgbHash, const System::String &str, const System::ArrayPtr< uint8_t > &rgbSignature)
 Checks data signature. Not implemented. More...
 
- Public Member Functions inherited from System::Security::Cryptography::RSA
virtual ASPOSECPP_SHARED_API void FromXmlString (String xmlString) override
 Initializes object using XML-encoded parameters. More...
 
virtual ASPOSECPP_SHARED_API String ToXmlString (bool includePrivateParameters) override
 Exports all parameters in XML format. More...
 
- Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
virtual ASPOSECPP_SHARED_API void set_KeySize (int 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...
 
- 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 () ASPOSE_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 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...
 

Static Public Member Functions

static ASPOSECPP_SHARED_API bool get_UseMachineKeyStore ()
 Checks whether the key persists in machine store instead of user store. More...
 
static ASPOSECPP_SHARED_API 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::RSA
static ASPOSECPP_SHARED_API SharedPtr< RSACreate ()
 Creates default RSA aglorithm implementation. More...
 
static ASPOSECPP_SHARED_API SharedPtr< RSACreate (const String &algName)
 Creates default RSA algorithm implementation. 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 &algName)
 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...
 

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

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/4]

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

Constructor. Uses default parameters.

◆ RSACryptoServiceProvider() [2/4]

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

Constructor. Not implemented.

Parameters
parametersAlgorithm parameters.

◆ RSACryptoServiceProvider() [3/4]

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

Constructor.

Parameters
dwKeySizeKey size in bits.

◆ RSACryptoServiceProvider() [4/4]

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

Constructor. Not implemented.

Parameters
dwKeySizeKey size in bits.
parametersAlgorithm parameters.

Member Function Documentation

◆ Decrypt()

ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::Decrypt ( const System::ArrayPtr< uint8_t > &  rgb,
bool  fOAEP 
)

Decrypts message. Not implemented.

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

◆ DecryptValue()

virtual ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::DecryptValue ( System::ArrayPtr< uint8_t >  rgb)
overridevirtual

Decrypts message. Not implemented.

Parameters
rgbData to decrypt.
Returns
Decrypted data array.

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

◆ Encrypt()

ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::Encrypt ( const System::ArrayPtr< uint8_t > &  rgb,
bool  fOAEP 
)

Encrypts message. Not implemented.

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

◆ EncryptValue()

virtual ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::EncryptValue ( System::ArrayPtr< uint8_t >  rgb)
overridevirtual

Encrypts message. Not implemented.

Parameters
rgbData to encrypt.
Returns
Encrypted data array.

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

◆ ExportCspBlob()

ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::ExportCspBlob ( bool  includePrivateParameters)
overridevirtual

Exports blob with information on key. Not implemented.

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

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

◆ ExportParameters()

virtual ASPOSECPP_SHARED_API RSAParameters System::Security::Cryptography::RSACryptoServiceProvider::ExportParameters ( bool  includePrivateParameters)
overridevirtual

Exports CSP parameters.

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

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

◆ get_KeyExchangeAlgorithm()

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

Checks key exchange algorithm associated with object.

Returns
Key exchange algorithm name.

Implements System::Security::Cryptography::AsymmetricAlgorithm.

◆ get_KeySize()

virtual ASPOSECPP_SHARED_API int 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 ( )

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

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

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

Gets signature algorithm associated with CSP object.

Returns
Signature algorithm name.

Implements System::Security::Cryptography::AsymmetricAlgorithm.

◆ 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 ( System::ArrayPtr< uint8_t >  keyBlob)
overridevirtual

Imports blob with information on key. Not implemented.

Parameters
keyBlobPreviously exported blob with key information.

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

◆ ImportParameters()

virtual 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 System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::SignData ( const System::ArrayPtr< uint8_t > &  buffer,
const System::SharedPtr< System::Object > &  halg 
)

Computes the signature of specified input value. Not implemented.

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

◆ SignData() [2/3]

ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::SignData ( const System::SharedPtr< System::IO::Stream > &  inputStream,
const System::SharedPtr< System::Object > &  halg 
)

Computes the signature of specified input value. Not implemented.

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

◆ SignData() [3/3]

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

Computes the signature of specified input value. Not implemented.

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

ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::RSACryptoServiceProvider::SignHash ( const System::ArrayPtr< uint8_t > &  rgbHash,
const System::String str 
)

Computes the signature of specified input value. Not implemented.

Parameters
rgbHashHash 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 System::ArrayPtr< uint8_t > &  buffer,
const System::SharedPtr< System::Object > &  halg,
const System::ArrayPtr< uint8_t > &  signature 
)

Checks data signature. Not implemented.

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

◆ VerifyHash()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::RSACryptoServiceProvider::VerifyHash ( const System::ArrayPtr< uint8_t > &  rgbHash,
const System::String str,
const System::ArrayPtr< uint8_t > &  rgbSignature 
)

Checks data signature. Not implemented.

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