libstorage-ng
Luks.h
1 /*
2  * Copyright (c) [2016-2020] 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 
30 namespace storage
31 {
32 
38  class Luks : public Encryption
39  {
40  public:
41 
48  static Luks* create(Devicegraph* devicegraph, const std::string& dm_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 
72  const std::string& get_label() const;
73 
79  void set_label(const std::string& label);
80 
84  const std::string& get_format_options() const;
85 
93  void set_format_options(const std::string& format_options);
94 
95  public:
96 
97  class Impl;
98 
99  Impl& get_impl();
100  const Impl& get_impl() const;
101 
102  virtual Luks* clone() const override;
103 
104  protected:
105 
106  Luks(Impl* impl);
107 
108  };
109 
110 
116  bool is_luks(const Device* device);
117 
124  Luks* to_luks(Device* device);
125 
129  const Luks* to_luks(const Device* device);
130 
131 }
132 
133 #endif
Luks * to_luks(Device *device)
Converts pointer to Device to pointer to Luks.
const std::string & get_uuid() const
Get the LUKS UUID.
const std::string & get_label() const
Get the LUKS label.
An encryption layer on a blk device.
Definition: Encryption.h:45
The main container of the libstorage-ng.
Definition: Devicegraph.h:169
void set_label(const std::string &label)
Set the LUKS label.
An abstract base class for storage devices.
Definition: Device.h:81
static std::vector< Luks * > get_all(Devicegraph *devicegraph)
Get all Lukses.
void set_format_options(const std::string &format_options)
Set extra options for luks format call.
static Luks * create(Devicegraph *devicegraph, const std::string &dm_name)
Create a device of type Luks.
An LUKS encryption layer on a block device.
Definition: Luks.h:38
bool is_luks(const Device *device)
Checks whether device points to a Luks.
const std::string & get_format_options() const
Get extra options for luks format call.
The storage namespace.
Definition: Actiongraph.h:38