Class which defines the base concept of a hash algorithm. More...
Inheritance diagram for cl_syoscb_hash_base< HASH_DIGEST_WIDTH >:
Collaboration diagram for cl_syoscb_hash_base< HASH_DIGEST_WIDTH >:
Public Types | |
| typedef bit< HASH_DIGEST_WIDTH-1:0 > | tp_hash_digest |
| Typedef for a bitstream of HASH_DIGEST_WIDTH bits. | |
| typedef bit< HASH_DIGEST_WIDTH-1:0 > | tp_hash_digest |
| Typedef for a bitstream of HASH_DIGEST_WIDTH bits. | |
Public Member Functions | |
| virtual tp_hash_digest | hash (cl_syoscb_item item) |
| Hash API: Hashes a cl_syoscb_item, returning its hash value More... | |
| virtual tp_hash_digest | hash_str (string str) |
| Hash API: Hashes a string, returning its hash value More... | |
Protected Member Functions | |
| virtual tp_hash_digest | do_hash (bit ser []) |
| Hash API: Returns the hash value of the given bitstream. More... | |
Protected Attributes | |
| cl_syoscb_cfg | cfg |
| Handle to the configuration object. | |
| cl_syoscb_hash_packer | packer |
| Handle to a packer suited for this hash algorithm. More... | |
Detailed Description
template<int unsigned HASH_DIGEST_WIDTH = 1>
class cl_syoscb_hash_base< HASH_DIGEST_WIDTH >
Class which defines the base concept of a hash algorithm.
All hash functions must extend this class and implement the hash API.
- Parameters
-
HASH_DIGEST_WIDTH The number of bits in the hash digest for that hashing algorithm
Definition at line 4 of file cl_syoscb_hash_base.svh.
Member Function Documentation
◆ do_hash()
|
protectedvirtual |
Hash API: Returns the hash value of the given bitstream.
The bitstream must comply with the chosen hash algorithm's requirements.
- Parameters
-
ser The bitstream to generate the hash for
- Returns
- The hash of the input bitstream
Reimplemented in cl_syoscb_hash_md5, and cl_syoscb_hash_md5.
Definition at line 54 of file cl_syoscb_hash_base.svh.
Referenced by cl_syoscb_hash_base< pk_syoscb::MD5_HASH_DIGEST_WIDTH >::hash(), and cl_syoscb_hash_base< pk_syoscb::MD5_HASH_DIGEST_WIDTH >::hash_str().
◆ hash()
|
virtual |
Hash API: Hashes a cl_syoscb_item, returning its hash value
- Parameters
-
item The item to hash
- Returns
- The hash value of that string
Definition at line 83 of file cl_syoscb_hash_base.svh.
◆ hash_str()
|
virtual |
Hash API: Hashes a string, returning its hash value
- Parameters
-
str The string to hash
- Returns
- The hash value of that string
Definition at line 62 of file cl_syoscb_hash_base.svh.
Member Data Documentation
◆ packer
|
protected |
Handle to a packer suited for this hash algorithm.
The packer should be set in the implementing class' constructor
Definition at line 16 of file cl_syoscb_hash_base.svh.
Referenced by cl_syoscb_hash_base< pk_syoscb::MD5_HASH_DIGEST_WIDTH >::hash(), and cl_syoscb_hash_base< pk_syoscb::MD5_HASH_DIGEST_WIDTH >::hash_str().
The documentation for this class was generated from the following files:
