CoreGenerator.h

// Copyright 2021-2022 Software Quality Laboratory, NYCU.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#ifndef S2E_PLUGINS_CRAX_CORE_GENERATOR_H
#define S2E_PLUGINS_CRAX_CORE_GENERATOR_H

#include <s2e/Plugins/CRAX/Techniques/Technique.h>

#include <vector>

namespace s2e::plugins::crax {

// The ExploitGenerator generates the exploit script, whereas a
// CoreGenerator generates the core logic, i.e., main() of the script.
// To add your own core generator, make your class derive from
// CoreGenerator and override `generateMainFunction()`.
class CoreGenerator {
public:
    virtual ~CoreGenerator() = default;

    virtual void generateMainFunction(S2EExecutionState *state,
                                      const std::vector<RopPayload> &ropPayload);

protected:
    void handleStage1(const std::vector<RopPayload> &ropPayload);
    void handleStage2(const std::vector<RopPayload> &ropPayload);
};

}  // namespace s2e::plugins::crax

#endif  // S2E_PLUGINS_CRAX_CORE_GENERATOR_H