Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #51287 from Djedouas/external-storage-aws-s3
[ExternalStorage] AWS S3 cloud
- Loading branch information
Showing
21 changed files
with
1,052 additions
and
84 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| set(AUTH_AWSS3_SRCS | ||
| core/qgsauthawss3method.cpp | ||
| ) | ||
|
|
||
| set(AUTH_AWSS3_HDRS | ||
| core/qgsauthawss3method.h | ||
| ) | ||
|
|
||
| set(AUTH_AWSS3_UIS_H "") | ||
|
|
||
| if (WITH_GUI) | ||
| set(AUTH_AWSS3_SRCS ${AUTH_AWSS3_SRCS} | ||
| gui/qgsauthawss3edit.cpp | ||
| ) | ||
| set(AUTH_AWSS3_HDRS ${AUTH_AWSS3_HDRS} | ||
| gui/qgsauthawss3edit.h | ||
| ) | ||
| set(AUTH_AWSS3_UIS gui/qgsauthawss3edit.ui) | ||
| if (BUILD_WITH_QT6) | ||
| QT6_WRAP_UI(AUTH_AWSS3_UIS_H ${AUTH_AWSS3_UIS}) | ||
| else() | ||
| QT5_WRAP_UI(AUTH_AWSS3_UIS_H ${AUTH_AWSS3_UIS}) | ||
| endif() | ||
| endif() | ||
|
|
||
|
|
||
| # static library | ||
| add_library(authmethod_awss3_a STATIC ${AUTH_AWSS3_SRCS} ${AUTH_AWSS3_HDRS} ${AUTH_AWSS3_UIS_H}) | ||
|
|
||
| target_include_directories(authmethod_awss3_a PUBLIC ${CMAKE_SOURCE_DIR}/src/auth/awss3/core) | ||
|
|
||
| # require c++17 | ||
| target_compile_features(authmethod_awss3_a PRIVATE cxx_std_17) | ||
|
|
||
| target_link_libraries(authmethod_awss3_a qgis_core) | ||
|
|
||
| if (WITH_GUI) | ||
| target_include_directories(authmethod_awss3_a PRIVATE | ||
| ${CMAKE_SOURCE_DIR}/src/auth/awss3/gui | ||
| ${CMAKE_BINARY_DIR}/src/auth/awss3 | ||
| ) | ||
|
|
||
| target_link_libraries (authmethod_awss3_a qgis_gui) | ||
| endif() | ||
|
|
||
| target_compile_definitions(authmethod_awss3_a PRIVATE "-DQT_NO_FOREACH") | ||
|
|
||
|
|
||
|
|
||
| if (FORCE_STATIC_LIBS) | ||
| # for (external) mobile apps to be able to pick up provider for linking | ||
| install (TARGETS authmethod_awss3_a ARCHIVE DESTINATION ${QGIS_PLUGIN_DIR}) | ||
| else() | ||
| # dynamically loaded module | ||
| add_library(authmethod_awss3 MODULE ${AUTH_AWSS3_SRCS} ${AUTH_AWSS3_HDRS} ${AUTH_AWSS3_UIS_H}) | ||
|
|
||
| # require c++17 | ||
| target_compile_features(authmethod_awss3 PRIVATE cxx_std_17) | ||
|
|
||
| target_link_libraries(authmethod_awss3 qgis_core) | ||
|
|
||
| if (WITH_GUI) | ||
| target_include_directories(authmethod_awss3 PRIVATE | ||
| ${CMAKE_SOURCE_DIR}/src/auth/awss3/gui | ||
| ${CMAKE_BINARY_DIR}/src/auth/awss3 | ||
| ) | ||
| target_link_libraries (authmethod_awss3 qgis_gui) | ||
| add_dependencies(authmethod_awss3 ui) | ||
| endif() | ||
|
|
||
| target_compile_definitions(authmethod_awss3 PRIVATE "-DQT_NO_FOREACH") | ||
|
|
||
| install (TARGETS authmethod_awss3 | ||
| RUNTIME DESTINATION ${QGIS_PLUGIN_DIR} | ||
| LIBRARY DESTINATION ${QGIS_PLUGIN_DIR} | ||
| ) | ||
| endif() |
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,208 @@ | ||
| /*************************************************************************** | ||
| qgsauthawss3method.cpp | ||
| -------------------------------------- | ||
| Date : December 2022 | ||
| Copyright : (C) 2022 by Jacky Volpes | ||
| Email : jacky dot volpes at oslandia 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 "qgsauthawss3method.h" | ||
|
|
||
| #include <QUrlQuery> | ||
| #include <QDateTime> | ||
| #include <QCryptographicHash> | ||
| #include <QMessageAuthenticationCode> | ||
|
|
||
| #include "qgsauthmanager.h" | ||
| #include "qgslogger.h" | ||
| #include "qgsapplication.h" | ||
|
|
||
| #ifdef HAVE_GUI | ||
| #include "qgsauthawss3edit.h" | ||
| #endif | ||
|
|
||
|
|
||
| const QString QgsAuthAwsS3Method::AUTH_METHOD_KEY = QStringLiteral( "AWSS3" ); | ||
| const QString QgsAuthAwsS3Method::AUTH_METHOD_DESCRIPTION = QStringLiteral( "AWS S3" ); | ||
| const QString QgsAuthAwsS3Method::AUTH_METHOD_DISPLAY_DESCRIPTION = tr( "AWS S3" ); | ||
|
|
||
| QMap<QString, QgsAuthMethodConfig> QgsAuthAwsS3Method::sAuthConfigCache = QMap<QString, QgsAuthMethodConfig>(); | ||
|
|
||
|
|
||
| QgsAuthAwsS3Method::QgsAuthAwsS3Method() | ||
| { | ||
| setVersion( 4 ); | ||
| setExpansions( QgsAuthMethod::NetworkRequest ); | ||
| setDataProviders( QStringList() << QStringLiteral( "awss3" ) ); | ||
| } | ||
|
|
||
| QString QgsAuthAwsS3Method::key() const | ||
| { | ||
| return AUTH_METHOD_KEY; | ||
| } | ||
|
|
||
| QString QgsAuthAwsS3Method::description() const | ||
| { | ||
| return AUTH_METHOD_DESCRIPTION; | ||
| } | ||
|
|
||
| QString QgsAuthAwsS3Method::displayDescription() const | ||
| { | ||
| return AUTH_METHOD_DISPLAY_DESCRIPTION; | ||
| } | ||
|
|
||
| bool QgsAuthAwsS3Method::updateNetworkRequest( QNetworkRequest &request, const QString &authcfg, | ||
| const QString &dataprovider ) | ||
| { | ||
| Q_UNUSED( dataprovider ) | ||
| const QgsAuthMethodConfig config = getMethodConfig( authcfg ); | ||
| if ( !config.isValid() ) | ||
| { | ||
| QgsDebugMsg( QStringLiteral( "Update request config FAILED for authcfg: %1: config invalid" ).arg( authcfg ) ); | ||
| return false; | ||
| } | ||
|
|
||
| const QByteArray username = config.config( QStringLiteral( "username" ) ).toLocal8Bit(); | ||
| const QByteArray password = config.config( QStringLiteral( "password" ) ).toLocal8Bit(); | ||
| const QByteArray region = config.config( QStringLiteral( "region" ) ).toLocal8Bit(); | ||
|
|
||
| const QByteArray headerList = "host;x-amz-content-sha256;x-amz-date"; | ||
| const QByteArray encryptionMethod = "AWS4-HMAC-SHA256"; | ||
| const QDateTime currentDateTime = QDateTime::currentDateTime().toUTC(); | ||
| const QByteArray date = currentDateTime.toString( "yyyyMMdd" ).toLocal8Bit(); | ||
| const QByteArray dateTime = currentDateTime.toString( "yyyyMMddThhmmssZ" ).toLocal8Bit(); | ||
|
|
||
| QByteArray canonicalPath = QUrl::toPercentEncoding( request.url().path(), "/" ); // Don't encode slash | ||
| if ( canonicalPath.isEmpty() ) | ||
| { | ||
| canonicalPath = "/"; | ||
| } | ||
|
|
||
| QByteArray method; | ||
| QByteArray payloadHash; | ||
| if ( request.hasRawHeader( "X-Amz-Content-SHA256" ) ) | ||
| { | ||
| method = "PUT"; | ||
| payloadHash = request.rawHeader( "X-Amz-Content-SHA256" ); | ||
| } | ||
| else | ||
| { | ||
| method = "GET"; | ||
| payloadHash = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"; // Sha256 of empty payload | ||
| request.setRawHeader( QByteArray( "X-Amz-Content-SHA256" ), payloadHash ); | ||
| } | ||
|
|
||
| const QByteArray canonicalRequest = method + '\n' + | ||
| canonicalPath + '\n' + | ||
| '\n' + | ||
| "host:" + request.url().host().toLocal8Bit() + '\n' + | ||
| "x-amz-content-sha256:" + payloadHash + '\n' + | ||
| "x-amz-date:" + dateTime + '\n' + | ||
| '\n' + | ||
| headerList + '\n' + | ||
| payloadHash; | ||
|
|
||
| const QByteArray canonicalRequestHash = QCryptographicHash::hash( canonicalRequest, QCryptographicHash::Sha256 ).toHex(); | ||
| const QByteArray stringToSign = encryptionMethod + '\n' + | ||
| dateTime + '\n' + | ||
| date + "/" + region + "/s3/aws4_request" + '\n' + | ||
| canonicalRequestHash; | ||
|
|
||
| const QByteArray signingKey = QMessageAuthenticationCode::hash( "aws4_request", | ||
| QMessageAuthenticationCode::hash( "s3", | ||
| QMessageAuthenticationCode::hash( region, | ||
| QMessageAuthenticationCode::hash( date, "AWS4" + password, | ||
| QCryptographicHash::Sha256 ), | ||
| QCryptographicHash::Sha256 ), | ||
| QCryptographicHash::Sha256 ), | ||
| QCryptographicHash::Sha256 ); | ||
|
|
||
| const QByteArray signature = QMessageAuthenticationCode::hash( stringToSign, signingKey, QCryptographicHash::Sha256 ).toHex(); | ||
|
|
||
| request.setRawHeader( QByteArray( "Host" ), request.url().host().toLocal8Bit() ); | ||
| request.setRawHeader( QByteArray( "X-Amz-Date" ), dateTime ); | ||
| request.setRawHeader( QByteArray( "Authorization" ), | ||
| encryptionMethod + "Credential=" + username + '/' + date + "/" + region + "/s3/aws4_request, SignedHeaders=" + headerList + ", Signature=" + signature ); | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| void QgsAuthAwsS3Method::clearCachedConfig( const QString &authcfg ) | ||
| { | ||
| removeMethodConfig( authcfg ); | ||
| } | ||
|
|
||
| void QgsAuthAwsS3Method::updateMethodConfig( QgsAuthMethodConfig &mconfig ) | ||
| { | ||
| Q_UNUSED( mconfig ); | ||
| // NOTE: add updates as method version() increases due to config storage changes | ||
| } | ||
|
|
||
| QgsAuthMethodConfig QgsAuthAwsS3Method::getMethodConfig( const QString &authcfg, bool fullconfig ) | ||
| { | ||
| const QMutexLocker locker( &mMutex ); | ||
| QgsAuthMethodConfig config; | ||
|
|
||
| // check if it is cached | ||
| if ( sAuthConfigCache.contains( authcfg ) ) | ||
| { | ||
| config = sAuthConfigCache.value( authcfg ); | ||
| QgsDebugMsgLevel( QStringLiteral( "Retrieved config for authcfg: %1" ).arg( authcfg ), 2 ); | ||
| return config; | ||
| } | ||
|
|
||
| // else build bundle | ||
| if ( !QgsApplication::authManager()->loadAuthenticationConfig( authcfg, config, fullconfig ) ) | ||
| { | ||
| QgsDebugMsgLevel( QStringLiteral( "Retrieved config for authcfg: %1" ).arg( authcfg ), 2 ); | ||
| return QgsAuthMethodConfig(); | ||
| } | ||
|
|
||
| // cache bundle | ||
| putMethodConfig( authcfg, config ); | ||
|
|
||
| return config; | ||
| } | ||
|
|
||
| void QgsAuthAwsS3Method::putMethodConfig( const QString &authcfg, const QgsAuthMethodConfig &mconfig ) | ||
| { | ||
| const QMutexLocker locker( &mMutex ); | ||
| QgsDebugMsgLevel( QStringLiteral( "Putting AWS S3 config for authcfg: %1" ).arg( authcfg ), 2 ); | ||
| sAuthConfigCache.insert( authcfg, mconfig ); | ||
| } | ||
|
|
||
| void QgsAuthAwsS3Method::removeMethodConfig( const QString &authcfg ) | ||
| { | ||
| const QMutexLocker locker( &mMutex ); | ||
| if ( sAuthConfigCache.contains( authcfg ) ) | ||
| { | ||
| sAuthConfigCache.remove( authcfg ); | ||
| QgsDebugMsgLevel( QStringLiteral( "Removed Aws S3 config for authcfg: %1" ).arg( authcfg ), 2 ); | ||
| } | ||
| } | ||
|
|
||
| #ifdef HAVE_GUI | ||
| QWidget *QgsAuthAwsS3Method::editWidget( QWidget *parent ) const | ||
| { | ||
| return new QgsAuthAwsS3Edit( parent ); | ||
| } | ||
| #endif | ||
|
|
||
| ////////////////////////////////////////////// | ||
| // Plugin externals | ||
| ////////////////////////////////////////////// | ||
|
|
||
|
|
||
| #ifndef HAVE_STATIC_PROVIDERS | ||
| QGISEXTERN QgsAuthMethodMetadata *authMethodMetadataFactory() | ||
| { | ||
| return new QgsAuthAwsS3MethodMetadata(); | ||
| } | ||
| #endif |
Oops, something went wrong.