mirror of
https://github.com/nasa/fprime.git
synced 2025-12-10 17:47:10 -06:00
ec08d43dd3
* NATIVE_INT_TYPE use in toString * NATIVE_INT_TYPE use in SimpleObjRegistry * NATIVE_INT_TYPE use in Asserts * NATIVE_INT_TYPE use in Fw/Comp * NATIVE_INT_TYPE use in getCapacity * NATIVE_INT_TYPE use in getEntries * NATIVE_INT_TYPE use in size/length * NATIVE_INT_TYPE use in FILE_NAME_ARG * NATIVE_INT_TYPE use in Fw (misc) * NATIVE_INT_TYPE use in identifier * NATIVE_INT_TYPE use in Fw (misc II) * POINTER_CAST in Buffer * POINTER_CAST in Serializable * sp * Removing no longer used DefaultTypes.hpp * Fixes to accomidate Fw refactor * Unit-test and CI fixes * Fixing review comments - pt 1
121 lines
3.2 KiB
C++
121 lines
3.2 KiB
C++
// ======================================================================
|
|
// \title Hash.hpp
|
|
// \author dinkel
|
|
// \brief hpp file for Hash class
|
|
//
|
|
// \copyright
|
|
// Copyright 2009-2015, by the California Institute of Technology.
|
|
// ALL RIGHTS RESERVED. United States Government Sponsorship
|
|
// acknowledged.
|
|
//
|
|
// ======================================================================
|
|
|
|
#ifndef UTILS_HASH_HPP
|
|
#define UTILS_HASH_HPP
|
|
|
|
#include "Fw/Types/StringType.hpp"
|
|
#include <Utils/Hash/HashBuffer.hpp>
|
|
|
|
namespace Utils {
|
|
|
|
//! \class Hash
|
|
//! \brief A generic interface for creating and comparing hash values
|
|
//!
|
|
class Hash {
|
|
|
|
public:
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Construction and destruction
|
|
// ----------------------------------------------------------------------
|
|
|
|
//! Construct a Hash object
|
|
//!
|
|
Hash();
|
|
|
|
//! Destroy a Hash object
|
|
//!
|
|
~Hash();
|
|
|
|
public:
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Public static methods
|
|
// ----------------------------------------------------------------------
|
|
|
|
//! Create a hash value all at once from raw data
|
|
//! \param data: pointer to start of data
|
|
//! \param len: length of the data
|
|
//! \param buffer: filled with resulting hash value
|
|
static void hash(
|
|
const void *data,
|
|
const FwSizeType len,
|
|
HashBuffer& buffer
|
|
);
|
|
|
|
public:
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Public instance methods
|
|
// ----------------------------------------------------------------------
|
|
|
|
//! Initialize a Hash object for incremental hash computation
|
|
//!
|
|
void init();
|
|
|
|
//! Set hash value to specified value
|
|
//!
|
|
void setHashValue(
|
|
HashBuffer &value //! Hash value
|
|
);
|
|
|
|
//! Update an incremental computation with new data
|
|
//! \param data: pointer to start of data to add to hash calculation
|
|
//! \param len: length of data to add to hash calculation
|
|
void update(
|
|
const void *const data,
|
|
const FwSizeType len
|
|
);
|
|
|
|
//! Finalize an incremental computation and return the result
|
|
//!
|
|
void final(
|
|
HashBuffer& buffer //! The result
|
|
);
|
|
|
|
//! Finalize an incremental computation and return the result
|
|
//!
|
|
void final(U32 &hashvalue);
|
|
|
|
//! Get the file extension for the supported hash type
|
|
//! E.g., could return "SHA256"
|
|
//!
|
|
static const char* getFileExtensionString();
|
|
|
|
//! Add the extension for the supported hash type
|
|
//!
|
|
static void addFileExtension(
|
|
const Fw::StringBase& baseName, //!< The base name
|
|
Fw::StringBase& extendedName //!< The extended name
|
|
);
|
|
|
|
//! Get the length of the file extension string
|
|
//!
|
|
static FwSizeType getFileExtensionLength();
|
|
|
|
private:
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Private member variables
|
|
// ----------------------------------------------------------------------
|
|
|
|
//! The hash handle
|
|
//!
|
|
HASH_HANDLE_TYPE hash_handle;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|