aboutsummaryrefslogtreecommitdiff
path: root/src/mailman_pgp/pgp/inline.py
blob: 94091ccbfae277ac697f3879fc89e6351ecdca1b (plain)
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
# Copyright (C) 2017 Jan Jancar
#
# 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/>.

"""Strict inline PGP message wrapper."""

from pgpy import PGPKey, PGPMessage
from pgpy.types import Armorable
from public import public


@public
class InlineWrapper:
    """Inline PGP wrapper."""

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

        :param msg: The message to wrap.
        :type msg: mailman.email.message.Message
        """
        self.msg = msg

    def _is_inline(self):
        return not self.msg.is_multipart()

    def _as_string(self):
        return str(self.msg.get_payload())

    def _has_signature(self):
        try:
            msg = PGPMessage.from_blob(self._as_string())
            return msg.is_signed
        except:
            pass
        return False

    def _has_message(self):
        try:
            msg = PGPMessage.from_blob(self._as_string())
            return msg.is_encrypted
        except:
            pass
        return False

    def _has_armor(self, block_type):
        try:
            dearm = Armorable.ascii_unarmor(self._as_string())
            if dearm['magic'] == block_type:
                return True
        except:
            pass
        return False

    def is_signed(self):
        """
        Whether the message is inline signed (cleartext).

        :return: If the message is inline signed.
        :rtype: bool
        """
        return self._is_inline() and self._has_signature()

    def is_encrypted(self):
        """
        Whether the message is inline encrypted.

        :return: If the message is inline encrypted.
        :rtype: bool
        """
        return self._is_inline() and self._has_message()

    def has_keys(self):
        """
        Whether the message contains public or private keys.

        :return: If the message contains keys.
        :rtype: bool
        """
        return self._is_inline() and (self._has_armor('PUBLIC KEY BLOCK') or
                                      self._has_armor('PRIVATE KEY BLOCK'))

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

        :return: A collection of keys.
        """
        # TODO: potentially return all things returned from from_blob?
        key, _ = PGPKey.from_blob(self._as_string())
        yield 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: pgpy.types.SignatureVerification
        """
        message = PGPMessage.from_blob(self._as_string())
        return key.verify(message)

    def sign(self):
        pass

    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
        """
        message = PGPMessage.from_blob(self._as_string())
        return key.decrypt(message)

    def encrypt(self):
        pass