Crypto++  5.6.4
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
Algorithm Class Reference

Interface for all crypto algorithms. More...

+ Inheritance diagram for Algorithm:

Public Member Functions

 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms. More...
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object. More...
 

Detailed Description

Interface for all crypto algorithms.

Definition at line 495 of file cryptlib.h.

Constructor & Destructor Documentation

◆ Algorithm()

Algorithm::Algorithm ( bool  checkSelfTestStatus = true)

Interface for all crypto algorithms.

Parameters
checkSelfTestStatusdetermines whether the object can proceed if the self tests have not been run or failed. When FIPS 140-2 compliance is enabled and checkSelfTestStatus == true, this constructor throws SelfTestFailure if the self test hasn't been run or fails. FIPS 140-2 compliance is disabled by default. It is only used by certain versions of the library when the library is built as a DLL on Windows. Also see CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2 in config.h.

Definition at line 89 of file cryptlib.cpp.

Member Function Documentation

◆ AlgorithmName()

virtual std::string Algorithm::AlgorithmName ( ) const
inlinevirtual

Provides the name of this algorithm.

Returns
the standard algorithm name The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.
Note
AlgorithmName is not universally implemented yet

Reimplemented in AuthenticatedSymmetricCipher, VMAC_Base, BitBucket, SHA3, RDSEED, RDRAND, Keccak, HMAC< T >, GCM_Base, SignatureVerificationFilter, SignerFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, HashFilter, StreamTransformationFilter, EAX_Base, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, ClassNullRNG, CRC32C, CRC32, CCM_Base, BLAKE2_Base< W, T_64bit >, and Adler32.

Definition at line 518 of file cryptlib.h.


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