-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Tomas Mizera <[email protected]>
- Loading branch information
1 parent
7349837
commit d827818
Showing
13 changed files
with
426 additions
and
22 deletions.
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
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
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,75 @@ | ||
| /*************************************************************************** | ||
| * * | ||
| * 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. * | ||
| * * | ||
| ***************************************************************************/ | ||
|
|
||
| #ifndef CREDENTIALSTORE_H | ||
| #define CREDENTIALSTORE_H | ||
|
|
||
| #include <QObject> | ||
| #include <QString> | ||
| #include <QDateTime> | ||
|
|
||
| #include <qt6keychain/keychain.h> | ||
|
|
||
| /** | ||
| * \brief The CredentialStore class stores user credentials either to QtKeychain | ||
| * or QSettings, according to USE_KEYCHAIN cmake flag. | ||
| * | ||
| * \note Read and write operations are async when QtKeychain is used | ||
| */ | ||
| class CredentialStore : public QObject | ||
| { | ||
| Q_OBJECT | ||
|
|
||
| public: | ||
| explicit CredentialStore( QObject *parent = nullptr ); | ||
| ~CredentialStore() = default; | ||
|
|
||
| static const QString KEYCHAIN_GROUP; | ||
| static const QString KEYCHAIN_ENTRY_CREDENTIALS; | ||
| static const QString KEYCHAIN_ENTRY_TOKEN; | ||
|
|
||
| static const QString KEY_USERNAME; | ||
| static const QString KEY_PASSWORD; | ||
| static const QString KEY_USERID; | ||
| static const QString KEY_TOKEN; | ||
| static const QString KEY_EXPIRE; | ||
|
|
||
| //! Write authentication values data to keychain | ||
| void writeAuthData( const QString &username, | ||
| const QString &password, | ||
| int userId, | ||
| const QString &token, | ||
| const QDateTime &tokenExpiration ); | ||
|
|
||
| //! Reads authentication data from keychain and emits a signal with all auth values | ||
| void readAuthData(); | ||
|
|
||
| signals: | ||
| //! Emitted when authentication data is read, including all authentication key values | ||
| void authDataRead( const QString &username, | ||
| const QString &password, | ||
| int userId, | ||
| const QString &token, | ||
| const QDateTime &tokenExpiration ); | ||
|
|
||
| private: | ||
|
|
||
| //! Reads a key from keychain and stores the value in the intermediary results | ||
| //! The method recursively calls itself to read both Keychain entries | ||
| void readKeyRecursively( const QString &key ); | ||
|
|
||
| void finishReadingOperation(); | ||
|
|
||
| QMap<QString, QString> mReadResults; // to store intermediary read results | ||
|
|
||
| QKeychain::WritePasswordJob *mWriteJob = nullptr; // owned by this | ||
| QKeychain::ReadPasswordJob *mReadJob = nullptr; // owned by this | ||
| }; | ||
|
|
||
| #endif // CREDENTIALSTORE_H |
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,202 @@ | ||
| /*************************************************************************** | ||
| * * | ||
| * 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 "credentialstore.h" | ||
| #include "coreutils.h" | ||
|
|
||
| #include <QJsonObject> | ||
| #include <QJsonDocument> | ||
|
|
||
| const QString CredentialStore::KEYCHAIN_GROUP = QStringLiteral( "mergin_maps" ); | ||
| const QString CredentialStore::KEYCHAIN_ENTRY_CREDENTIALS = QStringLiteral( "credentials" ); | ||
| const QString CredentialStore::KEYCHAIN_ENTRY_TOKEN = QStringLiteral( "token" ); | ||
|
|
||
| const QString CredentialStore::KEY_USERNAME = QStringLiteral( "u" ); | ||
| const QString CredentialStore::KEY_PASSWORD = QStringLiteral( "p" ); | ||
| const QString CredentialStore::KEY_USERID = QStringLiteral( "id" ); | ||
| const QString CredentialStore::KEY_TOKEN = QStringLiteral( "t" ); | ||
| const QString CredentialStore::KEY_EXPIRE = QStringLiteral( "e" ); | ||
|
|
||
| CredentialStore::CredentialStore( QObject *parent ) | ||
| : QObject( parent ) | ||
| { | ||
| mWriteJob = new QKeychain::WritePasswordJob( KEYCHAIN_GROUP, this ); | ||
| mWriteJob->setAutoDelete( false ); | ||
|
|
||
| mReadJob = new QKeychain::ReadPasswordJob( KEYCHAIN_GROUP, this ); | ||
| mReadJob->setAutoDelete( false ); | ||
| } | ||
|
|
||
|
|
||
| void CredentialStore::writeAuthData | ||
| ( const QString &username, | ||
| const QString &password, | ||
| int userId, | ||
| const QString &token, | ||
| const QDateTime &tokenExpiration ) | ||
| { | ||
| // | ||
| // 1. Split the data into two jsons | ||
| // | ||
|
|
||
| QJsonObject credentialsJsonObj; | ||
| credentialsJsonObj.insert( KEY_USERNAME, username ); | ||
| credentialsJsonObj.insert( KEY_PASSWORD, password ); | ||
| credentialsJsonObj.insert( KEY_USERID, userId ); | ||
|
|
||
| QJsonDocument credentialsJson( credentialsJsonObj ); | ||
|
|
||
| QJsonObject tokenJsonObj; | ||
| tokenJsonObj.insert( KEY_TOKEN, token ); | ||
| tokenJsonObj.insert( KEY_EXPIRE, tokenExpiration.toString( Qt::ISODateWithMs ) ); | ||
|
|
||
| QJsonDocument tokenJson( tokenJsonObj ); | ||
|
|
||
| // | ||
| // 2. Store JSONs one by one | ||
| // | ||
|
|
||
| mWriteJob->setKey( KEYCHAIN_ENTRY_CREDENTIALS ); | ||
| mWriteJob->setBinaryData( credentialsJson.toJson( QJsonDocument::Compact ) ); | ||
|
|
||
| connect( mWriteJob, &QKeychain::Job::finished, this, [this, tokenJson]() | ||
| { | ||
| if ( mWriteJob->error() ) | ||
| { | ||
| CoreUtils::log( "Auth", QString( "Keychain write error (%1): %2" ).arg( KEYCHAIN_ENTRY_CREDENTIALS, mWriteJob->errorString() ) ); | ||
| return; // do not try to store the token either | ||
| } | ||
|
|
||
| // let's store the token now | ||
| mWriteJob->setKey( KEYCHAIN_ENTRY_TOKEN ); | ||
| mWriteJob->setBinaryData( tokenJson.toJson( QJsonDocument::Compact ) ); | ||
|
|
||
| mWriteJob->start(); | ||
|
|
||
| }, Qt::SingleShotConnection ); | ||
|
|
||
| mWriteJob->start(); | ||
|
|
||
| // | ||
| // 3. Clear any previous data from QSettings (migration from the previous QSettings) | ||
| // | ||
|
|
||
| // TODO: pass | ||
| } | ||
|
|
||
| void CredentialStore::readAuthData() | ||
| { | ||
| mReadResults.clear(); | ||
| readKeyRecursively( KEYCHAIN_ENTRY_CREDENTIALS ); | ||
| } | ||
|
|
||
| void CredentialStore::readKeyRecursively( const QString &key ) | ||
| { | ||
| // | ||
| // 1. Read both entries from keychain (async) | ||
| // | ||
|
|
||
| mReadJob->setKey( key ); | ||
|
|
||
| connect( mReadJob, &QKeychain::Job::finished, this, [this, key]() | ||
| { | ||
| if ( mReadJob->error() ) | ||
| { | ||
| CoreUtils::log( "Auth", QString( "Keychain read error: %1" ).arg( mReadJob->errorString() ) ); | ||
| emit authDataRead( QString(), QString(), -1, QString(), QDateTime() ); | ||
| return; | ||
| } | ||
|
|
||
| mReadResults[ key ] = mReadJob->textData(); | ||
|
|
||
| if ( key == KEYCHAIN_ENTRY_CREDENTIALS ) | ||
| { | ||
| readKeyRecursively( KEYCHAIN_ENTRY_TOKEN ); // Read the second entry | ||
| } | ||
| else if ( key == KEYCHAIN_ENTRY_TOKEN ) | ||
| { | ||
| finishReadingOperation(); // We have all the data now, let's wrap it up and return back | ||
| } | ||
|
|
||
| }, Qt::SingleShotConnection ); | ||
|
|
||
| mReadJob->start(); | ||
| } | ||
|
|
||
| void CredentialStore::finishReadingOperation() | ||
| { | ||
| // | ||
| // 2. Construct JSONs from the intermediary results and emit the data | ||
| // | ||
|
|
||
| QString username, password; | ||
| int userid = -1; | ||
| QByteArray token; | ||
| QDateTime tokenExpiration; | ||
|
|
||
| if ( mReadResults.size() != 2 ) | ||
| { | ||
| CoreUtils::log( QStringLiteral( "Auth" ), | ||
| QString( "Something ugly happened when reading, invalid size of the intermediary results, size:" ).arg( mReadResults.size() ) | ||
| ); | ||
| emit authDataRead( username, password, userid, token, tokenExpiration ); | ||
| return; | ||
| } | ||
|
|
||
| QString credentialsJsonString = mReadResults.value( KEYCHAIN_ENTRY_CREDENTIALS, QString() ); | ||
| QString tokenJsonString = mReadResults.value( KEYCHAIN_ENTRY_TOKEN, QString() ); | ||
|
|
||
| if ( credentialsJsonString.isEmpty() || tokenJsonString.isEmpty() ) | ||
| { | ||
| CoreUtils::log( | ||
| QStringLiteral( "Auth" ), | ||
| QString( "Something ugly happened when reading, one of the read jsons is empty (%1, %2)" ).arg( credentialsJsonString.length(), tokenJsonString.length() ) | ||
| ); | ||
| emit authDataRead( username, password, userid, token, tokenExpiration ); | ||
| return; | ||
| } | ||
|
|
||
| QJsonParseError parsingError; | ||
| QJsonDocument credentialsJson = QJsonDocument::fromJson( credentialsJsonString.toUtf8(), &parsingError ); | ||
|
|
||
| if ( parsingError.error != QJsonParseError::NoError ) | ||
| { | ||
| CoreUtils::log( QStringLiteral( "Auth" ), QString( "Could not construct credentials JSON when reading, error: %1" ).arg( parsingError.errorString() ) ); | ||
| emit authDataRead( username, password, userid, token, tokenExpiration ); | ||
| return; | ||
| } | ||
|
|
||
| QJsonDocument tokenJson = QJsonDocument::fromJson( tokenJsonString.toUtf8(), &parsingError ); | ||
|
|
||
| if ( parsingError.error != QJsonParseError::NoError ) | ||
| { | ||
| CoreUtils::log( QStringLiteral( "Auth" ), QString( "Could not construct token JSON when reading, error: %1" ).arg( parsingError.errorString() ) ); | ||
| emit authDataRead( username, password, userid, token, tokenExpiration ); | ||
| return; | ||
| } | ||
|
|
||
| QJsonObject credentialsJsonObject = credentialsJson.object(); | ||
| QJsonObject tokenJsonObject = tokenJson.object(); | ||
|
|
||
| username = credentialsJsonObject.value( KEY_USERNAME ).toString(); | ||
| password = credentialsJsonObject.value( KEY_PASSWORD ).toString(); | ||
| userid = credentialsJsonObject.value( KEY_USERID ).toInt(); | ||
|
|
||
| token = tokenJsonObject.value( KEY_TOKEN ).toString().toUtf8(); | ||
| tokenExpiration = QDateTime::fromString( tokenJsonObject.value( KEY_EXPIRE ).toString(), Qt::ISODateWithMs ); | ||
|
|
||
| // | ||
| // If credentials are empty, we should look at QSettings as we previously stored credentials there. | ||
| // Freshly upgraded app might not have the auth data migrated yet. | ||
| // | ||
| // TODO: pass... | ||
| // | ||
|
|
||
| emit authDataRead( username, password, userid, token, tokenExpiration ); | ||
| } |
Oops, something went wrong.
d827818There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
iOS - version 25.2.704411 just submitted!
d827818There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
iOS - version 25.2.704412 just submitted!