class QOAuth1#

QOAuth1 类提供了一个 OAuth 1 协议 的实现。有关更多信息，请参阅[更多]...

Inheritance diagram of PySide6.QtNetworkAuth.QOAuth1

摘要#

方法#

插槽#

信号#

静态函数#

注意：

本文档可能包含从 C++ 自动翻译到 Python 的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译存在问题，也可以通过在 https:/bugreports.qt.io/projects/PYSIDE 上创建工单来告知我们。

详细说明#

QOAuth1 为客户端提供了代表资源拥有者（如另一个客户端或最终用户）访问服务器资源的方法。它还提供了一种流程，使最终用户可以在不共享凭据（通常是一对用户名和密码）的情况下，通过用户代理重定向授权第三方访问他们的服务器资源。

QOAuth1 使用令牌来表示资源拥有者授予客户端的授权。通常，令牌凭据是由服务器在资源拥有者的请求后发放，并在验证资源拥有者身份后（通常使用用户名和密码）。

在请求临时凭证时，客户端仅使用客户端凭据进行验证。在请求令牌时，客户端使用客户端凭据以及临时凭据进行验证。一旦客户端接收到并存储了令牌凭据，它就可以通过使用客户端凭据和收到的令牌凭据进行验证请求，进而代表资源拥有者访问受保护的资源。

class SignatureMethod#

指示用于签名请求的签名方法。

常量

描述

QOAuth1.SignatureMethod.Hmac_Sha1

HMAC-SHA1 签名方法。

QOAuth1.SignatureMethod.Rsa_Sha1

RSA-SHA1 签名方法（不支持）。

QOAuth1.SignatureMethod.PlainText

PLAINTEXT 签名方法。
__init__([parent=None])#
参数:

parent – QObject

使用父对象 parent 构造一个 QOAuth1 对象。

__init__(clientIdentifier, clientSharedSecret, manager[, parent=None])
参数:

使用父对象 parent 和 manager 访问网络来创建一个 QOAuth1 对象。同时设置 clientIdentifier 和 clientSharedSecret 来对访问网服务器的调用进行签名并识别应用程序。

__init__(manager[, parent=None])
参数:

使用父对象 parent 和 manager 访问网络来创建一个 QOAuth1 对象。

clientCredentials()#
返回类型：

.std.pairQString,QString

返回识别应用程序和为访问网服务器发送请求签名的 QString 对。

clientSharedSecret()#
返回类型：

str

返回用于对访问网服务器的请求进行签名的当前共享密钥。

clientSharedSecretChanged(credential)#
参数:

credential – str

continueGrantWithVerifier(verifier)#
参数:

verifier – str

使用 verifier 继续基于重定向的授权流程。当使用带外回复处理器提供由网服务器提供的验证器时，请调用该函数。

static generateAuthorizationHeader(oauthParams)#
参数:

oauthParams – 类型为 .QString 的键和类型为 QVariant 的值的字典。

返回类型：

QByteArray

使用 oauthParams 生成一个授权头。

参见: OAuth 1.0 协议：授权头

static nonce()#
返回类型：

QByteArray

生成一个 nonce。

参见: OAuth 1.0 协议：Nonce 和 Timestamp

requestTemporaryCredentials(operation, url[, parameters=QVariantMap()])#
参数:

  • operation – Operation

  • url – QUrl

  • parameters – 类型为 .QString 的键和类型为 QVariant 的值的字典。

返回类型：

QNetworkReply

通过请求方法 operation 启动对临时凭证的请求。请求 URL 是 url，且 parameters 应在请求过程中进行编码并发送。

参见：[OAuth 1.0 协议：临时凭证](https://tools.ietf.org/html/rfc5849#section-2.1)

requestTokenCredentials(operation, url, temporaryToken[, parameters=QVariantMap()])#
参数:

  • operation – Operation

  • url – QUrl

  • temporaryToken – .std.pairQString,QString

  • parameters – 类型为 .QString 的键和类型为 QVariant 的值的字典。

返回类型：

QNetworkReply

通过请求方法 operation 启动对令牌凭证的请求。请求 URL 是 url，且 parameters 应在请求过程中进行编码并发送。使用字符串对 temporaryToken 来标识和签名请求。

参见：[OAuth 1.0 协议：令牌凭证](https://tools.ietf.org/html/rfc5849#section-2.3)

setClientCredentials(clientIdentifier, clientSharedSecret)#
参数:

  • clientIdentifier – str

  • clientSharedSecret – str

将 clientIdentifier 和 clientSharedSecret 设置为用于标识应用程序并对 Web 服务器请求进行签名的 QString 对。 clientIdentifier 标识应用程序，而 clientSharedSecret 用于签名请求。

setClientCredentials(clientCredentials)
参数:

clientCredentials – .std.pairQString,QString

将 clientCredentials 设置为用于标识应用程序并对 Web 服务器请求进行签名的 QString 对。

setClientSharedSecret(clientSharedSecret)#
参数:

clientSharedSecret – str

将 clientSharedSecret 设置为用于对 Web 服务器请求进行签名的字符串。

setSignatureMethod(value)#
参数:

value – SignatureMethod

设置用于在Web服务器上签名请求的方法。

setTemporaryCredentialsUrl(url)#
参数:

url – QUrl

将url设置为目标URL，用于开始身份验证过程，请求数据临时凭据。

setTokenCredentials(token, tokenSecret)#
参数:

  • token – str

  • tokenSecret – str

设置token和tokenSecret作为QString，用于识别和签署发送到Web服务器的已认证请求。客户端接收到并存储令牌凭证后，可以继续以资源所有者的名义通过使用客户端凭据和接收到的令牌凭据进行认证请求来访问受保护的资源。

setTokenCredentials(tokenCredentials)
参数:

tokenCredentials – .std.pairQString,QString

将tokenCredentials设置为QString对，用于识别和签署发送到Web服务器的已认证请求。

setTokenCredentialsUrl(url)#
参数:

url – QUrl

设置url作为请求令牌凭据的URL，以继续身份验证过程。

setTokenSecret(tokenSecret)#
参数:

tokenSecret – str

将tokenSecret设置为当前令牌密钥，用于签署发送到Web服务器的已认证调用。

setup(request, signingParameters, operation)#
参数:

  • request – QNetworkRequest

  • signingParameters – 键为 QString 类型，值为 QVariant 类型的字典。

  • operation – Operation

setup(request, signingParameters, operationVerb)
参数:

  • request – QNetworkRequest

  • signingParameters – 键为 QString 类型，值为 QVariant 类型的字典。

  • operationVerb – QByteArray

signatureMethod()#
返回类型：

签名方法

返回用于对发送到Web服务器的请求进行签名的具体方法。

signatureMethodChanged(method)#
参数:

method – SignatureMethod

temporaryCredentialsUrl()#
返回类型：

QUrl

返回用于请求临时凭证以启动认证过程的URL。

temporaryCredentialsUrlChanged(url)#
参数:

url – QUrl

tokenCredentials()#
返回类型：

.std.pairQString,QString

返回一对 QString 用以识别和签名发送到 Web 服务器的经过认证的请求。

tokenCredentialsUrl()#
返回类型：

QUrl

返回用于在认证过程中请求令牌凭证的URL。

tokenCredentialsUrlChanged(url)#
参数:

url – QUrl

tokenSecret()#
返回类型：

str

返回当前用于对发送到 Web 服务器的经过认证的请求进行签名的令牌密钥。

tokenSecretChanged(token)#
参数:

token – str