pcl::CryptographicHashFactory Class Reference

Selectable cryptographic hashing algorithm. More...

#include <Cryptography.h>

Inheritance diagram for pcl::CryptographicHashFactory:

Public Member Functions
	CryptographicHashFactory (const IsoString &algorithmName)
	~CryptographicHashFactory () override
String	AlgorithmName () const override
size_type	HashLength () const override
void	Initialize () override
void	Update (const void *data, size_type length) override
Public Member Functions inherited from pcl::CryptographicHash
	CryptographicHash ()=default
	CryptographicHash (const CryptographicHash &)=delete
virtual	~CryptographicHash ()
ByteArray	Finalize ()
template<class C >
ByteArray	Hash (const C &data)
ByteArray	Hash (const void *data, size_type length)
void	Hash (uint8 *hash, const void *data, size_type length)
CryptographicHash &	operator= (const CryptographicHash &)=delete
template<class C >
void	UpdateWithContainer (const C &data)

Additional Inherited Members

Detailed Description

CryptographicHashFactory implements a cryptographic hashing algorithm that can be selected upon construction among all of the algorithms implemented in the PixInsight/PCL platform. This currently includes MD-5, SHA-1, SHA-224, SHA-256, SHA-384, and SHA-512.

See also

CryptographicHash, MD5, SHA1, SHA224, SHA256, SHA384, SHA512

Definition at line 655 of file Cryptography.h.

Constructor & Destructor Documentation

CryptographicHashFactory()

pcl::CryptographicHashFactory::CryptographicHashFactory ( const IsoString &  algorithmName )

inline

Constructs a CryptographicHashFactory object to implement the specified hashing algorithm.

Parameters

algorithmName

Name of a supported cryptographic hashing algorithm. Currently this parameter can be one of: "md5", "sha1", "sha224", "sha256", "sha384", and "sha512". Comparisons are performed on trimmed strings and case-insensitive.

If an invalid or unsupported algorithm name is specified, this constructor throws an Error exception.

Definition at line 672 of file Cryptography.h.

References pcl::GenericString< T, R, A >::Hash32().

~CryptographicHashFactory()

pcl::CryptographicHashFactory::~CryptographicHashFactory ( )

inlineoverride

Destroys a CryptographicHashFactory object.

Definition at line 695 of file Cryptography.h.

Member Function Documentation

AlgorithmName()

String pcl::CryptographicHashFactory::AlgorithmName ( ) const

inlineoverridevirtual

Returns the name of this cryptographic hashing algorithm.

Implements pcl::CryptographicHash.

Definition at line 702 of file Cryptography.h.

HashLength()

size_type pcl::CryptographicHashFactory::HashLength ( ) const

inlineoverridevirtual

Returns the length in bytes of a hash sequence (or message digest) calculated with this cryptographic hashing algorithm.

Implements pcl::CryptographicHash.

Definition at line 711 of file Cryptography.h.

Initialize()

void pcl::CryptographicHashFactory::Initialize ( )

inlineoverridevirtual

Initializes this cryptographic hash generator.

Implements pcl::CryptographicHash.

Definition at line 719 of file Cryptography.h.

Update()

void pcl::CryptographicHashFactory::Update ( const void *  data, size_type  length  )

inlineoverridevirtual

Updates the hash generator with a new data chunk of the specified length in bytes.

Implements pcl::CryptographicHash.

Definition at line 728 of file Cryptography.h.

---

The documentation for this class was generated from the following file:

• Cryptography.h