summaryrefslogtreecommitdiff
path: root/vmdb/plugins/cryptsetup_plugin.py
blob: be8ea4c77a3026b7ef3456ed4f1eedf85936e925 (plain)
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
# Copyright 2022  Lars Wirzenius
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# 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, see <http://www.gnu.org/licenses/>.
#
# =*= License: GPL-3+ =*=


import os
import shutil
import tempfile

import vmdb


class CryptsetupPlugin(vmdb.Plugin):
    def enable(self):
        self.app.step_runners.add(CryptsetupStepRunner())


class CryptsetupStepRunner(vmdb.StepRunnerInterface):
    def get_key_spec(self):
        return {
            "cryptsetup": str,
            "tag": str,
            "password": "",
            "key-file": "",
            "key-cmd": "",
        }

    def run(self, step, settings, state):
        underlying = values["cryptsetup"]
        crypt_name = values["tag"]
        password = values["password"] or None
        key_file = values["key-file"] or None
        key_cmd = values["key-cmd"] or None

        if not isinstance(underlying, str):
            raise vmdb.NotString("cryptsetup", underlying)

        if not isinstance(crypt_name, str):
            raise vmdb.NotString("cryptsetup: tag", crypt_name)

        if password is None and key_file is None and key_cmd is None:
            raise Exception(
                "cryptsetup step MUST define one of password, key-file, or key-cmd"
            )

        if password is not None and key_file is not None:
            raise Exception(
                "cryptsetup step MUST define only one of password or key-file"
            )

        if password is not None and key_cmd is not None:
            raise Exception(
                "cryptsetup step MUST define only one of password or key-cmd"
            )

        if key_file is not None and key_cmd is not None:
            raise Exception(
                "cryptsetup step MUST define only one of key_file or key-cmd"
            )

        state.tmp_key_file = None
        rmtmp = False

        if password is not None:
            key_file = self._write_temp(password)
            rmtp = True

        if key_cmd is not None:
            output = vmdb.runcmd(["sh", "-ec", key_cmd])
            output = output.decode("UTF-8")
            key = output.splitlines()[0]
            key_file = self._write_temp(key)
            rmtp = True

        assert key_file is not None

        dev = state.tags.get_dev(underlying)
        if dev is None:
            for t in state.tags.get_tags():
                logging.debug(
                    "tag %r dev %r mp %r",
                    t,
                    state.tags.get_dev(t),
                    state.tags.get_builder_mount_point(t),
                )
            assert 0

        vmdb.runcmd(
            [
                "cryptsetup",
                "luksFormat",
                "--batch-mode",
                "--type=luks2",
                "--pbkdf=argon2id",
                "--allow-discards",
                dev,
                key_file,
            ]
        )
        vmdb.runcmd(
            [
                "cryptsetup",
                "open",
                "--key-file",
                key_file,
                dev,
                crypt_name,
            ]
        )

        crypt_dev = "/dev/mapper/{}".format(crypt_name)
        assert os.path.exists(crypt_dev)

        uuid = vmdb.runcmd(["cryptsetup", "luksUUID", device]).decode("UTF8").strip()

        state.tags.append(crypt_name)
        state.tags.set_dev(crypt_name, crypt_dev)
        state.tags.set_luksuuid(name, uuid)
        state.tags.set_dm(name, name)

        vmdb.progress(
            f"LUKS: name={crypt_name} dev={crypt_dev} luksuuid={uuid} dm={crypt_name}"
        )
        vmdb.progress(f"LUKS: {state.tags._tags}")
        vmdb.progress("remembering LUKS device {} as {}".format(crypt_dev, crypt_name))

        if rmtmp:
            os.remove(key_file)

    def _write_temp(self, passord):
        fd, filename = tempfile.mkstemp()
        os.close(fd)
        open(filename, "w").write(password)
        return filename

    def teardown(self, values, settings, state):
        x = state.tmp_key_file
        if x is not None and os.path.exists(x):
            os.remove(x)

        crypt_name = values["name"]

        crypt_dev = "/dev/mapper/{}".format(crypt_name)
        vmdb.runcmd(["cryptsetup", "close", crypt_dev])