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

#include <rsa.h>

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

Inherited by System::Security::Cryptography::RSACryptoServiceProvider.

Public Member Functions
String	get_KeyExchangeAlgorithm () override
	Checks key exchange algorithm associated with object. More...

String	get_SignatureAlgorithm () override
	Gets signature algorithm associated with CSP object. More...

virtual ByteArrayPtr	Decrypt (ByteArrayPtr data, SharedPtr< RSAEncryptionPadding > padding)
	Decrypts input data using the specified padding mode. More...

virtual ByteArrayPtr	DecryptValue (ByteArrayPtr rgb)
	Decrypts value using private key. More...

virtual ByteArrayPtr	Encrypt (ByteArrayPtr data, SharedPtr< RSAEncryptionPadding > padding)
	Encrypts input data using the specified padding mode. More...

virtual ByteArrayPtr	EncryptValue (ByteArrayPtr rgb)
	Encrypts value using private key. More...

virtual RSAParameters	ExportParameters (bool include_private_parameters)=0
	Exports all parameters. More...

virtual void	ImportParameters (RSAParameters parameters)=0
	Imports all parameters from data structure. More...

void	FromXmlString (String xml_string) override
	Initializes object using XML-encoded parameters. More...

String	ToXmlString (bool include_private_parameters) override
	Exports all parameters in XML format. More...

ByteArrayPtr	SignData (const ByteArrayPtr &data, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
	Computes the hash value of the specified data array using the specified hash algorithm and padding, and signs the result. More...

ByteArrayPtr	SignData (const ByteArrayPtr &data, int32_t offset, int32_t count, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
	Computes the hash value of the specified data array using the specified hash algorithm and padding, and signs the result. More...

ByteArrayPtr	SignData (const StreamPtr &stream, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
	Computes the hash value of the specified binary stream using the specified hash algorithm and padding, and signs the result. More...

virtual ByteArrayPtr	SignHash (ByteArrayPtr hash, HashAlgorithmName hash_algorithm, SharedPtr< RSASignaturePadding > padding)
	Computes the signature for the specified hash value. More...

bool	VerifyData (const ByteArrayPtr &data, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
	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, const SharedPtr< RSASignaturePadding > &padding)
	Verifies that the signature of the specified data is valid. More...

bool	VerifyData (const StreamPtr &stream, const ByteArrayPtr &signature, const HashAlgorithmName &hash_algorithm, const SharedPtr< RSASignaturePadding > &padding)
	Verifies that the signature of the specified binary stream is valid. More...

virtual bool	VerifyHash (ByteArrayPtr hash, ByteArrayPtr signature, const HashAlgorithmName &hash_algorithm, SharedPtr< RSASignaturePadding > padding)
	Verifies that the signature of the specified hash is valid. 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...

virtual String	get_SignatureAlgorithm ()
	Gets signature algorithm to use. More...

virtual String	get_KeyExchangeAlgorithm ()
	Gets key exchange algorithm to use. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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...

virtual void	Dispose ()
	Does nothing. More...

Static Public Member Functions
static SharedPtr< RSA >	Create ()
	Creates default RSA aglorithm implementation. More...

static SharedPtr< RSA >	Create (const String &alg_name)
	Creates default RSA algorithm implementation. More...

static SharedPtr< RSA >	Create (int32_t key_size_in_bits)
	Creates default RSA algorithm implementation with specifed key size. More...

static SharedPtr< RSA >	Create (const RSAParameters &parameters)
	Creates default RSA algorithm implementation with specifed parameters. More...

static SharedPtr< RSA >	CreateFromXmlString (const String &xml_string)
	Creates default RSA algorithm implementation with specifed XML-encoded parameters. More...

Static Public Member Functions inherited from System::Security::Cryptography::AsymmetricAlgorithm
static SharedPtr< AsymmetricAlgorithm >	Create ()
	Creates a default algorithm. Not implemented. More...

static SharedPtr< AsymmetricAlgorithm >	Create (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 TypeInfo &	Type ()
	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
	RSA ()
	Constructor. More...

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< Object >	ptr
	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 RSA 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

◆ RSA()

System::Security::Cryptography::RSA::RSA ( )

protected

Constructor.

Member Function Documentation

◆ Create() [1/4]

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

static

Creates default RSA aglorithm implementation.

◆ Create() [2/4]

static SharedPtr< RSA > System::Security::Cryptography::RSA::Create ( const RSAParameters & parameters )

static

Creates default RSA algorithm implementation with specifed parameters.

Parameters

parameters The parameters for the RSA algorithm.

◆ Create() [3/4]

static SharedPtr< RSA > System::Security::Cryptography::RSA::Create ( const String & alg_name )

static

Creates default RSA algorithm implementation.

Parameters

alg_name Must be "System.Security.Cryptography.RSACryptoServiceProvider".

◆ Create() [4/4]

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

static

Creates default RSA algorithm implementation with specifed key size.

Parameters

key_size_in_bits The key size, in bits.

◆ CreateFromXmlString()

static SharedPtr< RSA > System::Security::Cryptography::RSA::CreateFromXmlString ( const String & xml_string )

static

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

Parameters

xml_string The parameters for the RSA algorithm.

◆ Decrypt()

virtual ByteArrayPtr System::Security::Cryptography::RSA::Decrypt	(	ByteArrayPtr	data,
		SharedPtr< RSAEncryptionPadding >	padding
	)

virtual

Decrypts input data using the specified padding mode.

Parameters

data	Byte array to decrypt.
padding	Padding mode.

Returns: Decrypted data in byte array format.

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ DecryptValue()

virtual ByteArrayPtr System::Security::Cryptography::RSA::DecryptValue ( ByteArrayPtr rgb )

virtual

Decrypts value using private key.

Parameters

rgb	Byte array to decrypt.

Returns: Decrypted data in byte array format.

◆ Encrypt()

virtual ByteArrayPtr System::Security::Cryptography::RSA::Encrypt	(	ByteArrayPtr	data,
		SharedPtr< RSAEncryptionPadding >	padding
	)

virtual

Encrypts input data using the specified padding mode.

Parameters

data	Byte array to encrypt.
padding	Padding mode.

Returns: Encrypted data in byte array format.

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ EncryptValue()

virtual ByteArrayPtr System::Security::Cryptography::RSA::EncryptValue ( ByteArrayPtr rgb )

virtual

Encrypts value using private key.

Parameters

rgb	Byte array to encrypt.

Returns: Encrypted data in byte array format.

◆ ExportParameters()

virtual RSAParameters System::Security::Cryptography::RSA::ExportParameters ( bool include_private_parameters )

pure virtual

Exports all parameters.

Parameters

include_private_parameters True to export both private and public parameters, false to export public parameters only.

Returns: Exported parameters structure.

Implemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ FromXmlString()

void System::Security::Cryptography::RSA::FromXmlString ( String xml_string )

overridevirtual

Initializes object using XML-encoded parameters.

Parameters

xml_string Parameters in XML format.

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

◆ get_KeyExchangeAlgorithm()

String System::Security::Cryptography::RSA::get_KeyExchangeAlgorithm ( )

overridevirtual

Checks key exchange algorithm associated with object.

Returns: Key exchange algorithm name.

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

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ get_SignatureAlgorithm()

String System::Security::Cryptography::RSA::get_SignatureAlgorithm ( )

overridevirtual

Gets signature algorithm associated with CSP object.

Returns: Signature algorithm name.

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

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ HashData() [1/2]

virtual ByteArrayPtr System::Security::Cryptography::RSA::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

data	Data to hash.
offset	Offset in `data`.
count	Number of bytes to hash.
hash_algorithm	Hash algorithm.

Returns: Hashed data.

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ HashData() [2/2]

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

protectedvirtual

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

Parameters

stream	Bynary stream to hashed.
hash_algorithm	Hash algorithm.

Returns: Hashed data.

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ ImportParameters()

virtual void System::Security::Cryptography::RSA::ImportParameters ( RSAParameters parameters )

pure virtual

Imports all parameters from data structure.

Parameters

parameters Structure to import parameters from.

Implemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ SignData() [1/3]

ByteArrayPtr System::Security::Cryptography::RSA::SignData	(	const ByteArrayPtr &	data,
		const HashAlgorithmName &	hash_algorithm,
		const SharedPtr< RSASignaturePadding > &	padding
	)

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

Parameters

data	Input data array.
hash_algorithm	Hash algorithm.
padding	Padding mode. return RSA signature for the input data.

◆ SignData() [2/3]

ByteArrayPtr System::Security::Cryptography::RSA::SignData	(	const ByteArrayPtr &	data,
		int32_t	offset,
		int32_t	count,
		const HashAlgorithmName &	hash_algorithm,
		const SharedPtr< RSASignaturePadding > &	padding
	)

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

Parameters

data	Input data array.
offset	Offset in `data`.
count	Number of bytes to use as input data.
hash_algorithm	Hash algorithm.
padding	Padding mode. return RSA signature for the input data.

◆ SignData() [3/3]

ByteArrayPtr System::Security::Cryptography::RSA::SignData	(	const StreamPtr &	stream,
		const HashAlgorithmName &	hash_algorithm,
		const SharedPtr< RSASignaturePadding > &	padding
	)

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

Parameters

stream	Binary stream.
hash_algorithm	Hash algorithm.
padding	Padding mode. return RSA signature for the input data.

◆ SignHash()

virtual ByteArrayPtr System::Security::Cryptography::RSA::SignHash	(	ByteArrayPtr	hash,
		HashAlgorithmName	hash_algorithm,
		SharedPtr< RSASignaturePadding >	padding
	)

virtual

Computes the signature for the specified hash value.

Parameters

hash	Hash value.
hash_algorithm	Hash algorithm.
padding	Padding mode. return RSA signature for the specified hash.

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

◆ ToXmlString()

String System::Security::Cryptography::RSA::ToXmlString ( bool include_private_parameters )

overridevirtual

Exports all parameters in XML format.

Parameters

include_private_parameters True 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]

bool System::Security::Cryptography::RSA::VerifyData	(	const ByteArrayPtr &	data,
		const ByteArrayPtr &	signature,
		const HashAlgorithmName &	hash_algorithm,
		const SharedPtr< RSASignaturePadding > &	padding
	)

Verifies that the signature of the specified data is valid.

Parameters

data	Signed data.
signature	Signature data.
hash_algorithm	Hash algorithm.
padding	Padding mode. return true if signature is valid, otherwise - false.

◆ VerifyData() [2/3]

bool System::Security::Cryptography::RSA::VerifyData	(	const ByteArrayPtr &	data,
		int32_t	offset,
		int32_t	count,
		const ByteArrayPtr &	signature,
		const HashAlgorithmName &	hash_algorithm,
		const SharedPtr< RSASignaturePadding > &	padding
	)

Verifies that the signature of the specified data is valid.

Parameters

data	Signed data.
offset	Offset in `data`.
count	Number of bytes to hash.
signature	Signature data.
hash_algorithm	Hash algorithm.
padding	Padding mode. return true if signature is valid, otherwise - false.

◆ VerifyData() [3/3]

bool System::Security::Cryptography::RSA::VerifyData	(	const StreamPtr &	stream,
		const ByteArrayPtr &	signature,
		const HashAlgorithmName &	hash_algorithm,
		const SharedPtr< RSASignaturePadding > &	padding
	)

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

Parameters

stream	Signed data.
signature	Signature data.
hash_algorithm	Hash algorithm.
padding	Padding mode. return true if signature is valid, otherwise - false.

◆ VerifyHash()

virtual bool System::Security::Cryptography::RSA::VerifyHash	(	ByteArrayPtr	hash,
		ByteArrayPtr	signature,
		const HashAlgorithmName &	hash_algorithm,
		SharedPtr< RSASignaturePadding >	padding
	)

virtual

Verifies that the signature of the specified hash is valid.

Parameters

hash	Hash value of the signed data.
signature	Signature data.
hash_algorithm	Hash algorithm.
padding	Padding mode. return true if signature is valid, otherwise - false.

Reimplemented in System::Security::Cryptography::RSACryptoServiceProvider.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RSA()

Member Function Documentation

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

◆ Create() [4/4]

◆ CreateFromXmlString()

◆ Decrypt()

◆ DecryptValue()

◆ Encrypt()

◆ EncryptValue()

◆ ExportParameters()

◆ FromXmlString()

◆ get_KeyExchangeAlgorithm()

◆ get_SignatureAlgorithm()

◆ HashData() [1/2]

◆ HashData() [2/2]

◆ ImportParameters()

◆ SignData() [1/3]

◆ SignData() [2/3]

◆ SignData() [3/3]

◆ SignHash()

◆ ToXmlString()

◆ VerifyData() [1/3]

◆ VerifyData() [2/3]

◆ VerifyData() [3/3]

◆ VerifyHash()