aboutsummaryrefslogtreecommitdiff
path: root/src/mailman_pgp/model/list.py
blob: 0163026e590e8d4855039848a1c0d3858758dfe4 (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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# 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/>.

"""Model for PGP enabled mailing lists."""

from os.path import exists, isfile, join

from flufl.lock import Lock
from mailman.database.types import Enum, SAUnicode
from mailman.interfaces.action import Action
from mailman.interfaces.listmanager import IListManager, ListDeletedEvent
from pgpy import PGPKey
from public import public
from sqlalchemy import Boolean, Column, Integer
from sqlalchemy.orm import reconstructor
from zope.component import getUtility
from zope.event import classhandler

from mailman_pgp.config import config
from mailman_pgp.database import transaction
from mailman_pgp.model.base import Base
from mailman_pgp.pgp.keygen import ListKeyGenerator


@public
class PGPMailingList(Base):
    """A PGP enabled mailing list."""

    __tablename__ = 'pgp_lists'

    id = Column(Integer, primary_key=True)
    list_id = Column(SAUnicode, index=True)

    # Signature related properties
    unsigned_msg_action = Column(Enum(Action), default=Action.reject)
    inline_pgp_action = Column(Enum(Action), default=Action.defer)
    expired_sig_action = Column(Enum(Action), default=Action.reject)
    revoked_sig_action = Column(Enum(Action), default=Action.reject)
    invalid_sig_action = Column(Enum(Action), default=Action.reject)
    duplicate_sig_action = Column(Enum(Action), default=Action.reject)
    strip_original_sig = Column(Boolean, default=False)
    sign_outgoing = Column(Boolean, default=False)

    # Encryption related properties
    nonencrypted_msg_action = Column(Enum(Action), default=Action.reject)
    encrypt_outgoing = Column(Boolean, default=True)

    def __init__(self, mlist):
        super().__init__()
        self._init()
        self.list_id = mlist.list_id
        self._mlist = mlist

    @reconstructor
    def _init(self):
        self._mlist = None
        self._key = None
        self._key_generator = None

    @property
    def mlist(self):
        """

        :return:
        :rtype: mailman.model.mailinglist.MailingList
        """
        if self._mlist is None:
            self._mlist = getUtility(IListManager).get_by_list_id(self.list_id)
        return self._mlist

    @property
    def key(self):
        """

        :return:
        :rtype: pgpy.PGPKey
        """
        if self._key is None:
            # Check the file
            if exists(self.key_path) and isfile(self.key_path):
                self._key, _ = PGPKey.from_file(self.key_path)
        return self._key

    @key.setter
    def key(self, value):
        with Lock(self.key_path + '.lock'):
            self._key = value
            with open(self.key_path, 'w') as key_file:
                key_file.write(str(value))

    def generate_key(self, block=False):
        self._key = None
        self._key_generator = ListKeyGenerator(config.pgp.primary_key_args,
                                               config.pgp.sub_key_args,
                                               self.mlist.display_name,
                                               self.mlist.posting_address,
                                               self.mlist.request_address,
                                               self.key_path)
        self._key_generator.start()
        if block:
            self._key_generator.join()
            return self.key

    @property
    def pubkey(self):
        """

        :return:
        :rtype: pgpy.PGPKey
        """
        if self.key is None:
            return None
        return self.key.pubkey

    @property
    def key_path(self):
        """

        :return:
        :rtype: str
        """
        return join(config.pgp.keydir_config['list_keydir'],
                    self.list_id + '.asc')

    @staticmethod
    def for_list(mlist):
        """

        :param mlist:
        :return:
        :rtype: PGPMailingList|None
        """
        if mlist is None:
            return None
        return PGPMailingList.query().filter_by(list_id=mlist.list_id).first()


@classhandler.handler(ListDeletedEvent)
def on_delete(mlist):
    pgp_list = PGPMailingList.for_list(mlist)
    if pgp_list:
        with transaction() as session:
            # TODO shred the list key
            session.delete(pgp_list)