Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport release_3_8] fix authenticating layers against qGIS auth config #5282

Merged
merged 6 commits into from
Jan 28, 2025
Merged

[Backport release_3_8] fix authenticating layers against qGIS auth config #5282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5cc01a1
bug:4470 authenticating layers against qGIS auth config
cfsgarcia Sep 26, 2024
49b9add
bug:4470 replace user/pwd in jdbParams with authcfg ones
cfsgarcia Sep 26, 2024
9cc940d
bug:4470 Lint / PHP-CS-Fixer (pull_request)
cfsgarcia Sep 27, 2024
8b59312
Run PHP-CS-Fixer
Gustry Sep 27, 2024
094cc64
bug:4470 authenticating layers against qGIS auth config - PHP unit tests
rldhont Jan 24, 2025
dd9f8d6
Rephrasing authcfg usage
rldhont Jan 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion lizmap/modules/lizmap/classes/qgisVectorLayer.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ public function getDatasourceParameters()
);
$parameters = array(
'dbname', 'service', 'host', 'port', 'user', 'password',
'sslmode', 'key', 'estimatedmetadata', 'selectatid',
'sslmode', 'authcfg', 'key', 'estimatedmetadata', 'selectatid',
'srid', 'type', 'checkPrimaryKeyUnicity',
'table', 'geocol', 'sql', 'schema', 'tablename',
);
Expand Down Expand Up @@ -279,6 +279,23 @@ public function getDatasourceProfile($timeout = 30, $setSearchPathFromLayer = tr
if (!empty($dtParams->sslmode)) {
$jdbParams['sslmode'] = $dtParams->sslmode;
}
// When the QGIS authentication config is used to authenticate a layer,
// it requires to have set up "jdb::profile" to align with the login credentials set in QGIS "authcfg"
if (!empty($dtParams->authcfg)) {
$jdbParams['authcfg'] = $dtParams->authcfg;
// retrieving user/password from the corresponding jdb::profile in profiles.ini.php.
$ini = new \Jelix\IniFile\IniModifier(jApp::varConfigPath('profiles.ini.php'));
$profiles = $ini->getSectionList();
foreach ($profiles as $profile) {
if ($profile == 'jdb:'.$dtParams->authcfg) {
$options = $ini->getValues($profile);
$jdbParams['user'] = $options['user'];
$jdbParams['password'] = $options['password'];

break;
}
}
}
}
if (!empty($dtParams->schema) && $setSearchPathFromLayer) {
$jdbParams['search_path'] = '"'.$dtParams->schema.'",public';
Expand Down
1 change: 1 addition & 0 deletions lizmap/modules/lizmap/classes/qgisVectorLayerDatasource.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ class qgisVectorLayerDatasource
'user' => "user='?([^ ']+)'? ",
'password' => "password='?([^ ']+)'? ",
'sslmode' => "sslmode='?([^ ']+)'? ",
'authcfg' => "authcfg='?([^ ']+)'? ",
'key' => "key='?([^ ']+)'? ",
'estimatedmetadata' => 'estimatedmetadata=([^ ]+) ',
'selectatid' => 'selectatid=([^ ]+) ',
Expand Down
63 changes: 63 additions & 0 deletions tests/units/edition/qgisVectorLayerDatasourceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public function testPostgresqlDatasource()
$this->assertEquals('5432', $element->getDatasourceParameter('port'));
$this->assertEquals('test_user', $element->getDatasourceParameter('user'));
$this->assertEquals('test_password', $element->getDatasourceParameter('password'));
$this->assertEquals('', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
Expand All @@ -47,6 +48,7 @@ public function testPostgresqlDatasource()
$this->assertEquals('5432', $element->getDatasourceParameter('port'));
$this->assertEquals('test_user', $element->getDatasourceParameter('user'));
$this->assertEquals('test_password', $element->getDatasourceParameter('password'));
$this->assertEquals('', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
Expand Down Expand Up @@ -74,6 +76,7 @@ public function testPostgresDatasourceWithoutGeometry()
$this->assertEquals('5432', $element->getDatasourceParameter('port'));
$this->assertEquals('test_user', $element->getDatasourceParameter('user'));
$this->assertEquals('test_password', $element->getDatasourceParameter('password'));
$this->assertEquals('', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('true', $element->getDatasourceParameter('estimatedmetadata'));
Expand Down Expand Up @@ -101,6 +104,7 @@ public function testPostgresqlDatasourceWithService()
$this->assertEquals('', $element->getDatasourceParameter('port'));
$this->assertEquals('', $element->getDatasourceParameter('user'));
$this->assertEquals('', $element->getDatasourceParameter('password'));
$this->assertEquals('', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
Expand Down Expand Up @@ -128,6 +132,63 @@ public function testPostgresqlDatasourceWithoutGeometryWithServiceWithoutSql()
$this->assertEquals('', $element->getDatasourceParameter('port'));
$this->assertEquals('', $element->getDatasourceParameter('user'));
$this->assertEquals('', $element->getDatasourceParameter('password'));
$this->assertEquals('', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
$this->assertEquals('', $element->getDatasourceParameter('selectatid'));
$this->assertEquals('2193', $element->getDatasourceParameter('srid'));
$this->assertEquals('', $element->getDatasourceParameter('type'));
$this->assertEquals('1', $element->getDatasourceParameter('checkPrimaryKeyUnicity'));
$this->assertEquals('"public"."EditTest"', $element->getDatasourceParameter('table'));
$this->assertEquals('EditTest', $element->getDatasourceParameter('tablename'));
$this->assertEquals('public', $element->getDatasourceParameter('schema'));
$this->assertEquals('', $element->getDatasourceParameter('geocol'));
$this->assertEquals('', $element->getDatasourceParameter('sql'));
}

public function testPostgresqlDatasourceWithAuthcfg()
{
$provider = 'postgres';
$datasource = "dbname='test_dbname' host=127.0.0.1 port=5432 authcfg='lizmap-test' sslmode=disable key='id' srid=4326 type=Polygon checkPrimaryKeyUnicity='1' table=\"test_schema\".\"test_table\" (geom) sql=";

$element = new qgisVectorLayerDatasource($provider, $datasource);

$this->assertEquals('test_dbname', $element->getDatasourceParameter('dbname'));
$this->assertEquals('', $element->getDatasourceParameter('service'));
$this->assertEquals('127.0.0.1', $element->getDatasourceParameter('host'));
$this->assertEquals('5432', $element->getDatasourceParameter('port'));
$this->assertEquals('', $element->getDatasourceParameter('user'));
$this->assertEquals('', $element->getDatasourceParameter('password'));
$this->assertEquals('lizmap-test', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
$this->assertEquals('', $element->getDatasourceParameter('selectatid'));
$this->assertEquals('4326', $element->getDatasourceParameter('srid'));
$this->assertEquals('Polygon', $element->getDatasourceParameter('type'));
$this->assertEquals('1', $element->getDatasourceParameter('checkPrimaryKeyUnicity'));
$this->assertEquals('"test_schema"."test_table"', $element->getDatasourceParameter('table'));
$this->assertEquals('test_table', $element->getDatasourceParameter('tablename'));
$this->assertEquals('test_schema', $element->getDatasourceParameter('schema'));
$this->assertEquals('geom', $element->getDatasourceParameter('geocol'));
$this->assertEquals('', $element->getDatasourceParameter('sql'));
}

public function testPostgresqlDatasourceWithoutGeometryWithAuthcfgWithoutSql()
{
$provider = 'postgres';
$datasource = "dbname='test_dbname' host=127.0.0.1 port=5432 authcfg='lizmap-test' sslmode=disable key='id' srid=2193 checkPrimaryKeyUnicity='1' table=\"public\".\"EditTest\"";

$element = new qgisVectorLayerDatasource($provider, $datasource);

$this->assertEquals('test_dbname', $element->getDatasourceParameter('dbname'));
$this->assertEquals('', $element->getDatasourceParameter('service'));
$this->assertEquals('127.0.0.1', $element->getDatasourceParameter('host'));
$this->assertEquals('5432', $element->getDatasourceParameter('port'));
$this->assertEquals('', $element->getDatasourceParameter('user'));
$this->assertEquals('', $element->getDatasourceParameter('password'));
$this->assertEquals('lizmap-test', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
Expand Down Expand Up @@ -155,6 +216,7 @@ public function testPostgresDatasourceSimpleTableWithSql()
$this->assertEquals('5432', $element->getDatasourceParameter('port'));
$this->assertEquals('test_user', $element->getDatasourceParameter('user'));
$this->assertEquals('test_password', $element->getDatasourceParameter('password'));
$this->assertEquals('', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id_lieux', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
Expand Down Expand Up @@ -182,6 +244,7 @@ public function testPostgresqlDatasourceWithoutSql()
$this->assertEquals('5432', $element->getDatasourceParameter('port'));
$this->assertEquals('test_user', $element->getDatasourceParameter('user'));
$this->assertEquals('test_password', $element->getDatasourceParameter('password'));
$this->assertEquals('', $element->getDatasourceParameter('authcfg'));
$this->assertEquals('disable', $element->getDatasourceParameter('sslmode'));
$this->assertEquals('id', $element->getDatasourceParameter('key'));
$this->assertEquals('', $element->getDatasourceParameter('estimatedmetadata'));
Expand Down
Loading