Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[auth] Add tests for Basic auth CAs on OGR and PG
providers
- Loading branch information
Showing
3 changed files
with
248 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,246 @@ | ||
| # -*- coding: utf-8 -*- | ||
| """ | ||
| Tests for auth manager Basic Auth access to postgres. | ||
| This is an integration test for QGIS Desktop Auth Manager postgres provider that | ||
| checks if QGIS can use a stored auth manager auth configuration to access | ||
| a username/password protected postgres. | ||
| Configuration from the environment: | ||
| * QGIS_POSTGRES_SERVER_PORT (default: 55432) | ||
| * QGIS_POSTGRES_EXECUTABLE_PATH (default: /usr/lib/postgresql/9.4/bin) | ||
| From build dir, run: ctest -R PyQgsAuthManagerOgrPostgresTest -V | ||
| or, if your PostgreSQL path differs from the default: | ||
| QGIS_POSTGRES_EXECUTABLE_PATH=/usr/lib/postgresql/<your_version_goes_here>/bin \ | ||
| ctest -R PyQgsAuthManagerOgrPostgresTest -V | ||
| .. note:: 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 2 of the License, or | ||
| (at your option) any later version. | ||
| """ | ||
| import os | ||
| import time | ||
| import signal | ||
| import stat | ||
| import subprocess | ||
| import tempfile | ||
|
|
||
| from shutil import rmtree | ||
|
|
||
| from utilities import unitTestDataPath | ||
| from qgis.core import ( | ||
| QgsApplication, | ||
| QgsAuthManager, | ||
| QgsAuthMethodConfig, | ||
| QgsVectorLayer, | ||
| QgsDataSourceUri, | ||
| QgsWkbTypes, | ||
| ) | ||
|
|
||
| from qgis.PyQt.QtNetwork import QSslCertificate | ||
|
|
||
| from qgis.testing import ( | ||
| start_app, | ||
| unittest, | ||
| ) | ||
|
|
||
|
|
||
| __author__ = 'Alessandro Pasotti' | ||
| __date__ = '03/11/2017' | ||
| __copyright__ = 'Copyright 2017, The QGIS Project' | ||
| # This will get replaced with a git SHA1 when you do a git archive | ||
| __revision__ = '$Format:%H$' | ||
|
|
||
| QGIS_POSTGRES_SERVER_PORT = os.environ.get('QGIS_POSTGRES_SERVER_PORT', '55432') | ||
| QGIS_POSTGRES_EXECUTABLE_PATH = os.environ.get('QGIS_POSTGRES_EXECUTABLE_PATH', '/usr/lib/postgresql/9.4/bin') | ||
|
|
||
| assert os.path.exists(QGIS_POSTGRES_EXECUTABLE_PATH) | ||
|
|
||
| QGIS_AUTH_DB_DIR_PATH = tempfile.mkdtemp() | ||
|
|
||
| # Postgres test path | ||
| QGIS_PG_TEST_PATH = tempfile.mkdtemp() | ||
|
|
||
| os.environ['QGIS_AUTH_DB_DIR_PATH'] = QGIS_AUTH_DB_DIR_PATH | ||
|
|
||
| qgis_app = start_app() | ||
|
|
||
| QGIS_POSTGRES_CONF_TEMPLATE = """ | ||
| hba_file = '%(tempfolder)s/pg_hba.conf' | ||
| listen_addresses = '*' | ||
| port = %(port)s | ||
| max_connections = 100 | ||
| unix_socket_directories = '%(tempfolder)s' | ||
| ssl = true | ||
| ssl_ciphers = 'DEFAULT:!LOW:!EXP:!MD5:@STRENGTH' # allowed SSL ciphers | ||
| ssl_cert_file = '%(server_cert)s' | ||
| ssl_key_file = '%(server_key)s' | ||
| ssl_ca_file = '%(sslrootcert_path)s' | ||
| password_encryption = on | ||
| """ | ||
|
|
||
| QGIS_POSTGRES_HBA_TEMPLATE = """ | ||
| hostssl all all 0.0.0.0/0 md5 | ||
| hostssl all all ::1/0 md5 | ||
| host all all 127.0.0.1/32 trust | ||
| host all all ::1/32 trust | ||
| host all all 0.0.0.0/0 trust | ||
| """ | ||
|
|
||
|
|
||
| class TestAuthManager(unittest.TestCase): | ||
|
|
||
| @classmethod | ||
| def setUpAuth(cls): | ||
| """Run before all tests and set up authentication""" | ||
| authm = QgsApplication.authManager() | ||
| assert (authm.setMasterPassword('masterpassword', True)) | ||
| cls.pg_conf = os.path.join(cls.tempfolder, 'postgresql.conf') | ||
| cls.pg_hba = os.path.join(cls.tempfolder, 'pg_hba.conf') | ||
| # Client side | ||
| cls.sslrootcert_path = os.path.join(cls.certsdata_path, 'chains_subissuer-issuer-root_issuer2-root2.pem') | ||
| assert os.path.isfile(cls.sslrootcert_path) | ||
| os.chmod(cls.sslrootcert_path, stat.S_IRUSR) | ||
| cls.auth_config = QgsAuthMethodConfig("Basic") | ||
| cls.auth_config.setConfig('username', cls.username) | ||
| cls.auth_config.setConfig('password', cls.password) | ||
| cls.auth_config.setName('test_basic_auth_config') | ||
| cls.sslrootcert = QSslCertificate.fromPath(cls.sslrootcert_path) | ||
| assert cls.sslrootcert is not None | ||
| authm.storeCertAuthorities(cls.sslrootcert) | ||
| authm.rebuildCaCertsCache() | ||
| authm.rebuildTrustedCaCertsCache() | ||
| authm.rebuildCertTrustCache() | ||
| assert (authm.storeAuthenticationConfig(cls.auth_config)[0]) | ||
| assert cls.auth_config.isValid() | ||
| cls.authcfg = cls.auth_config.id() | ||
|
|
||
| # Server side | ||
| cls.server_cert = os.path.join(cls.certsdata_path, 'localhost_ssl_cert.pem') | ||
| cls.server_key = os.path.join(cls.certsdata_path, 'localhost_ssl_key.pem') | ||
| cls.server_rootcert = cls.sslrootcert_path | ||
| os.chmod(cls.server_cert, stat.S_IRUSR) | ||
| os.chmod(cls.server_key, stat.S_IRUSR) | ||
| os.chmod(cls.server_rootcert, stat.S_IRUSR) | ||
|
|
||
| # Place conf in the data folder | ||
| with open(cls.pg_conf, 'w+') as f: | ||
| f.write(QGIS_POSTGRES_CONF_TEMPLATE % { | ||
| 'port': cls.port, | ||
| 'tempfolder': cls.tempfolder, | ||
| 'server_cert': cls.server_cert, | ||
| 'server_key': cls.server_key, | ||
| 'sslrootcert_path': cls.sslrootcert_path, | ||
| }) | ||
|
|
||
| with open(cls.pg_hba, 'w+') as f: | ||
| f.write(QGIS_POSTGRES_HBA_TEMPLATE) | ||
|
|
||
| @classmethod | ||
| def setUpClass(cls): | ||
| """Run before all tests: | ||
| Creates an auth configuration""" | ||
| cls.port = QGIS_POSTGRES_SERVER_PORT | ||
| cls.username = 'username' | ||
| cls.password = 'password' | ||
| cls.dbname = 'test_basic' | ||
| cls.tempfolder = QGIS_PG_TEST_PATH | ||
| cls.certsdata_path = os.path.join(unitTestDataPath('auth_system'), 'certs_keys') | ||
| cls.hostname = 'localhost' | ||
| cls.data_path = os.path.join(cls.tempfolder, 'data') | ||
| os.mkdir(cls.data_path) | ||
|
|
||
| cls.setUpAuth() | ||
| subprocess.check_call([os.path.join(QGIS_POSTGRES_EXECUTABLE_PATH, 'initdb'), '-D', cls.data_path]) | ||
|
|
||
| # Disable SSL verification for setup operations | ||
| env = dict(os.environ) | ||
| env['PGSSLMODE'] = 'disable' | ||
|
|
||
| cls.server = subprocess.Popen([os.path.join(QGIS_POSTGRES_EXECUTABLE_PATH, 'postgres'), '-D', | ||
| cls.data_path, '-c', | ||
| "config_file=%s" % cls.pg_conf], | ||
| env=env, | ||
| stdout=subprocess.PIPE, | ||
| stderr=subprocess.PIPE) | ||
| # Wait max 10 secs for the server to start | ||
| end = time.time() + 10 | ||
| while True: | ||
| line = cls.server.stderr.readline() | ||
| print(line) | ||
| if line.find(b"database system is ready to accept") != -1: | ||
| break | ||
| if time.time() > end: | ||
| raise Exception("Timeout connecting to PostgreSQL") | ||
| # Create a DB | ||
| subprocess.check_call([os.path.join(QGIS_POSTGRES_EXECUTABLE_PATH, 'createdb'), '-h', 'localhost', '-p', cls.port, 'test_basic'], env=env) | ||
| # Inject test SQL from test path | ||
| test_sql = os.path.join(unitTestDataPath('provider'), 'testdata_pg.sql') | ||
| subprocess.check_call([os.path.join(QGIS_POSTGRES_EXECUTABLE_PATH, 'psql'), '-h', 'localhost', '-p', cls.port, '-f', test_sql, cls.dbname], env=env) | ||
| # Create a role | ||
| subprocess.check_call([os.path.join(QGIS_POSTGRES_EXECUTABLE_PATH, 'psql'), '-h', 'localhost', '-p', cls.port, '-c', 'CREATE ROLE "%s" WITH SUPERUSER LOGIN PASSWORD \'%s\'' % (cls.username, cls.password), cls.dbname], env=env) | ||
|
|
||
| @classmethod | ||
| def tearDownClass(cls): | ||
| """Run after all tests""" | ||
| cls.server.terminate() | ||
| os.kill(cls.server.pid, signal.SIGABRT) | ||
| del cls.server | ||
| time.sleep(2) | ||
| rmtree(QGIS_AUTH_DB_DIR_PATH) | ||
| rmtree(cls.tempfolder) | ||
|
|
||
| def setUp(self): | ||
| """Run before each test.""" | ||
| pass | ||
|
|
||
| def tearDown(self): | ||
| """Run after each test.""" | ||
| pass | ||
|
|
||
| @classmethod | ||
| def _getPostGISLayer(cls, type_name, layer_name=None, authcfg=''): | ||
| """ | ||
| PG layer factory | ||
| """ | ||
| if layer_name is None: | ||
| layer_name = 'pg_' + type_name | ||
|
|
||
| # Warning: OGR needs the schema if it's not the default, so qgis_test.someData | ||
| connstring = "PG:dbname='%(dbname)s' host='%(hostname)s' port='%(port)s' sslmode='verify-full' sslrootcert='%(sslrootcert)s'%(authcfg)s|layername=qgis_test.someData" % ( | ||
| { | ||
| 'dbname': cls.dbname, | ||
| 'hostname': cls.hostname, | ||
| 'port': cls.port, | ||
| 'authcfg': ' authcfg=\'%s\'' % authcfg if authcfg else '', | ||
| 'sslrootcert': cls.sslrootcert_path, | ||
| } | ||
| ) | ||
| layer = QgsVectorLayer(connstring, layer_name, 'ogr') | ||
| return layer | ||
|
|
||
| def testValidAuthAccess(self): | ||
| """ | ||
| Access the protected layer with valid credentials | ||
| """ | ||
| pg_layer = self._getPostGISLayer('testlayer_èé', authcfg=self.auth_config.id()) | ||
| self.assertTrue(pg_layer.isValid()) | ||
|
|
||
| def testInvalidAuthAccess(self): | ||
| """ | ||
| Access the protected layer with not valid credentials | ||
| """ | ||
| pg_layer = self._getPostGISLayer('testlayer_èé') | ||
| self.assertFalse(pg_layer.isValid()) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| unittest.main() |