API网关Kong使用指南(五)—— hmac-auth插件相关开发用例

1、前提

现假设有一个钱包RPC服务地址是http://localhost:51234/,经Kong配置路由后新的服务地址是http://localhost:8000/rpc/。然后,我们为该RPC服务配置了hmac-auth插件,以实现HMAC认证,其详细信息如下:

项目 内容
用户名 block90cred
密钥 zkYEGk5KIYfuWgZqCeU6146uctQQVtnc
请求body {"method": "getwalletinfo", "params": [] }
原RPC服务地址 http://localhost:51234/
新服务地址 http://localhost:8000/rpc/

2、改造请求

除了请求的地址由原地址http://localhost:51234/改为新地址http://localhost:8000/rpc/之外,请求body是不需要改变的,关键是在请求的headers中添加一些相关的认证信息。

项目 名称 内容 备注
当前时间 Date Wed, 14 Aug 2019 09:09:28 GMT 防止重放攻击,注意格式不能改变
请求摘要 Digest SHA-256={} 防止请求body被篡改,使用sha256算法
认证信息 Authorization hmac username="{}", algorithm="hmac-sha256", headers="date digest", signature="{}" 说明验证的内容,以保证服务端与客户端使用相同内容与算法,使用hmac-sha256算法

3、实现代码

我们采用python编写了相应的实现方法。关键代码请看call_hmac_auth方法。

import hmac
import hashlib
import log_utils
import base64
import urllib.request
import urllib.parse
import json
import time

KEY_AUTH = 'block90'
GET_WALLET_INFO_BODY = bytes('{"method": "getwalletinfo", "params": [] }', encoding='utf-8')
HOST = 'http://localhost:8000/'
HMAC_USERNAME = 'block90cred'
HMAC_SECRET = "zkYEGk5KIYfuWgZqCeU6146uctQQVtnc"
BASIC_AUTH = 'Basic dmlyY2xlOjk5OTAwMA=='

logger = log_utils.get_logger('wallet_rpc')


def call_rpc(url, headers, body):
    logger.debug('call rpc url: %s', url)
    req_headers = {
        'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko)'
                      ' snap Chromium/76.0.3809.87 Chrome/76.0.3809.87 Safari/537.36'
    }
    req_headers.update(headers)
    logger.debug('request headers: %s', json.dumps(req_headers, indent=2))
    request = urllib.request.Request(url, body, req_headers)
    try:
        # 访问
        with urllib.request.urlopen(request) as response:
            html = response.read().decode('utf-8')
            # 利用json解析包解析返回的json数据 拿到翻译结果
            logger.info('response = %s', json.dumps(json.loads(html), indent=2))
    except urllib.error.HTTPError as err:
        logger.error('response error: %s', err)
        logger.error('response headers: %s', err.headers)
        err_html = err.read().decode('utf-8')
        if err_html:
            logger.error('response = %s', json.dumps(json.loads(err_html), indent=2))


def hmac_sha256_base64_encode(secret, str_to_sign):
    # hmac_sha256加密
    signature = hmac.new(bytes(secret, encoding='utf-8'), bytes(str_to_sign, encoding='utf-8'),
                         digestmod=hashlib.sha256).digest()
    logger.debug('signature hex: %s', signature.hex())
    str_base64 = base64.b64encode(signature).decode()
    logger.debug('signature base64: %s', str_base64)
    return str_base64


def call_hmac_auth():
    logger.debug('--------------- with hmac-auth ---------------')
    # 用sha256算法计算请求body的摘要
    body_digest = 'SHA-256={}'.format(base64.b64encode(hashlib.sha256(GET_WALLET_INFO_BODY).digest()).decode())
    logger.debug('body digest: %s', body_digest)
    # 生成当前GMT时间,注意格式不能改变,必须形如:Wed, 14 Aug 2019 09:09:28 GMT
    gm_time = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime())
    # 拼装待签名的数据
    str_to_sign = "date: {}\ndigest: {}".format(gm_time, body_digest)
    # 生成签名
    signature = hmac_sha256_base64_encode(HMAC_SECRET, str_to_sign)
    logger.debug('to_sign: %s', str_to_sign)
    logger.debug('signature: %s', signature)
    # 拼装headers
    headers = {
        'Authorization': 'hmac username=\"{}\", algorithm=\"hmac-sha256\", headers=\"date digest\", '
                         'signature=\"{}\"'.format(HMAC_USERNAME, signature),
        'Digest': body_digest,
        'Date': gm_time}
    # 调用rpc服务
    call_rpc(HOST + 'rpc', headers, GET_WALLET_INFO_BODY)


def call_no_auth():
    logger.debug('--------------- without auth ---------------')
    headers = {'Authorization': BASIC_AUTH}
    call_rpc(HOST + 'rpcnokey', headers, GET_WALLET_INFO_BODY)


def call_key_auth():
    logger.debug('--------------- with key-auth ---------------')
    headers = {'Authorization': BASIC_AUTH, 'apikey': KEY_AUTH}
    call_rpc(HOST + 'rpc', headers, GET_WALLET_INFO_BODY)


if __name__ == "__main__":
    # call_no_auth()
    # call_key_auth()
    call_hmac_auth()

4、参考资料

  1. hmac-auth认证插件官方说明文档

系列链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351