# 概述

appID管理功能维护应用鉴权信息,可配置是否启用签名、是否启用IP白名单,AppID级别的自定义配置供自定义插件使用。appID用于在路由管理配置中关联路由规则,当对应路由规则触发时会对应用进行鉴权。

# appID列表

菜单位置:网关管理 > appID管理。点击菜单后进入appID列表页面,如图所示。

manager_app_id_list_query

# 新增appID

点击 新增 按钮弹出新增窗口,如图所示。

manager_app_id_add_1

manager_app_id_add_2

appID:第三方应用唯一标识,长度不能超过64个字符,必填;

应用名:第三方应用名称,长度不能超过128个字符,必填;

是否启用签名:当启动时必须配置 认证方式 和 密钥;

认证方式:可选 MD5签名(使用网关内置鉴权方式验证)|自定义认证插件(使用自定义的鉴权逻辑),更多信息请查看Fizz网关的介绍;启用签名时必填;

密钥:第三方应用使用的密钥,可通过 生成随机密钥 按钮生成一个随机的密钥,启用签名时必填;

是否启用IP白名单:当启用时可以配置 IP白名单,网关会根据请求来源IP地址进行过滤;

IP白名单:IP段支持 1.2.3.100-120 和 1.2.3.*两种格式,仅最后一段可用范围或星号表示;

自定义配置:AppID级别的自定义配置供自定义插件使用,所有插件均可获取到此配置信息。

# 编辑appID

点击 编辑 按钮弹出编辑窗口,如图所示。

manager_app_id_edit_1

manager_app_id_edit_2

# 删除appID

点击 删除 按钮弹出删除确认窗口,如图所示。

manager_app_id_delete_1

manager_app_id_delete_2

点击 确定 按钮后删除appID,如果appID存在关联的路由配置时,对应关联的路由配置也会一起删除。

# appID使用说明

当appid启用了签名时,调用方在调用接口时需传以下请求头

  • fizz-appid appid请求头
  • fizz-sign 签名请求头,传根据密钥生成的签名值
  • fizz-ts 时间戳请求头,传当前时间戳

认证方式:

  • MD5签名是内置的认证方式,签名生成方式:MD5(appid+_+时间戳+_+密钥) 如:MD5(10001_1605255335977_e4502ba3a71448bbbcecef22b305d2ba)
  • 自定义认证插件需开发认证插件,可定制签名和验签方法

样例:

fizz-appid: 10001
fizz-sign: e4502ba3a71448bbbcecef22b305d2ba
fizz-ts: 1605255335977

# 自定义备用请求头

支持自定义可配置的备用签名头,当默认请求头没有值时取备用请求头的值,备用请求头主要用于兼容历史系统的验签请求头。

修改fizz-gateway-community的application.yml配置文件增加以下配置项:

custom:
  header:
    appid: app-id,gw-appid  # fizz-appid的备用请求头,多个以逗号分隔,如果前一个请求头没有值网关按顺序取下一个的值
    sign: signature # fizz-sign的备用请求头,多个以逗号分隔,如果前一个请求头没有值网关按顺序取下一个的值
    ts: timestamp # fizz-ts的备用请求头,多个以逗号分隔,如果前一个请求头没有值网关按顺序取下一个的值
上次更新: 2021-8-17 17:29