tencent cloud

文档反馈

Python(密钥对认证)

最后更新时间:2023-12-22 10:08:43

    操作场景

    该任务指导您使用 Python 语言,通过密钥对鉴权来对您的 API 进行认证管理。

    操作步骤

    1. API 网关控制台,创建一个 API,选择鉴权类型为密钥对鉴权(参考 创建 API 概述)。
    2. 将 API 所在服务发布至发布环境(参考 服务发布与下线)。
    3. 在控制台密钥管理界面创建密钥对。
    4. 在控制台使用计划界面创建使用计划,并将使用计划与已创建的密钥对绑定(参考 使用计划示例)。
    5. 将使用计划与 API 或 API 所在服务进行绑定。
    6. 参考 示例代码,使用 Python 语言生成签名内容。

    环境依赖

    API 网关提供 Python 2.7 和 Python 3 两个版本的示例代码,请您根据自己的 Python 版本合理选择。

    注意事项

    最终发送的 HTTP 请求内至少包含两个 Header:Date 和 X-Date 二选一以及 Authorization,可以包含更多 header。如果使用 Date Header,服务端将不会校验时间;如果使用 X-Date Header,服务端将校验时间。
    Date Header 的值为格林威治时间(GMT)格式的 HTTP 请求构造时间,例如 Fri, 09 Oct 2015 00:00:00 GMT。
    X-Date Header 的值为格林威治时间(GMT)格式的 HTTP 请求构造时间,例如 Mon, 19 Mar 2018 12:08:40 GMT。X-Date Header 里的时间和当前时间的差值不能超过15分钟。
    如果是微服务 API,Header 中需要添加 “X-NameSpace-Code” 和 “X-MicroService-Name” 两个字段,通用 API 不需要添加,Demo 中默认添加了这两个字段。

    示例代码

    Python 2.7 示例代码

    # -*- coding: utf-8 -*-
    import requests
    import datetime
    import hashlib
    from hashlib import sha1
    import hmac
    import base64
    
    
    GMT_FORMAT = '%a, %d %b %Y %H:%M:%S GMT'
    
    def getSimpleSign(source, SecretId, SecretKey) :
    dateTime = datetime.datetime.utcnow().strftime(GMT_FORMAT)
    auth = "hmac id=\\"" + SecretId + "\\", algorithm=\\"hmac-sha1\\", headers=\\"date source\\", signature=\\""
    signStr = "date: " + dateTime + "\\n" + "source: " + source
    sign = hmac.new(SecretKey, signStr, hashlib.sha1).digest()
    sign = base64.b64encode(sign)
    sign = auth + sign + "\\""
    return sign, dateTime
    
    SecretId = 'your SecretId' # 密钥对的 SecretId
    SecretKey = 'your SecretKey' # 密钥对的 SecretKey
    url = 'http://service-xxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com/release/xxx' # 用户 API 的访问路径
    
    #header = {}
    header = { 'Host':'service-xxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com', # 用户 API 所在服务的域名
    'Accept': 'text/html, */*; q=0.01',
    'X-Requested-With': 'XMLHttpRequest',
    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36',
    'Accept-Encoding': 'gzip, deflate, sdch',
    'Accept-Language': 'zh-CN,zh;q=0.8,ja;q=0.6'
    }
    
    Source = 'xxxxxx' # 签名水印值,可填写任意值
    sign, dateTime = getSimpleSign(Source, SecretId, SecretKey)
    header['Authorization'] = sign
    header['Date'] = dateTime
    header['Source'] = Source
    
    # 如果是微服务 API,Header 中需要添加'X-NameSpace-Code'、'X-MicroService-Name'两个字段,通用 API 不需要添加。
    header['X-NameSpace-Code'] = 'testmic'
    header['X-MicroService-Name'] = 'provider-demo'
    
    print header
    
    r = requests.get(url, headers=header)
    print r
    print r.text

    Python 3 示例代码

    # -*- coding: utf-8 -*-
    import base64
    import datetime
    import hashlib
    import hmac
    
    import requests
    
    GMT_FORMAT = '%a, %d %b %Y %H:%M:%S GMT'
    
    
    def getSimpleSign(source, SecretId, SecretKey):
    dateTime = datetime.datetime.utcnow().strftime(GMT_FORMAT)
    auth = "hmac id=\\"" + SecretId + "\\", algorithm=\\"hmac-sha1\\", headers=\\"date source\\", signature=\\""
    signStr = "date: " + dateTime + "\\n" + "source: " + source
    sign = hmac.new(SecretKey.encode(), signStr.encode(), hashlib.sha1).digest()
    sign = base64.b64encode(sign).decode()
    sign = auth + sign + "\\""
    return sign, dateTime
    
    
    SecretId = 'your SecretId' # 密钥对的 SecretId
    SecretKey = 'your SecretKey' # 密钥对的 SecretKey
    url = 'http://service-xxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com/release/xxx' # 用户 API 的访问路径
    
    header = {'Host': 'service-xxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com', # 用户 API 所在服务的域名
    'Accept': 'text/html, */*; q=0.01',
    'X-Requested-With': 'XMLHttpRequest',
    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36',
    'Accept-Encoding': 'gzip, deflate, sdch',
    'Accept-Language': 'zh-CN,zh;q=0.8,ja;q=0.6'
    }
    Source = 'xxxxxx' # 签名水印值,可填写任意值
    sign, dateTime = getSimpleSign(Source, SecretId, SecretKey)
    header['Authorization'] = sign
    header['Date'] = dateTime
    header['Source'] = Source
    
    
    r = requests.get(url, headers=header)
    print(r.text)
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持