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

Static Public Member Functions

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

 SymmetricAlgorithm (const std::vector< SharedPtr< KeySizes >> &block_sizes, const std::vector< SharedPtr< KeySizes >> &key_sizes)
 Constructor. More...
 

Protected Attributes

int m_block_size
 Block size. More...
 
int m_feedback_size
 Feedback size. More...
 
System::ArrayPtr< uint8_t > m_iv
 Initial value. More...
 
System::ArrayPtr< uint8_t > m_key
 Key. More...
 
std::vector< SharedPtr< KeySizes > > m_legal_block_sizes
 Allowed block sizes. More...
 
std::vector< SharedPtr< KeySizes > > m_legal_key_sizes
 Allowed key sizes. More...
 
int m_key_size
 Key size. More...
 
CipherMode m_mode
 Direction. More...
 
PaddingMode m_padding
 Padding. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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.

Constructor & Destructor Documentation

◆ SymmetricAlgorithm()

System::Security::Cryptography::SymmetricAlgorithm::SymmetricAlgorithm ( const std::vector< SharedPtr< KeySizes >> &  block_sizes,
const std::vector< SharedPtr< KeySizes >> &  key_sizes 
)
protected

Constructor.

Parameters
block_sizesSupported data block sizes.
key_sizesSupported key sizes.

Member Function Documentation

◆ Create()

static 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 SharedPtr<ICryptoTransform> System::Security::Cryptography::SymmetricAlgorithm::CreateDecryptor ( )
virtual

◆ CreateDecryptor() [2/2]

virtual 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::TripleDESManaged, System::Security::Cryptography::RijndaelManaged, and System::Security::Cryptography::RC2Managed.

◆ CreateEncryptor() [1/2]

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

◆ CreateEncryptor() [2/2]

virtual 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::TripleDESManaged, System::Security::Cryptography::RijndaelManaged, and System::Security::Cryptography::RC2Managed.

◆ GenerateIV()

virtual 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::TripleDESManaged, System::Security::Cryptography::RijndaelManaged, and System::Security::Cryptography::RC2Managed.

◆ GenerateKey()

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

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

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

◆ get_BlockSize()

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

Gets block size of cryptographic operation.

Returns
Block size in bits.

◆ get_FeedbackSize()

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

Gets feedback size of cryptographic operation.

Returns
Feedback size in bits.

◆ get_IV()

virtual 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 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 int System::Security::Cryptography::SymmetricAlgorithm::get_KeySize ( )
virtual

Gets key size of cryptographic operation.

Returns
Key size in bits.

◆ get_Mode()

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

Gets mode of cryptographic operation.

Returns
Cipher mode.

◆ get_Padding()

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

Gets padding of cryptographic operation.

Returns
Padding mode.

◆ set_BlockSize()

virtual 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 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 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 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 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 void System::Security::Cryptography::SymmetricAlgorithm::set_Mode ( CipherMode  value)
virtual

Sets mode of cryptographic operation.

Parameters
valueCipher mode.

◆ set_Padding()

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

Sets padding of cryptographic operation.

Parameters
valuePadding mode.

◆ ValidKeySize()

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.

Member Data Documentation

◆ m_block_size

int System::Security::Cryptography::SymmetricAlgorithm::m_block_size
protected

Block size.

◆ m_feedback_size

int System::Security::Cryptography::SymmetricAlgorithm::m_feedback_size
protected

Feedback size.

◆ m_iv

System::ArrayPtr<uint8_t> System::Security::Cryptography::SymmetricAlgorithm::m_iv
protected

Initial value.

◆ m_key

System::ArrayPtr<uint8_t> System::Security::Cryptography::SymmetricAlgorithm::m_key
protected

Key.

◆ m_key_size

int System::Security::Cryptography::SymmetricAlgorithm::m_key_size
protected

Key size.

◆ m_legal_block_sizes

std::vector<SharedPtr<KeySizes> > System::Security::Cryptography::SymmetricAlgorithm::m_legal_block_sizes
protected

Allowed block sizes.

◆ m_legal_key_sizes

std::vector<SharedPtr<KeySizes> > System::Security::Cryptography::SymmetricAlgorithm::m_legal_key_sizes
protected

Allowed key sizes.

◆ m_mode

CipherMode System::Security::Cryptography::SymmetricAlgorithm::m_mode
protected

Direction.

◆ m_padding

PaddingMode System::Security::Cryptography::SymmetricAlgorithm::m_padding
protected

Padding.