API安全
API安全模块基于内置检测机制和自定义检测策略,自动梳理已接入Web应用防火墙(Web Application Firewall,简称WAF)防护的业务的API资产,检测API风险(例如未授权访问、敏感数据过度暴露、内部接口泄露等),并通过报表还原API异常事件,提供详细的风险处理建议和API生命周期管理参考数据,帮助您实现API安全防护。
使用限制
通过ALB、MSE或FC接入WAF的防护对象暂不支持该功能。
功能介绍
API安全模块为您提供下表描述的功能。
API安全所有的计算和分析均离线完成,不会主动探测接口,对业务运行无任何影响。
功能 | 说明 |
资产总览及生命周期管理 | API安全通过离线分析业务访问日志,自动检测流量中存在的所有API,并支持根据接口特征,自动识别API业务用途。 您可以通过API概览查看API安全事件、API风险、API资产总览、API资产列表详情。 |
风险检测 | 检测API存在的未授权访问、敏感数据暴露等各类安全风险,并提供详细的风险分析及安全处置建议。 |
安全事件检测 | 监控分析API的调用行为,及时发现各类异常访问或攻击行为。 |
自定义API安全策略 | 在内置检测机制的基础上,API安全支持自定义符合业务特征的检测策略,使得识别出的API资产更符合您的实际业务情况,进一步提高API安全检测的准确率与召回率。 |
自定义生效对象 | 支持防护对象级别开启API安全,灵活控制API安全的生效对象。 |
通过单击以下问题,了解更多关于API安全的能力介绍:
前提条件
已开通中国内地的WAF 3.0实例。具体操作,请参见开通包年包月WAF 3.0、开通按量付费WAF 3.0。
步骤一:查看基础检测数据
包年包月实例默认开启基础检测,在开通API安全前,您可以通过基础检测,查看安全事件总览、资产总览和安全事件列表数据,帮助您了解您的API安全信息。如果您不希望了解相关数据,您也可以直接跳过该步骤。
按量付费实例暂不支持基础检测功能。
登录Web应用防火墙3.0控制台。在顶部菜单栏,选择WAF实例的资源组和地域(中国内地)。
在左侧导航栏,选择 。
在基础检测区域,查看基础检测数据。
安全事件总览:包括API安全事件总数、高危事件数、中危事件数和低危事件数。
资产总数:包括API资产总数、活跃API数、失活API数。
安全事件列表:通过卡片,查看安全事件的名称、API路径、域名、攻击源和产生时间。
如果您希望查看传输敏感数据API数,或查看安全事件的更多风险详情和处置建议,您可以开通API安全。具体操作,请参见步骤二:开通API安全。
如果您不希望进行基础检测,您也可以单击基础检测开关,关闭该功能。
步骤二:开通API安全
API安全会检测符合指定特征的请求响应内容,用于判断API是否存在数据泄露风险。开通API安全,就意味着授权WAF进行相关分析。开通前,请根据实际业务评估是否开通。
登录Web应用防火墙3.0控制台。在顶部菜单栏,选择WAF实例的资源组和地域(中国内地)。
在左侧导航栏,选择 。
开通API安全。
申请免费体验API安全
说明每个阿里云账号可享受一次试用机会。如果您的阿里云账号已经试用过API安全功能,则不支持重复申请试用。
API安全的免费体验时长为开通免费试用后的7天内。免费体验期间生成的API安全分析数据仅供您在体验期间使用。体验结束后,如果您未购买正式版本,WAF不会保存相关数据。
在API安全页面,单击申请体检。按照API安全解决方案试用申请页面的提示,填写试用申请信息并单击提交。
阿里云工程师在收到您的申请后,将通过您提交的联系方式联系您,与您确认试用关事宜相。试用申请经审核通过后,您的WAF实例会自动开通API安全功能。
开通正式版API安全
在API安全页面,单击立即开通。在立即开通面板,将API安全设置为开启,单击立即购买并完成支付。
开通API安全后,WAF实例将会自动检测业务请求中关联的API,分析API存在的风险和调用情况,并通过API安全页面向您展示分析结果。
步骤三:查看API安全数据
查看概览数据
在API安全页面的概览页签,查看API安全分析数据。
数据类型 | 说明 |
API安全事件 | 通过统计数据,介绍API安全事件的总数及其今日新增数,包括高危风险事件数、中危风险事件数、低危风险事件数。 |
API风险 | 介绍API风险的总数及其较昨日变化数,包括高危风险数、中危风险数、低危风险数。 |
API资产总览 | 通过统计数据,介绍API资产相关信息,包括:
|
API资产列表 | 查看WAF检测发现的所有开放API列表,了解API的开放规模和访问热度等。 API资产列表包含以下信息:
您可以在API资产列表进行如下操作:
|
查看风险检测数据
在API安全页面的风险检测页签,查看API风险检测分析数据。
数据类型 | 用途及说明 | 支持的操作 |
API风险总览 | 通过统计数据,了解API风险总数及其较昨日变化数,包括高危风险数、中危风险数、低危风险数。 | 单击高危风险数、中危风险数或低危风险数后的立即查看,查看今日新增的风险。 |
API风险趋势 | 通过趋势图,了解最近30天内高风险、中风险、低风险API的风险变化趋势。 | 单击趋势图下的高风险、中风险、低风险,设置要展示的数据。 |
API风险类型统计 | 通过饼图,了解API风险类型统计数据。 | 单击饼图右侧具体风险类型,设置要展示的数据。 |
API风险详情 | 查看WAF检测发现的所有API风险详情,了解API的风险名称、等级等信息。 API风险列表包含以下信息:
|
|
查看安全事件数据
在API安全页面的安全事件页签,查看API安全事件分析数据。
数据类型 | 用途及说明 | 支持的操作 |
API安全事件总览 | 通过统计数据,了解API安全事件的总数及其今日新增数,包括高危风险事件数、中危风险事件数、低危风险事件数。 | 单击高危风险事件数、中危风险事件数或低危风险事件数后的立即查看,查看昨日新增的安全事件。 |
API安全事件趋势 | 通过趋势图,了解最近30天内高风险事件、中风险事件、低风险事件的变化趋势。 | 单击趋势图下的高风险、中风险、低风险,设置要展示的数据。 |
API事件类型统计 | 通过饼图,了解API事件类型统计数据。 | 单击饼图右侧具体事件类型,设置要展示的数据。 |
API安全事件详情 | 查看WAF检测发现的所有API安全事件,了解API安全事件的名称、等级等信息。 API安全事件列表包含以下信息:
|
|
步骤四:配置API安全策略
在内置检测机制的基础上,API安全支持自定义符合业务特征的检测策略。您可以配置鉴权凭据特征策略、攻击检测模型策略、业务用途策略、API生命周期,使得识别出的API资产更符合您的实际业务情况,进一步提高API安全检测的准确率与召回率。
配置鉴权凭据特征策略
在API安全页面的策略配置 > 鉴权凭据特征配置页签,单击新建策略。配置鉴权凭据的特征检测策略后,内置模型检测Request请求中是否包含指定的参数名,从而确认是请求否携带鉴权凭据,可以提升API安全对于未鉴权风险识别的准确率。
创建鉴权凭据特征策略的各配置项说明如下表所示。
配置项 | 说明 |
特征字符 | 设置用于鉴权凭据的参数名。例如,如果请求Body示例为
|
位置 | 设置要鉴权的位置。可选项:
|
状态 | 设置鉴权凭据特征策略状态,默认开。 |
配置攻击检测模型策略
在API安全页面的策略配置 > 攻击检测模型配置页签,单击新建策略。当内置模型无法满足需求时,可以根据业务情况来自定义攻击检测模型,从而提高异常事件的检出率。
配置攻击检测模型策略的各配置项说明如下表所示。
配置项 | 说明 |
规则名称 | 为该规则设置一个名称。 支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 |
匹配条件 | 设置该规则要匹配的请求特征。 单击新增条件,添加一个条件。一个规则中最多可以添加五个条件。如果定义了多个条件,则只有当多个条件同时满足时,才算命中规则。 每个条件由匹配字段、逻辑符和匹配内容组成。关于匹配字段和逻辑符的更多说明,请参见支持的匹配字段说明。 |
统计时长 | 设置攻击检测的统计时长,默认值为15分钟。 |
访问量 | 设置网站最大访问量,统计维度为API粒度。 |
去重统计 | 设置重复参数的告警统计规则。可选项:
|
事件等级 | 设置攻击检测的事件等级。可选项:高危、中危、低危。 |
状态 | 设置攻击检测模型规则的状态,默认开。 |
配置业务用途策略
在API安全页面的策略配置 > 业务用途配置页签,配置API接口的业务用途策略,提高API安全对于具体业务场景的检测准确率。
业务用途策略内置多个场景的策略,包括数据更新、数据分享、手机短信发送、信息发送等场景。您可以根据业务需要,开启或关闭对应策略。内置策略不支持修改或删除。
业务用途策略支持自定义策略。您可以单击新建策略,创建符合业务情况的策略。配置业务用途策略的各配置项说明如下表所示。
配置项
说明
名称
为该规则设置一个名称。
支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。
URL特征
设置业务场景的URL特征关键字,多个参数间用逗号(,)分隔。
参数名特征
设置业务场景的参数名特征关键字,多个参数间用逗号(,)分隔。
状态
设置鉴权凭据特征策略状态,默认开。
配置API生命周期
在API安全页面的策略配置 > 生命周期管理页签,配置失活API的判断标准,使得失活API检测更符合业务情况。
您可以选择内置模型作为失活API标准,即近30天无访问量或访问量大幅下跌的API接口。
您也可以自定义日访问量和持续天数的阈值作为判定失活API的标准。例如:API接口的日访问量小于100次,且持续天数大于5天时,该API接口被判定为失活API。
步骤五:配置策略生效对象
如果是包年包月实例,所有接入WAF的防护对象默认生效API安全。如果您不希望该防护对象生效API安全,您可以在API安全页面的生效对象配置页签,将该防护对象移出已选择对象框。
如果是按量付费实例,您需要在API安全页面的生效对象配置页签,将需要生效API安全的防护对象添加到已选择对象框。
步骤六:查看更新后的API安全数据
完成步骤四:配置API安全策略和步骤五:配置策略生效对象的配置后,您可以在API安全页面的概览、风险检测、安全事件页签,查看配置了检测策略和生效对象后的安全数据。更多信息,请参见步骤三:查看API安全数据。
相关操作
您可以在云监控控制台设置API安全事件的监控和告警,使WAF在检测到高危风险事件时向您发送告警通知,帮助您及时掌握API资产的安全状态。具体操作,请参见设置WAF攻击事件的监控与告警。