aboutsummaryrefslogtreecommitdiff
path: root/src/mailman_pgp/pgp/wrapper.py
blob: 2b18134db42c7cbd17492afc0920f1803755a7f9 (plain) (blame)
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
#
# This file is a part of the Mailman PGP plugin.
#
# 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/>.

"""A combined PGP/MIME + inline PGP wrapper."""

from public import public

from mailman_pgp.pgp.inline import InlineWrapper
from mailman_pgp.pgp.mime import MIMEWrapper


@public
class PGPWrapper():
    """A combined PGP/MIME + inline PGP wrapper."""

    def __init__(self, msg, default=MIMEWrapper):
        """
        Wrap the given message.

        :param msg: The message to wrap.
        :type msg: mailman.email.message.Message
        :param default:
        :type default: MIMEWrapper or InlineWrapper
        """
        self.msg = msg
        self.mime = MIMEWrapper(msg)
        self.inline = InlineWrapper(msg)
        if default is MIMEWrapper:
            self.default = self.mime
        elif default is InlineWrapper:
            self.default = self.inline
        else:
            raise ValueError('Default wrapper must be one of ' +
                             MIMEWrapper.__name__ + ' ' +
                             InlineWrapper.__name__ + '.')

    def is_mime_signed(self):
        return self.mime.is_signed()

    def is_inline_signed(self):
        return self.inline.is_signed()

    def is_signed(self):
        return self.is_mime_signed() or self.is_inline_signed()

    def mime_sign(self, key):
        return self.mime.sign(key)

    def inline_sign(self, key):
        return self.inline.sign(key)

    def sign(self, key):
        return self.default.sign(key)

    def verify(self, key):
        """
        Verify the signature of this message with key.

        :param key: The key to verify with.
        :type key: pgpy.PGPKey
        :return: The verified signature.
        :rtype: generator of pgpy.types.SignatureVerification
        """
        if self.is_mime_signed():
            yield from self.mime.verify(key)
        elif self.is_inline_signed():
            yield from self.inline.verify(key)

    def is_mime_encrypted(self):
        return self.mime.is_encrypted()

    def is_inline_encrypted(self):
        return self.inline.is_encrypted()

    def is_encrypted(self):
        return self.is_mime_encrypted() or self.is_inline_encrypted()

    def mime_encrypt(self, *keys, **kwargs):
        return self.mime.encrypt(*keys, **kwargs)

    def inline_encrypt(self, *keys, **kwargs):
        return self.inline.encrypt(*keys, **kwargs)

    def encrypt(self, *keys, **kwargs):
        return self.default.encrypt(*keys, **kwargs)

    def decrypt(self, key):
        """
        Decrypt this message with key.

        :param key: The key to decrypt with.
        :type key: pgpy.PGPKey
        :return: The decrypted message.
        :rtype: PGPMessage
        """
        if self.is_mime_encrypted():
            return self.mime.decrypt(key)
        elif self.is_inline_encrypted():
            return self.inline.decrypt(key)

    def is_keys(self):
        return self.mime.is_keys() or self.inline.is_keys()

    def has_keys(self):
        return self.mime.has_keys() or self.inline.has_keys()

    def keys(self):
        """
        Get the collection of keys in this message.

        :return: A collection of keys.
        """
        if self.mime.has_keys():
            yield from self.mime.keys()
        elif self.inline.has_keys():
            yield from self.inline.keys()