libstorage-ng
Loading...
Searching...
No Matches
Luks.h
1/*
2 * Copyright (c) [2016-2026] SUSE LLC
3 *
4 * All Rights Reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of version 2 of the GNU General Public License as published
8 * by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, contact Novell, Inc.
17 *
18 * To contact Novell about this file by physical or electronic mail, you may
19 * find current contact information at www.novell.com.
20 */
21
22
23#ifndef STORAGE_LUKS_H
24#define STORAGE_LUKS_H
25
26
27#include "storage/Devices/Encryption.h"
28
29
30namespace storage
31{
32
38 class Luks : public Encryption
39 {
40 public:
41
48 static Luks* create(Devicegraph* devicegraph, const std::string& dm_table_name);
49
50 static Luks* load(Devicegraph* devicegraph, const xmlNode* node);
51
55 static std::vector<Luks*> get_all(Devicegraph* devicegraph);
56
60 static std::vector<const Luks*> get_all(const Devicegraph* devicegraph);
61
65 const std::string& get_uuid() const;
66
70 void set_uuid(const std::string& uuid);
71
77 const std::string& get_label() const;
78
84 void set_label(const std::string& label);
85
86 const std::string& get_format_options() const ST_DEPRECATED;
87 void set_format_options(const std::string& format_options) ST_DEPRECATED;
88
92 const std::vector<std::string>& get_format_options_v2() const;
93
102 void set_format_options_v2(const std::vector<std::string>& format_options_v2);
103
110
111 public:
112
113 class Impl;
114
115 Impl& get_impl();
116 const Impl& get_impl() const;
117
118 virtual Luks* clone() const override;
119 virtual std::unique_ptr<Device> clone_v2() const override;
120
121 Luks(Impl* impl);
122 ST_NO_SWIG Luks(std::unique_ptr<Device::Impl>&& impl);
123
124 };
125
126
132 bool is_luks(const Device* device);
133
140 Luks* to_luks(Device* device);
141
145 const Luks* to_luks(const Device* device);
146
147}
148
149#endif
An abstract base class for storage devices.
Definition Device.h:82
The main container of the libstorage-ng.
Definition Devicegraph.h:170
An LUKS encryption layer on a block device.
Definition Luks.h:39
void set_format_options_v2(const std::vector< std::string > &format_options_v2)
Set extra options for luks format call.
static Luks * create(Devicegraph *devicegraph, const std::string &dm_table_name)
Create a device of type Luks.
const std::string & get_label() const
Get the LUKS label.
const std::vector< std::string > & get_format_options_v2() const
Get extra options for luks format call.
static std::vector< Luks * > get_all(Devicegraph *devicegraph)
Get all Lukses.
static std::vector< const Luks * > get_all(const Devicegraph *devicegraph)
Get all Lukses.
static void reset_activation_infos()
The library keeps track of whether the activation of a specific LUKS device was canceled and of the p...
const std::string & get_uuid() const
Get the LUKS UUID.
void set_uuid(const std::string &uuid)
Set the LUKS UUID.
void set_label(const std::string &label)
Set the LUKS label.
The storage namespace.
Definition Actiongraph.h:40
Luks * to_luks(Device *device)
Converts pointer to Device to pointer to Luks.
bool is_luks(const Device *device)
Checks whether device points to a Luks.