Android开发规范：API接口安全设计规范

公众号【国民程序员】回馈粉丝福利： 现金红包和送书活动火热进行中，点击参与！

我的新书《Android App开发入门与实战》已于2020年8月由人民邮电出版社出版，欢迎购买。

书籍详情请见：https://blog.csdn.net/ddnosh/article/details/107666187

书籍购买地址：京东当当天猫

API接口设计系列文章

Android开发规范：API接口安全设计规范
Android开发规范：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的值。
比如获取到的timestamp=1564588800，那么下次请求的timestamp的值是1564588800 + diffTime。

服务器收到timestamp后会跟服务器当前时间比对，看是否大于还是小于10分钟。

一条正常的URL格式就是这样的：

xxx.html?nonce=xx?timestamp=xx?appKey=xx?sign=xx?key1=xx?key2=xx?key3=xx

所以一个正常的API请求应该是这样的：
用户登录成功后，每次进行一个API请求，则需要调用一次getSign接口，用于获取appSecret和timestamp。但是肯定不是每次请求都要拉一次这个接口的数据。我们可以在首次请求后，将这些数据保存起来，后续API请求可以直接使用。除非appSecret或者timestamp为空（比如app退出登录后清空appSecret和timestamp）

Https

Https是用SSL+HTTP协议构建的可用于网络传输以及身份认证的网络协议；
http使用明文通信，传输内容可以通过抓包工具截取；
https自动对数据进行加密压缩，防止监听，防止被抓包看到明文，防中间人劫持。
苹果从iOS9就开始默认使用https，android9.0开始也强制使用https了，默认阻塞http请求。如果在android9.0中需要兼容http，则需要额外进行特定配置。

文章目录

防篡改

防重放

Https

更多相关文章

随机推荐