计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
文档首页/ API网关 APIG/ 最佳实践/ API认证/ 使用APIG的APP认证和自定义认证实现API的双重认证

使用APIG的APP认证和自定义认证实现API的双重认证

更新时间:2025-01-21 GMT+08:00

应用场景

双重认证指用户根据业务需求自定义API认证策略,再结合APP认证/IAM认证,从而实现API的双重认证方式,保障API的安全性。本文以API前端认证使用APP认证和自定义认证结合场景为例,具体说明如何创建使用双重认证的API。

方案优势

在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全性。

约束与限制

API网关支持的自定义认证依赖于函数工作流服务,创建自定义认证前,需要先创建函数。

操作流程

  1. 创建函数

    创建自定义的前端函数,使用函数服务开发自定义认证。

  2. 创建自定义认证

    创建自定义认证,类型选择“前端”,函数地址选择上一步创建的函数。

  3. 创建API

    安全配置中的安全认证选择APP认证,并勾选“支持双重认证”,选择上一步创建的自定义认证。

  4. 创建凭据

    使用APP认证的API,需要在API网关中创建一个凭据,生成凭据ID和密钥对(Key、Secret)。

  5. 绑定API

    将创建的凭据绑定API后,才可以使用APP认证调用API。

  6. 验证

    调用API,验证双重认证是否设置成功。

实施步骤

  1. 登录函数工作流控制台,在“总览”页面,单击“创建函数”。

    1. 根据下表,填写函数信息后,单击“创建函数”。
      表1 函数信息配置

      参数

      配置说明

      选择创建方式

      默认“创建空白函数”。

      函数类型

      默认“事件函数”。

      区域

      与API网关相同区域。

      项目

      华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。

      函数名称

      根据规划自定义名称。

      企业项目

      企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。此处默认“default”。

      委托名称

      用户委托函数工作流去访问其他的云服务。此处选择“未使用任何委托”。

      运行时

      选择Python 3.9。

    2. 函数创建完成后,进入函数详情。在“设置”页签的左侧导航栏中选择“环境变量”,根据下表参数说明,单击“编辑环境变量 > 添加环境变量”。
      表2 设置环境变量

      参数

      配置说明

      环境变量的名称,此处添加“token”和“test”两个环境变量。token用于Header身份验证,test参数用于Query参数查询。

      环境变量的值,token值填写为“Basic dXNlcjE6cGFzc3dvcmQ=”,test填写为“user@123”。

      加密参数

      开启加密参数后,环境变量的值将以“*”号加密显示,参数传输过程中键值也处于加密状态。对于敏感数据token值,开启加密参数选项。

    3. 在“代码”页签,编辑自定义认证代码,将以下代码复制到index.py中。完成后,单击“部署代码”。代码编写请参考创建用于前端自定义认证的函数
      # -*- coding:utf-8 -*-
      import json
      def handler(event, context):
          testParameter = context.getUserData('test');
          userToken = context.getUserData('token');
          if event["headers"].get("token") == userToken and event["queryStringParameters"].get("test") == testParameter:
              resp = {
                  'statusCode': 200,
                  'body': json.dumps({
                      "status":"allow",
                      "context":{
                          "user":"auth success"
                      }
                  })
              }
          else:
              resp = {
                  'statusCode': 401,
                  'body': json.dumps({
                      "status":"deny",
                  })   
              }
          return json.dumps(resp)
    4. 配置测试事件并调试代码,然后部署。
      1. 在下拉框中选择“配置测试事件”并配置。将以下代码设置为测试事件。测试事件的参数值与环境变量中的参数值需要保持一致。
        {
            "headers": {
                "token": "Basic dXNlcjE6cGFzc3dvcmQ="
            },
            "queryStringParameters": {
                "test": "user@123"
            }   
        }

      2. 创建测试事件完成后,单击“测试”调试代码。如下图,表示代码调试成功。

      3. 调试成功后,单击“部署代码”。

  2. 进入API网关控制台页面,在左侧导航栏选择“API管理 > API策略”。

    在“自定义认证”页签中,创建自定义认证。
    表3 自定义认证配置

    参数

    配置说明

    认证名称

    根据规划自定义名称。

    类型

    此处选择“前端”。

    函数地址

    单击“添加”,选择已创建函数

    版本或别名

    默认“通过版本选择”。

    缓存时间(秒)

    30

    身份来源

    第一个身份来源参数位置选择“Header”,参数名填写“token”;第二个身份来源参数位置选择“Query”,参数名填写“test”。

  3. 在左侧导航栏选择“API管理 > API列表”,单击“创建API > 创建API”。

    1. 根据下表参数,配置前端信息。
      表4 前端配置

      参数

      配置说明

      API名称

      填写API名称。

      所属分组

      API所属分组,此处默认“DEFAULT”。

      URL

      请求方法:接口调用方式,此处选择“GET”。

      请求协议:选择API请求协议,此处选择“HTTPS”。

      子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。

      路径:接口请求路径。此处填写“/api/two_factor_authorization”。

      网关响应

      API网关未能成功处理API请求,从而产生的错误响应。

      默认的网关响应为“default”。

      安全认证

      选择API认证方式,此处选择“APP认证”。

      支持双重认证

      勾选后,开启双重认证。选择已创建自定义认证

    2. 单击“下一步”,后端服务类型选择“Mock”。

      选择Mock自定义返回码和填写Mock返回结果,单击“完成”。

    3. 发布API。

  4. 在左侧导航栏选择“API管理 > 凭据管理”,创建凭据。

    单击“创建凭据”,填写凭据名称后,然后单击“确定”。

  5. 绑定API。

    单击凭据名称,进入凭据详情。在“关联API”区域,单击“绑定API”,选择API并“确定”。

  6. 验证。

    • 您可以通过API网关的调试页面调用API,验证双重认证是否成功。

      分别在Parameters和Headers中添加定义的test和token参数,参数值确保与自定义认证函数中的参数值一致。如果请求参数与自定义认证函数不一致或参数错误,服务器返回401认证不通过。

    • 您可以使用curl命令调用API,需要先下载JavaScript SDK。传入Key、Secret、以及自定义的Header、Query等参数生成curl命令,然后将curl命令复制到命令行调用API,具体操作步骤请参考《API网关开发指南》中curl

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容