Arduino Cryptography Library
Public Member Functions | Static Public Attributes | List of all members
SHA1 Class Reference

SHA-1 hash algorithm. More...

#include <SHA1.h>

Inheritance diagram for SHA1:
Hash

Public Member Functions

 SHA1 ()
 Constructs a SHA-1 hash object.
 
virtual ~SHA1 ()
 Destroys this SHA-1 hash object after clearing sensitive information.
 
size_t hashSize () const
 Size of the hash result from finalize(). More...
 
size_t blockSize () const
 Size of the internal block used by the hash algorithm. More...
 
void reset ()
 Resets the hash ready for a new hashing process. More...
 
void update (const void *data, size_t len)
 Updates the hash with more data. More...
 
void finalize (void *hash, size_t len)
 Finalizes the hashing process and returns the hash. More...
 
void clear ()
 Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing process. More...
 
void resetHMAC (const void *key, size_t keyLen)
 Resets the hash ready for a new HMAC hashing process. More...
 
void finalizeHMAC (const void *key, size_t keyLen, void *hash, size_t hashLen)
 Finalizes the HMAC hashing process and returns the hash. More...
 
- Public Member Functions inherited from Hash
 Hash ()
 Constructs a new hash object.
 
virtual ~Hash ()
 Destroys this hash object. More...
 

Static Public Attributes

static const size_t HASH_SIZE = 20
 Constant for the size of the hash output of SHA1.
 
static const size_t BLOCK_SIZE = 64
 Constant for the block size of SHA1.
 

Additional Inherited Members

- Protected Member Functions inherited from Hash
void formatHMACKey (void *block, const void *key, size_t len, uint8_t pad)
 Formats a HMAC key into a block. More...
 

Detailed Description

SHA-1 hash algorithm.

Reference: http://en.wikipedia.org/wiki/SHA-1

See also
SHA256, SHA384, SHA512

Definition at line 28 of file SHA1.h.

Member Function Documentation

◆ blockSize()

size_t SHA1::blockSize ( ) const
virtual

Size of the internal block used by the hash algorithm.

See also
update(), hashSize()

Implements Hash.

Definition at line 69 of file SHA1.cpp.

◆ clear()

void SHA1::clear ( )
virtual

Clears the hash state, removing all sensitive data, and then resets the hash ready for a new hashing process.

See also
reset()

Implements Hash.

Definition at line 138 of file SHA1.cpp.

◆ finalize()

void SHA1::finalize ( void *  hash,
size_t  len 
)
virtual

Finalizes the hashing process and returns the hash.

Parameters
hashThe buffer to return the hash value in.
lenThe length of the hash buffer, normally hashSize().

If len is less than hashSize(), then the hash value will be truncated to the first len bytes. If len is greater than hashSize(), then the remaining bytes will left unchanged.

If finalize() is called again, then the returned hash value is undefined. Call reset() first to start a new hashing process.

See also
reset(), update(), finalizeHMAC()

Implements Hash.

Definition at line 107 of file SHA1.cpp.

◆ finalizeHMAC()

void SHA1::finalizeHMAC ( const void *  key,
size_t  keyLen,
void *  hash,
size_t  hashLen 
)
virtual

Finalizes the HMAC hashing process and returns the hash.

Parameters
keyPoints to the HMAC key for the hashing process. The contents of this array must be identical to the value passed to resetHMAC().
keyLenSize of the HMAC key in bytes.
hashThe buffer to return the hash value in.
hashLenThe length of the hash buffer, normally hashSize().
See also
resetHMAC(), finalize()

Implements Hash.

Definition at line 151 of file SHA1.cpp.

◆ hashSize()

size_t SHA1::hashSize ( ) const
virtual

Size of the hash result from finalize().

See also
finalize(), blockSize()

Implements Hash.

Definition at line 64 of file SHA1.cpp.

◆ reset()

void SHA1::reset ( )
virtual

Resets the hash ready for a new hashing process.

See also
update(), finalize(), resetHMAC()

Implements Hash.

Definition at line 74 of file SHA1.cpp.

◆ resetHMAC()

void SHA1::resetHMAC ( const void *  key,
size_t  keyLen 
)
virtual

Resets the hash ready for a new HMAC hashing process.

Parameters
keyPoints to the HMAC key for the hashing process.
keyLenSize of the HMAC key in bytes.

The following example computes a HMAC over a series of data blocks with a specific key:

hash.resetHMAC(key, sizeof(key));
hash.update(data1, sizeof(data1));
hash.update(data2, sizeof(data2));
...
hash.update(dataN, sizeof(dataN));
hash.finalizeHMAC(key, sizeof(key), hmac, sizeof(hmac));

The same key must be passed to both resetHMAC() and finalizeHMAC().

See also
finalizeHMAC(), reset()

Implements Hash.

Definition at line 144 of file SHA1.cpp.

◆ update()

void SHA1::update ( const void *  data,
size_t  len 
)
virtual

Updates the hash with more data.

Parameters
dataData to be hashed.
lenNumber of bytes of data to be hashed.

If finalize() has already been called, then the behavior of update() will be undefined. Call reset() first to start a new hashing process.

See also
reset(), finalize()

Implements Hash.

Definition at line 85 of file SHA1.cpp.


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