Asposecpplib

Base class for hashing 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...

Inherits System::Security::Cryptography::ICryptoTransform.

Inherited by System::Security::Cryptography::HMAC, System::Security::Cryptography::HMACSHA1, System::Security::Cryptography::HMACSHA512, System::Security::Cryptography::MD5, System::Security::Cryptography::SHA1, System::Security::Cryptography::SHA256, System::Security::Cryptography::SHA384, and System::Security::Cryptography::SHA512.

Public Member Functions

virtual ~HashAlgorithm ()
 Destructor. More...
 
ArrayPtr< uint8_t > ComputeHash (const ArrayPtr< uint8_t > &buffer)
 Hashes buffer. More...
 
ArrayPtr< uint8_t > ComputeHash (const ArrayPtr< uint8_t > &buffer, int offset, int count)
 Hashes buffer slice. More...
 
ArrayPtr< uint8_t > ComputeHash (SharedPtr< IO::Stream > const &inputStream)
 Reads stream until end and calculates hash for the data read. More...
 
virtual void Initialize ()
 Resets hasher into initial state. More...
 
virtual ArrayPtr< uint8_t > get_Hash ()
 Gets value of calculated hash code. More...
 
virtual int get_HashSize ()
 Gets size of calculated hash value in bytes. More...
 
int TransformBlock (ArrayPtr< uint8_t > inputBuffer, int inputOffset, int inputCount, ArrayPtr< uint8_t > outputBuffer, int outputOffset) override
 Processes block of data and copies data to output array. More...
 
ArrayPtr< uint8_t > TransformFinalBlock (ArrayPtr< uint8_t > inputBuffer, int inputOffset, int inputCount) override
 Processes last block of data and calculates hash. More...
 
int get_InputBlockSize () override
 Input block size. More...
 
int get_OutputBlockSize () override
 Output block size. 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< HashAlgorithmCreate (const String &hashName)
 Creates hash algorithm based on name. 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

 HashAlgorithm ()
 Constructor. More...
 
 HashAlgorithm (std::unique_ptr< Botan::HashFunction > hash_function)
 Constructor. More...
 
virtual void HashCore (System::ArrayPtr< uint8_t > array, int32_t ibStart, int32_t cbSize)
 Passes data which is written into the object to the actual hash algorithm. More...
 
virtual System::ArrayPtr< uint8_t > HashFinal ()
 Finishes hash calculation. More...
 

Protected Attributes

int HashSizeValue
 Size of computed hash code, in bits. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

Base class for hashing 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

◆ ~HashAlgorithm()

virtual System::Security::Cryptography::HashAlgorithm::~HashAlgorithm ( )
virtual

Destructor.

◆ HashAlgorithm() [1/2]

System::Security::Cryptography::HashAlgorithm::HashAlgorithm ( )
protected

Constructor.

◆ HashAlgorithm() [2/2]

System::Security::Cryptography::HashAlgorithm::HashAlgorithm ( std::unique_ptr< Botan::HashFunction >  hash_function)
protected

Constructor.

Parameters
hash_functionHash function to use.

Member Function Documentation

◆ ComputeHash() [1/3]

ArrayPtr<uint8_t> System::Security::Cryptography::HashAlgorithm::ComputeHash ( const ArrayPtr< uint8_t > &  buffer)

Hashes buffer.

Parameters
bufferSource buffer.
Returns
Calculated hash value.

◆ ComputeHash() [2/3]

ArrayPtr<uint8_t> System::Security::Cryptography::HashAlgorithm::ComputeHash ( const ArrayPtr< uint8_t > &  buffer,
int  offset,
int  count 
)

Hashes buffer slice.

Parameters
bufferSource buffer.
offsetOffset in the source buffer.
countNumber of bytes to use from the source buffer.
Returns
Calculated hash value.

◆ ComputeHash() [3/3]

ArrayPtr<uint8_t> System::Security::Cryptography::HashAlgorithm::ComputeHash ( SharedPtr< IO::Stream > const &  inputStream)

Reads stream until end and calculates hash for the data read.

Parameters
inputStreamStream to read data from.
Returns
Calculated hash value for the whole stream data.

◆ Create()

static SharedPtr<HashAlgorithm> System::Security::Cryptography::HashAlgorithm::Create ( const String hashName)
static

Creates hash algorithm based on name.

Parameters
hashNameOne of the following values: "MD5", "SHA1", "SHA256", "SHA384", "SHA512" or any of them with "System.Security.Cryptography." prefix.

◆ get_Hash()

virtual ArrayPtr<uint8_t> System::Security::Cryptography::HashAlgorithm::get_Hash ( )
virtual

Gets value of calculated hash code.

Returns
Hash code value.

◆ get_HashSize()

virtual int System::Security::Cryptography::HashAlgorithm::get_HashSize ( )
virtual

Gets size of calculated hash value in bytes.

Returns
Number of bytes in calculated hash value.

◆ get_InputBlockSize()

int System::Security::Cryptography::HashAlgorithm::get_InputBlockSize ( )
overridevirtual

Input block size.

Returns
Number of bytes in input block.

Implements System::Security::Cryptography::ICryptoTransform.

◆ get_OutputBlockSize()

int System::Security::Cryptography::HashAlgorithm::get_OutputBlockSize ( )
overridevirtual

Output block size.

Returns
Number of bytes in output block.

Implements System::Security::Cryptography::ICryptoTransform.

◆ HashCore()

virtual void System::Security::Cryptography::HashAlgorithm::HashCore ( System::ArrayPtr< uint8_t >  array,
int32_t  ibStart,
int32_t  cbSize 
)
protectedvirtual

Passes data which is written into the object to the actual hash algorithm.

Parameters
arrayData to pass to hash algorithm.
ibStartData offset.
cbSizeData size.

◆ HashFinal()

virtual System::ArrayPtr<uint8_t> System::Security::Cryptography::HashAlgorithm::HashFinal ( )
protectedvirtual

Finishes hash calculation.

Returns
Hash code calculated by algorithm.

◆ Initialize()

virtual void System::Security::Cryptography::HashAlgorithm::Initialize ( )
virtual

Resets hasher into initial state.

◆ TransformBlock()

int System::Security::Cryptography::HashAlgorithm::TransformBlock ( ArrayPtr< uint8_t >  inputBuffer,
int  inputOffset,
int  inputCount,
ArrayPtr< uint8_t >  outputBuffer,
int  outputOffset 
)
overridevirtual

Processes block of data and copies data to output array.

Parameters
inputBufferBuffer to read data from.
inputOffsetInput buffer offset.
inputCountNumber of bytes to process.
outputBufferOutput buffer to copy data into; nullptr to do no copying.
outputOffsetOutput buffer offset.
Returns
Number of bytes written.

Implements System::Security::Cryptography::ICryptoTransform.

◆ TransformFinalBlock()

ArrayPtr<uint8_t> System::Security::Cryptography::HashAlgorithm::TransformFinalBlock ( ArrayPtr< uint8_t >  inputBuffer,
int  inputOffset,
int  inputCount 
)
overridevirtual

Processes last block of data and calculates hash.

Parameters
inputBufferBuffer to read data from.
inputOffsetInput buffer offset.
inputCountNumber of bytes to process.
Returns
Hash calculated for the whole data sequence.

Implements System::Security::Cryptography::ICryptoTransform.

Member Data Documentation

◆ HashSizeValue

int System::Security::Cryptography::HashAlgorithm::HashSizeValue
protected

Size of computed hash code, in bits.