451 lines
17 KiB
Python
451 lines
17 KiB
Python
# Copyright 2011-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.
|
|
|
|
"""Tests for SSL support."""
|
|
|
|
import os
|
|
import socket
|
|
import sys
|
|
|
|
sys.path[0:0] = [""]
|
|
|
|
try:
|
|
from ssl import CertificateError
|
|
except ImportError:
|
|
# Backport.
|
|
from pymongo.ssl_match_hostname import CertificateError
|
|
|
|
try:
|
|
from urllib.parse import quote_plus
|
|
except ImportError:
|
|
# Python 2
|
|
from urllib import quote_plus
|
|
|
|
from pymongo import MongoClient
|
|
from pymongo.errors import (ConfigurationError,
|
|
ConnectionFailure,
|
|
OperationFailure)
|
|
from pymongo.ssl_support import HAVE_SSL
|
|
from test import (client_knobs,
|
|
host,
|
|
pair,
|
|
port,
|
|
SkipTest,
|
|
unittest)
|
|
from test.utils import server_started_with_auth, remove_all_users, connected
|
|
from test.version import Version
|
|
|
|
|
|
CERT_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)),
|
|
'certificates')
|
|
CLIENT_PEM = os.path.join(CERT_PATH, 'client.pem')
|
|
CA_PEM = os.path.join(CERT_PATH, 'ca.pem')
|
|
SIMPLE_SSL = False
|
|
CERT_SSL = False
|
|
SERVER_IS_RESOLVABLE = False
|
|
MONGODB_X509_USERNAME = (
|
|
"CN=client,OU=kerneluser,O=10Gen,L=New York City,ST=New York,C=US")
|
|
|
|
# To fully test this 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 \
|
|
# --sslWeakCertificateValidation
|
|
# Also, make sure you have 'server' as an alias for localhost in /etc/hosts
|
|
#
|
|
# Note: For all replica set tests to pass, the replica set configuration must
|
|
# use 'server' for the hostname of all hosts.
|
|
|
|
def is_server_resolvable():
|
|
"""Returns True if 'server' is resolvable."""
|
|
socket_timeout = socket.getdefaulttimeout()
|
|
socket.setdefaulttimeout(1)
|
|
try:
|
|
try:
|
|
socket.gethostbyname('server')
|
|
return True
|
|
except socket.error:
|
|
return False
|
|
finally:
|
|
socket.setdefaulttimeout(socket_timeout)
|
|
|
|
# Shared ssl-enabled client for the tests
|
|
ssl_client = None
|
|
|
|
if HAVE_SSL:
|
|
import ssl
|
|
|
|
# Check this all once instead of before every test method below.
|
|
|
|
# Is MongoDB configured for SSL?
|
|
try:
|
|
with client_knobs(server_wait_time=0.1):
|
|
connected(MongoClient(host, port, ssl=True))
|
|
|
|
SIMPLE_SSL = True
|
|
except ConnectionFailure:
|
|
pass
|
|
|
|
# Is MongoDB configured with server.pem, ca.pem, and crl.pem from
|
|
# mongodb jstests/lib?
|
|
try:
|
|
with client_knobs(server_wait_time=0.1):
|
|
ssl_client = connected(MongoClient(
|
|
host, port, ssl=True, ssl_certfile=CLIENT_PEM))
|
|
|
|
CERT_SSL = True
|
|
except ConnectionFailure:
|
|
pass
|
|
|
|
if CERT_SSL:
|
|
SERVER_IS_RESOLVABLE = is_server_resolvable()
|
|
|
|
|
|
class TestClientSSL(unittest.TestCase):
|
|
|
|
def test_no_ssl_module(self):
|
|
# Test that ConfigurationError is raised if the ssl
|
|
# module isn't available.
|
|
if HAVE_SSL:
|
|
raise SkipTest(
|
|
"The ssl module is available, can't test what happens "
|
|
"without it."
|
|
)
|
|
|
|
# Explicit
|
|
self.assertRaises(ConfigurationError,
|
|
MongoClient, ssl=True)
|
|
|
|
# Implied
|
|
self.assertRaises(ConfigurationError,
|
|
MongoClient, ssl_certfile=CLIENT_PEM)
|
|
|
|
def test_config_ssl(self):
|
|
# Tests various ssl configurations
|
|
self.assertRaises(ConfigurationError, MongoClient, ssl='foo')
|
|
self.assertRaises(ConfigurationError,
|
|
MongoClient,
|
|
ssl=False,
|
|
ssl_certfile=CLIENT_PEM)
|
|
self.assertRaises(TypeError, MongoClient, ssl=0)
|
|
self.assertRaises(TypeError, MongoClient, ssl=5.5)
|
|
self.assertRaises(TypeError, MongoClient, ssl=[])
|
|
|
|
self.assertRaises(IOError, MongoClient, ssl_certfile="NoSuchFile")
|
|
self.assertRaises(TypeError, MongoClient, ssl_certfile=True)
|
|
self.assertRaises(TypeError, MongoClient, ssl_certfile=[])
|
|
self.assertRaises(IOError, MongoClient, ssl_keyfile="NoSuchFile")
|
|
self.assertRaises(TypeError, MongoClient, ssl_keyfile=True)
|
|
self.assertRaises(TypeError, MongoClient, ssl_keyfile=[])
|
|
|
|
# Test invalid combinations
|
|
self.assertRaises(ConfigurationError,
|
|
MongoClient,
|
|
ssl=False,
|
|
ssl_keyfile=CLIENT_PEM)
|
|
self.assertRaises(ConfigurationError,
|
|
MongoClient,
|
|
ssl=False,
|
|
ssl_certfile=CLIENT_PEM)
|
|
self.assertRaises(ConfigurationError,
|
|
MongoClient,
|
|
ssl=False,
|
|
ssl_keyfile=CLIENT_PEM,
|
|
ssl_certfile=CLIENT_PEM)
|
|
|
|
|
|
class TestSSL(unittest.TestCase):
|
|
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
if not HAVE_SSL:
|
|
raise SkipTest("The ssl module is not available.")
|
|
|
|
if sys.version.startswith('3.0'):
|
|
raise SkipTest("Python 3.0.x has problems "
|
|
"with SSL and socket timeouts.")
|
|
|
|
def test_simple_ssl(self):
|
|
# Expects the server to be running with ssl and with
|
|
# no --sslPEMKeyFile or with --sslWeakCertificateValidation
|
|
if not SIMPLE_SSL:
|
|
raise SkipTest("No simple mongod available over SSL")
|
|
|
|
client = MongoClient(host, port, ssl=True)
|
|
response = client.admin.command('ismaster')
|
|
if 'setName' in response:
|
|
client = MongoClient(pair,
|
|
replicaSet=response['setName'],
|
|
w=len(response['hosts']),
|
|
ssl=True)
|
|
|
|
db = client.pymongo_ssl_test
|
|
db.test.drop()
|
|
self.assertTrue(db.test.insert({'ssl': True}))
|
|
self.assertTrue(db.test.find_one()['ssl'])
|
|
client.drop_database('pymongo_ssl_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 eg:
|
|
#
|
|
# --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 CERT_SSL:
|
|
raise SkipTest("No mongod available over SSL with certs")
|
|
|
|
client = ssl_client
|
|
response = ssl_client.admin.command('ismaster')
|
|
if 'setName' in response:
|
|
client = MongoClient(pair,
|
|
replicaSet=response['setName'],
|
|
w=len(response['hosts']),
|
|
ssl=True, ssl_certfile=CLIENT_PEM)
|
|
|
|
db = client.pymongo_ssl_test
|
|
db.test.drop()
|
|
self.assertTrue(db.test.insert({'ssl': True}))
|
|
self.assertTrue(db.test.find_one()['ssl'])
|
|
client.drop_database('pymongo_ssl_test')
|
|
|
|
def test_cert_ssl_implicitly_set(self):
|
|
# Expects the server to be running with the server.pem, ca.pem
|
|
# and crl.pem provided in mongodb and the server tests eg:
|
|
#
|
|
# --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 CERT_SSL:
|
|
raise SkipTest("No mongod available over SSL with certs")
|
|
|
|
client = ssl_client
|
|
response = ssl_client.admin.command('ismaster')
|
|
if 'setName' in response:
|
|
client = MongoClient(pair,
|
|
replicaSet=response['setName'],
|
|
w=len(response['hosts']),
|
|
ssl_certfile=CLIENT_PEM)
|
|
|
|
db = client.pymongo_ssl_test
|
|
db.test.drop()
|
|
self.assertTrue(db.test.insert({'ssl': True}))
|
|
self.assertTrue(db.test.find_one()['ssl'])
|
|
client.drop_database('pymongo_ssl_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 eg:
|
|
#
|
|
# --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 CERT_SSL:
|
|
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 = MongoClient('server',
|
|
ssl=True,
|
|
ssl_certfile=CLIENT_PEM,
|
|
ssl_cert_reqs=ssl.CERT_REQUIRED,
|
|
ssl_ca_certs=CA_PEM)
|
|
response = 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 = MongoClient('server',
|
|
replicaSet=response['setName'],
|
|
w=len(response['hosts']),
|
|
ssl=True,
|
|
ssl_certfile=CLIENT_PEM,
|
|
ssl_cert_reqs=ssl.CERT_REQUIRED,
|
|
ssl_ca_certs=CA_PEM)
|
|
|
|
db = client.pymongo_ssl_test
|
|
db.test.drop()
|
|
self.assertTrue(db.test.insert({'ssl': True}))
|
|
self.assertTrue(db.test.find_one()['ssl'])
|
|
client.drop_database('pymongo_ssl_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 eg:
|
|
#
|
|
# --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 CERT_SSL:
|
|
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 = MongoClient('server',
|
|
ssl=True,
|
|
ssl_certfile=CLIENT_PEM,
|
|
ssl_cert_reqs=ssl.CERT_OPTIONAL,
|
|
ssl_ca_certs=CA_PEM)
|
|
|
|
response = 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 = MongoClient('server',
|
|
replicaSet=response['setName'],
|
|
w=len(response['hosts']),
|
|
ssl=True,
|
|
ssl_certfile=CLIENT_PEM,
|
|
ssl_cert_reqs=ssl.CERT_OPTIONAL,
|
|
ssl_ca_certs=CA_PEM)
|
|
|
|
db = client.pymongo_ssl_test
|
|
db.test.drop()
|
|
self.assertTrue(db.test.insert({'ssl': True}))
|
|
self.assertTrue(db.test.find_one()['ssl'])
|
|
client.drop_database('pymongo_ssl_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 eg:
|
|
#
|
|
# --sslPEMKeyFile=jstests/libs/server.pem
|
|
# --sslCAFile=jstests/libs/ca.pem
|
|
# --sslCRLFile=jstests/libs/crl.pem
|
|
if not CERT_SSL:
|
|
raise SkipTest("No mongod available over SSL with certs")
|
|
|
|
response = ssl_client.admin.command('ismaster')
|
|
|
|
with self.assertRaises(ConnectionFailure):
|
|
with client_knobs(server_wait_time=0.1):
|
|
connected(MongoClient(pair,
|
|
ssl=True,
|
|
ssl_certfile=CLIENT_PEM,
|
|
ssl_cert_reqs=ssl.CERT_REQUIRED,
|
|
ssl_ca_certs=CA_PEM))
|
|
|
|
self.fail("Invalid hostname should have failed")
|
|
|
|
if 'setName' in response:
|
|
with self.assertRaises(ConnectionFailure):
|
|
with client_knobs(server_wait_time=0.1):
|
|
connected(MongoClient(pair,
|
|
replicaSet=response['setName'],
|
|
ssl=True,
|
|
ssl_certfile=CLIENT_PEM,
|
|
ssl_cert_reqs=ssl.CERT_REQUIRED,
|
|
ssl_ca_certs=CA_PEM))
|
|
|
|
self.fail("Invalid hostname should have failed")
|
|
|
|
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 CERT_SSL:
|
|
raise SkipTest("No mongod available over SSL with certs")
|
|
|
|
if not Version.from_client(ssl_client).at_least(2, 5, 3, -1):
|
|
raise SkipTest("MONGODB-X509 tests require MongoDB 2.5.3 or newer")
|
|
if not server_started_with_auth(ssl_client):
|
|
raise SkipTest('Authentication is not enabled on server')
|
|
# Give admin all necessary privileges.
|
|
ssl_client['$external'].add_user(MONGODB_X509_USERNAME, roles=[
|
|
{'role': 'readWriteAnyDatabase', 'db': 'admin'},
|
|
{'role': 'userAdminAnyDatabase', 'db': 'admin'}])
|
|
coll = ssl_client.pymongo_test.test
|
|
try:
|
|
self.assertRaises(OperationFailure, coll.count)
|
|
self.assertTrue(ssl_client.admin.authenticate(
|
|
MONGODB_X509_USERNAME, mechanism='MONGODB-X509'))
|
|
self.assertTrue(coll.remove())
|
|
uri = ('mongodb://%s@%s:%d/?authMechanism='
|
|
'MONGODB-X509' % (
|
|
quote_plus(MONGODB_X509_USERNAME), host, port))
|
|
# SSL options aren't supported in the URI...
|
|
self.assertTrue(MongoClient(uri,
|
|
ssl=True, ssl_certfile=CLIENT_PEM))
|
|
|
|
# Should require a username
|
|
uri = ('mongodb://%s:%d/?authMechanism=MONGODB-X509' % (host,
|
|
port))
|
|
client_bad = MongoClient(uri, ssl=True, ssl_certfile=CLIENT_PEM)
|
|
self.assertRaises(OperationFailure,
|
|
client_bad.pymongo_test.test.remove)
|
|
|
|
# Auth should fail if username and certificate do not match
|
|
uri = ('mongodb://%s@%s:%d/?authMechanism='
|
|
'MONGODB-X509' % (
|
|
quote_plus("not the username"), host, port))
|
|
|
|
bad_client = MongoClient(uri, ssl=True, ssl_certfile=CLIENT_PEM)
|
|
with self.assertRaises(OperationFailure):
|
|
bad_client.pymongo_test.test.find_one()
|
|
|
|
self.assertRaises(OperationFailure, ssl_client.admin.authenticate,
|
|
"not the username",
|
|
mechanism="MONGODB-X509")
|
|
|
|
# Invalid certificate (using CA certificate as client certificate)
|
|
uri = ('mongodb://%s@%s:%d/?authMechanism='
|
|
'MONGODB-X509' % (
|
|
quote_plus(MONGODB_X509_USERNAME), host, port))
|
|
# These tests will raise SSLError (>= 3.2) or ConnectionFailure
|
|
# (2.x) depending on where OpenSSL first sees the PEM file.
|
|
try:
|
|
with client_knobs(server_wait_time=0.1):
|
|
connected(MongoClient(uri, ssl=True, ssl_certfile=CA_PEM))
|
|
except (ssl.SSLError, ConnectionFailure):
|
|
pass
|
|
else:
|
|
self.fail("Invalid certificate accepted.")
|
|
|
|
try:
|
|
with client_knobs(server_wait_time=0.1):
|
|
connected(MongoClient(pair, ssl=True, ssl_certfile=CA_PEM))
|
|
except (ssl.SSLError, ConnectionFailure):
|
|
pass
|
|
else:
|
|
self.fail("Invalid certificate accepted.")
|
|
|
|
# Cleanup
|
|
finally:
|
|
remove_all_users(ssl_client['$external'])
|
|
ssl_client['$external'].logout()
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|