PySide6.QtNetworkAuth.QOAuth1

class QOAuth1

QOAuth1 类提供了 OAuth 1 协议 的实现。更多

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])
Parameters:

父对象QObject

构造一个带有父对象 parentQOAuth1 对象。

__init__(manager[, parent=None])
Parameters:

使用manager访问网络,构造一个QOAuth1对象,其父对象为parent

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

使用父对象 parent 构造一个 QOAuth1 对象,并使用 manager 访问网络。同时设置 clientIdentifierclientSharedSecret 以签名对网络服务器的调用并识别应用程序。

clientCredentials()
Return type:

.std.pairQString,QString

返回用于标识应用程序并向Web服务器签名请求的QString对。

另请参阅

setClientCredentials()

clientSharedSecret()
Return type:

字符串

返回用于签名向Web服务器发出的请求的当前共享密钥。

clientSharedSecretChanged(credential)
Parameters:

credential – str

continueGrantWithVerifier(verifier)
Parameters:

verifier – str

继续使用verifier进行基于重定向的授权流程。当使用带外回复处理程序提供由Web服务器提供的验证器时,调用此函数。

static generateAuthorizationHeader(oauthParams)
Parameters:

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

Return type:

QByteArray

使用oauthParams生成授权头。

另请参阅: The OAuth 1.0 Protocol: Authorization Header

static nonce()
Return type:

QByteArray

生成一个随机数。

另请参阅: The OAuth 1.0 Protocol: Nonce and Timestamp

requestTemporaryCredentials(operation, url[, parameters=QVariantMap()])
Parameters:
  • 操作Operation

  • urlQUrl

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

Return type:

QNetworkReply

开始使用请求方法 operation 请求临时凭证。请求的URL是 url,并且 parameters 应在请求期间进行编码并发送。

另请参阅: The OAuth 1.0 Protocol: Temporary Credentials

requestTokenCredentials(operation, url, temporaryToken[, parameters=QVariantMap()])
Parameters:
  • 操作Operation

  • urlQUrl

  • temporaryToken – .std.pairQString,QString

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

Return type:

QNetworkReply

使用请求方法 operation 开始请求令牌凭证。请求的URL是 url,并且 parameters 应在请求期间进行编码并发送。字符串对 temporaryToken 用于识别和签名请求。

另请参阅: The OAuth 1.0 Protocol: Token Credentials

setClientCredentials(clientCredentials)
Parameters:

clientCredentials – .std.pairQString,QString

clientCredentials 设置为用于识别应用程序并签署对Web服务器请求的QString对。

另请参阅

clientCredentials()

setClientCredentials(clientIdentifier, clientSharedSecret)
Parameters:
  • clientIdentifier – str

  • clientSharedSecret – str

clientIdentifierclientSharedSecret设置为用于识别应用程序并签署对Web服务器请求的QString对。clientIdentifier用于识别应用程序,clientSharedSecret用于签署请求。

另请参阅

clientCredentials()

setClientSharedSecret(clientSharedSecret)
Parameters:

clientSharedSecret – str

clientSharedSecret设置为用于签名向Web服务器发送请求的字符串。

setSignatureMethod(value)
Parameters:

SignatureMethod

value 设置为用于签名请求到Web服务器的方法。

另请参阅

signatureMethod()

setTemporaryCredentialsUrl(url)
Parameters:

urlQUrl

url 设置为请求临时凭证以启动身份验证过程的URL。

setTokenCredentials(tokenCredentials)
Parameters:

tokenCredentials – .std.pairQString,QString

tokenCredentials设置为用于识别和签名对Web服务器的认证请求的QString对。

另请参阅

tokenCredentials()

setTokenCredentials(token, tokenSecret)
Parameters:
  • token – str

  • tokenSecret – str

tokentokenSecret设置为用于识别和签名对Web服务器的认证请求的QString对。一旦客户端接收并存储了令牌凭证,它就可以通过使用客户端凭证与接收到的令牌凭证一起进行认证请求,代表资源所有者访问受保护的资源。

另请参阅

tokenCredentials()

setTokenCredentialsUrl(url)
Parameters:

urlQUrl

url设置为请求令牌凭据以继续认证过程的URL。

另请参阅

tokenCredentialsUrl()

setTokenSecret(tokenSecret)
Parameters:

tokenSecret – str

tokenSecret设置为当前用于签名对Web服务器的认证调用的令牌密钥。

setup(request, signingParameters, operation)
Parameters:
  • 请求QNetworkRequest

  • signingParameters – 字典,键类型为 .QString,值类型为 QVariant。

  • 操作Operation

setup(request, signingParameters, operationVerb)
Parameters:
  • 请求QNetworkRequest

  • signingParameters – 字典,键类型为 .QString,值类型为 QVariant。

  • operationVerbQByteArray

signatureMethod()
Return type:

SignatureMethod

返回用于对Web服务器请求进行签名的方法。

另请参阅

setSignatureMethod()

signatureMethodChanged(method)
Parameters:

方法SignatureMethod

temporaryCredentialsUrl()
Return type:

QUrl

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

temporaryCredentialsUrlChanged(url)
Parameters:

urlQUrl

tokenCredentials()
Return type:

.std.pairQString,QString

返回用于识别和签名对Web服务器的认证请求的QString对。

另请参阅

setTokenCredentials()

tokenCredentialsUrl()
Return type:

QUrl

返回用于请求令牌凭据以继续身份验证过程的URL。

tokenCredentialsUrlChanged(url)
Parameters:

urlQUrl

tokenSecret()
Return type:

字符串

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

tokenSecretChanged(token)
Parameters:

token – str