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
|
# -*- encoding: utf-8 -*-
# couchdb.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/>.
"""
Classes for working with CouchDB or BigCouch instances which store email alias
maps, user UUIDs, and GPG keyIDs.
"""
from paisley import client
from twisted.internet import defer
from twisted.python import log
from leap.soledad.common.couch import CouchDatabase
class ConnectedCouchDB(client.CouchDB):
"""
Connect to a CouchDB instance.
CouchDB document for testing is '_design', and the view is simply
a preconfigured set of mapped responses.
"""
def __init__(self, host, port=5984, dbName=None, username=None,
password=None, *args, **kwargs):
"""
Connect to a CouchDB instance.
:param host: A hostname string for the CouchDB server.
:type host: str
:param port: The port of the CouchDB server.
:type port: int
:param dbName: (optional) The default database to bind queries to.
:type dbName: str
:param username: (optional) The username for authorization.
:type username: str
:param str password: (optional) The password for authorization.
:type password: str
"""
self._mail_couch_url = "http://%s:%s@%s:%s" % (username,
password,
host,
port)
client.CouchDB.__init__(self,
host,
port=port,
dbName=dbName,
username=username,
password=password,
*args, **kwargs)
self._cache = {}
def createDB(self, dbName):
"""
Overrides ``paisley.client.CouchDB.createDB``.
"""
pass
def deleteDB(self, dbName):
"""
Overrides ``paisley.client.CouchDB.deleteDB``.
"""
pass
def getUuidAndPubkey(self, address):
"""
Query couch and return a deferred that will fire with the uuid and pgp
public key for address.
:param address: A string representing the email or alias to check.
:type address: str
:return: A deferred that will fire with the user's uuid and pgp public
key.
:rtype twisted.defer.Deferred
"""
# TODO: Cache results
d = self.openView(docId="Identity",
viewId="by_address/",
key=address,
reduce=False,
include_docs=True)
def _get_uuid_and_pubkey_cbk(result):
uuid = None
pubkey = None
if result["rows"]:
doc = result["rows"][0]["doc"]
if "enabled" not in doc or doc["enabled"]:
uuid = doc["user_id"]
if "keys" in doc:
pubkey = doc["keys"]["pgp"]
return uuid, pubkey
d.addCallback(_get_uuid_and_pubkey_cbk)
d.addErrback(lambda _: (None, None))
return d
def getPubkey(self, uuid):
"""
Query couch and return a deferred that will fire with the pgp public
key for user with given uuid.
:param uuid: The uuid of a user
:type uuid: str
:return: A deferred that will fire with the pgp public key for
the user.
:rtype: Deferred
"""
d = self.openView(docId="Identity",
viewId="by_user_id/",
key=uuid,
reduce=False,
include_docs=True)
def _get_pubkey_cbk(result):
pubkey = None
try:
doc = result["rows"][0]["doc"]
pubkey = doc["keys"]["pgp"]
except (KeyError, IndexError):
pass
return pubkey
d.addCallbacks(_get_pubkey_cbk, log.err)
return d
def getCertExpiry(self, fingerprint):
"""
Query couch and return a deferred that will fire with the expiration
date for the cert with the given fingerprint.
:param fingerprint: The cert fingerprint
:type fingerprint: str
:return: A deferred that will fire with the cert expiration date as a
str.
:rtype: Deferred
"""
d = self.openView(docId="Identity",
viewId="cert_expiry_by_fingerprint/",
key=fingerprint,
reduce=False,
include_docs=True)
def _get_cert_expiry_cbk(result):
try:
expiry = result["rows"][0]["value"]
except (KeyError, IndexError):
expiry = None
return expiry
d.addCallback(_get_cert_expiry_cbk)
return d
def put_doc(self, uuid, doc):
"""
Update a document.
If the document currently has conflicts, put will fail.
If the database specifies a maximum document size and the document
exceeds it, put will fail and raise a DocumentTooBig exception.
:param uuid: The uuid of a user
:type uuid: str
:param doc: A Document with new content.
:type doc: leap.soledad.common.couch.CouchDocument
:return: A deferred which fires with the new revision identifier for
the document if the Document object has being updated, or
which fails with CouchDBError if there was any error.
"""
# TODO: that should be implemented with paisley
url = self._mail_couch_url + "/user-%s" % (uuid,)
try:
db = CouchDatabase.open_database(url, create=False)
return defer.succeed(db.put_doc(doc))
except Exception as e:
return defer.fail(CouchDBError(e.message))
class CouchDBError(Exception):
pass
|
