-
Notifications
You must be signed in to change notification settings - Fork 207
/
test_motor_ssl.py
346 lines (286 loc) · 12.7 KB
/
test_motor_ssl.py
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
# Copyright 2012-2014 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Test Motor, an asynchronous driver for MongoDB and Tornado."""
import socket
import ssl
from urllib import quote_plus
from nose.plugins.skip import SkipTest
from pymongo.common import HAS_SSL
from pymongo.errors import (ConfigurationError,
ConnectionFailure,
OperationFailure)
from tornado.testing import gen_test
import motor
import test
from test import MotorTest, host, port, version
from test import HAVE_SSL, CLIENT_PEM, CA_PEM
from test.utils import server_started_with_auth, remove_all_users
# Whether 'server' is a resolvable hostname.
SERVER_IS_RESOLVABLE = False
MONGODB_X509_USERNAME = \
"CN=client,OU=kerneluser,O=10Gen,L=New York City,ST=New York,C=US"
# Start a mongod instance (built with SSL support) like so:
#
# mongod --dbpath /path/to/data/directory --sslOnNormalPorts \
# --sslPEMKeyFile /path/to/mongo/jstests/libs/server.pem \
# --sslCAFile /path/to/mongo/jstests/libs/ca.pem \
# --sslCRLFile /path/to/mongo/jstests/libs/crl.pem
#
# Optionally, also pass --sslWeakCertificateValidation to run test_simple_ssl.
#
# For all tests to pass with MotorReplicaSetClient, the replica set
# configuration must use 'server' for the hostname of all hosts.
# Make sure you have 'server' as an alias for localhost in /etc/hosts.
def is_server_resolvable():
"""Returns True if 'server' is resolvable."""
socket_timeout = socket.getdefaulttimeout()
socket.setdefaulttimeout(1)
try:
socket.gethostbyname('server')
return True
except socket.error:
return False
finally:
socket.setdefaulttimeout(socket_timeout)
def setup_module():
global SERVER_IS_RESOLVABLE
if HAVE_SSL and test.mongod_validates_client_cert:
SERVER_IS_RESOLVABLE = is_server_resolvable()
class MotorNoSSLTest(MotorTest):
ssl = True
def test_no_ssl(self):
# Test that ConfigurationError is raised if the ssl
# module isn't available.
if HAS_SSL:
raise SkipTest(
"We have SSL compiled into Python, can't test what happens "
"without SSL")
# ssl=True is passed explicitly.
self.assertRaises(ConfigurationError,
motor.MotorClient, ssl=True)
self.assertRaises(ConfigurationError,
motor.MotorReplicaSetClient,
replicaSet='rs',
ssl=True)
# ssl=True is implied.
self.assertRaises(ConfigurationError,
motor.MotorClient,
ssl_certfile=CLIENT_PEM)
self.assertRaises(ConfigurationError,
motor.MotorReplicaSetClient,
replicaSet='rs',
ssl_certfile=CLIENT_PEM)
class MotorSSLTest(MotorTest):
ssl = True
def setUp(self):
if not HAS_SSL:
raise SkipTest("The ssl module is not available.")
super(MotorSSLTest, self).setUp()
def test_config_ssl(self):
self.assertRaises(ConfigurationError, motor.MotorClient, ssl='foo')
self.assertRaises(ConfigurationError,
motor.MotorClient,
ssl=False,
ssl_certfile=CLIENT_PEM)
self.assertRaises(ConfigurationError,
motor.MotorReplicaSetClient,
replicaSet='rs',
ssl='foo')
self.assertRaises(ConfigurationError,
motor.MotorReplicaSetClient,
replicaSet='rs',
ssl=False,
ssl_certfile=CLIENT_PEM)
self.assertRaises(IOError, motor.MotorClient, ssl_certfile="NoFile")
self.assertRaises(TypeError, motor.MotorClient, ssl_certfile=True)
self.assertRaises(IOError, motor.MotorClient, ssl_keyfile="NoFile")
self.assertRaises(TypeError, motor.MotorClient, ssl_keyfile=True)
@gen_test
def test_simple_ssl(self):
if test.mongod_validates_client_cert:
raise SkipTest("mongod validates SSL certs")
# Expects the server to be running with ssl and with
# no --sslPEMKeyFile or with --sslWeakCertificateValidation.
client = motor.MotorClient(host, port, ssl=True)
yield client.db.collection.find_one()
response = yield client.admin.command('ismaster')
if 'setName' in response:
client = motor.MotorReplicaSetClient(
'%s:%d' % (host, port),
replicaSet=response['setName'],
ssl=True)
yield client.db.collection.find_one()
@gen_test
def test_cert_ssl(self):
# Expects the server to be running with the server.pem, ca.pem
# and crl.pem provided in mongodb and the server tests e.g.:
#
# --sslPEMKeyFile=jstests/libs/server.pem
# --sslCAFile=jstests/libs/ca.pem
# --sslCRLFile=jstests/libs/crl.pem
#
# Also requires an /etc/hosts entry where "server" is resolvable.
if not test.mongod_validates_client_cert:
raise SkipTest("No mongod available over SSL with certs")
if not SERVER_IS_RESOLVABLE:
raise SkipTest("No hosts entry for 'server'. Cannot validate "
"hostname in the certificate")
client = motor.MotorClient(host, port, ssl_certfile=CLIENT_PEM)
yield client.db.collection.find_one()
response = yield client.admin.command('ismaster')
if 'setName' in response:
client = motor.MotorReplicaSetClient(
'%s:%d' % (host, port),
replicaSet=response['setName'],
ssl=True,
ssl_certfile=CLIENT_PEM)
yield client.db.collection.find_one()
@gen_test
def test_cert_ssl_validation(self):
# Expects the server to be running with the server.pem, ca.pem
# and crl.pem provided in mongodb and the server tests e.g.:
#
# --sslPEMKeyFile=jstests/libs/server.pem
# --sslCAFile=jstests/libs/ca.pem
# --sslCRLFile=jstests/libs/crl.pem
#
# Also requires an /etc/hosts entry where "server" is resolvable.
if not test.mongod_validates_client_cert:
raise SkipTest("No mongod available over SSL with certs")
if not SERVER_IS_RESOLVABLE:
raise SkipTest("No hosts entry for 'server'. Cannot validate "
"hostname in the certificate")
client = motor.MotorClient(
'server',
ssl_certfile=CLIENT_PEM,
ssl_cert_reqs=ssl.CERT_REQUIRED,
ssl_ca_certs=CA_PEM)
yield client.db.collection.find_one()
response = yield client.admin.command('ismaster')
if 'setName' in response:
if response['primary'].split(":")[0] != 'server':
raise SkipTest("No hosts in the replicaset for 'server'. "
"Cannot validate hostname in the certificate")
client = motor.MotorReplicaSetClient(
'server',
replicaSet=response['setName'],
ssl_certfile=CLIENT_PEM,
ssl_cert_reqs=ssl.CERT_REQUIRED,
ssl_ca_certs=CA_PEM)
yield client.db.collection.find_one()
@gen_test
def test_cert_ssl_validation_optional(self):
# Expects the server to be running with the server.pem, ca.pem
# and crl.pem provided in mongodb and the server tests e.g.:
#
# --sslPEMKeyFile=jstests/libs/server.pem
# --sslCAFile=jstests/libs/ca.pem
# --sslCRLFile=jstests/libs/crl.pem
#
# Also requires an /etc/hosts entry where "server" is resolvable.
if not test.mongod_validates_client_cert:
raise SkipTest("No mongod available over SSL with certs")
if not SERVER_IS_RESOLVABLE:
raise SkipTest("No hosts entry for 'server'. Cannot validate "
"hostname in the certificate")
client = motor.MotorClient(
'server',
ssl_certfile=CLIENT_PEM,
ssl_cert_reqs=ssl.CERT_OPTIONAL,
ssl_ca_certs=CA_PEM)
response = yield client.admin.command('ismaster')
if 'setName' in response:
if response['primary'].split(":")[0] != 'server':
raise SkipTest("No hosts in the replicaset for 'server'. "
"Cannot validate hostname in the certificate")
client = motor.MotorReplicaSetClient(
'server',
replicaSet=response['setName'],
ssl_certfile=CLIENT_PEM,
ssl_cert_reqs=ssl.CERT_OPTIONAL,
ssl_ca_certs=CA_PEM)
yield client.db.collection.find_one()
@gen_test
def test_cert_ssl_validation_hostname_fail(self):
# Expects the server to be running with the server.pem, ca.pem
# and crl.pem provided in mongodb and the server tests e.g.:
#
# --sslPEMKeyFile=jstests/libs/server.pem
# --sslCAFile=jstests/libs/ca.pem
# --sslCRLFile=jstests/libs/crl.pem
if not test.mongod_validates_client_cert:
raise SkipTest("No mongod available over SSL with certs")
client = motor.MotorClient(
host, port, ssl=True, ssl_certfile=CLIENT_PEM)
response = yield client.admin.command('ismaster')
try:
# Create client with hostname 'localhost' or whatever, not
# the name 'server', which is what the server cert presents.
client = motor.MotorClient(
host, port,
ssl_certfile=CLIENT_PEM,
ssl_cert_reqs=ssl.CERT_REQUIRED,
ssl_ca_certs=CA_PEM)
yield client.db.collection.find_one()
self.fail("Invalid hostname should have failed")
except ConnectionFailure:
pass
if 'setName' in response:
try:
client = motor.MotorReplicaSetClient(
'%s:%d' % (host, port),
replicaSet=response['setName'],
ssl_certfile=CLIENT_PEM,
ssl_cert_reqs=ssl.CERT_REQUIRED,
ssl_ca_certs=CA_PEM)
yield client.db.collection.find_one()
self.fail("Invalid hostname should have failed")
except ConnectionFailure:
pass
@gen_test
def test_mongodb_x509_auth(self):
# Expects the server to be running with the server.pem, ca.pem
# and crl.pem provided in mongodb and the server tests as well as
# --auth:
#
# --sslPEMKeyFile=jstests/libs/server.pem
# --sslCAFile=jstests/libs/ca.pem
# --sslCRLFile=jstests/libs/crl.pem
# --auth
if not test.mongod_validates_client_cert:
raise SkipTest("No mongod available over SSL with certs")
client = motor.MotorClient(host, port, ssl_certfile=CLIENT_PEM)
if not (yield version.at_least(client, (2, 5, 3, -1))):
raise SkipTest("MONGODB-X509 tests require MongoDB 2.5.3 or newer")
if not (yield server_started_with_auth(client)):
raise SkipTest('Authentication is not enabled on server')
# Give admin all necessary privileges.
yield client['$external'].add_user(MONGODB_X509_USERNAME, roles=[
{'role': 'readWriteAnyDatabase', 'db': 'admin'},
{'role': 'userAdminAnyDatabase', 'db': 'admin'}])
collection = client.motor_test.test
with test.assert_raises(OperationFailure):
yield collection.count()
yield client.admin.authenticate(
MONGODB_X509_USERNAME, mechanism='MONGODB-X509')
yield collection.remove()
uri = ('mongodb://%s@%s:%d/?authMechanism='
'MONGODB-X509' % (
quote_plus(MONGODB_X509_USERNAME), host, port))
# SSL options aren't supported in the URI....
auth_uri_client = motor.MotorClient(uri, ssl_certfile=CLIENT_PEM)
yield auth_uri_client.db.collection.find_one()
# Cleanup.
yield remove_all_users(client['$external'])
yield client['$external'].logout()