API接口设计系列文章
文章目录
-
- 防篡改
-
防重放
-
Https
APP的数据来源就是API接口,所以API接口对于APP的意义来说不言而喻。
设计API接口最重要的考虑点就是安全机制。
我们这边将从三个方面来考虑怎么设计一个安全的API接口。
防篡改就是防止请求的URL参数值发送至服务器的时候被改动。
普通的API接口格式是xxx.html?key1=xx?key2=xx?key3=xx。
我们采用 sign 签名方式保证数据传输的正确性。
我们的app一般会在公司的后台申请一个appKey和appSecret,这两个是一一对应的。
appKey我们会作为一个参数写在URL中,发送至服务器。
appSecret则用于参与生成sign的计算。
sign算法需要足够复杂,最好有一套自己的签名算法,不是外界公开的;
一般采用安全散列算法实现,比如SHA1。
sign也要作为一个参数添加到URL中,和appKey一并发送至服务器。
如:xxx.html?appKey=xx?sign=xx?key1=xx?key2=xx?key3=xx。
服务器收到请求后,会通过appKey查到对应的appSecret,然后通过同样的散列算法,得到一个sign,然后比较一下两个sign是否相等。如果不相等则数据找到篡改,废弃这条请求。
另外,关于appSecret有两种使用方式:
-
appSecret直接写死在客户端代码中,这样直接获取调用即可。
-
appSecret还可以通过一个专门的接口getSign从后台获取。
这种情况需要用户首先登录成功后,服务器返回一个accessToken,然后调用appSecret接口需要带上这个accessToken参数。
解决了数据被篡改的问题,还有一个问题就是如果一条正常的请求数据被人获取到了,从而进行二次甚至多次请求怎么办?
我们这边可以使用nonce + timestamp的解决方案。
- nonce
nonce就是一个随机数,由客户端生成,每次请求将随机数作为一个参数发送给服务器。
服务器会在数据库里查询是否有这个nonce,如果没有则是一条新的请求,进行正常处理;
如果能查到已经存在这个nonce,则废弃这条请求。
nonce可以通过UUID.randomUUID().toString()来生成。
有个问题就是这个nonce在数据库中随着请求量的增大而导致数据量会越来越大。
解决这个问题我们可以采用timestamp时间戳的方式。
2. timestamp
时间戳是服务器给URL请求设定的一个有限时间范围起点。
比如服务器认为客户端发送带过来的timestamp与服务器的当前时间戳在10分钟之内,则认为这条请求是有效的。超过了10分钟则废弃这条请求。
如果10分钟内的请求,需要在数据库中查询nonce是否有记录,如果有记录这废弃这条请求;
如果没有记录,则记录这个nonce,并且将超过10分钟的nonce全部删除。
关于这个timestamp获取的问题,同样需要从服务器获取,不然客户端怎么知道服务器的起点计算时间呢?
上面说到有个获取appSecret的接口,其实我们可以在这个接口中一并将timestamp获取到。
需要注意的点是,客户端需要在每次发送URL请求的时候,计算一下timestamp的值。
给大家的福利
零基础入门
对于从来没有接触过网络安全的同学,我们帮你准备了详细的学习成长路线图。可以说是最科学最系统的学习路线,大家跟着这个大的方向学习准没问题。
同时每个成长路线对应的板块都有配套的视频提供:
因篇幅有限,仅展示部分资料
网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!