QOAuthUriSchemeReplyHandler Class

詳しい説明

このクラスは、OAuth 2.0 の認証処理でプライベート/カスタム URI または HTTPS URI スキームを使用してリダイレクトを行う際のリプライハンドラとして機能します。認可リダイレクトの受信 (コールバックとも呼ばれます) と、それに続くアクセストークンの取得を管理します。

リダイレクトURIは、認可サーバーがフローの認可部分が完了すると、ユーザーエージェント(通常、好ましくはシステムブラウザ)をリダイレクトする場所である。

特定のURIスキームの使用は、URIを正しいアプリケーションに関連付けるた めに、オペレーティングシステムレベルでの設定を必要とする。この関連付けの設定方法は、オペレーティングシステムによって異なる。Platform Support and Dependencies を参照のこと。

このクラスはQOAuthHttpServerReplyHandler を補完するもので、http スキームをローカルホスト・サーバーをセットアップすることで処理する。

次のコードは、その使い方を示している。まず、必要な変数：

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthUriSchemeReplyHandler m_handler;

続いてOAuthのセットアップ（簡潔のためエラー処理は省略）：

m_oauth.setAuthorizationUrl(QUrl("https://some.authorization.service/v3/authorize"_L1));
m_oauth.setAccessTokenUrl(QUrl("https://some.authorization.service/v3/access_token"_L1));
m_oauth.setClientIdentifier("a_client_id"_L1);
m_oauth.setScope("read"_L1);

connect(&m_oauth, &QAbstractOAuth::authorizeWithBrowser, this, &QDesktopServices::openUrl);
connect(&m_oauth, &QAbstractOAuth::granted, this, [this]() {
    // Here we use QNetworkRequestFactory to store the access token
    m_api.setBearerToken(m_oauth.token().toLatin1());
    m_handler.close();
});

最後に、URIスキームのreply-handlerを設定します：

m_handler.setRedirectUrl(QUrl{"com.my.app:/oauth2redirect"_L1});
m_oauth.setReplyHandler(&m_handler);

// Initiate the authorization
if (m_handler.listen()) {
    m_oauth.grant();
}

プライベート/カスタムURIスキーム

カスタムURIスキームは通常、逆ドメイン表記にパスが続くか、場合によってはホスト/ホスト+パスを使用します：

// Example with path:
com.example.myapp:/oauth2/callback
// Example with host:
com.example.myapp://oauth2.callback

HTTPS URIスキーム

HTTPS URIスキームでは、リダイレクトURLは通常のhttpsリンクになります：

https://myapp.example.com/oauth2/callback

これらのリンクは、iOSではユニバーサルリンク、Androidではアプリリンクと呼ばれます。

https スキームの使用は、アプリケーション開発者に使用する URL の所有権を証明させることで、さらなるセキュリティを提供するため推奨されます。この証明は、オペレーティングシステムが内部の URL ディスパッチの一部として参照する関連ファイルをホストすることによって行われます。

このファイルの内容は、アプリケーションと使用されるURLの関連付けを行います。関連ファイルは、HTTPリダイレクトなしで一般にアクセス可能でなければならない。さらに、ホスティングサイトは有効な証明書を持っている必要があり、少なくとも Android では、ファイルはapplication/json content-type として提供される必要があります（サーバーの設定ガイドを参照してください）。

さらに、https のリンクにはユーザビリティ上の利点もあります：

• https URL は、通常の https リンクとしても機能します。https の URL は、通常の https のリンクとしても機能します。もしユーザがアプリケーションをインストールし ていない場合（その URL はどのアプリケーションによっても処理されないため）、https のリンクは、例えば、インストー ルするように指示することができます。
• URL を開くためのアプリケーション選択ダイアログは回避され、代わりにアプリケーションが自動的に開かれます。

その代償として、この一般に公開された関連ファイルをセットアップする必要があるため、余計なセットアップが必要になります。

プラットフォームのサポートと依存関係

現在サポートされているプラットフォームは、Android、iOS、macOSです。

URI スキームのリスニングはQDesktopServices::setUrlHandler() とQDesktopServices::unsetUrlHandler() に基づいています。これらは現在 Qt::Gui モジュールによって提供されているため、QtNetworkAuth モジュールは Qt::Gui に依存しています。Qt::Gui なしでQtNetworkAuth をビルドした場合、QOAuthUriSchemeReplyHandler は含まれません。

アンドロイド

Androidでは URI スキームが必要です：

• アプリケーション マニフェストでintent-filters を設定する
• オプションとして、https スキームでの自動検証のために、サイト関連付けファイルをホストする。assetlinks.json

Qt Android Manifest File Configuration も参照してください。

iOS と macOS

iOSとmacOSでは、URI スキームが必要です：

• サイトの関連付けの設定entitlement
• https スキームでは、site association file (apple-app-site-association) をホストします。

Windows、Linux

現在サポートされていません。