Basic验证插件 - 玩转Kong插件

如何启用插件?

1、通过以下请求在服务上配置这个插件:

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=basic-auth"  \
    --data "config.hide_credentials=true"

2、在路由上启用插件:

$ curl -X POST http://kong:8001/routes/{route_id}/plugins \
    --data "name=basic-auth"  \
    --data "config.hide_credentials=true"

3、在API上启用插件(API管理自0.13.0版本已过时)

$ curl -X POST http://kong:8001/apis/{api}/plugins \
    --data "name=basic-auth"  \
    --data "config.hide_credentials=true"

所有插件都可以使用 http://kong:8001/plugins/ 进行通用配置。这是与任何服务、路由或消费者都无关的插件,它是“公共的”,并且将在每个请求上运行。下面是basic-auth插件可配置参数列表:

形式参数 默认值 描述
name 插件名称, 这里是 basic-auth
service_id 插件针对的服务ID
route_id 插件针对的路由ID
enabled true 插件是否可用
api_id 插件针对的API模块
config.hide_credentials 可选 false 可选的布尔值,告诉插件从上游服务中显示或隐藏凭证. 如果为"true",插件将在代理之前将凭据从请求中剥离(例如:Authorization 头部)
config.anonymous 可选 可选字符串,如果身份验证失败,该值(消费者uuid)用作“匿名”使用者。 如果空(默认),请求失败将提示认证失败“4xx”。请注意,这个值必须是指向消费者 id属性, 而不是 它的 custom_id.

一旦应用,任何具有有效凭证的用户都可以访问Service/API。要限制只有部分经过身份验证的用户,还可以添加ACL插件,并创建白名单或黑名单用户组。

如何使用插件?

1、 创建一个消费者:

curl -d "username=user123&custom_id=SOME_CUSTOM_ID" http://kong:8001/consumers/
参数 默认值 描述
username 半可选 必须制定username或custom_id其中一个
custom_id 半可选 必须制定username或custom_id其中一个

一个消费者可以有很多凭证。如果您还使用该服务的ACL插件和白名单,您必须将新消费者添加到白名单组。

2、创建一个凭证

您可以通过发出以下HTTP请求来提供新的用户名/密码凭证:

$ curl -X POST http://kong:8001/consumers/{consumer}/basic-auth \
    --data "username=Aladdin" \
    --data "password=OpenSesame"

3、使用凭证

授权头必须是base64编码的。例如,如果凭证用户是Aladdin,密码是OpenSesame ,那么就是Aladdin:OpenSesame的base64编码,即QWxhZGRpbjpPcGVuU2VzYW1l。例如:

$ curl http://kong:8000/{path matching a configured Route} \
    -H 'Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l'

4、上游头部

当客户端经过身份验证时,插件会在将其代理到上游服务之前,在请求中附加一些头信息,这样您就可以在代码中识别使用者:

  • X-Consumer-ID,消费者ID
  • X-Consumer-Custom-ID, 消费者的custom_id (如果有设置)
  • X-Consumer-Username, 消费者的username (如果有设置)
  • X-Credential-Username, 证书的username (只有当消费者不是anonymous消费者的时候)
  • X-Anonymous-Consumer, 当身份验证失败时,将被设置为true,取而代之的是anonymous消费者。

5、通过basic-auth凭证进行分页

$ curl -X GET http://kong:8001/basic-auths
属性 描述
id 可选 basic-auth认证id
username 可选 basic-auth认证用户名
consumer_id 可选 A filter on the list based on the basic-auth credential consumer_id field.
size 可选,默认100 要返回的对象数量
offset 可选 分页的游标、偏移

6、检索与凭证相关联的消费者

curl -X GET http://kong:8001/basic-auths/{username or id}/consumer

穿梭机:开源API网关系统(Kong教程)入门到精通

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139
  • 姓名:周小蓬 16019110037 转载自:http://blog.csdn.net/YChenFeng/art...
    aeytifiw阅读 34,524评论 13 425
  • 客户端访问上游API服务,通常由Kong的认证插件及其配置参数来控制。 通用认证 一般情况下,上游API服务都需要...
    DreamsonMa阅读 15,439评论 10 9
  • 泰国的夏天十分炎热,想要让内心平静下来,一杯泰式冰茶就能轻松搞定!让这股凉意从嘴里一直冰到心里。不管心里有怎样的烦...
    熊猫GO阅读 435评论 0 0
  • 少年处于生长发育的关键时期,这段青春期的发育需要营养的支持,身体发育快,肌肉、骨骼齐生长,特别需要蛋白质、...
    张晓蓉营养师阅读 3,086评论 0 1