Encryption.h

/*
 * Copyright (c) [2016-2020] 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_ENCRYPTION_H
#define STORAGE_ENCRYPTION_H
 
 
#include "storage/Devices/BlkDevice.h"
 
 
namespace storage
{
 
    enum class EncryptionType {
        NONE, TWOFISH, TWOFISH_OLD, TWOFISH256_OLD, LUKS, LUKS1 = LUKS, UNKNOWN, LUKS2, PLAIN
    };
 
 
    // TODO depending on the encryption types supported the Encryption class
    // can be dropped or be abstract
 
 
    class Encryption : public BlkDevice
    {
    public:
 
        static Encryption* create(Devicegraph* devicegraph, const std::string& name);
 
        static Encryption* load(Devicegraph* devicegraph, const xmlNode* node);
 
        EncryptionType get_type() const;
 
        void set_type(EncryptionType type);
 
        const std::string& get_password() const;
 
        void set_password(const std::string& password);
 
        const std::string& get_key_file() const;
 
        void set_key_file(const std::string& key_file);
 
        const std::string& get_cipher() const;
 
        void set_cipher(const std::string& cipher);
 
        unsigned int get_key_size() const;
 
        void set_key_size(unsigned int key_size);
 
        MountByType get_mount_by() const;
 
        void set_mount_by(MountByType mount_by);
 
        void set_default_mount_by();
 
        const std::vector<std::string>& get_crypt_options() const;
 
        void set_crypt_options(const std::vector<std::string>& crypt_options);
 
        bool is_in_etc_crypttab() const;
 
        void set_in_etc_crypttab(bool in_etc_crypttab);
 
        const BlkDevice* get_blk_device() const;
 
        const std::string& get_open_options() const;
 
        void set_open_options(const std::string& open_options);
 
        static std::vector<Encryption*> get_all(Devicegraph* devicegraph);
 
        static std::vector<const Encryption*> get_all(const Devicegraph* devicegraph);
 
    public:
 
        class Impl;
 
        Impl& get_impl();
        const Impl& get_impl() const;
 
        virtual Encryption* clone() const override;
 
    protected:
 
        Encryption(Impl* impl);
 
    };
 
 
    bool is_encryption(const Device* device);
 
    Encryption* to_encryption(Device* device);
 
    const Encryption* to_encryption(const Device* device);
 
}
 
#endif