← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/gpg.py

  • Committer: Martin Pool
  • Date: 2005-07-28 11:56:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050728115624-93c11c2b1e399023
- note changes to command line parsing

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/gpg.py
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
3
 
#
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
#
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
#
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
 
 
18
 
"""GPG signing and checking logic."""
19
 
 
20
 
import os
21
 
import sys
22
 
 
23
 
from bzrlib.lazy_import import lazy_import
24
 
lazy_import(globals(), """
25
 
import errno
26
 
import subprocess
27
 
 
28
 
from bzrlib import (
29
 
    errors,
30
 
    trace,
31
 
    ui,
32
 
    )
33
 
""")
34
 
 
35
 
 
36
 
class DisabledGPGStrategy(object):
37
 
    """A GPG Strategy that makes everything fail."""
38
 
 
39
 
    def __init__(self, ignored):
40
 
        """Real strategies take a configuration."""
41
 
 
42
 
    def sign(self, content):
43
 
        raise errors.SigningFailed('Signing is disabled.')
44
 
 
45
 
 
46
 
class LoopbackGPGStrategy(object):
47
 
    """A GPG Strategy that acts like 'cat' - data is just passed through."""
48
 
 
49
 
    def __init__(self, ignored):
50
 
        """Real strategies take a configuration."""
51
 
 
52
 
    def sign(self, content):
53
 
        return ("-----BEGIN PSEUDO-SIGNED CONTENT-----\n" + content +
54
 
                "-----END PSEUDO-SIGNED CONTENT-----\n")
55
 
 
56
 
 
57
 
def _set_gpg_tty():
58
 
    tty = os.environ.get('TTY')
59
 
    if tty is not None:
60
 
        os.environ['GPG_TTY'] = tty
61
 
        trace.mutter('setting GPG_TTY=%s', tty)
62
 
    else:
63
 
        # This is not quite worthy of a warning, because some people
64
 
        # 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
66
 
        trace.mutter('** Env var TTY empty, cannot set GPG_TTY.'
67
 
                     '  Is TTY exported?')
68
 
 
69
 
 
70
 
class GPGStrategy(object):
71
 
    """GPG Signing and checking facilities."""
72
 
 
73
 
    def _command_line(self):
74
 
        return [self._config.gpg_signing_command(), '--clearsign']
75
 
 
76
 
    def __init__(self, config):
77
 
        self._config = config
78
 
 
79
 
    def sign(self, content):
80
 
        if isinstance(content, unicode):
81
 
            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())
103
 
                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