// 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_EXPLOIT_GENERATOR_H
#define S2E_PLUGINS_CRAX_EXPLOIT_GENERATOR_H

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

#include <memory>
#include <string>
#include <vector>

namespace s2e::plugins::crax {

class ExploitGenerator {
public:
    ExploitGenerator();

    // The entry point of the exploit generator.
    void run(S2EExecutionState *state);

    bool generateExploitScript(const std::vector<RopPayload> &ropPayload) const;

    bool generateExploit(const std::vector<uint8_t> &stage1,
                         std::string filename = "stage1.bin") const;

    RopGadgetResolver &getRopGadgetResolver() {
        return m_ropGadgetResolver;
    }

    const RopGadgetResolver &getRopGadgetResolver() const {
        return m_ropGadgetResolver;
    }

private:
    [[nodiscard]]
    bool checkRequirements() const;

    void initialize();

    [[nodiscard]]
    std::vector<RopPayload> buildFullRopPayload();

    [[nodiscard]]
    std::vector<RopPayload> buildStage1RopPayload();

    S2EExecutionState *m_state;
    RopGadgetResolver m_ropGadgetResolver;
    RopPayloadBuilder m_ropPayloadBuilder;
    std::unique_ptr<CoreGenerator> m_coreGenerator;
};

}  // namespace s2e::plugins::crax

#endif  // S2E_PLUGINS_CRAX_EXPLOIT_GENERATOR_H
