cipher_candidate.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
//
// 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.
 
#pragma once
 
#include "hal_core/netlist/boolean_function.h"
#include "hal_core/utilities/result.h"
#include "hawkeye/candidate_search.h"
#include "hawkeye/sbox_database.h"
 
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
 
namespace hal
{
    class Gate;
    class Module;
    class Net;
    class Netlist;
 
    namespace graph_algorithm
    {
        class NetlistGraph;
    }
 
    namespace hawkeye
    {
        enum class SBoxStatus
        {
            unidentified, 
            identified,   
            superseded,   
        };
 
        struct SBox
        {
            std::vector<Gate*> component;
 
            std::vector<Gate*> input_gates;
 
            std::vector<Gate*> output_gates;
 
            std::string identified_as;
 
            SBoxStatus status = SBoxStatus::unidentified;
 
            std::vector<Gate*> get_combinational_gates() const;
        };
 
        class CipherCandidate
        {
        public:
            CipherCandidate() = default;
            ~CipherCandidate() = default;
 
            explicit CipherCandidate(const std::set<Gate*>& round_reg);
 
            CipherCandidate(const std::set<Gate*>& in_reg, const std::set<Gate*>& out_reg);
 
            CipherCandidate(CipherCandidate&&) = default;
            CipherCandidate& operator=(CipherCandidate&&) = default;
 
            CipherCandidate(const CipherCandidate&) = delete;
            CipherCandidate& operator=(const CipherCandidate&) = delete;
 
            static Result<std::vector<CipherCandidate>>
                detect(Netlist* nl, const std::vector<DetectionConfiguration>& configs, u32 min_state_size = 40, const std::vector<Gate*>& start_ffs = {});
 
            Result<std::monostate> build_round_function();
 
            Result<std::vector<SBox*>> locate_sboxes();
 
            void clear_sboxes();
 
            Result<u32> identify_sboxes(const SBoxDatabase& db);
 
            Result<std::string> identify_sbox(const SBox* sbox, const SBoxDatabase& db) const;
 
            static Result<std::string> identify_sbox(const std::vector<BooleanFunction>& output_functions, const SBoxDatabase& db);
 
            Result<Module*> create_modules();
 
            Netlist* get_netlist() const;
 
            u32 get_size() const;
 
            bool is_round_based() const;
 
            bool has_round_function() const;
 
            const std::vector<Gate*>& get_input_reg() const;
 
            const std::vector<Gate*>& get_output_reg() const;
 
            const std::vector<Gate*>& get_round_logic() const;
 
            std::vector<Gate*> get_gates() const;
 
            std::vector<SBox*> get_sboxes() const;
 
            graph_algorithm::NetlistGraph* get_graph() const;
 
            const std::set<Net*>& get_state_inputs() const;
 
            const std::set<Net*>& get_control_inputs() const;
 
            const std::set<Net*>& get_other_inputs() const;
 
            const std::set<Net*>& get_state_outputs() const;
 
            const std::map<Gate*, std::set<Gate*>>& get_input_ffs_of_gate() const;
 
            const std::map<u32, std::set<Gate*>>& get_longest_distance_to_gate() const;
 
            bool operator<(const CipherCandidate& rhs) const;
 
            bool operator==(const CipherCandidate& rhs) const;
 
        private:
            Netlist* m_netlist = nullptr;
 
            u32 m_size = 0;
 
            bool m_is_round_based = false;
 
            std::vector<Gate*> m_in_reg;
 
            std::vector<Gate*> m_out_reg;
 
            std::vector<u32> m_in_reg_ids, m_out_reg_ids;
 
            std::vector<Gate*> m_round_logic;
 
            std::unique_ptr<graph_algorithm::NetlistGraph> m_graph;
 
            std::set<Net*> m_state_inputs, m_state_outputs, m_control_inputs, m_other_inputs;
 
            mutable std::map<Gate*, std::set<Gate*>> m_input_ffs_of_gate;
            mutable std::map<u32, std::set<Gate*>> m_longest_distance_to_gate;
 
            mutable bool m_has_gate_dependencies = false;
 
            void compute_gate_dependencies() const;
 
            std::vector<std::unique_ptr<SBox>> m_sboxes;
 
            bool m_has_round_function = false;
        };
    }    // namespace hawkeye
}    // namespace hal