mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-07 18:08:53 +00:00
112 lines
2.7 KiB
C++
112 lines
2.7 KiB
C++
/*
|
|
* Copyright (c) 2014, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*
|
|
*/
|
|
|
|
#include <string>
|
|
|
|
namespace osquery {
|
|
|
|
/**
|
|
* @brief The supported hashing algorithms in osquery
|
|
*
|
|
* These are usually used as a constructor argument to osquery::Hash
|
|
*/
|
|
enum HashType {
|
|
HASH_TYPE_MD5 = 2,
|
|
HASH_TYPE_SHA1 = 4,
|
|
HASH_TYPE_SHA256 = 8,
|
|
};
|
|
|
|
/**
|
|
* @brief Hash is a general utility class for hashing content
|
|
*
|
|
* @code{.cpp}
|
|
* Hash my_hash(HASH_TYPE_SHA256);
|
|
* my_hash.update(my_buffer, my_buffer_size);
|
|
* std::cout << my_hash.digest();
|
|
* @endcode
|
|
*
|
|
*/
|
|
class Hash {
|
|
public:
|
|
/**
|
|
* @brief Hash constructor
|
|
*
|
|
* The hash class should be initialized with one of osquery::HashType as a
|
|
* constructor argument.
|
|
*
|
|
* @param algorithm The hashing algorithm which will be used to compute the
|
|
* hash
|
|
*/
|
|
explicit Hash(HashType algorithm);
|
|
|
|
/**
|
|
* @brief Hash destructor
|
|
*/
|
|
~Hash();
|
|
|
|
/**
|
|
* @brief Update the internal context buffer with additional content
|
|
*
|
|
* This method allows you to chunk up large content so that it doesn't all
|
|
* have to be loaded into memory at the same time
|
|
*
|
|
* @param buffer The buffer to be hashed
|
|
* @param size The size of the buffer to be hashed
|
|
*/
|
|
void update(const void* buffer, size_t size);
|
|
|
|
/**
|
|
* @brief Compute the final hash and return it's result
|
|
*
|
|
* @return The final hash value
|
|
*/
|
|
std::string digest();
|
|
|
|
private:
|
|
/**
|
|
* @brief Private default constructor
|
|
*
|
|
* The osquery::Hash class should only ever be instantiated with a HashType
|
|
*/
|
|
Hash(){};
|
|
|
|
private:
|
|
/// The hashing algorithm which is used to compute the hash
|
|
HashType algorithm_;
|
|
|
|
/// The buffer used to maintain the context and state of the hashing
|
|
/// operations
|
|
void* ctx_;
|
|
|
|
/// The length of the hash to be returned
|
|
size_t length_;
|
|
};
|
|
|
|
/**
|
|
* @brief Compute a hash digest from an already allocated buffer.
|
|
*
|
|
* @param hash_type The osquery-supported hash algorithm.
|
|
* @param buffer A caller-controlled buffer.
|
|
* @param size The length of buffer in bytes.
|
|
* @return A string (hex) representation of the hash digest.
|
|
*/
|
|
std::string hashFromBuffer(HashType hash_type, const void* buffer, size_t size);
|
|
|
|
/**
|
|
* @brief Compute a hash digest from the file content at a path.
|
|
*
|
|
*
|
|
* @param hash_type The osquery-supported hash algorithm.
|
|
* @param path Filesystem path, the hash target.
|
|
* @return A string (hex) representation of the hash digest.
|
|
*/
|
|
std::string hashFromFile(HashType hash_type, const std::string& path);
|
|
}
|