pass.hpp

Go to the documentation of this file.

// Copyright (c) 2022, _xeroxz
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
 
#pragma once
#include <spdlog/spdlog.h>
#include <decomp/symbol.hpp>
#include <obf/transform/gen.hpp>
 
#define XED_ENCODER
extern "C" {
#include <xed-decode.h>
#include <xed-interface.h>
}
 
/// <summary>
/// this is the main namespace for obfuscation related things.
/// </summary>
namespace theo::obf {
 
/// <summary>
/// the pass_t class is a base clase for all passes made. you must override the
/// pass_t::run virtual function and declare the logic of your pass there.
///
/// in the constructor of your pass you must call the super constructor (the
/// pass_t constructor) and pass it the type of symbol which you are interesting
/// in receiving.
/// </summary>
class pass_t {
 public:
  /// <summary>
  /// the explicit constructor of the pass_t base class.
  /// </summary>
  /// <param name="sym_type">the type of symbol in which the pass will run on.
  /// every symbol passed to the virtual "run" instruction will be of this
  /// type.</param>
  explicit pass_t(decomp::sym_type_t sym_type) : m_sym_type(sym_type){};
 
  /// <summary>
  /// virtual method which must be implimented by the pass that inherits this
  /// class.
  /// </summary>
  /// <param name="sym">a symbol of the same type of m_sym_type.</param>
  virtual void run(decomp::symbol_t* sym) = 0;
 
  /// <summary>
  /// gets the passes symbol type.
  /// </summary>
  /// <returns>the passes symbol type.</returns>
  decomp::sym_type_t sym_type() { return m_sym_type; }
 
 private:
  decomp::sym_type_t m_sym_type;
};
}  // namespace theo::obf