Luks.h

/*
 * Copyright (c) [2016-2026] SUSE LLC
 *
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as published
 * by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, contact Novell, Inc.
 *
 * To contact Novell about this file by physical or electronic mail, you may
 * find current contact information at www.novell.com.
 */


#ifndef STORAGE_LUKS_H
#define STORAGE_LUKS_H


#include "storage/Devices/Encryption.h"


namespace storage
{

    class Luks : public Encryption
    {
    public:

        static Luks* create(Devicegraph* devicegraph, const std::string& dm_table_name);

        static Luks* load(Devicegraph* devicegraph, const xmlNode* node);

        static std::vector<Luks*> get_all(Devicegraph* devicegraph);

        static std::vector<const Luks*> get_all(const Devicegraph* devicegraph);

        const std::string& get_uuid() const;

        void set_uuid(const std::string& uuid);

        const std::string& get_label() const;

        void set_label(const std::string& label);

        const std::string& get_format_options() const ST_DEPRECATED;
        void set_format_options(const std::string& format_options) ST_DEPRECATED;

        const std::vector<std::string>& get_format_options_v2() const;

        void set_format_options_v2(const std::vector<std::string>& format_options_v2);

        static void reset_activation_infos();

    public:

        class Impl;

        Impl& get_impl();
        const Impl& get_impl() const;

        virtual Luks* clone() const override;
        virtual std::unique_ptr<Device> clone_v2() const override;

        Luks(Impl* impl);
        ST_NO_SWIG Luks(std::unique_ptr<Device::Impl>&& impl);

    };


    bool is_luks(const Device* device);

    Luks* to_luks(Device* device);

    const Luks* to_luks(const Device* device);

}

#endif