Asposecpplib
System::Security::Cryptography::SymmetricAlgorithm Class Referenceabstract

Symmetric algorithm using same key for encryption and decryption base class. 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::Object.

Inherited by System::Security::Cryptography::RC2, System::Security::Cryptography::Rijndael, and System::Security::Cryptography::TripleDES.

Public Member Functions

virtual ASPOSECPP_SHARED_API int get_BlockSize ()
 Gets block size of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API void set_BlockSize (int value)
 Sets block size of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API int get_FeedbackSize ()
 Gets feedback size of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API void set_FeedbackSize (int value)
 Sets feedback size of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > get_Key ()
 Gets key of cryptographic operation. Creates new if not created yet. More...
 
virtual ASPOSECPP_SHARED_API void set_Key (System::ArrayPtr< uint8_t > value)
 Sets key of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API System::ArrayPtr< uint8_t > get_IV ()
 Gets initial value of cryptographic operation. Creates new if not created yet. More...
 
virtual ASPOSECPP_SHARED_API void set_IV (System::ArrayPtr< uint8_t > value)
 Sets initial value of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API int get_KeySize ()
 Gets key size of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API void set_KeySize (int value)
 Sets key size of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API CipherMode get_Mode ()
 Gets mode of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API void set_Mode (CipherMode value)
 Sets mode of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API PaddingMode get_Padding ()
 Gets padding of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API void set_Padding (PaddingMode value)
 Sets padding of cryptographic operation. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< ICryptoTransformCreateEncryptor ()
 Creates encryptor with parameters associated with algorithm object. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< ICryptoTransformCreateEncryptor (System::ArrayPtr< uint8_t > rgbKey, System::ArrayPtr< uint8_t > rgbIV)=0
 Creates encryptor with explicit parameters. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< ICryptoTransformCreateDecryptor ()
 Creates decryptor with parameters associated with algorithm object. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< ICryptoTransformCreateDecryptor (System::ArrayPtr< uint8_t > rgbKey, System::ArrayPtr< uint8_t > rgbIV)=0
 Creates decryptor with explicit parameters. More...
 
virtual ASPOSECPP_SHARED_API void GenerateKey ()=0
 Generates random key for the algorithm. Overrides existing one (if any). More...
 
virtual ASPOSECPP_SHARED_API void GenerateIV ()=0
 Generates random initial value for the algorithm. Overrides existing one (if any). More...
 
ASPOSECPP_SHARED_API bool ValidKeySize (int bitLength)
 Checks if key size is valid. 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 SharedPtr< SymmetricAlgorithmCreate (const String &algName)
 Creates algorithm instance. 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

Symmetric algorithm using same key for encryption and decryption base class. 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

◆ Create()

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

Creates algorithm instance.

Parameters
algNameShould be "Rijndael", "TripleDES" or "RC2".
Returns
Newly created algorithm.

◆ CreateDecryptor() [1/2]

virtual ASPOSECPP_SHARED_API SharedPtr<ICryptoTransform> System::Security::Cryptography::SymmetricAlgorithm::CreateDecryptor ( )
virtual

Creates decryptor with parameters associated with algorithm object.

Returns
Newly created decryptor object.

◆ CreateDecryptor() [2/2]

virtual ASPOSECPP_SHARED_API SharedPtr<ICryptoTransform> System::Security::Cryptography::SymmetricAlgorithm::CreateDecryptor ( System::ArrayPtr< uint8_t >  rgbKey,
System::ArrayPtr< uint8_t >  rgbIV 
)
pure virtual

Creates decryptor with explicit parameters.

Parameters
rgbKeyKey to use.
rgbIVInitial value to use.
Returns
Newly created decryptor object.

Implemented in System::Security::Cryptography::RC2Managed, System::Security::Cryptography::RijndaelManaged, and System::Security::Cryptography::TripleDESManaged.

◆ CreateEncryptor() [1/2]

virtual ASPOSECPP_SHARED_API SharedPtr<ICryptoTransform> System::Security::Cryptography::SymmetricAlgorithm::CreateEncryptor ( )
virtual

Creates encryptor with parameters associated with algorithm object.

Returns
Newly created encryptor object.

◆ CreateEncryptor() [2/2]

virtual ASPOSECPP_SHARED_API SharedPtr<ICryptoTransform> System::Security::Cryptography::SymmetricAlgorithm::CreateEncryptor ( System::ArrayPtr< uint8_t >  rgbKey,
System::ArrayPtr< uint8_t >  rgbIV 
)
pure virtual

Creates encryptor with explicit parameters.

Parameters
rgbKeyKey to use.
rgbIVInitial value to use.
Returns
Newly created encryptor object.

Implemented in System::Security::Cryptography::RC2Managed, System::Security::Cryptography::RijndaelManaged, and System::Security::Cryptography::TripleDESManaged.

◆ GenerateIV()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::GenerateIV ( )
pure virtual

Generates random initial value for the algorithm. Overrides existing one (if any).

Implemented in System::Security::Cryptography::RC2Managed, System::Security::Cryptography::RijndaelManaged, and System::Security::Cryptography::TripleDESManaged.

◆ GenerateKey()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::GenerateKey ( )
pure virtual

Generates random key for the algorithm. Overrides existing one (if any).

Implemented in System::Security::Cryptography::RC2Managed, System::Security::Cryptography::RijndaelManaged, and System::Security::Cryptography::TripleDESManaged.

◆ get_BlockSize()

virtual ASPOSECPP_SHARED_API int System::Security::Cryptography::SymmetricAlgorithm::get_BlockSize ( )
virtual

Gets block size of cryptographic operation.

Returns
Block size in bits.

◆ get_FeedbackSize()

virtual ASPOSECPP_SHARED_API int System::Security::Cryptography::SymmetricAlgorithm::get_FeedbackSize ( )
virtual

Gets feedback size of cryptographic operation.

Returns
Feedback size in bits.

◆ get_IV()

virtual ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::SymmetricAlgorithm::get_IV ( )
virtual

Gets initial value of cryptographic operation. Creates new if not created yet.

Returns
Copy of initial value array.

◆ get_Key()

virtual ASPOSECPP_SHARED_API System::ArrayPtr<uint8_t> System::Security::Cryptography::SymmetricAlgorithm::get_Key ( )
virtual

Gets key of cryptographic operation. Creates new if not created yet.

Returns
Copy of key array.

◆ get_KeySize()

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

Gets key size of cryptographic operation.

Returns
Key size in bits.

◆ get_Mode()

virtual ASPOSECPP_SHARED_API CipherMode System::Security::Cryptography::SymmetricAlgorithm::get_Mode ( )
virtual

Gets mode of cryptographic operation.

Returns
Cipher mode.

◆ get_Padding()

virtual ASPOSECPP_SHARED_API PaddingMode System::Security::Cryptography::SymmetricAlgorithm::get_Padding ( )
virtual

Gets padding of cryptographic operation.

Returns
Padding mode.

◆ set_BlockSize()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::set_BlockSize ( int  value)
virtual

Sets block size of cryptographic operation.

Parameters
valueBlock size in bits.
Exceptions
CryptographicExceptionIf block size is not supported.

◆ set_FeedbackSize()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::set_FeedbackSize ( int  value)
virtual

Sets feedback size of cryptographic operation.

Parameters
valueFeedback size in bits.
Exceptions
CryptographicExceptionIf feedback size is not supported.

◆ set_IV()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::set_IV ( System::ArrayPtr< uint8_t >  value)
virtual

Sets initial value of cryptographic operation.

Parameters
valueInitial value to set.

◆ set_Key()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::set_Key ( System::ArrayPtr< uint8_t >  value)
virtual

Sets key of cryptographic operation.

Parameters
valueKey to set.

◆ set_KeySize()

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

Sets key size of cryptographic operation.

Parameters
valueKey size in bits.
Exceptions
CryptographicExceptionIf key size is not valid.

◆ set_Mode()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::set_Mode ( CipherMode  value)
virtual

Sets mode of cryptographic operation.

Parameters
valueCipher mode.

◆ set_Padding()

virtual ASPOSECPP_SHARED_API void System::Security::Cryptography::SymmetricAlgorithm::set_Padding ( PaddingMode  value)
virtual

Sets padding of cryptographic operation.

Parameters
valuePadding mode.

◆ ValidKeySize()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::SymmetricAlgorithm::ValidKeySize ( int  bitLength)

Checks if key size is valid.

Parameters
bitLengthKey size in bits.
Returns
True if key size is valid, false otherwise.