京東云 OpenAPI 簽名機制的 Python 實現

khs1994 發布于2019-07-31 11:17 / 2501人閱讀

摘要：京東云是將京東云所有資源的管理能力通過的方式提供出來，供京東云用戶和合作伙伴使用。是京東云控制臺的有效補充，方便用戶更靈活的控制自己的云上資源。在開始調用京東云之前，需提前在京東云用戶中心賬戶管理下的管理頁面申請和密鑰對簡稱。

京東云OpenAPI是將京東云所有資源的管理能力通過API的方式提供出來，供京東云用戶和合作伙伴使用。OpenAPI是京東云控制臺的有效補充，方便用戶更靈活的控制自己的云上資源。

本文檔通過step-by-step生成簽名以及完整HTTP請求，并將請求發送至京東公共OpenAPI并得到response。

京東云：www.jdcloud.com
京東云OpenAPI：docs.jdcloud.com/cn/?act=3
公共說明：docs.jdcloud.com/cn/common-declaration/api/introduction

前置條件

要使用某個產品線的OpenAPI，首先需要先通過產品文檔了解產品功能、計費等方面的信息。

在開始調用京東云OpenAPI之前，需提前在京東云用戶中心賬戶管理下的AccessKey管理頁面申請AccessKey和SecretKey密鑰對（簡稱AK/SK）。AK/SK信息請妥善保管，如果遺失可能會造成非法用戶使用此信息操作您在云上的資源，給你造成數據和財產損失。AK/SK密鑰對允許啟用、禁用，啟用后可用其調用OpenAPI，禁用后不能用其調用OpenAPI。

京東云OpenAPI使用Restful接口風格，要進行OpenAPI調用需要包含如下信息：請求協議，請求方式，請求地址，請求路徑，請求頭，請求參數，請求體。

為了您的數據安全，建議務必使用https協議。

基本步驟

初始基本配置

生成初始請求header

生成標準請求串

生成待簽名字符串

生成簽名key

計算簽名值

更新請求頭

發送請求

請求簽名具體 Python 實現 1. 初始基本配置

# GET請求
method = "GET"
# 地域
region = "cn-north-1"
# 產品線
service = "vm"
# vm產品線服務地址：{product}.jdcloud-api.com
full_host = "vm.jdcloud-api.com"

# OpenAPI服務的地址和路徑格式一般為（默認為https）：
# https://{product}.jdcloud-api.com/{API版本號}/regions/{地域ID}/{資源名稱}/{資源ID(可選)}/{子資源名稱(可選)}/{子資源ID(可選)}{:自定義動作(可選)}
url = "https://vm.jdcloud-api.com/v1/regions/cn-north-1/instances/i-uvvtdzuxre"

# 規范請求路徑Path：/{apiVersion}/regions/{regionId}/instances/{instanceId}
canonical_uri = "/v1/regions/cn-north-1/instances/i-uvvtdzuxre"

# 本例中為GET請求，body為空（若為PUT/POST/PATCH請求，則body為parameter的JSON格式）
body = ""

2. 生成初始請求header

# 當前時間
now = datetime.datetime.utcfromtimestamp(time.time())

# 格式化字符串為："20180812T074253Z"
jdcloud_date = now.strftime("%Y%m%dT%H%M%SZ")

# 生成datestamp字符串：“20180812”，用于簽名
datestamp = now.strftime("%Y%m%d")

# 隨機生成的字符串：“58542f21-bda3-4736-9a08-da2339669e52”
nonce = str(uuid.uuid4())

# 增加請求header字段：
# Content-Type：請求數據格式為JSON
# User-Agent：格式為“JdcloudSdkPython/ <產品線>/<產品線revision>”
# 請求頭如下：
#         {"x-jdcloud-nonce": "63e0148e-0fef-4c78-9228-47fefe470b07", 
#         "Content-Type": "application/json", 
#         "x-jdcloud-date": "20180812T094103Z", 
#         "User-Agent": "JdcloudSdkPython/1.2.1 vm/1.0.0"}
headers = {"Content-Type": "application/json", "User-Agent": "JdcloudSdkPython/1.2.1 vm/1.0.0"}
headers["x-jdcloud-date"] = jdcloud_date
headers["x-jdcloud-nonce"] = nonce

3. 生成標準請求串

# 生成請求查詢字符串，本例為空。
canonical_querystring = ""

# 生成CanonicalHeaders字符串，CanonicalHeaders為需要參與簽名的請求頭及值。要創建規范 HTTP header 列表，請將所有 HTTP header 名稱轉換為小寫，并刪除前導空格和尾隨空格。通過用字符代碼排序HTTP header ，然后遍歷 HTTP header 名稱來構建規范 HTTP header 列表。使用:分隔名稱和值，并添加換行符。
# 如下：
#         content-type:application/json
#         host:vm.jdcloud-api.com
#         x-jdcloud-date:20180812T074253Z
#         x-jdcloud-nonce:58542f21-bda3-4736-9a08-da2339669e52
#
canonical_headers = "content-type" + ":" + headers["Content-Type"] + "
" + "host" + ":" + full_host + "
" + "x-jdcloud-date" + ":" + headers["x-jdcloud-date"] + "
" + "x-jdcloud-nonce" + ":" + headers["x-jdcloud-nonce"] + "
"

# SignedHeaders用于告知京東云，請求中的哪些頭是簽名過程的一部分，京東云可以忽略哪些頭（例如，由代理添加的任何附加標頭），以驗證請求。注意host, x-jdcloud-date, x-jdcloud-nonce必須包含在內。
signed_headers = "content-type;host;x-jdcloud-date;x-jdcloud-nonce"

# 生成body的hash（即使body為空字符串）： 
#        “e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855”
payload_hash = hashlib.sha256(body.encode("utf-8")).hexdigest()

# 生成標準請求串：
# GET
# /v1/regions/cn-north-1/instances/i-uvvtdzuxre
# 
# content-type:application/json
# host:vm.jdcloud-api.com
# x-jdcloud-date:20180812T074253Z
# x-jdcloud-nonce:58542f21-bda3-4736-9a08-da2339669e52
# content-type;host;x-jdcloud-date;x-jdcloud-nonce
#
# e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
canonical_request = (method + "
" +
                     canonical_uri + "
" +
                     canonical_querystring + "
" +
                     canonical_headers + "
" +
                     signed_headers + "
" +
                     payload_hash)

4. 生成待簽名字符串

# 用于創建請求簽名的哈希算法，目前只支持 `JDCLOUD2-HMAC-SHA256`
algorithm = "JDCLOUD2-HMAC-SHA256"

# CredentialScope格式為”{時間}/{地域編碼}/{產品線}/jdcloud2_request
”，例如20180130/cn-north-1/vpc/jdcloud2_request

# "20180812/cn-north-1/vm/jdcloud2_request"
credential_scope = (datestamp + "/" + region + "/" + service + "/" + "jdcloud2_request")

# 生成canonical_request的哈希值
#         a3349e006302711650240165d89bb9c0b504ff8dc95d665cd98907877fbbd423
canonical_request_hash = hashlib.sha256(canonical_request.encode("utf-8")).hexdigest()

# 生成待簽名字符串：
#  StringToSign =
#         Algorithm + 
 +
#         RequestDateTime + 
 +
#         CredentialScope + 
 +
#         HashedCanonicalRequest
# 結果為：
# JDCLOUD2-HMAC-SHA256
# 20180812T074253Z
# 20180812/cn-north-1/vm/jdcloud2_request
# a3349e006302711650240165d89bb9c0b504ff8dc95d665cd98907877fbbd423

string_to_sign = algorithm + "
" + jdcloud_date + "
" + credential_scope + "
" + canonical_request_hash

5. 生成簽名key

# 計算簽名key（二進制），其中HMAC(key, data)代表以二進制格式返回輸出的HMAC-SHA256函數
# 偽代碼：
# kSecret = your secret access key
# kDate = HMAC("JDCLOUD2" + kSecret, Date)
# kRegion = HMAC(kDate, Region)
# kService = HMAC(kRegion, Service)
# kSigning = HMAC(kService, "jdcloud2_request")

k_date = hmac.new(("JDCLOUD2" + secret_key).encode("utf-8"), datestamp.encode("utf-8"), hashlib.sha256).digest()

k_region = hmac.new(k_date, region.encode("utf-8"), hashlib.sha256).digest()

k_service = hmac.new(k_region, service.encode("utf-8"), hashlib.sha256).digest()

signing_key = hmac.new(k_service, "jdcloud2_request".encode("utf-8"), hashlib.sha256).digest()

6. 計算簽名值

# 最終生成簽名：
#     如：9b2026198d3acbf99da395e23a994ed369a0d70f5b4a5d7567dd0caf3009656d
encoded = string_to_sign.encode("utf-8")
signature = hmac.new(signing_key, encoded, hashlib.sha256).hexdigest()

7. 更新請求頭

# 計算簽名后，需要將簽名的結果作為Authorization請求頭將其添加到請求中
# "JDCLOUD2-HMAC-SHA256 Credential=xxxxxxxxxxxxxxxxxxxxxxxxxxx/20180812/cn-north-1/vm/jdcloud2_request, SignedHeaders=content-type;host;x-jdcloud-date;x-jdcloud-nonce, Signature=53305ed8290a26493beec3060d9b1ff7d94cb1a6f2171cd193a1562814c8de37"
authorization_header = algorithm + " " + "Credential=" + access_key + "/" + credential_scope + ", " + "SignedHeaders=" + signed_headers + ", " + "Signature=" + signature

# 更新請求headers，如下：
#        {"x-jdcloud-date": "20180812T074253Z", 
#        "x-jdcloud-content-sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", 
#        "JDCLOUD2-HMAC-SHA256": "JDCLOUD2-HMAC-SHA256", 
#        "x-jdcloud-nonce": "58542f21-bda3-4736-9a08-da2339669e52", 
#        "User-Agent": "JdcloudSdkPython/1.2.1 vm/1.0.0", 
#        "Content-Type": "application/json", 
#        "Authorization": "JDCLOUD2-HMAC-SHA256 Credential=xxxxxxxxxxxxxxxxxxxxxxxxxxx/20180812/cn-north-1/vm/jdcloud2_request, SignedHeaders=content-type;host;x-jdcloud-date;x-jdcloud-nonce, Signature=53305ed8290a26493beec3060d9b1ff7d94cb1a6f2171cd193a1562814c8de37"}

headers["Authorization"] = authorization_header
headers["x-jdcloud-date"] = jdcloud_date
headers["x-jdcloud-content-sha256"] = payload_hash
headers["JDCLOUD2-HMAC-SHA256"] = "JDCLOUD2-HMAC-SHA256"
headers["x-jdcloud-nonce"] = nonce

8. 發送請求 8.1 Python 發送請求

# Python發送請求，并獲得相應
resp = requests.request(method, url, data=body, headers=headers)

8.2 Curl發送請求

請求頭中必須包含SignedHeaders中的各個字段：

# curl -X GET -H "x-jdcloud-date:20180812T094103Z" -H "x-jdcloud-nonce:63e0148e-0fef-4c78-9228-47fefe470b07" -H "Content-Type:application/json" -H "Authorization:JDCLOUD2-HMAC-SHA256 Credential=xxxxxxxxxxxxxxxxxxxxxxxxxxx/20180812/cn-north-1/vm/jdcloud2_request, SignedHeaders=content-type;host;x-jdcloud-date;x-jdcloud-nonce, Signature=53305ed8290a26493beec3060d9b1ff7d94cb1a6f2171cd193a1562814c8de37" https://vm.jdcloud-api.com/v1/regions/cn-north-1/instances/i-uvvtdzuxre

總結

可將發送OpenAPI請求簡單總結為：

生成待簽名字符串（包含header各個字段、body的hash等）

生成簽名key（包含SK并多層加鹽）；

用key簽名step 1的待簽名字符串，將簽名信息加入到header并發送請求（包含AK），服務端按照同樣的方式可以校驗身份。

使用Python SDK發送請求源代碼：

from jdcloud_sdk.core.credential import *
from jdcloud_sdk.services.vm.client.VmClient import *
from jdcloud_sdk.services.vm.apis.DescribeInstanceRequest import *
import json
# 用戶AK&SK
access_key = ""
secret_key = ""
# 地域
regionId = "cn-north-1"
# 要查詢的實例ID
instanceId = "i-uvvtdzuxre"
# 生成Credential和Client
myCredential = Credential(access_key, secret_key)
myClient = VmClient(myCredential)
# 定義參數
myParam = DescribeInstanceParameters(regionId, instanceId)
# 定義請求
myRequest = DescribeInstanceRequest(myParam)
# Client發送請求，并得到響應
resp = myClient.send(myRequest)
# 將返回結果以JSON格式打印
print json.dumps(resp.result, indent=2)

云服務器 GPU云服務器 webrtc內網穿透實現的機制是什么實現機制 Ajax實現機制阿里云 openapi

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/44928.html

干貨 | 京東云賬號安全管理最佳實踐

摘要：賬號操作保護建議啟用操作保護，在控制臺進行關鍵操作時對操作人進行驗證，進一步提高賬號安全性。結語本文介紹了京東云提供的一些賬號安全管理最佳實踐能力，請掌握并持續遵循這些最佳實踐。 showImg(https://segmentfault.com/img/bVbtNqp?w=688&h=113); showImg(https://segmentfault.com/img/bVbtSTC?...

Ajian 2019-06-28 11:24 評論0 收藏0
玩轉京東支付(python)

摘要：接收到京東支付加密報文后的處理方式接收到京東支付返回的加密報文后，先判斷標簽下的標簽的返回碼，檢查接口調用是否正常返回。說明 github地址做了微信。支付寶和京東支付之后，發現，最扯蛋的支付，肯定是京東支付，要完整開發京東支付，必須要看完京東支付開發者文檔的官網每一個角落，絕對不能憑你的任何經驗去猜測有些流程，比如公私鑰加解密（不看官網，保證你后悔）、發送請求的方式（form表單...

sydMobile 2019-07-30 15:13 評論0 收藏0
記一次在阿里云上創建VPC網絡

摘要：起因所在的公司使用的云服務器之前一直是經典網絡連接的，最近收到阿里的郵件說部分購置較早的云服務器需要坐一些硬件的升級，隨著升級而來的要求是把這些服務器切換至網絡。我這里只需要創建，所以就寫一個簡單的腳本調用阿里的實現。起因所在的公司使用的云服務器之前一直是經典網絡連接的，最近收到阿里的郵件說部分購置較早的云服務器需要坐一些硬件的升級，隨著升級而來的要求是把這些服務器切換至VPC網絡...

wdzgege 2019-07-30 16:51 評論0 收藏0