← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/gpg.py

  • Committer: Vincent Ladeuil
  • Date: 2010-12-07 10:16:53 UTC
  • mto: (5575.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 5576.
  • Revision ID: v.ladeuil+lp@free.fr-20101207101653-20iiufih26buvmy3
Use assertLength as it provides a better ouput to debug tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/gpg.py
1
 
# Copyright (C) 2005, 2011 Canonical Ltd
 
1
# Copyright (C) 2005 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
 
 
22
20
import os
23
21
import sys
24
 
from StringIO import StringIO
25
22
 
26
23
from bzrlib.lazy_import import lazy_import
27
24
lazy_import(globals(), """
29
26
import subprocess
30
27
 
31
28
from bzrlib import (
32
 
    config,
33
29
    errors,
34
30
    trace,
35
31
    ui,
36
32
    )
37
 
from bzrlib.i18n import (
38
 
    gettext, 
39
 
    ngettext,
40
 
    )
41
33
""")
42
34
 
43
 
from bzrlib.symbol_versioning import (
44
 
    deprecated_in,
45
 
    deprecated_method,
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
 
def bulk_verify_signatures(repository, revids, strategy,
57
 
        process_events_callback=None):
58
 
    """Do verifications on a set of revisions
59
 
 
60
 
    :param repository: repository object
61
 
    :param revids: list of revision ids to verify
62
 
    :param strategy: GPG strategy to use
63
 
    :param process_events_callback: method to call for GUI frontends that
64
 
        want to keep their UI refreshed
65
 
 
66
 
    :return: count dictionary of results of each type,
67
 
             result list for each revision,
68
 
             boolean True if all results are verified successfully
69
 
    """
70
 
    count = {SIGNATURE_VALID: 0,
71
 
             SIGNATURE_KEY_MISSING: 0,
72
 
             SIGNATURE_NOT_VALID: 0,
73
 
             SIGNATURE_NOT_SIGNED: 0,
74
 
             SIGNATURE_EXPIRED: 0}
75
 
    result = []
76
 
    all_verifiable = True
77
 
    total = len(revids)
78
 
    pb = ui.ui_factory.nested_progress_bar()
79
 
    try:
80
 
        for i, (rev_id, verification_result, uid) in enumerate(
81
 
                repository.verify_revision_signatures(
82
 
                    revids, strategy)):
83
 
            pb.update("verifying signatures", i, total)
84
 
            result.append([rev_id, verification_result, uid])
85
 
            count[verification_result] += 1
86
 
            if verification_result != SIGNATURE_VALID:
87
 
                all_verifiable = False
88
 
            if process_events_callback is not None:
89
 
                process_events_callback()
90
 
    finally:
91
 
        pb.finished()
92
 
    return (count, result, all_verifiable)
93
 
 
94
35
 
95
36
class DisabledGPGStrategy(object):
96
37
    """A GPG Strategy that makes everything fail."""
97
38
 
98
 
    @staticmethod
99
 
    def verify_signatures_available():
100
 
        return True
101
 
 
102
39
    def __init__(self, ignored):
103
40
        """Real strategies take a configuration."""
104
41
 
105
42
    def sign(self, content):
106
43
        raise errors.SigningFailed('Signing is disabled.')
107
44
 
108
 
    def verify(self, content, testament):
109
 
        raise errors.SignatureVerificationFailed('Signature verification is \
110
 
disabled.')
111
 
 
112
 
    def set_acceptable_keys(self, command_line_input):
113
 
        pass
114
 
 
115
45
 
116
46
class LoopbackGPGStrategy(object):
117
 
    """A GPG Strategy that acts like 'cat' - data is just passed through.
118
 
    Used in tests.
119
 
    """
120
 
 
121
 
    @staticmethod
122
 
    def verify_signatures_available():
123
 
        return True
 
47
    """A GPG Strategy that acts like 'cat' - data is just passed through."""
124
48
 
125
49
    def __init__(self, ignored):
126
50
        """Real strategies take a configuration."""
129
53
        return ("-----BEGIN PSEUDO-SIGNED CONTENT-----\n" + content +
130
54
                "-----END PSEUDO-SIGNED CONTENT-----\n")
131
55
 
132
 
    def verify(self, content, testament):
133
 
        return SIGNATURE_VALID, None
134
 
 
135
 
    def set_acceptable_keys(self, command_line_input):
136
 
        if command_line_input is not None:
137
 
            patterns = command_line_input.split(",")
138
 
            self.acceptable_keys = []
139
 
            for pattern in patterns:
140
 
                if pattern == "unknown":
141
 
                    pass
142
 
                else:
143
 
                    self.acceptable_keys.append(pattern)
144
 
 
145
 
    @deprecated_method(deprecated_in((2, 6, 0)))
146
 
    def do_verifications(self, revisions, repository):
147
 
        return bulk_verify_signatures(repository, revisions, self)
148
 
 
149
 
    @deprecated_method(deprecated_in((2, 6, 0)))
150
 
    def valid_commits_message(self, count):
151
 
        return valid_commits_message(count)
152
 
 
153
 
    @deprecated_method(deprecated_in((2, 6, 0)))
154
 
    def unknown_key_message(self, count):
155
 
        return unknown_key_message(count)
156
 
 
157
 
    @deprecated_method(deprecated_in((2, 6, 0)))
158
 
    def commit_not_valid_message(self, count):
159
 
        return commit_not_valid_message(count)
160
 
 
161
 
    @deprecated_method(deprecated_in((2, 6, 0)))
162
 
    def commit_not_signed_message(self, count):
163
 
        return commit_not_signed_message(count)
164
 
 
165
 
    @deprecated_method(deprecated_in((2, 6, 0)))
166
 
    def expired_commit_message(self, count):
167
 
        return expired_commit_message(count)
168
 
 
169
56
 
170
57
def _set_gpg_tty():
171
58
    tty = os.environ.get('TTY')
183
70
class GPGStrategy(object):
184
71
    """GPG Signing and checking facilities."""
185
72
 
186
 
    acceptable_keys = None
187
 
 
188
 
    def __init__(self, config_stack):
189
 
        self._config_stack = config_stack
190
 
        try:
191
 
            import gpgme
192
 
            self.context = gpgme.Context()
193
 
        except ImportError, error:
194
 
            pass # can't use verify()
195
 
 
196
 
    @staticmethod
197
 
    def verify_signatures_available():
198
 
        """
199
 
        check if this strategy can verify signatures
200
 
 
201
 
        :return: boolean if this strategy can verify signatures
202
 
        """
203
 
        try:
204
 
            import gpgme
205
 
            return True
206
 
        except ImportError, error:
207
 
            return False
208
 
 
209
73
    def _command_line(self):
210
 
        key = self._config_stack.get('gpg_signing_key')
211
 
        if key is None or key == 'default':
212
 
            # 'default' or not setting gpg_signing_key at all means we should
213
 
            # use the user email address
214
 
            key = config.extract_email_address(self._config_stack.get('email'))
215
 
        return [self._config_stack.get('gpg_signing_command'), '--clearsign',
216
 
                '-u', key, '--no-tty']
 
74
        return [self._config.gpg_signing_command(), '--clearsign']
 
75
 
 
76
    def __init__(self, config):
 
77
        self._config = config
217
78
 
218
79
    def sign(self, content):
219
80
        if isinstance(content, unicode):
250
111
                raise errors.SigningFailed(self._command_line())
251
112
            else:
252
113
                raise
253
 
 
254
 
    def verify(self, content, testament):
255
 
        """Check content has a valid signature.
256
 
 
257
 
        :param content: the commit signature
258
 
        :param testament: the valid testament string for the commit
259
 
 
260
 
        :return: SIGNATURE_VALID or a failed SIGNATURE_ value, key uid if valid
261
 
        """
262
 
        try:
263
 
            import gpgme
264
 
        except ImportError, error:
265
 
            raise errors.GpgmeNotInstalled(error)
266
 
 
267
 
        signature = StringIO(content)
268
 
        plain_output = StringIO()
269
 
        try:
270
 
            result = self.context.verify(signature, None, plain_output)
271
 
        except gpgme.GpgmeError,error:
272
 
            raise errors.SignatureVerificationFailed(error[2])
273
 
 
274
 
        # No result if input is invalid.
275
 
        # test_verify_invalid()
276
 
        if len(result) == 0:
277
 
            return SIGNATURE_NOT_VALID, None
278
 
        # User has specified a list of acceptable keys, check our result is in
279
 
        # it.  test_verify_unacceptable_key()
280
 
        fingerprint = result[0].fpr
281
 
        if self.acceptable_keys is not None:
282
 
            if not fingerprint in self.acceptable_keys:
283
 
                return SIGNATURE_KEY_MISSING, fingerprint[-8:]
284
 
        # Check the signature actually matches the testament.
285
 
        # test_verify_bad_testament()
286
 
        if testament != plain_output.getvalue():
287
 
            return SIGNATURE_NOT_VALID, None
288
 
        # Yay gpgme set the valid bit.
289
 
        # Can't write a test for this one as you can't set a key to be
290
 
        # trusted using gpgme.
291
 
        if result[0].summary & gpgme.SIGSUM_VALID:
292
 
            key = self.context.get_key(fingerprint)
293
 
            name = key.uids[0].name
294
 
            email = key.uids[0].email
295
 
            return SIGNATURE_VALID, name + " <" + email + ">"
296
 
        # Sigsum_red indicates a problem, unfortunatly I have not been able
297
 
        # to write any tests which actually set this.
298
 
        if result[0].summary & gpgme.SIGSUM_RED:
299
 
            return SIGNATURE_NOT_VALID, None
300
 
        # GPG does not know this key.
301
 
        # test_verify_unknown_key()
302
 
        if result[0].summary & gpgme.SIGSUM_KEY_MISSING:
303
 
            return SIGNATURE_KEY_MISSING, fingerprint[-8:]
304
 
        # Summary isn't set if sig is valid but key is untrusted but if user
305
 
        # has explicity set the key as acceptable we can validate it.
306
 
        if result[0].summary == 0 and self.acceptable_keys is not None:
307
 
            if fingerprint in self.acceptable_keys:
308
 
                # test_verify_untrusted_but_accepted()
309
 
                return SIGNATURE_VALID, None
310
 
        # test_verify_valid_but_untrusted()
311
 
        if result[0].summary == 0 and self.acceptable_keys is None:
312
 
            return SIGNATURE_NOT_VALID, None
313
 
        if result[0].summary & gpgme.SIGSUM_KEY_EXPIRED:
314
 
            expires = self.context.get_key(result[0].fpr).subkeys[0].expires
315
 
            if expires > result[0].timestamp:
316
 
                # The expired key was not expired at time of signing.
317
 
                # test_verify_expired_but_valid()
318
 
                return SIGNATURE_EXPIRED, fingerprint[-8:]
319
 
            else:
320
 
                # I can't work out how to create a test where the signature
321
 
                # was expired at the time of signing.
322
 
                return SIGNATURE_NOT_VALID, None
323
 
        # A signature from a revoked key gets this.
324
 
        # test_verify_revoked_signature()
325
 
        if result[0].summary & gpgme.SIGSUM_SYS_ERROR:
326
 
            return SIGNATURE_NOT_VALID, None
327
 
        # Other error types such as revoked keys should (I think) be caught by
328
 
        # SIGSUM_RED so anything else means something is buggy.
329
 
        raise errors.SignatureVerificationFailed("Unknown GnuPG key "\
330
 
                                                 "verification result")
331
 
 
332
 
    def set_acceptable_keys(self, command_line_input):
333
 
        """Set the acceptable keys for verifying with this GPGStrategy.
334
 
 
335
 
        :param command_line_input: comma separated list of patterns from
336
 
                                command line
337
 
        :return: nothing
338
 
        """
339
 
        key_patterns = None
340
 
        acceptable_keys_config = self._config_stack.get('acceptable_keys')
341
 
        try:
342
 
            if isinstance(acceptable_keys_config, unicode):
343
 
                acceptable_keys_config = str(acceptable_keys_config)
344
 
        except UnicodeEncodeError:
345
 
            # gpg Context.keylist(pattern) does not like unicode
346
 
            raise errors.BzrCommandError(
347
 
                gettext('Only ASCII permitted in option names'))
348
 
 
349
 
        if acceptable_keys_config is not None:
350
 
            key_patterns = acceptable_keys_config
351
 
        if command_line_input is not None: # command line overrides config
352
 
            key_patterns = command_line_input
353
 
        if key_patterns is not None:
354
 
            patterns = key_patterns.split(",")
355
 
 
356
 
            self.acceptable_keys = []
357
 
            for pattern in patterns:
358
 
                result = self.context.keylist(pattern)
359
 
                found_key = False
360
 
                for key in result:
361
 
                    found_key = True
362
 
                    self.acceptable_keys.append(key.subkeys[0].fpr)
363
 
                    trace.mutter("Added acceptable key: " + key.subkeys[0].fpr)
364
 
                if not found_key:
365
 
                    trace.note(gettext(
366
 
                            "No GnuPG key results for pattern: {0}"
367
 
                                ).format(pattern))
368
 
 
369
 
    @deprecated_method(deprecated_in((2, 6, 0)))
370
 
    def do_verifications(self, revisions, repository,
371
 
                            process_events_callback=None):
372
 
        """do verifications on a set of revisions
373
 
 
374
 
        :param revisions: list of revision ids to verify
375
 
        :param repository: repository object
376
 
        :param process_events_callback: method to call for GUI frontends that
377
 
            want to keep their UI refreshed
378
 
 
379
 
        :return: count dictionary of results of each type,
380
 
                 result list for each revision,
381
 
                 boolean True if all results are verified successfully
382
 
        """
383
 
        return bulk_verify_signatures(repository, revisions, self,
384
 
            process_events_callback)
385
 
 
386
 
    @deprecated_method(deprecated_in((2, 6, 0)))
387
 
    def verbose_valid_message(self, result):
388
 
        """takes a verify result and returns list of signed commits strings"""
389
 
        return verbose_valid_message(result)
390
 
 
391
 
    @deprecated_method(deprecated_in((2, 6, 0)))
392
 
    def verbose_not_valid_message(self, result, repo):
393
 
        """takes a verify result and returns list of not valid commit info"""
394
 
        return verbose_not_valid_message(result, repo)
395
 
 
396
 
    @deprecated_method(deprecated_in((2, 6, 0)))
397
 
    def verbose_not_signed_message(self, result, repo):
398
 
        """takes a verify result and returns list of not signed commit info"""
399
 
        return verbose_not_valid_message(result, repo)
400
 
 
401
 
    @deprecated_method(deprecated_in((2, 6, 0)))
402
 
    def verbose_missing_key_message(self, result):
403
 
        """takes a verify result and returns list of missing key info"""
404
 
        return verbose_missing_key_message(result)
405
 
 
406
 
    @deprecated_method(deprecated_in((2, 6, 0)))
407
 
    def verbose_expired_key_message(self, result, repo):
408
 
        """takes a verify result and returns list of expired key info"""
409
 
        return verbose_expired_key_message(result, repo)
410
 
 
411
 
    @deprecated_method(deprecated_in((2, 6, 0)))
412
 
    def valid_commits_message(self, count):
413
 
        """returns message for number of commits"""
414
 
        return valid_commits_message(count)
415
 
 
416
 
    @deprecated_method(deprecated_in((2, 6, 0)))
417
 
    def unknown_key_message(self, count):
418
 
        """returns message for number of commits"""
419
 
        return unknown_key_message(count)
420
 
 
421
 
    @deprecated_method(deprecated_in((2, 6, 0)))
422
 
    def commit_not_valid_message(self, count):
423
 
        """returns message for number of commits"""
424
 
        return commit_not_valid_message(count)
425
 
 
426
 
    @deprecated_method(deprecated_in((2, 6, 0)))
427
 
    def commit_not_signed_message(self, count):
428
 
        """returns message for number of commits"""
429
 
        return commit_not_signed_message(count)
430
 
 
431
 
    @deprecated_method(deprecated_in((2, 6, 0)))
432
 
    def expired_commit_message(self, count):
433
 
        """returns message for number of commits"""
434
 
        return expired_commit_message(count)
435
 
 
436
 
 
437
 
def valid_commits_message(count):
438
 
    """returns message for number of commits"""
439
 
    return gettext(u"{0} commits with valid signatures").format(
440
 
                                    count[SIGNATURE_VALID])
441
 
 
442
 
 
443
 
def unknown_key_message(count):
444
 
    """returns message for number of commits"""
445
 
    return ngettext(u"{0} commit with unknown key",
446
 
                    u"{0} commits with unknown keys",
447
 
                    count[SIGNATURE_KEY_MISSING]).format(
448
 
                                    count[SIGNATURE_KEY_MISSING])
449
 
 
450
 
 
451
 
def commit_not_valid_message(count):
452
 
    """returns message for number of commits"""
453
 
    return ngettext(u"{0} commit not valid",
454
 
                    u"{0} commits not valid",
455
 
                    count[SIGNATURE_NOT_VALID]).format(
456
 
                                        count[SIGNATURE_NOT_VALID])
457
 
 
458
 
 
459
 
def commit_not_signed_message(count):
460
 
    """returns message for number of commits"""
461
 
    return ngettext(u"{0} commit not signed",
462
 
                    u"{0} commits not signed",
463
 
                    count[SIGNATURE_NOT_SIGNED]).format(
464
 
                                    count[SIGNATURE_NOT_SIGNED])
465
 
 
466
 
 
467
 
def expired_commit_message(count):
468
 
    """returns message for number of commits"""
469
 
    return ngettext(u"{0} commit with key now expired",
470
 
                    u"{0} commits with key now expired",
471
 
                    count[SIGNATURE_EXPIRED]).format(
472
 
                                count[SIGNATURE_EXPIRED])
473
 
 
474
 
 
475
 
def verbose_expired_key_message(result, repo):
476
 
    """takes a verify result and returns list of expired key info"""
477
 
    signers = {}
478
 
    fingerprint_to_authors = {}
479
 
    for rev_id, validity, fingerprint in result:
480
 
        if validity == SIGNATURE_EXPIRED:
481
 
            revision = repo.get_revision(rev_id)
482
 
            authors = ', '.join(revision.get_apparent_authors())
483
 
            signers.setdefault(fingerprint, 0)
484
 
            signers[fingerprint] += 1
485
 
            fingerprint_to_authors[fingerprint] = authors
486
 
    result = []
487
 
    for fingerprint, number in signers.items():
488
 
        result.append(
489
 
            ngettext(u"{0} commit by author {1} with key {2} now expired",
490
 
                     u"{0} commits by author {1} with key {2} now expired",
491
 
                     number).format(
492
 
                number, fingerprint_to_authors[fingerprint], fingerprint))
493
 
    return result
494
 
 
495
 
 
496
 
def verbose_valid_message(result):
497
 
    """takes a verify result and returns list of signed commits strings"""
498
 
    signers = {}
499
 
    for rev_id, validity, uid in result:
500
 
        if validity == SIGNATURE_VALID:
501
 
            signers.setdefault(uid, 0)
502
 
            signers[uid] += 1
503
 
    result = []
504
 
    for uid, number in signers.items():
505
 
         result.append(ngettext(u"{0} signed {1} commit",
506
 
                                u"{0} signed {1} commits",
507
 
                                number).format(uid, number))
508
 
    return result
509
 
 
510
 
 
511
 
def verbose_not_valid_message(result, repo):
512
 
    """takes a verify result and returns list of not valid commit info"""
513
 
    signers = {}
514
 
    for rev_id, validity, empty in result:
515
 
        if validity == SIGNATURE_NOT_VALID:
516
 
            revision = repo.get_revision(rev_id)
517
 
            authors = ', '.join(revision.get_apparent_authors())
518
 
            signers.setdefault(authors, 0)
519
 
            signers[authors] += 1
520
 
    result = []
521
 
    for authors, number in signers.items():
522
 
        result.append(ngettext(u"{0} commit by author {1}",
523
 
                               u"{0} commits by author {1}",
524
 
                               number).format(number, authors))
525
 
    return result
526
 
 
527
 
 
528
 
def verbose_not_signed_message(result, repo):
529
 
    """takes a verify result and returns list of not signed commit info"""
530
 
    signers = {}
531
 
    for rev_id, validity, empty in result:
532
 
        if validity == SIGNATURE_NOT_SIGNED:
533
 
            revision = repo.get_revision(rev_id)
534
 
            authors = ', '.join(revision.get_apparent_authors())
535
 
            signers.setdefault(authors, 0)
536
 
            signers[authors] += 1
537
 
    result = []
538
 
    for authors, number in signers.items():
539
 
        result.append(ngettext(u"{0} commit by author {1}",
540
 
                               u"{0} commits by author {1}",
541
 
                               number).format(number, authors))
542
 
    return result
543
 
 
544
 
 
545
 
def verbose_missing_key_message(result):
546
 
    """takes a verify result and returns list of missing key info"""
547
 
    signers = {}
548
 
    for rev_id, validity, fingerprint in result:
549
 
        if validity == SIGNATURE_KEY_MISSING:
550
 
            signers.setdefault(fingerprint, 0)
551
 
            signers[fingerprint] += 1
552
 
    result = []
553
 
    for fingerprint, number in signers.items():
554
 
        result.append(ngettext(u"Unknown key {0} signed {1} commit",
555
 
                               u"Unknown key {0} signed {1} commits",
556
 
                               number).format(fingerprint, number))
557
 
    return result