Driver::Crypto Namespace Reference

The 'Crypto' namespace provides a collection of Cryptographic functions and algorithms. More...

Detailed Description

The 'Crypto' namespace provides a collection of Cryptographic functions and algorithms.

The top of the namespace provides abstractions for the core crypto functions. This allows the application to decouple from any specific platform (e.g. MCU with crypto hardware support vs Simulator running on Windoze or Linux)

Namespaces
namespace	Orlp
	The 'Orlp' namespace implements a sub-set of the Crypto interfaces using third-party code from Orson Peters (https://github.com/orlp)
namespace	PasswordHash
	The 'PasswordHash' namespace provides a basic 'algorithm' to hash a password when something like 'bcrypt' is not available.
namespace	TShell
	The 'TShell' namespace provides TShell/Console commands that invoke Crypto functions.

Classes
class	ED25519
	This class implements the Edwards-curve digital signature defined by Edwards-Curve Digital Signature Algorithm (EdDSA) [RFC8032], using standard parameters. More...
class	Hash
	This class defines an abstract interface for a Hashing Algorithms. More...

Functions
DriverCryptoStatus_T	initialize () noexcept
	This method is used to initialize the Crytpo engine.
void	shutdown () noexcept
	This method is used to 'cleanly' shutdown the Crypto engine.
DriverCryptoStatus_T	generateRandom (void *dstBuffer, size_t numBytesToGenerate) noexcept
	This method is used to generate random bytes.

Function Documentation

generateRandom()

DriverCryptoStatus_T Driver::Crypto::generateRandom ( void *  dstBuffer, size_t  numBytesToGenerate  )

noexcept

This method is used to generate random bytes.

'dstBuffer' must be at least 'numBytesToGenerate' in size. Returns DRIVER_CRYPTO_SUCCESS when successful.

Note: How "true" the random generator is platform specific.

initialize()

DriverCryptoStatus_T Driver::Crypto::initialize ( )

noexcept

This method is used to initialize the Crytpo engine.

It must be called before any other Crypto methods.

Returns DRIVER_CRYPTO_SUCCESS when successful

shutdown()

void Driver::Crypto::shutdown ( )

noexcept

This method is used to 'cleanly' shutdown the Crypto engine.