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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
# -*- coding: utf-8 -*-
# imap.py
# Copyright (C) 2013 LEAP
#
# 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/>.
"""
Imap service initialization
"""
from copy import copy
import logging
from twisted.internet.protocol import ServerFactory
from twisted.internet.error import CannotListenError
from twisted.mail import imap4
from twisted.python import log
from twisted import cred
logger = logging.getLogger(__name__)
from leap.common import events as leap_events
from leap.common.check import leap_assert, leap_assert_type, leap_check
from leap.keymanager import KeyManager
from leap.mail.imap.server import SoledadBackedAccount
from leap.mail.imap.fetch import LeapIncomingMail
from leap.soledad.client import Soledad
# The default port in which imap service will run
IMAP_PORT = 1984
# The period between succesive checks of the incoming mail
# queue (in seconds)
INCOMING_CHECK_PERIOD = 300
from leap.common.events.events_pb2 import IMAP_SERVICE_STARTED
from leap.common.events.events_pb2 import IMAP_SERVICE_FAILED_TO_START
from leap.common.events.events_pb2 import IMAP_CLIENT_LOGIN
class LeapIMAPServer(imap4.IMAP4Server):
"""
An IMAP4 Server with mailboxes backed by soledad
"""
def __init__(self, *args, **kwargs):
# pop extraneous arguments
soledad = kwargs.pop('soledad', None)
uuid = kwargs.pop('uuid', None)
userid = kwargs.pop('userid', None)
leap_assert(soledad, "need a soledad instance")
leap_assert_type(soledad, Soledad)
leap_assert(uuid, "need a user in the initialization")
self._userid = userid
# initialize imap server!
imap4.IMAP4Server.__init__(self, *args, **kwargs)
# we should initialize the account here,
# but we move it to the factory so we can
# populate the test account properly (and only once
# per session)
# theAccount = SoledadBackedAccount(
# user, soledad=soledad)
# ---------------------------------
# XXX pre-populate acct for tests!!
# populate_test_account(theAccount)
# ---------------------------------
#self.theAccount = theAccount
def lineReceived(self, line):
"""
Attempt to parse a single line from the server.
:param line: the line from the server, without the line delimiter.
:type line: str
"""
if "login" in line.lower():
# avoid to log the pass, even though we are using a dummy auth
# by now.
msg = line[:7] + " [...]"
else:
msg = copy(line)
log.msg('rcv: %s' % msg)
imap4.IMAP4Server.lineReceived(self, line)
def authenticateLogin(self, username, password):
"""
Lookup the account with the given parameters, and deny
the improper combinations.
:param username: the username that is attempting authentication.
:type username: str
:param password: the password to authenticate with.
:type password: str
"""
# XXX this should use portal:
# return portal.login(cred.credentials.UsernamePassword(user, pass)
if username != self._userid:
# bad username, reject.
raise cred.error.UnauthorizedLogin()
# any dummy password is allowed so far. use realm instead!
leap_events.signal(IMAP_CLIENT_LOGIN, "1")
return imap4.IAccount, self.theAccount, lambda: None
class IMAPAuthRealm(object):
"""
Dummy authentication realm. Do not use in production!
"""
theAccount = None
def requestAvatar(self, avatarId, mind, *interfaces):
return imap4.IAccount, self.theAccount, lambda: None
class LeapIMAPFactory(ServerFactory):
"""
Factory for a IMAP4 server with soledad remote sync and gpg-decryption
capabilities.
"""
def __init__(self, uuid, userid, soledad):
"""
Initializes the server factory.
:param uuid: user uuid
:type uuid: str
:param userid: user id (user@provider.org)
:type userid: str
:param soledad: soledad instance
:type soledad: Soledad
"""
self._uuid = uuid
self._userid = userid
self._soledad = soledad
theAccount = SoledadBackedAccount(
uuid, soledad=soledad)
self.theAccount = theAccount
def buildProtocol(self, addr):
"Return a protocol suitable for the job."
imapProtocol = LeapIMAPServer(
uuid=self._uuid,
userid=self._userid,
soledad=self._soledad)
imapProtocol.theAccount = self.theAccount
imapProtocol.factory = self
return imapProtocol
def run_service(*args, **kwargs):
"""
Main entry point to run the service from the client.
:returns: the LoopingCall instance that will have to be stoppped
before shutting down the client, the port as returned by
the reactor when starts listening, and the factory for
the protocol.
"""
leap_assert(len(args) == 2)
soledad, keymanager = args
leap_assert_type(soledad, Soledad)
leap_assert_type(keymanager, KeyManager)
port = kwargs.get('port', IMAP_PORT)
check_period = kwargs.get('check_period', INCOMING_CHECK_PERIOD)
userid = kwargs.get('userid', None)
leap_check(userid is not None, "need an user id")
uuid = soledad._get_uuid()
factory = LeapIMAPFactory(uuid, userid, soledad)
from twisted.internet import reactor
try:
tport = reactor.listenTCP(port, factory,
interface="localhost")
fetcher = LeapIncomingMail(
keymanager,
soledad,
factory.theAccount,
check_period,
userid)
except CannotListenError:
logger.error("IMAP Service failed to start: "
"cannot listen in port %s" % (port,))
except Exception as exc:
logger.error("Error launching IMAP service: %r" % (exc,))
else:
# all good.
fetcher.start_loop()
logger.debug("IMAP4 Server is RUNNING in port %s" % (port,))
leap_events.signal(IMAP_SERVICE_STARTED, str(port))
return fetcher, tport, factory
# not ok, signal error.
leap_events.signal(IMAP_SERVICE_FAILED_TO_START, str(port))
|
