File: test_CLI.py

package info (click to toggle)
bmap-tools 3.9.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 760 kB
  • sloc: python: 5,822; sh: 105; makefile: 2
file content (283 lines) | stat: -rw-r--r-- 10,153 bytes parent folder | download
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
# -*- coding: utf-8 -*-
# vim: ts=4 sw=4 tw=88 et ai si
#
# Copyright (c) 2022 Benedikt Wildenhain
# License: GPLv2
# Author: Benedikt Wildenhain <benedikt.wildenhain@hs-bochum.de>
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License, version 2 or any later version,
# as published by the Free Software Foundation.
#
# 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.

import unittest

import os
import subprocess
import sys
import tempfile
import tests.helpers
import shutil
from dataclasses import dataclass


@dataclass
class Key:
    gnupghome: str
    uid: str
    fpr: str = None


testkeys = {
    "correct": Key(None, "correct <foo@bar.org>", None),
    "unknown": Key(None, "unknown <blub@bla.net>", None),
}


class TestCLI(unittest.TestCase):
    def test_valid_signature(self):
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/test.image.bmap.v2.0",
                "--bmap-sig",
                "tests/test-data/signatures/test.image.bmap.v2.0correct.det.asc",
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
        )
        self.assertEqual(completed_process.returncode, 0)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(
            b"successfully verified bmap file signature", completed_process.stderr
        )

    def test_valid_signature_fingerprint(self):
        assert testkeys["correct"].fpr is not None
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/signatures/test.image.bmap.v2.0correct.asc",
                "--fingerprint",
                testkeys["correct"].fpr,
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
        )
        self.assertEqual(completed_process.returncode, 0)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(
            b"successfully verified bmap file signature", completed_process.stderr
        )

    def test_valid_signature_fingerprint_keyring(self):
        assert testkeys["correct"].fpr is not None
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/signatures/test.image.bmap.v2.0correct.asc",
                "--fingerprint",
                testkeys["correct"].fpr,
                "--keyring",
                testkeys["correct"].gnupghome + ".keyring",
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
            # should work without GNUPGHOME set because we supply --keyring
            env={k: v for k, v in os.environ.items() if k != "GNUPGHOME"},
        )
        self.assertEqual(completed_process.returncode, 0)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(
            b"successfully verified bmap file signature", completed_process.stderr
        )

    def test_unknown_signer(self):
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/test.image.bmap.v2.0",
                "--bmap-sig",
                "tests/test-data/signatures/test.image.bmap.v2.0unknown.det.asc",
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
        )
        self.assertEqual(completed_process.returncode, 1)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(b"discovered a BAD GPG signature", completed_process.stderr)

    def test_wrong_signature(self):
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/test.image.bmap.v1.4",
                "--bmap-sig",
                "tests/test-data/signatures/test.image.bmap.v2.0correct.det.asc",
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
        )
        self.assertEqual(completed_process.returncode, 1)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(b"discovered a BAD GPG signature", completed_process.stderr)

    def test_wrong_signature_unknown_signer(self):
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/test.image.bmap.v1.4",
                "--bmap-sig",
                "tests/test-data/signatures/test.image.bmap.v2.0unknown.det.asc",
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
        )
        self.assertEqual(completed_process.returncode, 1)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(b"discovered a BAD GPG signature", completed_process.stderr)

    def test_clearsign(self):
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/signatures/test.image.bmap.v2.0correct.asc",
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
        )
        self.assertEqual(completed_process.returncode, 0)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(
            b"successfully verified bmap file signature", completed_process.stderr
        )

    def test_fingerprint_without_signature(self):
        assert testkeys["correct"].fpr is not None
        completed_process = subprocess.run(
            [
                "bmaptool",
                "copy",
                "--bmap",
                "tests/test-data/test.image.bmap.v2.0",
                "--fingerprint",
                testkeys["correct"].fpr,
                "tests/test-data/test.image.gz",
                self.tmpfile,
            ],
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            check=False,
        )
        self.assertEqual(completed_process.returncode, 1)
        self.assertEqual(completed_process.stdout, b"")
        self.assertIn(
            b"no signature found but --fingerprint given", completed_process.stderr
        )

    def setUp(self):
        try:
            import gpg
        except ImportError:
            self.skipTest("python module 'gpg' missing")

        os.makedirs("tests/test-data/signatures", exist_ok=True)
        for key in testkeys.values():
            assert key.gnupghome is None
            key.gnupghome = tempfile.mkdtemp(prefix="bmaptool")
            context = gpg.Context(home_dir=key.gnupghome)
            dmkey = context.create_key(
                key.uid,
                algorithm="rsa3072",
                expires_in=31536000,
                sign=True,
                certify=True,
            )
            key.fpr = dmkey.fpr
            for bmapv in ["2.0", "1.4"]:
                testp = "tests/test-data"
                imbn = "test.image.bmap.v"
                with open(f"{testp}/{imbn}{bmapv}", "rb") as bmapf:
                    bmapcontent = bmapf.read()
                    with open(
                        f"{testp}/signatures/{imbn}{bmapv}{key.uid.split()[0]}.asc",
                        "wb",
                    ) as sigf:
                        signed_data, result = context.sign(
                            bmapcontent, mode=gpg.constants.sig.mode.CLEAR
                        )
                        sigf.write(signed_data)
                        plaintext, sigs = context.verify(signed_data, None)
                    with open(
                        f"{testp}/signatures/{imbn}{bmapv}{key.uid.split()[0]}.det.asc",
                        "wb",
                    ) as detsigf:
                        signed_data, result = context.sign(
                            bmapcontent, mode=gpg.constants.sig.mode.DETACH
                        )
                        detsigf.write(signed_data)
            # the file supplied to gpgv via --keyring must not be armored
            context.armor = False
            with open(f"{key.gnupghome}.keyring", "wb") as f:
                f.write(context.key_export_minimal())

        self.tmpfile = tempfile.mkstemp(prefix="testfile_", dir=".")[1]
        os.environ["GNUPGHOME"] = testkeys["correct"].gnupghome

    def tearDown(self):
        os.unlink(self.tmpfile)
        for key in testkeys.values():
            shutil.rmtree(key.gnupghome)
            os.unlink(f"{key.gnupghome}.keyring")
            key.gnupghome = None
            for bmapv in ["2.0", "1.4"]:
                testp = "tests/test-data"
                imbn = "test.image.bmap.v"
                os.unlink(f"{testp}/signatures/{imbn}{bmapv}{key.uid.split()[0]}.asc")
                os.unlink(
                    f"{testp}/signatures/{imbn}{bmapv}{key.uid.split()[0]}.det.asc"
                )
        os.rmdir("tests/test-data/signatures")


if __name__ == "__main__":
    unittest.main()