System::Security::Cryptography::AsymmetricAlgorithm Class Reference

Inherits System::Object.

Inherited by System::Security::Cryptography::RSA.

Public Member Functions
virtual ASPOSECPP_SHARED_API int	get_KeySize ()
virtual ASPOSECPP_SHARED_API void	set_KeySize (int value)
virtual ASPOSECPP_SHARED_API ArrayPtr< SharedPtr< KeySizes > >	get_LegalKeySizes ()
ASPOSECPP_SHARED_API void	Clear ()
	Releases all resources. More...
virtual ASPOSECPP_SHARED_API void	FromXmlString (String xmlString)=0
virtual ASPOSECPP_SHARED_API String	ToXmlString (bool includePrivateParameters)=0
virtual ASPOSECPP_SHARED_API String	get_SignatureAlgorithm ()=0
virtual ASPOSECPP_SHARED_API String	get_KeyExchangeAlgorithm ()=0
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...
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 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 TypeInfo &	GetType () 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)
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 SharedPtr< AsymmetricAlgorithm >	Create ()
static ASPOSECPP_SHARED_API SharedPtr< AsymmetricAlgorithm >	Create (const String &algName)
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 ()
	Impleemnts C# typeof(System.Object) construct. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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

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.

Member Function Documentation

Clear()

ASPOSECPP_SHARED_API void System::Security::Cryptography::AsymmetricAlgorithm::Clear

(

)

Releases all resources.

Create() [1/2]

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

static

Creates a default algorithm. Not implemented.

Returns

Algorithm object.

Create() [2/2]

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

static

Creates algorithm by name. Not implemented.

Parameters

algName

Algorithm name.

Returns

Algorithm object.

FromXmlString()

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

pure virtual

Reads algorithm parameters from XML string.

Parameters

xmlString

Parameters string in XML format.

Implemented in System::Security::Cryptography::RSA.

get_KeyExchangeAlgorithm()

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

pure virtual

Gets key exchange algorithm to use.

Returns

Algorithm name.

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

get_KeySize()

virtual ASPOSECPP_SHARED_API int System::Security::Cryptography::AsymmetricAlgorithm::get_KeySize ( )

virtual

Gets key size.

Returns

Size of the key to use.

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

get_LegalKeySizes()

virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API String System::Security::Cryptography::AsymmetricAlgorithm::get_SignatureAlgorithm ( )

pure virtual

Gets signature algorithm to use.

Returns

Algorithm name.

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

set_KeySize()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::AsymmetricAlgorithm::set_KeySize ( int  value )

virtual

Sets key size.

Parameters

value

Size of the key to use.

ToXmlString()

virtual ASPOSECPP_SHARED_API String System::Security::Cryptography::AsymmetricAlgorithm::ToXmlString ( bool  includePrivateParameters )

pure virtual

Writes algorithm parameters to XML string.

Returns

Parameters string in XML format.

Implemented in System::Security::Cryptography::RSA.