Enigma  3.2.0
A Simple, Reliable and Efficient Encryption Tool
Meta Class Referencefinal

#include <Meta.hpp>

Classes

struct  EnigmaCipherChunk
 
struct  EnigmaFooter
 Encrypted buffer footer. More...
 

Public Types

using magic_t = std::uint64_t
 
using size_type = std::size_t
 

Static Public Member Functions

static bool isEnigmaFile (const fs::path &filename)
 Returns true if the file is encrypted with enigma. More...
 
static bool isEnigmaCipher (const byte *cipher, const std::size_t cipherSize)
 Returns true if the file is encrypted with enigma. More...
 
static bool isEnigmaCipher (const std::vector< byte > &cipher)
 
static void readCipherChunks (const fs::path &filename, const std::function< bool(EnigmaCipherChunk &&)> &callback)
 Read cipher chunks from an Enigma encrypted file. More...
 

Static Public Attributes

static constexpr const magic_t ENIGMA_MAGIC = 0x456e69676d61
 
static constexpr const magic_t ENIGMA_CIPHER_CHUNK_MAGIC = 0x43456e69676d6143
 
static constexpr const size_type ENIGMA_BUFFER_DEFAULT_SIZE = ENIGMA_KB_TO_BYTES(64)
 

Detailed Description

Notes:

Definition at line 19 of file Meta.hpp.

Member Typedef Documentation

◆ magic_t

using Meta::magic_t = std::uint64_t

Definition at line 23 of file Meta.hpp.

◆ size_type

using Meta::size_type = std::size_t

Definition at line 24 of file Meta.hpp.

Member Function Documentation

◆ isEnigmaCipher() [1/2]

static bool Meta::isEnigmaCipher ( const byte *  cipher,
const std::size_t  cipherSize 
)
static

Returns true if the file is encrypted with enigma.

◆ isEnigmaCipher() [2/2]

static bool Meta::isEnigmaCipher ( const std::vector< byte > &  cipher)
static

◆ isEnigmaFile()

static bool Meta::isEnigmaFile ( const fs::path &  filename)
static

Returns true if the file is encrypted with enigma.

◆ readCipherChunks()

static void Meta::readCipherChunks ( const fs::path &  filename,
const std::function< bool(EnigmaCipherChunk &&)> &  callback 
)
static

Read cipher chunks from an Enigma encrypted file.

Member Data Documentation

◆ ENIGMA_BUFFER_DEFAULT_SIZE

constexpr const size_type Meta::ENIGMA_BUFFER_DEFAULT_SIZE = ENIGMA_KB_TO_BYTES(64)
staticconstexpr

Definition at line 27 of file Meta.hpp.

◆ ENIGMA_CIPHER_CHUNK_MAGIC

constexpr const magic_t Meta::ENIGMA_CIPHER_CHUNK_MAGIC = 0x43456e69676d6143
staticconstexpr

Definition at line 26 of file Meta.hpp.

◆ ENIGMA_MAGIC

constexpr const magic_t Meta::ENIGMA_MAGIC = 0x456e69676d61
staticconstexpr

Definition at line 25 of file Meta.hpp.


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