网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
本文导读

自定义鉴权使用说明

更新时间:2024-11-26 GMT+08:00
分享

使用说明

图1 自定义鉴权操作流程

操作步骤

  1. 配置自定义鉴权函数:用户通过调用函数服务(FunctionGraph)创建自定义鉴权函数。

    图2 函数列表-创建函数
    图3 创建函数-参数信息

  2. 创建自定义鉴权:用户可以通过Console配置自定义鉴权信息,IoTDA负责自定义鉴权信息存库和进行相应的管理维护。用户最多支持配置10个自定义鉴权器,其中最多可以设置1个默认鉴权器。

    图4 自定义鉴权-创建鉴权

    表1 自定义鉴权参数信息

    参数名称

    是否必选

    描述

    鉴权名称

    自定义鉴权器名称。

    鉴权函数

    自定义鉴权器对应的函数名称,从1中FunctionGraph已经创建的函数列表中选取。

    状态

    激活停用参数,用于表示该鉴权是否为激活状态,默认为停用状态。若需使用该鉴权器,则应激活后才能生效。

    签名认证

    启动签名认证后,不满足签名要求的鉴权信息将被拒绝,以减少无效的函数调用,默认为开启。

    token值

    签名校验的token值,开启签名校验时使用,用于认证设备携带的签名信息是否正确。

    公钥

    签名校验的公钥,开启签名校验时使用,用于认证设备携带的签名信息是否正确。

    是否默认自定义鉴权器

    开启后,如果设备发起鉴权时的username没有携带authorizer_name参数,则默认使用此鉴权器。此处默认为不开启。

    是否缓存

    缓存开关,用于开启缓存FunctionGraph的鉴权结果,缓存时间为300分钟~1天,默认不开启。

  3. 设备发起鉴权请求:设备通过MQTT协议发起的CONNECT请求需携带username参数,该参数应包含自定义鉴权的相关可选参数。

    • username格式如下。参数传值时需去掉大括号“{}”,username的每个参数需采用分隔符“|”分隔,各参数具体内容不要出现“|”,否则可能导致鉴权失败。
      {device-identifier}|authorizer-name={authorizer-name}|authorizer-signature={token-signature}|signing-token={token-value}
      示例:
      659b70a0bd3f665a471e5ec9_auth|authorizer-name=Test_auth_1|authorizer-signature=***|signing-token=tokenValue
      表2 username参数信息

      参数名称

      是否必选

      描述

      device-identifier

      设备标识符,建议设定为设备id。

      authorizer-name

      自定义鉴权器名称,需要同用户配置的鉴权器一致。不携带鉴权器名称时,如用户配置了默认的自定义鉴权器,则使用自定义鉴权,否则使用原有的密钥/证书鉴权方式。

      authorizer-signature

      签名校验功能开启时,需要携带该参数。该参数由私钥和signing-token进行加密后获取。需与2中创建自定义鉴权时填写的鉴权名称保持一致。

      signing-token

      签名校验功能开启时,需要携带该参数。该参数为签名校验的token,需与2中创建自定义鉴权时填写的token值保持一致。

    • authorizer-signature通过如下命令行获取:
      echo -n {signing-token} | openssl dgst -sha256 -sign {private key} | openssl base64
      表3 命令行参数解析

      参数名称

      描述

      echo -n {signing-token}

      使用echo命令将签名令牌(signing-token)的值输出,并使用-n参数去掉末尾的换行符。signing-token需与2中创建自定义鉴权时填写的token值保持一致。

      openssl dgst -sha256 -sign

      使用 SHA256 算法对输入的数据进行哈希处理。

      {private key}

      使用 RSA 算法加密的私钥,可传入.pem/.key格式的私钥文件。

      openssl base64

      将签名结果进行Base64编码,以便于传输和存储。

  4. IoTDA处理鉴权请求:IoTDA收到鉴权请求时,会根据username的参数信息和自定义鉴权的配置来决策是否使用自定义鉴权方式。

    1. 判断username是否携带了自定义鉴权名称,如果有携带,则根据平台的自定义鉴权名称,去匹配鉴权器处理函数。如果没有携带,则使用用户配置的默认自定义鉴权器去匹配鉴权处理函数,若无匹配到则使用原有的密钥/证书鉴权方式。
    2. 检查用户是否开启了签名校验,如果开启了签名校验,则校验username携带的签名信息是否可以校验成功,校验失败则直接返回鉴权失败。
    3. 匹配到处理函数后,携带设备的鉴权信息(即5的入参event)并通过函数urn向FunctionGraph发起鉴权请求。

  5. 用户实现鉴权逻辑:用户在1中通过FunctionGraph创建的处理函数中进行开发,函数的返回结果有要求,函数使用示例及返回的JSON格式要求如下:

    exports.handler = async (event, context) => {
        console.log("username=" + event.username);
        // 此处编写您的校验逻辑
        
    
        // 返回的JSON格式(格式固定不变)
        const authRes = {
            "result_code": 200,
            "result_desc": "successful",
            "refresh_seconds": 300,
            "device": {
                "device_id": "myDeviceId",
                "provision_enable": true,
                "provisioning_resource": {
                    "device_name": "myDeviceName",
                    "node_id": "myNodeId",
                    "product_id": "myProductId",
                    "app_id": "customization0000000000000000000",
                    "policy_ids": ["657a4e0c2ea0cb2cd831d12a", "657a4e0c2ea0cb2cd831d12b"]
                }
            }
        }
        return JSON.stringify(authRes);
    }

    其中,函数的请求参数(即event,JSON格式)如下:

    {
        "username": "myUserName",
        "password": "myPassword",
        "client_id": "myClientId",
        "certificate_info": {
            "common_name": "",
            "fingerprint": "123"
        }
    }
    表4 请求参数信息

    参数名称

    参数类型

    是否必选

    描述

    username

    String

    MQTT协议中CONNECT消息的username字段,与3的username格式相同。

    password

    String

    MQTT协议中CONNECT消息的password参数。

    client_id

    String

    MQTT协议中CONNECT消息的clientId参数。

    certificate_info

    JsonObject

    MQTT协议中CONNECT消息的设备证书信息。

    表5 certificate_info证书信息

    参数名称

    参数类型

    是否必选

    描述

    common_name

    String

    设备携带设备证书时,从设备证书中解析的commonName信息。

    fingerprint

    String

    设备携带设备证书时,从设备证书中解析的指纹信息。

    表6 返回参数信息

    参数名称

    参数类型

    是否必选

    描述

    result_code

    Integer

    鉴权结果码, 返回200标识鉴权成功。

    result_desc

    String

    鉴权结果描述信息。

    refresh_seconds

    Integer

    鉴权结果的缓存时间,单位(s)。

    device

    JsonObject

    认证成功时的设备信息。当设备信息中的设备ID不存在时,如果用户开启自注册,则平台会根据设备信息自动创建对应的设备。

    表7 device设备信息

    参数名称

    参数类型

    是否必选

    描述

    device_id

    String

    参数说明:设备ID,自注册场景、非自注册场景都必选。全局唯一,用于唯一标识一个设备。如果携带该参数,平台将设备ID设置为该参数值;建议使用product_id + _ + node_id拼接而成。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合,建议不少于4个字符。

    provision_enable

    Boolean

    参数说明:自注册开关,默认为false。

    provisioning_resource

    JsonObject

    自注册场景必选

    参数说明:自注册参数信息。

    表8 provisioning_resource自注册参数信息

    参数名称

    参数类型

    是否必选

    描述

    device_name

    String

    参数说明:设备名称,资源空间下唯一,用于资源空间下唯一标识一个设备。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合,建议不少于4个字符。

    最小长度:1

    最大长度:256

    node_id

    String

    参数说明:设备标识码,通常使用IMEI、MAC地址或Serial No作为node_id。 设备标识码长度为1到64个字符,包含英文字母、数字、连接号-和下划线_。 注意:NB设备由于模组烧录信息后无法配置,所以NB设备会校验node_id全局唯一。 取值范围:长度不超过64,只允许字母、数字、下划线(_)、连接符(-)的组合,建议不少于4个字符。

    product_id

    String

    参数说明:设备关联的产品ID,用于唯一标识一个产品模型,创建产品后获得。取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合,建议不少于4个字符。

    最小长度:1

    最大长度:256

    app_id

    String

    参数说明:资源空间ID,该参数指定创建的设备归属到哪个资源空间。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

    policy_ids

    List<String>

    参数说明:Topic策略ID。

    图5 函数编写-部署

  6. FunctionGraph返回结果后,判断是否需要支持自注册功能,如果需要则触发设备的自动注册。自注册设备全部默认为密钥认证,密钥随机生成。IoTDA收到鉴权结果后,进行接下来的业务实现流程。
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容