​如何设计一个安全可靠的API接口？

作者 | 阿文

责编 | 屠敏

出品 | CSDN&＃xff08;ID&＃xff1a;CSDNnews&＃xff09;

最近几年&＃xff0c;随着RESTful API开始风靡&＃xff0c;使用HTTP header来传递认证令牌似乎变得理所应当&＃xff0c;通过 RESTful 的API 接口设计简化了系统架构, 减少了耦合性, 可以让所有模块各自独立的进行改进。

不过&＃xff0c;在实际的REST API 接口设计过程中&＃xff0c;我们需要考虑如何让鉴权变得更安全可靠&＃xff0c;例如不会被第三方恶意请求或者保证传输过程中的数据安全以及防止重复提交&＃xff0c;本文就一起聊一聊。

传统的Session 认证方式

首先&＃xff0c;我们说一些传统的认证方式&＃xff0c;众所周知&＃xff0c;HTTP 协议是一种无状态的协议&＃xff0c;而这就意味着如果用户向我们的应用提供了用户名和密码来进行用户认证&＃xff0c;那么下一次请求时&＃xff0c;用户还要再一次进行用户认证才行&＃xff0c;因为我们并不能知道是哪个用户发出的请求&＃xff0c;所以为了让我们的应用能识别是哪个用户发出的请求&＃xff0c;我们只能在服务器存储一份用户登录的信息&＃xff0c;这份登录信息会在响应时传递给浏览器&＃xff0c;告诉其保存为COOKIE,以便下次请求时发送给我们的应用&＃xff0c;这样我们的应用就能识别请求来自哪个用户了,这就是传统的基于session认证。

而这种方式有很多问题:

首先&＃xff0c;占用资源&＃xff0c;这种方式需要每个用户经过认证之后&＃xff0c;都要在服务端做一次记录&＃xff0c;以方便用户下次请求的鉴别&＃xff0c;通常而言session都是保存在内存中&＃xff0c;而随着认证用户的增多&＃xff0c;服务端的开销会明显增大。

其次&＃xff0c;扩展性差: 客户端认证之后&＃xff0c;服务端做认证记录&＃xff0c;如果认证的记录被保存在内存中的话&＃xff0c;这意味着用户下次请求还必须要请求在这台服务器上,这样才能拿到授权的资源&＃xff0c;在一些分布式的场景下会限制了负载均衡器的能力&＃xff0c;会限制了应用的扩展能力。

第三&＃xff0c;容易遭受攻击: 这种基于COOKIE来进行用户识别的认证方式, 很容易被截获&＃xff0c;用户就会很容易受到跨站请求伪造的攻击。

基于Token 的鉴权方式

由于session 认证的诸多问题&＃xff0c;因此出现了基于token 的鉴权方式&＃xff0c;这种方式不需要在服务端去保留用户的认证信息或者会话信息。这就意味着基于token认证机制的应用不需要去考虑用户在哪一台服务器登录了&＃xff0c;这就为应用的扩展提供了便利。

基于token 鉴权的工作流程如下&＃xff1a;

• 首先&＃xff0c;客户端通过用户名密码来请求对应的API接口

• 第二&＃xff0c;服务器会验证用户的信息

• 第三&＃xff0c;服务器通过验证后会发送token给客户端

• 第四&＃xff0c;客户端存储token&＃xff0c;并在每次请求时附送上这个token值

• 第五&＃xff0c;服务端验证token值&＃xff0c;并返回数据

这种方式的典型代表就是JWT(Json web token , 它是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准&＃xff08;(RFC 7519)&＃xff0c;该token被设计为紧凑且安全的&＃xff0c;特别适用于分布式站点的单点登录&＃xff08;SSO&＃xff09;场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息&＃xff0c;以便于从资源服务器获取资源&＃xff0c;也可以增加一些额外的其它业务逻辑所必须的声明信息&＃xff0c;该token也可直接被用于认证&＃xff0c;也可被加密。

它的特点如下:

• 体积小&＃xff08;一串字符串&＃xff09;。因而传输速度快

• 传输方式多样。可以通过 HTTP 头部&＃xff08;推荐&＃xff09;/URL/POST 参数等方式传输

• 严谨的结构化。它自身&＃xff08;在 payload 中&＃xff09;就包含了所有与用户相关的验证消息&＃xff0c;如用户可访问路由、访问有效期等信息&＃xff0c;服务器无需再去连接数据库验证信息的有效性&＃xff0c;并且 payload 支持应用定制

• 支持跨域验证&＃xff0c;多应用于单点登录

JWT通常由三部分组成:

• 头信息&＃xff08;header&＃xff09;

• 消息体&＃xff08;payload&＃xff09;

• 签名&＃xff08;signature&＃xff09;

如下所示&＃xff1a;

// Header { "alg": "HS256", "typ": "JWT" }// Payload { // reserved claims "iss": "a.com", "exp": "1d", // public claims "http://a.com": true, // private claims "company": "A", "awesome": true }// $Signature HS256(Base64(Header) &＃43; "." &＃43; Base64(Payload), secretKey)// JWT JWT &＃61; Base64(Header) &＃43; "." &＃43; Base64(Payload) &＃43; "." &＃43; $Signature 

其工作流程如下:

• 首先&＃xff0c;客户端通过发送HTTP 请求把账号密码发送给服务短&＃xff0c;通常使用的是POST请求&＃xff0c; 服务器会校验账号与密码是否合法&＃xff0c;如果一致&＃xff0c;则根据密钥生成一个 token 并返回&＃xff0c;客户端收到这个 token 并保存在本地。在这之后&＃xff0c;需要访问一个受保护的路由或资源时&＃xff0c;只要附加上 token&＃xff08;通常使用 Header 的 Authorization 属性&＃xff09;发送到服务器&＃xff0c;服务器就会检查这个 token 是否有效&＃xff0c;并做出响应。

• 服务端接收到 token 之后&＃xff0c;会逆向构造过程&＃xff0c;解码出 JWT 的三个部分&＃xff0c;这一步可以得到 sign 的算法及 payload&＃xff0c;结合服务端配置的 secretKey&＃xff0c;可以再次进行 $Signature 的生成得到新的 $Signature&＃xff0c;与原有的 $Signature 比对以验证 token 是否有效&＃xff0c;完成用户身份的认证&＃xff0c;验证通过才会使用 payload 的数据。

如何保证接口安全性

要想实现接口的安全性&＃xff0c;我们可以做到以下几点:

首先&＃xff0c;我们需要采用HTTPS 对传输过程中的数据进行加密&＃xff0c;避免使用HTTP 这种明文传输的协议&＃xff0c;防止数据直接暴露在公网中&＃xff0c;在使用HTTPS的同时要保证时间安全可靠的加密方法和SSL 协议&＃xff0c;目前主流的是TLS1.2 和最新的TLS1.3。同时要对证书进行校验&＃xff0c;因为即使是HTTPS协议&＃xff0c;证书也是能够被伪造的。

其次&＃xff0c;对接口设计一般会加入 token、timestamp和sign 这些参数&＃xff0c;不同的参数有自己不同的用途&＃xff1a;

• timestamp&＃xff0c;即时间戳&＃xff0c;它是客户端调用接口时传入的当前时间戳&＃xff0c;时间戳的目的是用于防止DoS攻击。每次调用接口时接口都会判断服务器当前系统时间和接口中传的的timestamp的差值&＃xff0c;如果这个差值超过某个设置的时间&＃xff0c;例如设置的时间是3分钟&＃xff0c;那么这个请求将被拦截掉&＃xff0c;如果在设置的超时时间范围内&＃xff0c;是不能阻止DoS攻击的。timestamp机制只能减轻DoS攻击的时间&＃xff0c;缩短攻击时间。如果黑客修改了时间戳的值可通过sign签名机制来处理。

• sign&＃xff0c;即签名&＃xff0c;通常用于参数签名&＃xff0c;防止参数被非法篡改&＃xff0c;最常见的是修改金额等重要敏感参数&＃xff0c; sign的值一般是将所有非空参数按照升续排序然后&＃43;token&＃43;key&＃43;timestamp&＃43;nonce(随机数)拼接在一起&＃xff0c;然后使用某种加密算法进行加密&＃xff0c;这种方式的好处就是&＃xff0c;当被劫持后&＃xff0c;修改其中的参数值&＃xff0c;然后再继续调用接口&＃xff0c;虽然参数的值被修改了&＃xff0c;但是因为攻击者并不清楚sign是如何计算出来的&＃xff0c;所以即可是篡改参数的值&＃xff0c;但没法修改sign的值&＃xff0c;当服务器调用接口前会按照sign的规则重新计算出sign的值然后和接口传递的sign参数的值做比较&＃xff0c;如果相等表示参数值没有被篡改&＃xff0c;如果不等&＃xff0c;表示参数被非法篡改了&＃xff0c;则不会返回真实的响应信息。

• 此外&＃xff0c;接口设计时候要实现幂等性操作&＃xff0c;所谓的幂等性操作就是为了防止重复性运算&＃xff0c;我们可以将生成的签名和key保存到redis 中&＃xff0c;并且设置超时时间&＃xff0c;过期自动删除&＃xff0c;当有重复的值存在则不会处理&＃xff0c;就可以防止重复提交&＃xff0c;从而保证请求结果一致性。

其使用流程如下:

1. 接口调用方(客户端)向接口提供方(服务器)申请接口调用账号&＃xff0c;申请成功后&＃xff0c;接口提供方会给接口调用方一个AppKey和一个APP Secret参数

2. 调用方申请App Key 和 App Secret 在生成请求时&＃xff0c;将参数拼接后进行加密&＃xff0c;例如使用HMAC-SHA256 或MD5加密&＃xff0c;然后将 App Key&＃xff0c; 加密结果追加到请求上。sign&＃61;加密(appId &＃43; timestamp &＃43; key)

3. 服务收到请求后&＃xff0c;根据App Key识别出调用方&＃xff0c;解密得到参数以及对时间进行对比&＃xff0c;判断是否超时&＃xff0c;然后从字典中查询到对应的App Secret&＃xff0c;与请求参数拼接、加密&＃xff0c;与请求中的签名进行对比&＃xff0c;签名结果相同的为合法请求。

以上就是给API 接口设计的一些建议&＃xff0c;仅供参考&＃xff0c;在实际的应用中还可以追加一些公共的参数&＃xff0c;例如Host、接口的版本等等参数去进行校验保证接口的安全性。

更多精彩推荐
☞马斯克身家超马云&＃xff0c;网友&＃xff1a;看完他的履历后一点也不惊讶
☞31 道 Java 核心面试题&＃xff0c;统统打包给你&＃xff01;
☞阿里回应被列为被执行人&＃xff1b;Linus Torvalds&＃xff1a;我已经不是程序员&＃xff1b;Ant Design 4.4.1 发布 | 极客头条
☞看懂别人的代码&＃xff0c;只是成为高效程序员的第一步&＃xff01;
☞用Python轻松搞定Excel中的20个常用操作
☞孟岩&＃xff1a;从DeFi内卷式发展看数字资产的意义
点分享点点赞点在看