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
|
# -*- coding: utf-8 -*-
# state.py
# Copyright (C) 2015,2016 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/>.
"""
Server state using CouchDatabase as backend.
"""
import couchdb
import re
from six.moves.urllib.parse import urljoin
from leap.soledad.common.log import getLogger
from leap.soledad.common.couch import CouchDatabase
from leap.soledad.common.couch import CONFIG_DOC_ID
from leap.soledad.common.couch import SCHEMA_VERSION
from leap.soledad.common.couch import SCHEMA_VERSION_KEY
from leap.soledad.common.command import exec_validated_cmd
from leap.soledad.common.l2db.remote.server_state import ServerState
from leap.soledad.common.l2db.errors import Unauthorized
from leap.soledad.common.errors import WrongCouchSchemaVersionError
from leap.soledad.common.errors import MissingCouchConfigDocumentError
logger = getLogger(__name__)
def is_db_name_valid(name):
"""
Validate a user database using a regular expression.
:param name: database name.
:type name: str
:return: boolean for name vailidity
:rtype: bool
"""
db_name_regex = "^user-[a-f0-9]+$"
return re.match(db_name_regex, name) is not None
class CouchServerState(ServerState):
"""
Inteface of the WSGI server with the CouchDB backend.
"""
def __init__(self, couch_url, create_cmd=None,
check_schema_versions=False):
"""
Initialize the couch server state.
:param couch_url: The URL for the couch database.
:type couch_url: str
:param create_cmd: Command to be executed for user db creation. It will
receive a properly sanitized parameter with user db
name and should access CouchDB with necessary
privileges, which server lacks for security reasons.
:type create_cmd: str
:param check_schema_versions: Whether to check couch schema version of
user dbs. Set to False as this is only
intended to run once during start-up.
:type check_schema_versions: bool
"""
self.couch_url = couch_url
self.create_cmd = create_cmd
if check_schema_versions:
self._check_schema_versions()
def _check_schema_versions(self):
"""
Check that all user databases use the correct couch schema.
"""
server = couchdb.client.Server(self.couch_url)
for dbname in server:
if not dbname.startswith('user-'):
continue
db = server[dbname]
# if there are documents, ensure that a config doc exists
config_doc = db.get(CONFIG_DOC_ID)
if config_doc:
if config_doc[SCHEMA_VERSION_KEY] != SCHEMA_VERSION:
logger.error(
"Unsupported database schema in database %s" % dbname)
raise WrongCouchSchemaVersionError(dbname)
else:
result = db.view('_all_docs', limit=1)
if result.total_rows != 0:
logger.error(
"Missing couch config document in database %s"
% dbname)
raise MissingCouchConfigDocumentError(dbname)
def open_database(self, dbname):
"""
Open a couch database.
:param dbname: The name of the database to open.
:type dbname: str
:return: The SoledadBackend object.
:rtype: SoledadBackend
"""
url = urljoin(self.couch_url, dbname)
db = CouchDatabase.open_database(url, create=False)
return db
def ensure_database(self, dbname):
"""
Ensure couch database exists.
:param dbname: The name of the database to ensure.
:type dbname: str
:raise Unauthorized: If disabled or other error was raised.
:return: The SoledadBackend object and its replica_uid.
:rtype: (SoledadBackend, str)
"""
if not self.create_cmd:
raise Unauthorized()
else:
code, out = exec_validated_cmd(self.create_cmd, dbname,
validator=is_db_name_valid)
if code is not 0:
logger.error("""
Error while creating database (%s) with (%s) command.
Output: %s
Exit code: %d
""" % (dbname, self.create_cmd, out, code))
raise Unauthorized()
db = self.open_database(dbname)
return db, db.replica_uid
def delete_database(self, dbname):
"""
Delete couch database.
:param dbname: The name of the database to delete.
:type dbname: str
:raise Unauthorized: Always, because Soledad server is not allowed to
delete databases.
"""
raise Unauthorized()
|
