/
qgsauthmanager.cpp
3796 lines (3153 loc) · 113 KB
/
qgsauthmanager.cpp
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
qgsauthmanager.cpp
---------------------
begin : October 5, 2014
copyright : (C) 2014 by Boundless Spatial, Inc. USA
author : Larry Shaffer
email : lshaffer at boundlessgeo dot com
***************************************************************************
* *
* 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. *
* *
***************************************************************************/
#include "qgsauthmanager.h"
#include <QDir>
#include <QEventLoop>
#include <QFile>
#include <QFileInfo>
#include <QMutexLocker>
#include <QObject>
#include <QSet>
#include <QSqlDatabase>
#include <QSqlError>
#include <QSqlQuery>
#include <QTextStream>
#include <QTime>
#include <QTimer>
#include <QVariant>
#include <QSqlDriver>
#include <QtCrypto>
#ifndef QT_NO_SSL
#include <QSslConfiguration>
#endif
// QtKeyChain library
#include "keychain.h"
// QGIS includes
#include "qgsapplication.h"
#include "qgsauthcertutils.h"
#include "qgsauthcrypto.h"
#include "qgsauthmethod.h"
#include "qgsauthmethodmetadata.h"
#include "qgsauthmethodregistry.h"
#include "qgscredentials.h"
#include "qgslogger.h"
#include "qgsmessagelog.h"
#include "qgssettings.h"
#include "qgsruntimeprofiler.h"
QgsAuthManager *QgsAuthManager::sInstance = nullptr;
const QString QgsAuthManager::AUTH_CONFIG_TABLE = QStringLiteral( "auth_configs" );
const QString QgsAuthManager::AUTH_PASS_TABLE = QStringLiteral( "auth_pass" );
const QString QgsAuthManager::AUTH_SETTINGS_TABLE = QStringLiteral( "auth_settings" );
const QString QgsAuthManager::AUTH_IDENTITIES_TABLE = QStringLiteral( "auth_identities" );
const QString QgsAuthManager::AUTH_SERVERS_TABLE = QStringLiteral( "auth_servers" );
const QString QgsAuthManager::AUTH_AUTHORITIES_TABLE = QStringLiteral( "auth_authorities" );
const QString QgsAuthManager::AUTH_TRUST_TABLE = QStringLiteral( "auth_trust" );
const QString QgsAuthManager::AUTH_MAN_TAG = QObject::tr( "Authentication Manager" );
const QString QgsAuthManager::AUTH_CFG_REGEX = QStringLiteral( "authcfg=([a-z]|[A-Z]|[0-9]){7}" );
const QLatin1String QgsAuthManager::AUTH_PASSWORD_HELPER_KEY_NAME( "QGIS-Master-Password" );
const QLatin1String QgsAuthManager::AUTH_PASSWORD_HELPER_FOLDER_NAME( "QGIS" );
#if defined(Q_OS_MAC)
const QString QgsAuthManager::AUTH_PASSWORD_HELPER_DISPLAY_NAME( "Keychain" );
#elif defined(Q_OS_WIN)
const QString QgsAuthManager::AUTH_PASSWORD_HELPER_DISPLAY_NAME( "Password Manager" );
#elif defined(Q_OS_LINUX)
const QString QgsAuthManager::AUTH_PASSWORD_HELPER_DISPLAY_NAME( QStringLiteral( "Wallet/KeyRing" ) );
#else
const QString QgsAuthManager::AUTH_PASSWORD_HELPER_DISPLAY_NAME( "Password Manager" );
#endif
QgsAuthManager *QgsAuthManager::instance()
{
static QMutex sMutex;
QMutexLocker locker( &sMutex );
if ( !sInstance )
{
sInstance = new QgsAuthManager( );
}
return sInstance;
}
QgsAuthManager::QgsAuthManager()
{
mMutex.reset( new QMutex( QMutex::Recursive ) );
mMasterPasswordMutex.reset( new QMutex( QMutex::Recursive ) );
connect( this, &QgsAuthManager::messageOut,
this, &QgsAuthManager::writeToConsole );
}
QSqlDatabase QgsAuthManager::authDatabaseConnection() const
{
QSqlDatabase authdb;
if ( isDisabled() )
return authdb;
// while everything we use from QSqlDatabase here is thread safe, we need to ensure
// that the connection cleanup on thread finalization happens in a predictable order
QMutexLocker locker( mMutex.get() );
// Sharing the same connection between threads is not allowed.
// We use a dedicated connection for each thread requiring access to the database,
// using the thread address as connection name.
const QString connectionName = QStringLiteral( "authentication.configs:0x%1" ).arg( reinterpret_cast<quintptr>( QThread::currentThread() ), 2 * QT_POINTER_SIZE, 16, QLatin1Char( '0' ) );
QgsDebugMsgLevel( QStringLiteral( "Using auth db connection name: %1 " ).arg( connectionName ), 2 );
if ( !QSqlDatabase::contains( connectionName ) )
{
QgsDebugMsgLevel( QStringLiteral( "No existing connection, creating a new one" ), 2 );
authdb = QSqlDatabase::addDatabase( QStringLiteral( "QSQLITE" ), connectionName );
authdb.setDatabaseName( authenticationDatabasePath() );
// for background threads, remove database when current thread finishes
if ( QThread::currentThread() != qApp->thread() )
{
QgsDebugMsgLevel( QStringLiteral( "Scheduled auth db remove on thread close" ), 2 );
// IMPORTANT - we use a direct connection here, because the database removal must happen immediately
// when the thread finishes, and we cannot let this get queued on the main thread's event loop (where
// QgsAuthManager lives).
// Otherwise, the QSqlDatabase's private data's thread gets reset immediately the QThread::finished,
// and a subsequent call to QSqlDatabase::database with the same thread address (yep it happens, actually a lot)
// triggers a condition in QSqlDatabase which detects the nullptr private thread data and returns an invalid database instead.
// QSqlDatabase::removeDatabase is thread safe, so this is ok to do.
// Right about now is a good time to re-evaluate your selected career ;)
QMetaObject::Connection connection = connect( QThread::currentThread(), &QThread::finished, QThread::currentThread(), [connectionName, this ]
{
QMutexLocker locker( mMutex.get() );
QSqlDatabase::removeDatabase( connectionName );
mConnectedThreads.remove( QThread::currentThread() );
}, Qt::DirectConnection );
mConnectedThreads.insert( QThread::currentThread(), connection );
}
}
else
{
QgsDebugMsgLevel( QStringLiteral( "Reusing existing connection" ), 2 );
authdb = QSqlDatabase::database( connectionName );
}
locker.unlock();
if ( !authdb.isOpen() )
{
if ( !authdb.open() )
{
const char *err = QT_TR_NOOP( "Opening of authentication db FAILED" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), CRITICAL );
}
}
return authdb;
}
bool QgsAuthManager::init( const QString &pluginPath, const QString &authDatabasePath )
{
if ( mAuthInit )
return true;
mAuthInit = true;
QgsScopedRuntimeProfile profile( tr( "Initializing authentication manager" ) );
QgsDebugMsgLevel( QStringLiteral( "Initializing QCA..." ), 2 );
mQcaInitializer = qgis::make_unique<QCA::Initializer>( QCA::Practical, 256 );
QgsDebugMsgLevel( QStringLiteral( "QCA initialized." ), 2 );
QCA::scanForPlugins();
QgsDebugMsgLevel( QStringLiteral( "QCA Plugin Diagnostics Context: %1" ).arg( QCA::pluginDiagnosticText() ), 2 );
QStringList capabilities;
capabilities = QCA::supportedFeatures();
QgsDebugMsgLevel( QStringLiteral( "QCA supports: %1" ).arg( capabilities.join( "," ) ), 2 );
// do run-time check for qca-ossl plugin
if ( !QCA::isSupported( "cert", QStringLiteral( "qca-ossl" ) ) )
{
mAuthDisabled = true;
mAuthDisabledMessage = tr( "QCA's OpenSSL plugin (qca-ossl) is missing" );
return isDisabled();
}
QgsDebugMsgLevel( QStringLiteral( "Prioritizing qca-ossl over all other QCA providers..." ), 2 );
const QCA::ProviderList provds = QCA::providers();
QStringList prlist;
for ( QCA::Provider *p : provds )
{
QString pn = p->name();
int pr = 0;
if ( pn != QLatin1String( "qca-ossl" ) )
{
pr = QCA::providerPriority( pn ) + 1;
}
QCA::setProviderPriority( pn, pr );
prlist << QStringLiteral( "%1:%2" ).arg( pn ).arg( QCA::providerPriority( pn ) );
}
QgsDebugMsgLevel( QStringLiteral( "QCA provider priorities: %1" ).arg( prlist.join( ", " ) ), 2 );
QgsDebugMsgLevel( QStringLiteral( "Populating auth method registry" ), 3 );
QgsAuthMethodRegistry *authreg = QgsAuthMethodRegistry::instance( pluginPath );
QStringList methods = authreg->authMethodList();
QgsDebugMsgLevel( QStringLiteral( "Authentication methods found: %1" ).arg( methods.join( ", " ) ), 2 );
if ( methods.isEmpty() )
{
mAuthDisabled = true;
mAuthDisabledMessage = tr( "No authentication method plugins found" );
return isDisabled();
}
if ( !registerCoreAuthMethods() )
{
mAuthDisabled = true;
mAuthDisabledMessage = tr( "No authentication method plugins could be loaded" );
return isDisabled();
}
mAuthDbPath = QDir::cleanPath( authDatabasePath );
QgsDebugMsgLevel( QStringLiteral( "Auth database path: %1" ).arg( authenticationDatabasePath() ), 2 );
QFileInfo dbinfo( authenticationDatabasePath() );
QFileInfo dbdirinfo( dbinfo.path() );
QgsDebugMsgLevel( QStringLiteral( "Auth db directory path: %1" ).arg( dbdirinfo.filePath() ), 2 );
if ( !dbdirinfo.exists() )
{
QgsDebugMsgLevel( QStringLiteral( "Auth db directory path does not exist, making path: %1" ).arg( dbdirinfo.filePath() ), 2 );
if ( !QDir().mkpath( dbdirinfo.filePath() ) )
{
const char *err = QT_TR_NOOP( "Auth db directory path could not be created" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), CRITICAL );
return false;
}
}
if ( dbinfo.exists() )
{
if ( !dbinfo.permission( QFile::ReadOwner | QFile::WriteOwner ) )
{
const char *err = QT_TR_NOOP( "Auth db is not readable or writable by user" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), CRITICAL );
return false;
}
if ( dbinfo.size() > 0 )
{
QgsDebugMsgLevel( QStringLiteral( "Auth db exists and has data" ), 2 );
if ( !createCertTables() )
return false;
updateConfigAuthMethods();
#ifndef QT_NO_SSL
initSslCaches();
#endif
// set the master password from first line of file defined by QGIS_AUTH_PASSWORD_FILE env variable
const char *passenv = "QGIS_AUTH_PASSWORD_FILE";
if ( getenv( passenv ) && masterPasswordHashInDatabase() )
{
QString passpath( getenv( passenv ) );
// clear the env variable, so it can not be accessed from plugins, etc.
// (note: stored QgsApplication::systemEnvVars() skips this env variable as well)
#ifdef Q_OS_WIN
putenv( passenv );
#else
unsetenv( passenv );
#endif
QString masterpass;
QFile passfile( passpath );
if ( passfile.exists() && passfile.open( QIODevice::ReadOnly | QIODevice::Text ) )
{
QTextStream passin( &passfile );
while ( !passin.atEnd() )
{
masterpass = passin.readLine();
break;
}
passfile.close();
}
if ( !masterpass.isEmpty() )
{
if ( setMasterPassword( masterpass, true ) )
{
QgsDebugMsgLevel( QStringLiteral( "Authentication master password set from QGIS_AUTH_PASSWORD_FILE" ), 2 );
}
else
{
QgsDebugMsg( "QGIS_AUTH_PASSWORD_FILE set, but FAILED to set password using: " + passpath );
return false;
}
}
else
{
QgsDebugMsg( "QGIS_AUTH_PASSWORD_FILE set, but FAILED to read password from: " + passpath );
return false;
}
}
return true;
}
}
else
{
QgsDebugMsgLevel( QStringLiteral( "Auth db does not exist: creating through QSqlDatabase initial connection" ), 2 );
if ( !createConfigTables() )
return false;
if ( !createCertTables() )
return false;
}
#ifndef QT_NO_SSL
initSslCaches();
#endif
return true;
}
bool QgsAuthManager::createConfigTables()
{
QMutexLocker locker( mMutex.get() );
// create and open the db
if ( !authDbOpen() )
{
const char *err = QT_TR_NOOP( "Auth db could not be created and opened" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), CRITICAL );
return false;
}
QSqlQuery query( authDatabaseConnection() );
// create the tables
QString qstr;
qstr = QStringLiteral( "CREATE TABLE %1 (\n"
" 'salt' TEXT NOT NULL,\n"
" 'civ' TEXT NOT NULL\n"
", 'hash' TEXT NOT NULL);" ).arg( authDbPassTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE TABLE %1 (\n"
" 'id' TEXT NOT NULL,\n"
" 'name' TEXT NOT NULL,\n"
" 'uri' TEXT,\n"
" 'type' TEXT NOT NULL,\n"
" 'version' INTEGER NOT NULL\n"
", 'config' TEXT NOT NULL);" ).arg( authDatabaseConfigTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE UNIQUE INDEX 'id_index' on %1 (id ASC);" ).arg( authDatabaseConfigTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE INDEX 'uri_index' on %1 (uri ASC);" ).arg( authDatabaseConfigTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
return true;
}
bool QgsAuthManager::createCertTables()
{
QMutexLocker locker( mMutex.get() );
// NOTE: these tables were added later, so IF NOT EXISTS is used
QgsDebugMsgLevel( QStringLiteral( "Creating cert tables in auth db" ), 2 );
QSqlQuery query( authDatabaseConnection() );
// create the tables
QString qstr;
qstr = QStringLiteral( "CREATE TABLE IF NOT EXISTS %1 (\n"
" 'setting' TEXT NOT NULL\n"
", 'value' TEXT);" ).arg( authDbSettingsTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE TABLE IF NOT EXISTS %1 (\n"
" 'id' TEXT NOT NULL,\n"
" 'key' TEXT NOT NULL\n"
", 'cert' TEXT NOT NULL);" ).arg( authDbIdentitiesTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE UNIQUE INDEX IF NOT EXISTS 'id_index' on %1 (id ASC);" ).arg( authDbIdentitiesTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE TABLE IF NOT EXISTS %1 (\n"
" 'id' TEXT NOT NULL,\n"
" 'host' TEXT NOT NULL,\n"
" 'cert' TEXT\n"
", 'config' TEXT NOT NULL);" ).arg( authDatabaseServersTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE UNIQUE INDEX IF NOT EXISTS 'host_index' on %1 (host ASC);" ).arg( authDatabaseServersTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE TABLE IF NOT EXISTS %1 (\n"
" 'id' TEXT NOT NULL\n"
", 'cert' TEXT NOT NULL);" ).arg( authDbAuthoritiesTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE UNIQUE INDEX IF NOT EXISTS 'id_index' on %1 (id ASC);" ).arg( authDbAuthoritiesTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE TABLE IF NOT EXISTS %1 (\n"
" 'id' TEXT NOT NULL\n"
", 'policy' TEXT NOT NULL);" ).arg( authDbTrustTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
qstr = QStringLiteral( "CREATE UNIQUE INDEX IF NOT EXISTS 'id_index' on %1 (id ASC);" ).arg( authDbTrustTable() );
query.prepare( qstr );
if ( !authDbQuery( &query ) )
return false;
query.clear();
return true;
}
bool QgsAuthManager::isDisabled() const
{
if ( mAuthDisabled )
{
QgsDebugMsg( QStringLiteral( "Authentication system DISABLED: QCA's qca-ossl (OpenSSL) plugin is missing" ) );
}
return mAuthDisabled;
}
const QString QgsAuthManager::disabledMessage() const
{
return tr( "Authentication system is DISABLED:\n%1" ).arg( mAuthDisabledMessage );
}
bool QgsAuthManager::setMasterPassword( bool verify )
{
QMutexLocker locker( mMasterPasswordMutex.get() );
if ( isDisabled() )
return false;
if ( mScheduledDbErase )
return false;
if ( mMasterPass.isEmpty() )
{
QgsDebugMsg( QStringLiteral( "Master password is not yet set by user" ) );
if ( !masterPasswordInput() )
{
QgsDebugMsg( QStringLiteral( "Master password input canceled by user" ) );
return false;
}
}
else
{
QgsDebugMsg( QStringLiteral( "Master password is set" ) );
if ( !verify )
return true;
}
if ( !verifyMasterPassword() )
return false;
QgsDebugMsg( QStringLiteral( "Master password is set and verified" ) );
return true;
}
bool QgsAuthManager::setMasterPassword( const QString &pass, bool verify )
{
QMutexLocker locker( mMutex.get() );
if ( isDisabled() )
return false;
if ( mScheduledDbErase )
return false;
// since this is generally for automation, we don't care if passed-in is same as existing
QString prevpass = QString( mMasterPass );
mMasterPass = pass;
if ( verify && !verifyMasterPassword() )
{
mMasterPass = prevpass;
const char *err = QT_TR_NOOP( "Master password set: FAILED to verify, reset to previous" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
return false;
}
QgsDebugMsg( QStringLiteral( "Master password set: SUCCESS%1" ).arg( verify ? " and verified" : "" ) );
return true;
}
bool QgsAuthManager::verifyMasterPassword( const QString &compare )
{
if ( isDisabled() )
return false;
int rows = 0;
if ( !masterPasswordRowsInDb( &rows ) )
{
const char *err = QT_TR_NOOP( "Master password: FAILED to access database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), CRITICAL );
clearMasterPassword();
return false;
}
QgsDebugMsg( QStringLiteral( "Master password: %1 rows in database" ).arg( rows ) );
if ( rows > 1 )
{
const char *err = QT_TR_NOOP( "Master password: FAILED to find just one master password record in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
clearMasterPassword();
return false;
}
else if ( rows == 1 )
{
if ( !masterPasswordCheckAgainstDb( compare ) )
{
if ( compare.isNull() ) // don't complain when comparing, since it could be an incomplete comparison string
{
const char *err = QT_TR_NOOP( "Master password: FAILED to verify against hash in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
clearMasterPassword();
emit masterPasswordVerified( false );
}
++mPassTries;
if ( mPassTries >= 5 )
{
mAuthDisabled = true;
const char *err = QT_TR_NOOP( "Master password: failed 5 times authentication system DISABLED" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
return false;
}
else
{
QgsDebugMsg( QStringLiteral( "Master password: verified against hash in database" ) );
if ( compare.isNull() )
emit masterPasswordVerified( true );
}
}
else if ( compare.isNull() ) // compares should never be stored
{
if ( !masterPasswordStoreInDb() )
{
const char *err = QT_TR_NOOP( "Master password: hash FAILED to be stored in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), CRITICAL );
clearMasterPassword();
return false;
}
else
{
QgsDebugMsg( QStringLiteral( "Master password: hash stored in database" ) );
}
// double-check storing
if ( !masterPasswordCheckAgainstDb() )
{
const char *err = QT_TR_NOOP( "Master password: FAILED to verify against hash in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
clearMasterPassword();
emit masterPasswordVerified( false );
return false;
}
else
{
QgsDebugMsg( QStringLiteral( "Master password: verified against hash in database" ) );
emit masterPasswordVerified( true );
}
}
return true;
}
bool QgsAuthManager::masterPasswordIsSet() const
{
return !mMasterPass.isEmpty();
}
bool QgsAuthManager::masterPasswordSame( const QString &pass ) const
{
return mMasterPass == pass;
}
bool QgsAuthManager::resetMasterPassword( const QString &newpass, const QString &oldpass,
bool keepbackup, QString *backuppath )
{
if ( isDisabled() )
return false;
// verify caller knows the current master password
// this means that the user will have had to already set the master password as well
if ( !masterPasswordSame( oldpass ) )
return false;
QString dbbackup;
if ( !backupAuthenticationDatabase( &dbbackup ) )
return false;
QgsDebugMsg( QStringLiteral( "Master password reset: backed up current database" ) );
// create new database and connection
authDatabaseConnection();
// store current password and civ
QString prevpass = QString( mMasterPass );
QString prevciv = QString( masterPasswordCiv() );
// on ANY FAILURE from this point, reinstate previous password and database
bool ok = true;
// clear password hash table (also clears mMasterPass)
if ( ok && !masterPasswordClearDb() )
{
ok = false;
const char *err = QT_TR_NOOP( "Master password reset FAILED: could not clear current password from database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
if ( ok )
{
QgsDebugMsg( QStringLiteral( "Master password reset: cleared current password from database" ) );
}
// mMasterPass empty, set new password (don't verify, since not stored yet)
setMasterPassword( newpass, false );
// store new password hash
if ( ok && !masterPasswordStoreInDb() )
{
ok = false;
const char *err = QT_TR_NOOP( "Master password reset FAILED: could not store new password in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
if ( ok )
{
QgsDebugMsg( QStringLiteral( "Master password reset: stored new password in database" ) );
}
// verify it stored password properly
if ( ok && !verifyMasterPassword() )
{
ok = false;
const char *err = QT_TR_NOOP( "Master password reset FAILED: could not verify new password in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
// re-encrypt everything with new password
if ( ok && !reencryptAllAuthenticationConfigs( prevpass, prevciv ) )
{
ok = false;
const char *err = QT_TR_NOOP( "Master password reset FAILED: could not re-encrypt configs in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
if ( ok )
{
QgsDebugMsg( QStringLiteral( "Master password reset: re-encrypted configs in database" ) );
}
// verify it all worked
if ( ok && !verifyPasswordCanDecryptConfigs() )
{
ok = false;
const char *err = QT_TR_NOOP( "Master password reset FAILED: could not verify password can decrypt re-encrypted configs" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
if ( ok && !reencryptAllAuthenticationSettings( prevpass, prevciv ) )
{
ok = false;
const char *err = QT_TR_NOOP( "Master password reset FAILED: could not re-encrypt settings in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
if ( ok && !reencryptAllAuthenticationIdentities( prevpass, prevciv ) )
{
ok = false;
const char *err = QT_TR_NOOP( "Master password reset FAILED: could not re-encrypt identities in database" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
}
// something went wrong, reinstate previous password and database
if ( !ok )
{
// backup database of failed attempt, for inspection
authDatabaseConnection().close();
QString errdbbackup( dbbackup );
errdbbackup.replace( QLatin1String( ".db" ), QLatin1String( "_ERROR.db" ) );
QFile::rename( authenticationDatabasePath(), errdbbackup );
QgsDebugMsg( QStringLiteral( "Master password reset FAILED: backed up failed db at %1" ).arg( errdbbackup ) );
// reinstate previous database and password
QFile::rename( dbbackup, authenticationDatabasePath() );
mMasterPass = prevpass;
authDatabaseConnection();
QgsDebugMsg( QStringLiteral( "Master password reset FAILED: reinstated previous password and database" ) );
// assign error db backup
if ( backuppath )
*backuppath = errdbbackup;
return false;
}
if ( !keepbackup && !QFile::remove( dbbackup ) )
{
const char *err = QT_TR_NOOP( "Master password reset: could not remove old database backup" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
// a non-blocking error, continue
}
if ( keepbackup )
{
QgsDebugMsg( QStringLiteral( "Master password reset: backed up previous db at %1" ).arg( dbbackup ) );
if ( backuppath )
*backuppath = dbbackup;
}
QgsDebugMsg( QStringLiteral( "Master password reset: SUCCESS" ) );
emit authDatabaseChanged();
return true;
}
void QgsAuthManager::setScheduledAuthDatabaseErase( bool scheduleErase )
{
mScheduledDbErase = scheduleErase;
// any call (start or stop) should reset these
mScheduledDbEraseRequestEmitted = false;
mScheduledDbEraseRequestCount = 0;
if ( scheduleErase )
{
if ( !mScheduledDbEraseTimer )
{
mScheduledDbEraseTimer = new QTimer( this );
connect( mScheduledDbEraseTimer, &QTimer::timeout, this, &QgsAuthManager::tryToStartDbErase );
mScheduledDbEraseTimer->start( mScheduledDbEraseRequestWait * 1000 );
}
else if ( !mScheduledDbEraseTimer->isActive() )
{
mScheduledDbEraseTimer->start();
}
}
else
{
if ( mScheduledDbEraseTimer && mScheduledDbEraseTimer->isActive() )
mScheduledDbEraseTimer->stop();
}
}
bool QgsAuthManager::registerCoreAuthMethods()
{
if ( isDisabled() )
return false;
qDeleteAll( mAuthMethods );
mAuthMethods.clear();
const QStringList methods = QgsAuthMethodRegistry::instance()->authMethodList();
for ( const auto &authMethodKey : methods )
{
mAuthMethods.insert( authMethodKey, QgsAuthMethodRegistry::instance()->authMethod( authMethodKey ).release() );
}
return !mAuthMethods.isEmpty();
}
const QString QgsAuthManager::uniqueConfigId() const
{
QStringList configids = configIds();
QString id;
int len = 7;
// sleep just a bit to make sure the current time has changed
QEventLoop loop;
QTimer::singleShot( 3, &loop, &QEventLoop::quit );
loop.exec();
uint seed = static_cast< uint >( QTime::currentTime().msec() );
qsrand( seed );
while ( true )
{
id.clear();
for ( int i = 0; i < len; i++ )
{
switch ( qrand() % 2 )
{
case 0:
id += ( '0' + qrand() % 10 );
break;
case 1:
id += ( 'a' + qrand() % 26 );
break;
}
}
if ( !configids.contains( id ) )
{
break;
}
}
QgsDebugMsg( QStringLiteral( "Generated unique ID: %1" ).arg( id ) );
return id;
}
bool QgsAuthManager::configIdUnique( const QString &id ) const
{
if ( isDisabled() )
return false;
if ( id.isEmpty() )
{
const char *err = QT_TR_NOOP( "Config ID is empty" );
QgsDebugMsg( err );
emit messageOut( tr( err ), authManTag(), WARNING );
return false;
}
QStringList configids = configIds();
return !configids.contains( id );
}
bool QgsAuthManager::hasConfigId( const QString &txt ) const
{
QRegExp rx( AUTH_CFG_REGEX );
return rx.indexIn( txt ) != -1;
}
QgsAuthMethodConfigsMap QgsAuthManager::availableAuthMethodConfigs( const QString &dataprovider )
{
QMutexLocker locker( mMutex.get() );
QStringList providerAuthMethodsKeys;
if ( !dataprovider.isEmpty() )
{
providerAuthMethodsKeys = authMethodsKeys( dataprovider.toLower() );
}
QgsAuthMethodConfigsMap baseConfigs;
if ( isDisabled() )
return baseConfigs;
QSqlQuery query( authDatabaseConnection() );
query.prepare( QStringLiteral( "SELECT id, name, uri, type, version FROM %1" ).arg( authDatabaseConfigTable() ) );
if ( !authDbQuery( &query ) )
{
return baseConfigs;
}
if ( query.isActive() && query.isSelect() )
{
while ( query.next() )
{
QString authcfg = query.value( 0 ).toString();
QgsAuthMethodConfig config;
config.setId( authcfg );
config.setName( query.value( 1 ).toString() );
config.setUri( query.value( 2 ).toString() );
config.setMethod( query.value( 3 ).toString() );
config.setVersion( query.value( 4 ).toInt() );
if ( !dataprovider.isEmpty() && !providerAuthMethodsKeys.contains( config.method() ) )
{
continue;
}
baseConfigs.insert( authcfg, config );
}
}
return baseConfigs;
}
void QgsAuthManager::updateConfigAuthMethods()
{
QMutexLocker locker( mMutex.get() );
if ( isDisabled() )
return;
QSqlQuery query( authDatabaseConnection() );
query.prepare( QStringLiteral( "SELECT id, type FROM %1" ).arg( authDatabaseConfigTable() ) );
if ( !authDbQuery( &query ) )
{
return;
}
if ( query.isActive() )
{
QgsDebugMsgLevel( QStringLiteral( "Syncing existing auth config and their auth methods" ), 2 );
mConfigAuthMethods.clear();
QStringList cfgmethods;
while ( query.next() )
{
mConfigAuthMethods.insert( query.value( 0 ).toString(),
query.value( 1 ).toString() );
cfgmethods << QStringLiteral( "%1=%2" ).arg( query.value( 0 ).toString(), query.value( 1 ).toString() );
}
QgsDebugMsgLevel( QStringLiteral( "Stored auth config/methods:\n%1" ).arg( cfgmethods.join( ", " ) ), 2 );
}
}
QgsAuthMethod *QgsAuthManager::configAuthMethod( const QString &authcfg )
{
if ( isDisabled() )
return nullptr;
if ( !mConfigAuthMethods.contains( authcfg ) )
{
QgsDebugMsg( QStringLiteral( "No config auth method found in database for authcfg: %1" ).arg( authcfg ) );
return nullptr;
}
QString authMethodKey = mConfigAuthMethods.value( authcfg );
return authMethod( authMethodKey );
}
QString QgsAuthManager::configAuthMethodKey( const QString &authcfg ) const
{
if ( isDisabled() )
return QString();
return mConfigAuthMethods.value( authcfg, QString() );
}
QStringList QgsAuthManager::authMethodsKeys( const QString &dataprovider )
{
return authMethodsMap( dataprovider.toLower() ).uniqueKeys();