Struct capsules_extra::hmac_sha256::HmacSha256Software

pub struct HmacSha256Software<'a, S: Sha256 + DigestDataHash<'a, 32>> { /* private fields */ }

Implementations

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> HmacSha256Software<'a, S>

pub fn new( sha256: &'a S, data_buffer: &'static mut [u8], verify_buffer: &'static mut [u8; 32], ) -> Self

Trait Implementations

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> ClientData<32> for HmacSha256Software<'a, S>

fn add_data_done( &self, result: Result<(), ErrorCode>, data: SubSlice<'static, u8>, )

Called when the data has been added to the digest. data is the SubSlice passed in the call to add_data, whose active slice contains the data that was not added. On Ok, data has an active slice of size zero (all data was added). Valid ErrorCode values are:

fn add_mut_data_done( &self, result: Result<(), ErrorCode>, data: SubSliceMut<'static, u8>, )

Called when the data has been added to the digest. data is the SubSliceMut passed in the call to add_mut_data, whose active slice contains the data that was not added. On Ok, data has an active slice of size zero (all data was added). Valid ErrorCode values are:

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> ClientHash<32> for HmacSha256Software<'a, S>

fn hash_done( &self, result: Result<(), ErrorCode>, digest: &'static mut [u8; 32], )

Called when a digest is computed. digest is the same reference passed to run() to store the hash value. If result is Ok, digest stores the computed hash. If result is Err, the data stored in digest is undefined and may have any value. Valid ErrorCode values are:

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> ClientVerify<32> for HmacSha256Software<'a, S>

fn verification_done( &self, _result: Result<bool, ErrorCode>, _compare: &'static mut [u8; 32], )

Called when a verification is computed. compare is the reference supplied to verify() and the data stored in compare is unchanged. On Ok the bool indicates if the computed hash matches the value in compare. Valid ErrorCode values are:

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> Digest<'a, 32> for HmacSha256Software<'a, S>

fn set_client(&'a self, client: &'a dyn Client<32>)

Set the client instance which will receive hash_done(), add_data_done() and verification_done() callbacks.

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> DigestData<'a, 32> for HmacSha256Software<'a, S>

fn add_data( &self, data: SubSlice<'static, u8>, ) -> Result<(), (ErrorCode, SubSlice<'static, u8>)>

Add data to the input of the hash function/digest. Ok indicates all of the active bytes in data will be added. There is no guarantee the data has been added to the digest until the add_data_done() callback is called. On error the cause of the error is returned along with the SubSlice unchanged (it has the same range of active bytes as the call). Valid ErrorCode values are:

fn add_mut_data( &self, data: SubSliceMut<'static, u8>, ) -> Result<(), (ErrorCode, SubSliceMut<'static, u8>)>

Add data to the input of the hash function/digest. Ok indicates all of the active bytes in data will be added. There is no guarantee the data has been added to the digest until the add_mut_data_done() callback is called. On error the cause of the error is returned along with the SubSlice unchanged (it has the same range of active bytes as the call). Valid ErrorCode values are:

fn clear_data(&self)

Clear the keys and any other internal state. Any pending operations terminate and issue a callback with an ErrorCode::CANCEL. This call does not clear buffers passed through add_mut_data, those are up to the client clear.

fn set_data_client(&'a self, _client: &'a dyn ClientData<32>)

Set the client instance which will handle the add_data_done and add_mut_data_done callbacks.

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> DigestDataHash<'a, 32> for HmacSha256Software<'a, S>

fn set_client(&'a self, _client: &'a dyn ClientDataHash<32>)

Set the client instance which will receive hash_done() and add_data_done() callbacks.

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> DigestHash<'a, 32> for HmacSha256Software<'a, S>

fn run( &'a self, digest: &'static mut [u8; 32], ) -> Result<(), (ErrorCode, &'static mut [u8; 32])>

Compute a digest of all of the data added with add_data and add_data_mut, storing the computed value in digest. The computed value is returned in a hash_done callback. On error the return value will contain a return code and the slice passed in digest. Valid ErrorCode values are:

fn set_hash_client(&'a self, _client: &'a dyn ClientHash<32>)

Set the client instance which will receive the hash_done() callback.

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> DigestVerify<'a, 32> for HmacSha256Software<'a, S>

fn verify( &'a self, compare: &'static mut [u8; 32], ) -> Result<(), (ErrorCode, &'static mut [u8; 32])>

Compute a digest of all of the data added with add_data and add_data_mut then compare it with value in compare. The compare value is returned in a verification_done callback, along with a boolean indicating whether it matches the computed value. On error the return value will contain a return code and the slice passed in compare. Valid ErrorCode values are:

fn set_verify_client(&'a self, _client: &'a dyn ClientVerify<32>)

Set the client instance which will receive the verification_done() callback.

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> HmacSha256 for HmacSha256Software<'a, S>

fn set_mode_hmacsha256(&self, key: &[u8]) -> Result<(), ErrorCode>

Call before adding data to perform HMACSha256

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> HmacSha384 for HmacSha256Software<'a, S>

fn set_mode_hmacsha384(&self, _key: &[u8]) -> Result<(), ErrorCode>

Call before adding data to perform HMACSha384

impl<'a, S: Sha256 + DigestDataHash<'a, 32>> HmacSha512 for HmacSha256Software<'a, S>

fn set_mode_hmacsha512(&self, _key: &[u8]) -> Result<(), ErrorCode>

Call before adding data to perform HMACSha512