/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/gpg.py

  • Committer: Jelmer Vernooij
  • Date: 2018-03-10 13:18:10 UTC
  • mto: This revision was merged to the branch mainline in revision 6893.
  • Revision ID: jelmer@jelmer.uk-20180310131810-iiblggbkb757eopm
Avoid call to has_id.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/gpg.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009, 2011, 2012, 2013, 2016 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
17
17
 
18
18
"""GPG signing and checking logic."""
19
19
 
 
20
from __future__ import absolute_import
 
21
 
20
22
import os
21
23
import sys
22
24
 
23
 
from bzrlib.lazy_import import lazy_import
 
25
from breezy.lazy_import import lazy_import
24
26
lazy_import(globals(), """
25
27
import errno
26
28
import subprocess
27
29
 
28
 
from bzrlib import (
29
 
    errors,
 
30
from breezy import (
 
31
    config,
30
32
    trace,
31
33
    ui,
32
34
    )
 
35
from breezy.i18n import (
 
36
    gettext,
 
37
    ngettext,
 
38
    )
33
39
""")
34
40
 
 
41
from . import (
 
42
    errors,
 
43
    )
 
44
from .sixish import (
 
45
    BytesIO,
 
46
    )
 
47
 
 
48
#verification results
 
49
SIGNATURE_VALID = 0
 
50
SIGNATURE_KEY_MISSING = 1
 
51
SIGNATURE_NOT_VALID = 2
 
52
SIGNATURE_NOT_SIGNED = 3
 
53
SIGNATURE_EXPIRED = 4
 
54
 
 
55
 
 
56
class GpgNotInstalled(errors.DependencyNotPresent):
 
57
 
 
58
    _fmt = 'python-gpg is not installed, it is needed to verify signatures'
 
59
 
 
60
    def __init__(self, error):
 
61
        errors.DependencyNotPresent.__init__(self, 'gpg', error)
 
62
 
 
63
 
 
64
class SigningFailed(errors.BzrError):
 
65
 
 
66
    _fmt = 'Failed to GPG sign data: "%(error)s"'
 
67
 
 
68
    def __init__(self, error):
 
69
        errors.BzrError.__init__(self, error=error)
 
70
 
 
71
 
 
72
class SignatureVerificationFailed(errors.BzrError):
 
73
 
 
74
    _fmt = 'Failed to verify GPG signature data with error "%(error)s"'
 
75
 
 
76
    def __init__(self, error):
 
77
        errors.BzrError.__init__(self, error=error)
 
78
 
 
79
 
 
80
def bulk_verify_signatures(repository, revids, strategy,
 
81
        process_events_callback=None):
 
82
    """Do verifications on a set of revisions
 
83
 
 
84
    :param repository: repository object
 
85
    :param revids: list of revision ids to verify
 
86
    :param strategy: GPG strategy to use
 
87
    :param process_events_callback: method to call for GUI frontends that
 
88
        want to keep their UI refreshed
 
89
 
 
90
    :return: count dictionary of results of each type,
 
91
             result list for each revision,
 
92
             boolean True if all results are verified successfully
 
93
    """
 
94
    count = {SIGNATURE_VALID: 0,
 
95
             SIGNATURE_KEY_MISSING: 0,
 
96
             SIGNATURE_NOT_VALID: 0,
 
97
             SIGNATURE_NOT_SIGNED: 0,
 
98
             SIGNATURE_EXPIRED: 0}
 
99
    result = []
 
100
    all_verifiable = True
 
101
    total = len(revids)
 
102
    with ui.ui_factory.nested_progress_bar() as pb:
 
103
        for i, (rev_id, verification_result, uid) in enumerate(
 
104
                repository.verify_revision_signatures(
 
105
                    revids, strategy)):
 
106
            pb.update("verifying signatures", i, total)
 
107
            result.append([rev_id, verification_result, uid])
 
108
            count[verification_result] += 1
 
109
            if verification_result != SIGNATURE_VALID:
 
110
                all_verifiable = False
 
111
            if process_events_callback is not None:
 
112
                process_events_callback()
 
113
    return (count, result, all_verifiable)
 
114
 
35
115
 
36
116
class DisabledGPGStrategy(object):
37
117
    """A GPG Strategy that makes everything fail."""
38
118
 
 
119
    @staticmethod
 
120
    def verify_signatures_available():
 
121
        return True
 
122
 
39
123
    def __init__(self, ignored):
40
124
        """Real strategies take a configuration."""
41
125
 
42
126
    def sign(self, content):
43
 
        raise errors.SigningFailed('Signing is disabled.')
 
127
        raise SigningFailed('Signing is disabled.')
 
128
 
 
129
    def verify(self, content, testament):
 
130
        raise SignatureVerificationFailed('Signature verification is \
 
131
disabled.')
 
132
 
 
133
    def set_acceptable_keys(self, command_line_input):
 
134
        pass
44
135
 
45
136
 
46
137
class LoopbackGPGStrategy(object):
47
 
    """A GPG Strategy that acts like 'cat' - data is just passed through."""
 
138
    """A GPG Strategy that acts like 'cat' - data is just passed through.
 
139
    Used in tests.
 
140
    """
 
141
 
 
142
    @staticmethod
 
143
    def verify_signatures_available():
 
144
        return True
48
145
 
49
146
    def __init__(self, ignored):
50
147
        """Real strategies take a configuration."""
53
150
        return ("-----BEGIN PSEUDO-SIGNED CONTENT-----\n" + content +
54
151
                "-----END PSEUDO-SIGNED CONTENT-----\n")
55
152
 
 
153
    def verify(self, content, testament):
 
154
        return SIGNATURE_VALID, None
 
155
 
 
156
    def set_acceptable_keys(self, command_line_input):
 
157
        if command_line_input is not None:
 
158
            patterns = command_line_input.split(",")
 
159
            self.acceptable_keys = []
 
160
            for pattern in patterns:
 
161
                if pattern == "unknown":
 
162
                    pass
 
163
                else:
 
164
                    self.acceptable_keys.append(pattern)
 
165
 
56
166
 
57
167
def _set_gpg_tty():
58
168
    tty = os.environ.get('TTY')
62
172
    else:
63
173
        # This is not quite worthy of a warning, because some people
64
174
        # don't need GPG_TTY to be set. But it is worthy of a big mark
65
 
        # in ~/.bzr.log, so that people can debug it if it happens to them
 
175
        # in ~/.brz.log, so that people can debug it if it happens to them
66
176
        trace.mutter('** Env var TTY empty, cannot set GPG_TTY.'
67
177
                     '  Is TTY exported?')
68
178
 
70
180
class GPGStrategy(object):
71
181
    """GPG Signing and checking facilities."""
72
182
 
73
 
    def _command_line(self):
74
 
        return [self._config.gpg_signing_command(), '--clearsign']
75
 
 
76
 
    def __init__(self, config):
77
 
        self._config = config
 
183
    acceptable_keys = None
 
184
 
 
185
    def __init__(self, config_stack):
 
186
        self._config_stack = config_stack
 
187
        try:
 
188
            import gpg
 
189
            self.context = gpg.Context()
 
190
        except ImportError as error:
 
191
            pass # can't use verify()
 
192
 
 
193
        self.context.signers = self._get_signing_keys()
 
194
 
 
195
    def _get_signing_keys(self):
 
196
        import gpg
 
197
        keyname = self._config_stack.get('gpg_signing_key')
 
198
        if keyname:
 
199
            try:
 
200
                return [self.context.get_key(keyname)]
 
201
            except gpg.errors.KeyNotFound:
 
202
                pass
 
203
 
 
204
        if keyname is None or keyname == 'default':
 
205
            # 'default' or not setting gpg_signing_key at all means we should
 
206
            # use the user email address
 
207
            keyname = config.extract_email_address(self._config_stack.get('email'))
 
208
        possible_keys = self.context.keylist(keyname, secret=True)
 
209
        try:
 
210
            return [possible_keys.next()]
 
211
        except StopIteration:
 
212
            return []
 
213
 
 
214
    @staticmethod
 
215
    def verify_signatures_available():
 
216
        """
 
217
        check if this strategy can verify signatures
 
218
 
 
219
        :return: boolean if this strategy can verify signatures
 
220
        """
 
221
        try:
 
222
            import gpg
 
223
            return True
 
224
        except ImportError as error:
 
225
            return False
78
226
 
79
227
    def sign(self, content):
 
228
        import gpg
80
229
        if isinstance(content, unicode):
81
230
            raise errors.BzrBadParameterUnicode('content')
82
 
        ui.ui_factory.clear_term()
83
 
 
84
 
        preexec_fn = _set_gpg_tty
85
 
        if sys.platform == 'win32':
86
 
            # Win32 doesn't support preexec_fn, but wouldn't support TTY anyway.
87
 
            preexec_fn = None
88
 
        try:
89
 
            process = subprocess.Popen(self._command_line(),
90
 
                                       stdin=subprocess.PIPE,
91
 
                                       stdout=subprocess.PIPE,
92
 
                                       preexec_fn=preexec_fn)
93
 
            try:
94
 
                result = process.communicate(content)[0]
95
 
                if process.returncode is None:
96
 
                    process.wait()
97
 
                if process.returncode != 0:
98
 
                    raise errors.SigningFailed(self._command_line())
99
 
                return result
100
 
            except OSError, e:
101
 
                if e.errno == errno.EPIPE:
102
 
                    raise errors.SigningFailed(self._command_line())
 
231
 
 
232
        plain_text = gpg.Data(content)
 
233
        try:
 
234
            output, result = self.context.sign(
 
235
                plain_text, mode=gpg.constants.sig.mode.CLEAR)
 
236
        except gpg.errors.GPGMEError as error:
 
237
            raise SigningFailed(str(error))
 
238
 
 
239
        return output
 
240
 
 
241
    def verify(self, content, testament):
 
242
        """Check content has a valid signature.
 
243
 
 
244
        :param content: the commit signature
 
245
        :param testament: the valid testament string for the commit
 
246
 
 
247
        :return: SIGNATURE_VALID or a failed SIGNATURE_ value, key uid if valid
 
248
        """
 
249
        try:
 
250
            import gpg
 
251
        except ImportError as error:
 
252
            raise errors.GpgNotInstalled(error)
 
253
 
 
254
        signature = gpg.Data(content)
 
255
        sink = gpg.Data()
 
256
        try:
 
257
            plain_output, result = self.context.verify(signature)
 
258
        except gpg.errors.BadSignatures as error:
 
259
            fingerprint = error.result.signatures[0].fpr
 
260
            if error.result.signatures[0].summary & gpg.constants.SIGSUM_KEY_EXPIRED:
 
261
                expires = self.context.get_key(error.result.signatures[0].fpr).subkeys[0].expires
 
262
                if expires > error.result.signatures[0].timestamp:
 
263
                    # The expired key was not expired at time of signing.
 
264
                    # test_verify_expired_but_valid()
 
265
                    return SIGNATURE_EXPIRED, fingerprint[-8:]
103
266
                else:
104
 
                    raise
105
 
        except ValueError:
106
 
            # bad subprocess parameters, should never happen.
107
 
            raise
108
 
        except OSError, e:
109
 
            if e.errno == errno.ENOENT:
110
 
                # gpg is not installed
111
 
                raise errors.SigningFailed(self._command_line())
112
 
            else:
113
 
                raise
 
267
                    # I can't work out how to create a test where the signature
 
268
                    # was expired at the time of signing.
 
269
                    return SIGNATURE_NOT_VALID, None
 
270
 
 
271
            # GPG does not know this key.
 
272
            # test_verify_unknown_key()
 
273
            if error.result.signatures[0].summary & gpg.constants.SIGSUM_KEY_MISSING:
 
274
                return SIGNATURE_KEY_MISSING, fingerprint[-8:]
 
275
 
 
276
            return SIGNATURE_NOT_VALID, None
 
277
        except gpg.errors.GPGMEError as error:
 
278
            raise SignatureVerificationFailed(error[2])
 
279
 
 
280
        # No result if input is invalid.
 
281
        # test_verify_invalid()
 
282
        if len(result.signatures) == 0:
 
283
            return SIGNATURE_NOT_VALID, None
 
284
        # User has specified a list of acceptable keys, check our result is in
 
285
        # it.  test_verify_unacceptable_key()
 
286
        fingerprint = result.signatures[0].fpr
 
287
        if self.acceptable_keys is not None:
 
288
            if not fingerprint in self.acceptable_keys:
 
289
                return SIGNATURE_KEY_MISSING, fingerprint[-8:]
 
290
        # Check the signature actually matches the testament.
 
291
        # test_verify_bad_testament()
 
292
        if testament != plain_output:
 
293
            return SIGNATURE_NOT_VALID, None
 
294
        # Yay gpg set the valid bit.
 
295
        # Can't write a test for this one as you can't set a key to be
 
296
        # trusted using gpg.
 
297
        if result.signatures[0].summary & gpg.constants.SIGSUM_VALID:
 
298
            key = self.context.get_key(fingerprint)
 
299
            name = key.uids[0].name
 
300
            email = key.uids[0].email
 
301
            return SIGNATURE_VALID, name + " <" + email + ">"
 
302
        # Sigsum_red indicates a problem, unfortunatly I have not been able
 
303
        # to write any tests which actually set this.
 
304
        if result.signatures[0].summary & gpg.constants.SIGSUM_RED:
 
305
            return SIGNATURE_NOT_VALID, None
 
306
        # Summary isn't set if sig is valid but key is untrusted but if user
 
307
        # has explicity set the key as acceptable we can validate it.
 
308
        if result.signatures[0].summary == 0 and self.acceptable_keys is not None:
 
309
            if fingerprint in self.acceptable_keys:
 
310
                # test_verify_untrusted_but_accepted()
 
311
                return SIGNATURE_VALID, None
 
312
        # test_verify_valid_but_untrusted()
 
313
        if result.signatures[0].summary == 0 and self.acceptable_keys is None:
 
314
            return SIGNATURE_NOT_VALID, None
 
315
        # Other error types such as revoked keys should (I think) be caught by
 
316
        # SIGSUM_RED so anything else means something is buggy.
 
317
        raise SignatureVerificationFailed(
 
318
            "Unknown GnuPG key verification result")
 
319
 
 
320
    def set_acceptable_keys(self, command_line_input):
 
321
        """Set the acceptable keys for verifying with this GPGStrategy.
 
322
 
 
323
        :param command_line_input: comma separated list of patterns from
 
324
                                command line
 
325
        :return: nothing
 
326
        """
 
327
        patterns = None
 
328
        acceptable_keys_config = self._config_stack.get('acceptable_keys')
 
329
        if acceptable_keys_config is not None:
 
330
            patterns = acceptable_keys_config
 
331
        if command_line_input is not None: # command line overrides config
 
332
            patterns = command_line_input.split(',')
 
333
 
 
334
        if patterns:
 
335
            self.acceptable_keys = []
 
336
            for pattern in patterns:
 
337
                result = self.context.keylist(pattern)
 
338
                found_key = False
 
339
                for key in result:
 
340
                    found_key = True
 
341
                    self.acceptable_keys.append(key.subkeys[0].fpr)
 
342
                    trace.mutter("Added acceptable key: " + key.subkeys[0].fpr)
 
343
                if not found_key:
 
344
                    trace.note(gettext(
 
345
                            "No GnuPG key results for pattern: {0}"
 
346
                                ).format(pattern))
 
347
 
 
348
 
 
349
def valid_commits_message(count):
 
350
    """returns message for number of commits"""
 
351
    return gettext(u"{0} commits with valid signatures").format(
 
352
                                    count[SIGNATURE_VALID])
 
353
 
 
354
 
 
355
def unknown_key_message(count):
 
356
    """returns message for number of commits"""
 
357
    return ngettext(u"{0} commit with unknown key",
 
358
                    u"{0} commits with unknown keys",
 
359
                    count[SIGNATURE_KEY_MISSING]).format(
 
360
                                    count[SIGNATURE_KEY_MISSING])
 
361
 
 
362
 
 
363
def commit_not_valid_message(count):
 
364
    """returns message for number of commits"""
 
365
    return ngettext(u"{0} commit not valid",
 
366
                    u"{0} commits not valid",
 
367
                    count[SIGNATURE_NOT_VALID]).format(
 
368
                                        count[SIGNATURE_NOT_VALID])
 
369
 
 
370
 
 
371
def commit_not_signed_message(count):
 
372
    """returns message for number of commits"""
 
373
    return ngettext(u"{0} commit not signed",
 
374
                    u"{0} commits not signed",
 
375
                    count[SIGNATURE_NOT_SIGNED]).format(
 
376
                                    count[SIGNATURE_NOT_SIGNED])
 
377
 
 
378
 
 
379
def expired_commit_message(count):
 
380
    """returns message for number of commits"""
 
381
    return ngettext(u"{0} commit with key now expired",
 
382
                    u"{0} commits with key now expired",
 
383
                    count[SIGNATURE_EXPIRED]).format(
 
384
                                count[SIGNATURE_EXPIRED])
 
385
 
 
386
 
 
387
def verbose_expired_key_message(result, repo):
 
388
    """takes a verify result and returns list of expired key info"""
 
389
    signers = {}
 
390
    fingerprint_to_authors = {}
 
391
    for rev_id, validity, fingerprint in result:
 
392
        if validity == SIGNATURE_EXPIRED:
 
393
            revision = repo.get_revision(rev_id)
 
394
            authors = ', '.join(revision.get_apparent_authors())
 
395
            signers.setdefault(fingerprint, 0)
 
396
            signers[fingerprint] += 1
 
397
            fingerprint_to_authors[fingerprint] = authors
 
398
    result = []
 
399
    for fingerprint, number in signers.items():
 
400
        result.append(
 
401
            ngettext(u"{0} commit by author {1} with key {2} now expired",
 
402
                     u"{0} commits by author {1} with key {2} now expired",
 
403
                     number).format(
 
404
                number, fingerprint_to_authors[fingerprint], fingerprint))
 
405
    return result
 
406
 
 
407
 
 
408
def verbose_valid_message(result):
 
409
    """takes a verify result and returns list of signed commits strings"""
 
410
    signers = {}
 
411
    for rev_id, validity, uid in result:
 
412
        if validity == SIGNATURE_VALID:
 
413
            signers.setdefault(uid, 0)
 
414
            signers[uid] += 1
 
415
    result = []
 
416
    for uid, number in signers.items():
 
417
         result.append(ngettext(u"{0} signed {1} commit",
 
418
                                u"{0} signed {1} commits",
 
419
                                number).format(uid, number))
 
420
    return result
 
421
 
 
422
 
 
423
def verbose_not_valid_message(result, repo):
 
424
    """takes a verify result and returns list of not valid commit info"""
 
425
    signers = {}
 
426
    for rev_id, validity, empty in result:
 
427
        if validity == SIGNATURE_NOT_VALID:
 
428
            revision = repo.get_revision(rev_id)
 
429
            authors = ', '.join(revision.get_apparent_authors())
 
430
            signers.setdefault(authors, 0)
 
431
            signers[authors] += 1
 
432
    result = []
 
433
    for authors, number in signers.items():
 
434
        result.append(ngettext(u"{0} commit by author {1}",
 
435
                               u"{0} commits by author {1}",
 
436
                               number).format(number, authors))
 
437
    return result
 
438
 
 
439
 
 
440
def verbose_not_signed_message(result, repo):
 
441
    """takes a verify result and returns list of not signed commit info"""
 
442
    signers = {}
 
443
    for rev_id, validity, empty in result:
 
444
        if validity == SIGNATURE_NOT_SIGNED:
 
445
            revision = repo.get_revision(rev_id)
 
446
            authors = ', '.join(revision.get_apparent_authors())
 
447
            signers.setdefault(authors, 0)
 
448
            signers[authors] += 1
 
449
    result = []
 
450
    for authors, number in signers.items():
 
451
        result.append(ngettext(u"{0} commit by author {1}",
 
452
                               u"{0} commits by author {1}",
 
453
                               number).format(number, authors))
 
454
    return result
 
455
 
 
456
 
 
457
def verbose_missing_key_message(result):
 
458
    """takes a verify result and returns list of missing key info"""
 
459
    signers = {}
 
460
    for rev_id, validity, fingerprint in result:
 
461
        if validity == SIGNATURE_KEY_MISSING:
 
462
            signers.setdefault(fingerprint, 0)
 
463
            signers[fingerprint] += 1
 
464
    result = []
 
465
    for fingerprint, number in list(signers.items()):
 
466
        result.append(ngettext(u"Unknown key {0} signed {1} commit",
 
467
                               u"Unknown key {0} signed {1} commits",
 
468
                               number).format(fingerprint, number))
 
469
    return result