Abstract base class for asymmetric encryption algorithms. 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 <asymmetric_algorithm.h>

Inherits System::Object, and System::IDisposable.

Inherited by System::Security::Cryptography::DSA, System::Security::Cryptography::ECDsa, and System::Security::Cryptography::RSA.

Public Member Functions
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< 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
	AsymmetricAlgorithm ()
	Constructor. More...

Protected Attributes
int32_t	KeySizeValue
	Key size associated with algorithm. More...

ArrayPtr< SharedPtr< KeySizes > >	LegalKeySizesValue
	Enabled key sizes. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Detailed Description

Abstract base class for asymmetric encryption algorithms. 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

◆ AsymmetricAlgorithm()

System::Security::Cryptography::AsymmetricAlgorithm::AsymmetricAlgorithm ( )

protected

Constructor.

Member Function Documentation

◆ Clear()

void System::Security::Cryptography::AsymmetricAlgorithm::Clear ( )

Releases all resources.

◆ Create() [1/2]

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

static

Creates a default algorithm. Not implemented.

Returns: Algorithm object.

◆ Create() [2/2]

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

static

Creates algorithm by name. Not implemented.

Parameters

alg_name Algorithm name.

Returns: Algorithm object.

◆ Dispose()

void System::Security::Cryptography::AsymmetricAlgorithm::Dispose ( )

overridevirtual

Releases resources owned by the current object.

Reimplemented from System::IDisposable.

Reimplemented in System::Security::Cryptography::DSACryptoServiceProvider, and System::Security::Cryptography::RSACryptoServiceProvider.

◆ FromXmlString()

virtual void System::Security::Cryptography::AsymmetricAlgorithm::FromXmlString ( String xmlString )

virtual

Reads algorithm parameters from XML string.

Parameters

xmlString Parameters string in XML format.

Reimplemented in System::Security::Cryptography::DSA, System::Security::Cryptography::ECDsaBotan, and System::Security::Cryptography::RSA.

◆ get_KeyExchangeAlgorithm()

virtual String System::Security::Cryptography::AsymmetricAlgorithm::get_KeyExchangeAlgorithm ( )

virtual

Gets key exchange algorithm to use.

Returns: Algorithm name.

Reimplemented in System::Security::Cryptography::DSACryptoServiceProvider, System::Security::Cryptography::ECDsa, System::Security::Cryptography::RSA, and System::Security::Cryptography::RSACryptoServiceProvider.

◆ get_KeySize()

virtual int32_t System::Security::Cryptography::AsymmetricAlgorithm::get_KeySize ( )

virtual

Gets key size.

Returns: Size of the key to use.

Reimplemented in System::Security::Cryptography::DSACryptoServiceProvider, and System::Security::Cryptography::RSACryptoServiceProvider.

◆ get_LegalKeySizes()

virtual ArrayPtr< SharedPtr< KeySizes > > System::Security::Cryptography::AsymmetricAlgorithm::get_LegalKeySizes ( )

virtual

Gets array of allowed key sizes.

Returns: Array of allowed key sizes.

◆ get_SignatureAlgorithm()

virtual String System::Security::Cryptography::AsymmetricAlgorithm::get_SignatureAlgorithm ( )

virtual

Gets signature algorithm to use.

Returns: Algorithm name.

Reimplemented in System::Security::Cryptography::DSACryptoServiceProvider, System::Security::Cryptography::ECDsa, System::Security::Cryptography::RSA, and System::Security::Cryptography::RSACryptoServiceProvider.

◆ set_KeySize()

virtual void System::Security::Cryptography::AsymmetricAlgorithm::set_KeySize ( int32_t value )

virtual

Sets key size.

Parameters

value Size of the key to use.

Reimplemented in System::Security::Cryptography::ECDsaBotan.

◆ ToXmlString()

virtual String System::Security::Cryptography::AsymmetricAlgorithm::ToXmlString ( bool include_private_parameters )

virtual

Writes algorithm parameters to XML string.

Returns: Parameters string in XML format.

Reimplemented in System::Security::Cryptography::DSA, System::Security::Cryptography::ECDsaBotan, and System::Security::Cryptography::RSA.

Member Data Documentation

◆ KeySizeValue

int32_t System::Security::Cryptography::AsymmetricAlgorithm::KeySizeValue

protected

Key size associated with algorithm.

◆ LegalKeySizesValue

ArrayPtr<SharedPtr<KeySizes> > System::Security::Cryptography::AsymmetricAlgorithm::LegalKeySizesValue

protected

Enabled key sizes.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AsymmetricAlgorithm()

Member Function Documentation

◆ Clear()

◆ Create() [1/2]

◆ Create() [2/2]

◆ Dispose()

◆ FromXmlString()

◆ get_KeyExchangeAlgorithm()

◆ get_KeySize()

◆ get_LegalKeySizes()

◆ get_SignatureAlgorithm()

◆ set_KeySize()

◆ ToXmlString()

Member Data Documentation

◆ KeySizeValue

◆ LegalKeySizesValue