QOAuth1 Class
QOAuth1 クラスはOAuth 1 プロトコルの実装を提供します。詳細...
ヘッダ | #include <QOAuth1> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
qmake: | QT += networkauth |
継承: | QAbstractOAuth |
パブリックな型
enum class | SignatureMethod { Hmac_Sha1, Rsa_Sha1, PlainText } |
パブリック関数
QOAuth1(QObject *parent = nullptr) | |
QOAuth1(QNetworkAccessManager *manager, QObject *parent = nullptr) | |
QOAuth1(const QString &clientIdentifier, const QString &clientSharedSecret, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
std::pair<QString, QString> | clientCredentials() const |
QString | clientSharedSecret() const |
void | setClientCredentials(const std::pair<QString, QString> &clientCredentials) |
void | setClientCredentials(const QString &clientIdentifier, const QString &clientSharedSecret) |
void | setClientSharedSecret(const QString &clientSharedSecret) |
void | setSignatureMethod(QOAuth1::SignatureMethod value) |
void | setTemporaryCredentialsUrl(const QUrl &url) |
void | setTokenCredentials(const std::pair<QString, QString> &tokenCredentials) |
void | setTokenCredentials(const QString &token, const QString &tokenSecret) |
void | setTokenCredentialsUrl(const QUrl &url) |
void | setTokenSecret(const QString &tokenSecret) |
QOAuth1::SignatureMethod | signatureMethod() const |
QUrl | temporaryCredentialsUrl() const |
std::pair<QString, QString> | tokenCredentials() const |
QUrl | tokenCredentialsUrl() const |
QString | tokenSecret() const |
再実装されたパブリック関数
virtual QNetworkReply * | deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
virtual QNetworkReply * | get(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
virtual QNetworkReply * | head(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
virtual QNetworkReply * | post(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
virtual void | prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray()) override |
virtual QNetworkReply * | put(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
パブリックスロット
void | continueGrantWithVerifier(const QString &verifier) |
virtual void | grant() override |
保護された関数
QNetworkReply * | requestTemporaryCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const QVariantMap ¶meters = QVariantMap()) |
QNetworkReply * | requestTokenCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const std::pair<QString, QString> &temporaryToken, const QVariantMap ¶meters = QVariantMap()) |
void | setup(QNetworkRequest *request, const QVariantMap &signingParameters, QNetworkAccessManager::Operation operation) |
void | setup(QNetworkRequest *request, const QVariantMap &signingParameters, const QByteArray &operationVerb) |
静的プロテクトメンバ
QByteArray | generateAuthorizationHeader(const QVariantMap &oauthParams) |
QByteArray | nonce() |
詳しい説明
QOAuth1 は、クライアントがリソース所有者 (別のクライアントやエンドユーザーなど) に代わってサーバーリソースにアクセスするためのメソッドを提供します。QOAuth1 は、クライアントがリソースの所有者 (別のクライアントやエンドユーザなど) に代わってサーバリソースにアクセスするための方法を提供します。また、エンドユーザがユーザエージェントのリダイレクトを使用して、認証情報 (通常はユーザ名とパスワードのペア) を共有せずにサードパーティのサーバリソースへのアクセスを承認するためのプロセスも提供します。
QOAuth1 は、リソース所有者がクライアントに与えた認可を表すためにトークンを使用する。通常、トークンクレデンシャルはリソース所有者のリクエストに応じて、リソース所有者の身元を認証した後にサーバーから発行される(通常はユーザー名とパスワードを使用する)。
一時的なクレデンシャル要求を行うとき、クライアントはクライアントのクレデンシャルのみを使用して認証する。トークン・リクエストを行うとき、クライアントはクライアント・クレデンシャルと一時的なクレデンシャルを使用して認証する。クライアントがトークンクレデンシャルを受け取って保存すると、受け取ったトークンクレデンシャルとともにクライアントクレデンシャルを使用して認証されたリクエストを行うことで、リソース所有者に代わって保護されたリソースにアクセスすることができる。
メンバー関数ドキュメント
[explicit]
QOAuth1::QOAuth1(QObject *parent = nullptr)
親オブジェクトparent を持つ QOAuth1 オブジェクトを構築する。
[explicit]
QOAuth1::QOAuth1(QNetworkAccessManager *manager, QObject *parent = nullptr)
親オブジェクトparent を持つQOAuth1オブジェクトを構築し、manager を使用してネットワークにアクセスする。
QOAuth1::QOAuth1(const QString &clientIdentifier, const QString &clientSharedSecret, QNetworkAccessManager *manager, QObject *parent = nullptr)
親オブジェクトparent を持つQOAuth1オブジェクトを構築し、manager を使用してネットワークにアクセスする。また、clientIdentifier とclientSharedSecret を設定して、ウェブサーバーへの呼び出しに署名し、アプリケーションを識別します。
std::pair<QString, QString> QOAuth1::clientCredentials() const
アプリケーションを識別し、ウェブサーバーへのリクエストに署名するために使用されるQString のペアを返します。
setClientCredentials()も参照ください 。
QString QOAuth1::clientSharedSecret() const
ウェブサーバーへのリクエストの署名に使われる現在の共有秘密を返します。
setClientSharedSecret() およびclientCredentials()も参照 ください。
[slot]
void QOAuth1::continueGrantWithVerifier(const QString &verifier)
verifier を使用したリダイレクトベースの認証フローを継続する。Out-of-bandリプライハンドラを使用して、ウェブサーバが提供するベリファイアを提供するときに、この関数を呼び出します。
[override virtual]
QNetworkReply *QOAuth1::deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
再実装:QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap ¶meters).
認証された DELETE リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください:ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください:DELETE
[static protected]
QByteArray QOAuth1::generateAuthorizationHeader(const QVariantMap &oauthParams)
oauthParams を使って認可ヘッダーを生成します。
こちらも参照してください:OAuth 1.0 プロトコル:認可ヘッダ
[override virtual]
QNetworkReply *QOAuth1::get(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
再実装:QAbstractOAuth::get(const QUrl &url, const QVariantMap ¶meters).
認証された GET リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください:ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください:GET
[override virtual slot]
void QOAuth1::grant()
再インプリメント:QAbstractOAuth::grant().
リダイレクトベースの認可フローを開始する。
注意: 帯域外リプライハンドラの場合、この関数をコールした後にベリファイア文字列を受け取ります。それをcontinueGrantWithVerifier() に渡すことで、付与処理を継続します。
その文字列を () に渡すと、付与処理が継続されます: OAuth 1.0 プロトコル:リダイレクトベースの認証
continueGrantWithVerifier()も参照 。
[override virtual]
QNetworkReply *QOAuth1::head(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
再実装:QAbstractOAuth::head(const QUrl &url, const QVariantMap ¶meters).
認証された HEAD リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください:ハイパーテキスト転送プロトコル - HTTP/1.1:HEAD
[static protected]
QByteArray QOAuth1::nonce()
nonce を生成する。
こちらも参照:OAuth 1.0 プロトコル:ノンスとタイムスタンプ
[override virtual]
QNetworkReply *QOAuth1::post(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
再実装:QAbstractOAuth::post(const QUrl &url, const QVariantMap ¶meters).
認証された POST リクエストを送信し、新しいQNetworkReply を返します。url とparameters はリクエストの作成に使用されます。
こちらも参照してください:ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください:POST
[override virtual]
void QOAuth1::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())
再実装:QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body).
[override virtual]
QNetworkReply *QOAuth1::put(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
再実装:QAbstractOAuth::put(const QUrl &url, const QVariantMap ¶meters).
認証された PUT リクエストを送信し、新しいQNetworkReply を返します。url とparameters がリクエストの作成に使用されます。
こちらも参照してください:ハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください:PUT
[protected]
QNetworkReply *QOAuth1::requestTemporaryCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const QVariantMap ¶meters = QVariantMap())
リクエストメソッドoperation を使用して一時的な信用証明書のリクエストを開始する。リクエスト URL はurl であり、parameters はリクエスト中にエンコードされて送信されるものとする。
以下も参照のこと:OAuth 1.0 プロトコル:一時クレデンシャル
[protected]
QNetworkReply *QOAuth1::requestTokenCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const std::pair<QString, QString> &temporaryToken, const QVariantMap ¶meters = QVariantMap())
リクエストメソッドoperation を使用してトークンクレデンシャルのリクエストを開始する。リクエストURLはurl であり、parameters はリクエスト中にエンコードされて送信される。temporaryToken 、文字列のペアはリクエストの識別と署名に使用される。
こちらも参照:OAuth 1.0 プロトコル:トークン・クレデンシャル
void QOAuth1::setClientCredentials(const std::pair<QString, QString> &clientCredentials)
アプリケーションの識別とウェブサーバーへのリクエストの署名に使用されるQString のペアとしてclientCredentials を設定します。
clientCredentials()も参照してください 。
void QOAuth1::setClientCredentials(const QString &clientIdentifier, const QString &clientSharedSecret)
アプリケーションを識別し、Webサーバーへのリクエストに署名するために使用されるQString のペアとして、clientIdentifier とclientSharedSecret を設定します。clientIdentifier はアプリケーションを識別し、clientSharedSecret はリクエストに署名するために使用されます。
clientCredentials()も参照してください 。
void QOAuth1::setClientSharedSecret(const QString &clientSharedSecret)
ウェブサーバーへのリクエストの署名に使用する文字列としてclientSharedSecret を設定します。
clientSharedSecret() およびsetClientCredentials()も参照 。
void QOAuth1::setSignatureMethod(QOAuth1::SignatureMethod value)
ウェブサーバへのリクエストに署名するためのメソッドとしてvalue を設定します。
signatureMethod()も参照 。
void QOAuth1::setTemporaryCredentialsUrl(const QUrl &url)
認証プロセスを開始するための一時的な証明書を要求する URL としてurl を設定する。
temporaryCredentialsUrl()も参照 。
void QOAuth1::setTokenCredentials(const std::pair<QString, QString> &tokenCredentials)
ウェブサーバへの認証済みリクエストの識別と署名に使われるQString のペアとしてtokenCredentials を設定します。
tokenCredentials()も参照してください 。
void QOAuth1::setTokenCredentials(const QString &token, const QString &tokenSecret)
Web サーバーへの認証済みリクエストの識別と署名に使用されるQString のペアとしてtoken とtokenSecret を設定します。クライアントがトークン認証情報を受け取って保存すると、受け取ったトークン認証情報とクライアント認証情報を使って認証されたリクエストを行うことで、リソース所有者に代わって保護されたリソースにアクセスすることができます。
tokenCredentials()も参照 。
void QOAuth1::setTokenCredentialsUrl(const QUrl &url)
認証プロセスを続行するためのトークン情報を要求する URL としてurl を設定します。
tokenCredentialsUrl()も参照 。
void QOAuth1::setTokenSecret(const QString &tokenSecret)
ウェブ・サーバーへの認証された呼び出しの署名に使用される現在のトークン・シークレットをtokenSecret に設定します。
tokenSecret() およびsetTokenCredentials()も参照 。
[protected]
void QOAuth1::setup(QNetworkRequest *request, const QVariantMap &signingParameters, QNetworkAccessManager::Operation operation)
signingParameters とoperation を使ってrequest に署名する。
これはオーバーロードされた関数である。
[protected]
void QOAuth1::setup(QNetworkRequest *request, const QVariantMap &signingParameters, const QByteArray &operationVerb)
signingParameters とoperationVerb を使ってrequest に署名する。
これはオーバーロードされた関数である。
QOAuth1::SignatureMethod QOAuth1::signatureMethod() const
ウェブサーバーへのリクエストの署名に使用したメソッドを返します。
setSignatureMethod()も参照ください 。
QUrl QOAuth1::temporaryCredentialsUrl() const
認証プロセスを開始するための一時的な認証情報を要求する際に使用する URL を返します。
setTemporaryCredentialsUrl()も参照ください 。
std::pair<QString, QString> QOAuth1::tokenCredentials() const
ウェブサーバーへの認証済みリクエストの識別と署名に使用するQString のペアを返します。
setTokenCredentials()も参照ください 。
QUrl QOAuth1::tokenCredentialsUrl() const
認証プロセスを続行するためのトークン情報を要求する際に使用する url を返します。
setTokenCredentialsUrl()も参照ください 。
QString QOAuth1::tokenSecret() const
ウェブサーバーへの認証済みリクエストの署名に使用されている、 現在のトークンシークレットを返します。
setTokenSecret() およびtokenCredentials()も参照 ください。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.