libstorage-ng
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
storage::Encryption Class Reference

An encryption layer on a blk device. More...

#include <Encryption.h>

Inheritance diagram for storage::Encryption:
[legend]
Collaboration diagram for storage::Encryption:
[legend]

Public Member Functions

EncryptionType get_type () const
 Get the encryption type.
 
void set_type (EncryptionType type)
 Set the encryption type. More...
 
const std::string & get_password () const
 Get the encryption password.
 
void set_password (const std::string &password)
 Set the encryption password.
 
const std::string & get_key_file () const
 Get the key file.
 
void set_key_file (const std::string &key_file)
 Set the key file. More...
 
const std::string & get_cipher () const
 Get the cipher. More...
 
void set_cipher (const std::string &cipher)
 Set the cipher. More...
 
unsigned int get_key_size () const
 Get the key size in bytes. More...
 
void set_key_size (unsigned int key_size)
 Set the key size in bytes. More...
 
MountByType get_mount_by () const
 Get the mount-by method. More...
 
void set_mount_by (MountByType mount_by)
 Set the mount-by method. More...
 
void set_default_mount_by ()
 Set the mount-by method to the global default, see Storage::get_default_mount_by(). More...
 
const std::vector< std::string > & get_crypt_options () const
 Get options (fourth field) in /etc/crypttab.
 
void set_crypt_options (const std::vector< std::string > &crypt_options)
 Set options (fourth field) in /etc/crypttab.
 
bool is_in_etc_crypttab () const
 Query whether the LUKS device is present (probed devicegraph) or will be present (staging devicegraph) in /etc/crypttab.
 
void set_in_etc_crypttab (bool in_etc_crypttab)
 Set whether the LUKS device will be present in /etc/crypttab.
 
const BlkDeviceget_blk_device () const
 Return underlying blk device.
 
const std::string & get_open_options () const
 Get extra options for open calls.
 
void set_open_options (const std::string &open_options)
 Set extra options for open calls. More...
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
virtual Encryptionclone () const override
 
- Public Member Functions inherited from storage::BlkDevice
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const Regionget_region () const
 
void set_region (const Region &region)
 
unsigned long long get_size () const
 
void set_size (unsigned long long size)
 
std::string get_size_string () const
 Returns the size of the block device as a localised string. More...
 
const Topologyget_topology () const
 Get the topology.
 
void set_topology (const Topology &topology)
 Set the topology. More...
 
bool is_active () const
 
const std::string & get_sysfs_name () const
 
const std::string & get_sysfs_path () const
 
const std::vector< std::string > & get_udev_paths () const
 
const std::vector< std::string > & get_udev_ids () const
 
bool is_usable_as_blk_device () const
 Checks whether the blk device is in general usable as a blk device. More...
 
const std::string & get_dm_table_name () const
 Return device-mapper table name (dm-table-name for short). More...
 
void set_dm_table_name (const std::string &dm_table_name)
 
BlkFilesystemcreate_blk_filesystem (FsType fs_type)
 Creates a block filesystem on the block device. More...
 
bool has_blk_filesystem () const
 
BlkFilesystemget_blk_filesystem ()
 
const BlkFilesystemget_blk_filesystem () const
 
BlkFilesystemcreate_filesystem (FsType fs_type) ST_DEPRECATED
 Creates a block filesystem on the block device. More...
 
bool has_filesystem () const ST_DEPRECATED
 
BlkFilesystemget_filesystem () ST_DEPRECATED
 
const BlkFilesystemget_filesystem () const ST_DEPRECATED
 
Encryptioncreate_encryption (const std::string &dm_name) ST_DEPRECATED
 Creates an encryption device on the blk device. More...
 
Encryptioncreate_encryption (const std::string &dm_name, EncryptionType type)
 Creates an encryption device on the blk device. More...
 
void remove_encryption ()
 Removes an encryption device on the blk device. More...
 
bool has_encryption () const
 
Encryptionget_encryption ()
 
const Encryptionget_encryption () const
 
Bcachecreate_bcache (const std::string &name)
 Creates a Bcache on the blk device. More...
 
bool has_bcache () const
 
Bcacheget_bcache ()
 
const Bcacheget_bcache () const
 
BcacheCsetcreate_bcache_cset ()
 Creates an BcacheCset on the blk device. More...
 
bool has_bcache_cset () const
 
BcacheCsetget_bcache_cset ()
 
const BcacheCsetget_bcache_cset () const
 
std::vector< MountByTypepossible_mount_bys () const
 Returns the possible mount-by methods to reference the block device.
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
- Public Member Functions inherited from storage::Device
sid_t get_sid () const
 
bool operator== (const Device &rhs) const
 
bool operator!= (const Device &rhs) const
 
Devicecopy_to_devicegraph (Devicegraph *devicegraph) const
 Copies the device to the devicegraph. More...
 
bool exists_in_devicegraph (const Devicegraph *devicegraph) const
 Checks if the device exists in the devicegraph.
 
bool exists_in_probed () const
 Checks if the device exists in the probed devicegraph.
 
bool exists_in_staging () const
 Checks if the device exists in the staging devicegraph.
 
bool exists_in_system () const
 Checks if the device exists in the system devicegraph.
 
std::string get_displayname () const
 
ResizeInfo detect_resize_info () const
 Detect the resize info of the device. More...
 
bool has_children () const
 
size_t num_children () const
 
bool has_parents () const
 
size_t num_parents () const
 
std::vector< Device * > get_children ()
 
std::vector< const Device * > get_children () const
 
std::vector< Device * > get_parents ()
 
std::vector< const Device * > get_parents () const
 
std::vector< Device * > get_siblings (bool itself)
 
std::vector< const Device * > get_siblings (bool itself) const
 
std::vector< Device * > get_descendants (bool itself)
 
std::vector< const Device * > get_descendants (bool itself) const
 
std::vector< Device * > get_ancestors (bool itself)
 
std::vector< const Device * > get_ancestors (bool itself) const
 
std::vector< Device * > get_leaves (bool itself)
 
std::vector< const Device * > get_leaves (bool itself) const
 
std::vector< Device * > get_roots (bool itself)
 
std::vector< const Device * > get_roots (bool itself) const
 
std::vector< Holder * > get_in_holders ()
 
std::vector< const Holder * > get_in_holders () const
 
std::vector< Holder * > get_out_holders ()
 
std::vector< const Holder * > get_out_holders () const
 
void remove_descendants ()
 
const std::map< std::string, std::string > & get_userdata () const
 
void set_userdata (const std::map< std::string, std::string > &userdata)
 
std::string get_name_sort_key () const
 Get a sort-key based on the device name. More...
 
Devicegraphget_devicegraph ()
 
const Devicegraphget_devicegraph () const
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
void save (xmlNode *node) const
 

Static Public Member Functions

static Encryptioncreate (Devicegraph *devicegraph, const std::string &name)
 
static Encryptionload (Devicegraph *devicegraph, const xmlNode *node)
 
static std::vector< Encryption * > get_all (Devicegraph *devicegraph)
 
static std::vector< const Encryption * > get_all (const Devicegraph *devicegraph)
 
- Static Public Member Functions inherited from storage::BlkDevice
static std::vector< BlkDevice * > get_all (Devicegraph *devicegraph)
 Get all BlkDevices.
 
static std::vector< const BlkDevice * > get_all (const Devicegraph *devicegraph)
 Get all BlkDevices. More...
 
static BlkDevicefind_by_name (Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name. More...
 
static const BlkDevicefind_by_name (const Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name. More...
 
static BlkDevicefind_by_any_name (Devicegraph *devicegraph, const std::string &name)
 Find a block device by any name including any symbolic links in /dev. More...
 
static const BlkDevicefind_by_any_name (const Devicegraph *devicegraph, const std::string &name)
 Find a block device by any name including any symbolic links in /dev. More...
 
static bool compare_by_dm_table_name (const BlkDevice *lhs, const BlkDevice *rhs)
 Compare (less than) two BlkDevices by DM table name. More...
 
- Static Public Member Functions inherited from storage::Device
static std::vector< Device * > get_all (Devicegraph *devicegraph)
 
static std::vector< const Device * > get_all (const Devicegraph *devicegraph)
 
static bool compare_by_sid (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by sid.
 
static bool compare_by_name (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by name. More...
 

Protected Member Functions

 Encryption (Impl *impl)
 
- Protected Member Functions inherited from storage::BlkDevice
 BlkDevice (Impl *impl)
 
- Protected Member Functions inherited from storage::Device
 Device (Impl *impl)
 
void create (Devicegraph *devicegraph)
 
void load (Devicegraph *devicegraph)
 

Detailed Description

An encryption layer on a blk device.

Member Function Documentation

◆ get_cipher()

const std::string& storage::Encryption::get_cipher ( ) const

Get the cipher.

Currently only supported for LUKS.

◆ get_key_size()

unsigned int storage::Encryption::get_key_size ( ) const

Get the key size in bytes.

Currently only supported for LUKS.

◆ get_mount_by()

MountByType storage::Encryption::get_mount_by ( ) const

Get the mount-by method.

For encrypted devices the mount-by method defines the name used for the second parameter in /etc/crypttab.

◆ set_cipher()

void storage::Encryption::set_cipher ( const std::string &  cipher)

Set the cipher.

If the cipher is empty the default of cryptsetup will be used during creation.

Currently only supported for LUKS.

◆ set_default_mount_by()

void storage::Encryption::set_default_mount_by ( )

Set the mount-by method to the global default, see Storage::get_default_mount_by().

For encrypted devices the mount-by method defines the name used for the second parameter in /etc/crypttab.

◆ set_key_file()

void storage::Encryption::set_key_file ( const std::string &  key_file)

Set the key file.

When accessing the key file the rootprefix is not used.

◆ set_key_size()

void storage::Encryption::set_key_size ( unsigned int  key_size)

Set the key size in bytes.

If the key size is zero the default of cryptsetup will be used during creation.

Currently only supported for LUKS.

◆ set_mount_by()

void storage::Encryption::set_mount_by ( MountByType  mount_by)

Set the mount-by method.

For encrypted devices the mount-by method defines the name used for the second parameter in /etc/crypttab.

◆ set_open_options()

void storage::Encryption::set_open_options ( const std::string &  open_options)

Set extra options for open calls.

The options are injected as-is to the command so must be properly quoted.

◆ set_type()

void storage::Encryption::set_type ( EncryptionType  type)

Set the encryption type.

So far only LUKS1, LUKS2 and PLAIN are allowed but it is not supported to switch between LUKS and PLAIN.


The documentation for this class was generated from the following file: