QOAuth1 Class

QOAuth1 クラスはOAuth 1 プロトコルの実装を提供します。詳細...

Header: #include <QOAuth1>
CMake: find_package(Qt6 REQUIRED COMPONENTS NetworkAuth)
target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth)
qmake: QT += networkauth
Inherits: 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 &parameters = QVariantMap()) override
virtual QNetworkReply *get(const QUrl &url, const QVariantMap &parameters = QVariantMap()) override
virtual QNetworkReply *head(const QUrl &url, const QVariantMap &parameters = QVariantMap()) override
virtual QNetworkReply *post(const QUrl &url, const QVariantMap &parameters = QVariantMap()) override
virtual void prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray()) override
virtual QNetworkReply *put(const QUrl &url, const QVariantMap &parameters = QVariantMap()) override

パブリックスロット

void continueGrantWithVerifier(const QString &verifier)
virtual void grant() override

保護された関数

QNetworkReply *requestTemporaryCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const QVariantMap &parameters = QVariantMap())
QNetworkReply *requestTokenCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const std::pair<QString, QString> &temporaryToken, const QVariantMap &parameters = 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 は、リソース所有者がクライアントに与えた認可を表すためにトークンを使用する。通常、トークンクレデンシャルはリソース所有者の要求に応じて、リソース所有者の身元を認証した後にサーバーから発行される(通常はユーザー名とパスワードを使用する)。

一時的なクレデンシャル要求を行うとき、クライアントはクライアントのクレデンシャルのみを使用して認証する。トークン・リクエストを行うとき、クライアントはクライアント・クレデンシャルと一時的なクレデンシャルを使用して認証する。クライアントがトークンクレデンシャルを受け取って保存すると、受け取ったトークンクレデンシャルとともにクライアントクレデンシャルを使用して認証されたリクエストを行うことで、リソース所有者に代わって保護されたリソースにアクセスすることができる。

メンバ型ドキュメント

enum class QOAuth1::SignatureMethod

リクエストに署名するために使用する署名メソッドを示します。

定数説明
QOAuth1::SignatureMethod::Hmac_Sha10HMAC-SHA1署名方法。
QOAuth1::SignatureMethod::Rsa_Sha11RSA-SHA1署名方法 (サポートされていません)。
QOAuth1::SignatureMethod::PlainText2PLAINTEXT署名メソッド。

メンバー関数ドキュメント

[explicit] QOAuth1::QOAuth1(QObject *parent = nullptr)

親オブジェクトparent を持つ QOAuth1 オブジェクトを構築する。

[explicit] QOAuth1::QOAuth1(QNetworkAccessManager *manager, QObject *parent = nullptr)

manager を使用してネットワークにアクセスするために、親オブジェクトparent を持つ QOAuth1 オブジェクトを構築する。

QOAuth1::QOAuth1(const QString &clientIdentifier, const QString &clientSharedSecret, QNetworkAccessManager *manager, QObject *parent = nullptr)

親オブジェクトparent を持つ QOAuth1 オブジェクトを構築し、manager を使用してネットワークにアクセスします。また、ウェブサーバーへの呼び出しに署名し、アプリケーションを識別するためにclientIdentifierclientSharedSecret を設定します。

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 reply ハンドラを使用してウェブサーバが提供するベリファイアを提供するときに、 この関数をコールします。

[override virtual] QNetworkReply *QOAuth1::deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap())

再実装:QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap &parameters) を再実装します。

認証された DELETE リクエストを送信し、新しいQNetworkReply を返します。urlparameters はリクエストの作成に使用されます。

こちらも参照してくださいハイパーテキスト転送プロトコル - 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 &parameters = QVariantMap())

再実装:QAbstractOAuth::get(const QUrl &url, const QVariantMap &parameters).

認証された GET リクエストを送信し、新しいQNetworkReply を返します。urlparameters はリクエストの作成に使用されます。

こちらも参照してくださいハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください:GET

[override virtual slot] void QOAuth1::grant()

再インプリメント:QAbstractOAuth::grant().

リダイレクトベースの認証フローを開始します。

注意: 帯域外リプライハンドラの場合、この関数のコール後にベリファイア文字列を受け取ります。これをcontinueGrantWithVerifier() に渡すと、付与処理を継続します。

その文字列を () に渡すと、付与処理が継続されます OAuth 1.0 プロトコル:リダイレクトベースの認証

continueGrantWithVerifier()も参照 ください。

再実装:QAbstractOAuth::head(const QUrl &url, const QVariantMap &parameters) を再実装します。

認証された HEAD リクエストを送信し、新しいQNetworkReply を返します。urlparameters がリクエストの作成に使用されます。

こちらも参照してくださいハイパーテキスト転送プロトコル - HTTP/1.1:HEAD

[static protected] QByteArray QOAuth1::nonce()

nonce を生成する。

こちらも参照:OAuth 1.0 プロトコル:ノンスとタイムスタンプ

[override virtual] QNetworkReply *QOAuth1::post(const QUrl &url, const QVariantMap &parameters = QVariantMap())

再実装:QAbstractOAuth::post(const QUrl &url, const QVariantMap &parameters).

認証された POST リクエストを送信し、新しいQNetworkReply を返します。urlparameters はリクエストの作成に使用されます。

こちらも参照してくださいハイパーテキスト転送プロトコル - 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 &parameters = QVariantMap())

再実装:QAbstractOAuth::put(const QUrl &url, const QVariantMap &parameters)。

認証されたPUTリクエストを送信し、新しいQNetworkReply を返します。urlparameters はリクエストの作成に使用されます。

こちらも参照してくださいハイパーテキスト転送プロトコル - HTTP/1.1 も参照してください:PUT

[protected] QNetworkReply *QOAuth1::requestTemporaryCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const QVariantMap &parameters = 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 &parameters = 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)

アプリケーションの識別とウェブサーバーへのリクエストの署名に使用されるQString のペアとして、clientIdentifierclientSharedSecret を設定します。clientIdentifier はアプリケーションを識別し、clientSharedSecret はリクエストの署名に使用されます。

clientCredentials()も参照

void QOAuth1::setClientSharedSecret(const QString &clientSharedSecret)

Web サーバーへのリクエストの署名に使用する文字列として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)

Web サーバーへの認証済みリクエストの識別と署名に使用するQString のペアとしてtokenCredentials を設定します。

tokenCredentials()参照してください。

void QOAuth1::setTokenCredentials(const QString &token, const QString &tokenSecret)

ウェブサーバへの認証済みリクエストの識別と署名に使用されるQString のペアとしてtokentokenSecret を設定します。クライアントがトークン認証情報を受信して保存すると、クライアントは受信したトークン認証情報とともにクライアント認証情報を使用して認証されたリクエストを行うことで、リソース所有者に代わって保護されたリソースにアクセスできるようになります。

tokenCredentials()も参照

void QOAuth1::setTokenCredentialsUrl(const QUrl &url)

認証プロセスを継続するためにトークン資格情報を要求する URL としてurl を設定します。

tokenCredentialsUrl() も参照

void QOAuth1::setTokenSecret(const QString &tokenSecret)

Web サーバへの認証済み呼び出しの署名に使用する現在のトークン・シークレットとして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

Web サーバーへのリクエストの署名に使用されるメソッドを返します。

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() も参照 ください。

©2024 The Qt Company Ltd. 本文書に含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。