1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
# luks.py
# Device format classes for anaconda's storage configuration module.
#
# Copyright (C) 2009 Red Hat, Inc.
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# the GNU General Public License v.2, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY expressed or implied, including the implied warranties 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, write to the
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA. Any Red Hat trademarks that are incorporated in the
# source code or documentation are not subject to the GNU General Public
# License and may only be used or replicated with the express permission of
# Red Hat, Inc.
#
# Red Hat Author(s): Dave Lehman <dlehman@redhat.com>
#
import os
from iutil import log_method_call
from ..errors import *
from ..devicelibs import crypto
from . import DeviceFormat, register_device_format
import gettext
_ = lambda x: gettext.ldgettext("anaconda", x)
import logging
log = logging.getLogger("storage")
class LUKS(DeviceFormat):
""" A LUKS device. """
_type = "luks"
_name = "LUKS"
_lockedName = _("Encrypted")
_udevTypes = ["crypto_LUKS"]
_formattable = True # can be formatted
_supported = False # is supported
_linuxNative = True # for clearpart
_packages = ["cryptsetup-luks"] # required packages
def __init__(self, *args, **kwargs):
""" Create a LUKS instance.
Keyword Arguments:
device -- the path to the underlying device
name -- the name of the mapped device
uuid -- this device's UUID
passphrase -- device passphrase (string)
key_file -- path to a file containing a key (string)
cipher -- cipher mode string
key_size -- key size in bits
exists -- indicates whether this is an existing format
"""
log_method_call(self, *args, **kwargs)
DeviceFormat.__init__(self, *args, **kwargs)
self.cipher = kwargs.get("cipher")
self.key_size = kwargs.get("key_size")
self.mapName = kwargs.get("name")
if not self.exists and not self.cipher:
self.cipher = "aes-xts-plain"
if not self.key_size:
# default to the max (512 bits) for aes-xts
self.key_size = 512
# FIXME: these should both be lists, but managing them will be a pain
self.__passphrase = kwargs.get("passphrase")
self._key_file = kwargs.get("key_file")
if not self.mapName and self.exists and self.uuid:
self.mapName = "luks-%s" % self.uuid
elif not self.mapName and self.device:
self.mapName = "luks-%s" % os.path.basename(self.device)
@property
def name(self):
name = self._name
# for existing locked devices, show "Encrypted" instead of LUKS
if self.hasKey or not self.exists:
name = self._name
else:
name = "%s (%s)" % (self._lockedName, self._name)
return name
def _setPassphrase(self, passphrase):
""" Set the passphrase used to access this device. """
self.__passphrase = passphrase
passphrase = property(fset=_setPassphrase)
@property
def hasKey(self):
return (self.__passphrase or
(self._key_file and os.access(self._key_file, os.R_OK)))
@property
def configured(self):
""" To be ready we need a key or passphrase and a map name. """
return self.hasKey and self.mapName
@property
def status(self):
if not self.exists or not self.mapName:
return False
return os.path.exists("/dev/mapper/%s" % self.mapName)
def probe(self):
""" Probe for any missing information about this format.
cipher mode, key size
"""
raise NotImplementedError("probe method not defined for LUKS")
def setup(self, *args, **kwargs):
""" Open, or set up, the format. """
log_method_call(self, device=self.device, mapName=self.mapName,
type=self.type, status=self.status)
if not self.configured:
raise LUKSError("luks device not configured")
if self.status:
return
DeviceFormat.setup(self, *args, **kwargs)
crypto.luks_open(self.device, self.mapName,
passphrase=self.__passphrase,
key_file=self._key_file)
def teardown(self, *args, **kwargs):
""" Close, or tear down, the format. """
log_method_call(self, device=self.device,
type=self.type, status=self.status)
if not self.exists:
raise LUKSError("format has not been created")
if self.status:
log.debug("unmapping %s" % self.mapName)
crypto.luks_close(self.mapName)
def create(self, *args, **kwargs):
""" Create the format. """
log_method_call(self, device=self.device,
type=self.type, status=self.status)
if not self.hasKey:
raise LUKSError("luks device has no key/passphrase")
DeviceFormat.create(self, *args, **kwargs)
crypto.luks_format(self.device,
passphrase=self.__passphrase,
key_file=self._key_file,
cipher=self.cipher,
key_size=self.key_size)
self.uuid = crypto.luks_uuid(self.device)
self.exists = True
self.mapName = "luks-%s" % self.uuid
self.notifyKernel()
def destroy(self, *args, **kwargs):
""" Create the format. """
log_method_call(self, device=self.device,
type=self.type, status=self.status)
self.teardown()
DeviceFormat.destroy(self, *args, **kwargs)
@property
def keyFile(self):
""" Path to key file to be used in /etc/crypttab """
return self._key_file
def addKeyFromFile(self, keyfile):
""" Add a new key from a file.
Add the contents of the specified key file to an available key
slot in the LUKS header.
"""
log_method_call(self, device=self.device,
type=self.type, status=self.status, file=keyfile)
if not self.exists:
raise LUKSError("format has not been created")
crypto.luks_add_key(self.device,
passphrase=self.__passphrase,
key_file=self._key_file,
new_key_file=keyfile)
def addPassphrase(self, passphrase):
""" Add a new passphrase.
Add the specified passphrase to an available key slot in the
LUKS header.
"""
log_method_call(self, device=self.device,
type=self.type, status=self.status)
if not self.exists:
raise LUKSError("format has not been created")
crypto.luks_add_key(self.device,
passphrase=self.__passphrase,
key_file=self._key_file,
new_passphrase=passphrase)
def removeKeyFromFile(self, keyfile):
""" Remove a key contained in a file.
Remove key contained in the specified key file from the LUKS
header.
"""
log_method_call(self, device=self.device,
type=self.type, status=self.status, file=keyfile)
if not self.exists:
raise LUKSError("format has not been created")
crypto.luks_remove_key(self.device,
passphrase=self.__passphrase,
key_file=self._key_file,
del_key_file=keyfile)
def removePassphrase(self, passphrase):
""" Remove the specified passphrase from the LUKS header. """
log_method_call(self, device=self.device,
type=self.type, status=self.status)
if not self.exists:
raise LUKSError("format has not been created")
crypto.luks_remove_key(self.device,
passphrase=self.__passphrase,
key_file=self._key_file,
del_passphrase=passphrase)
register_device_format(LUKS)
|
