此页面是 密文模式 对应的 API 说明,你可以查看 索引 来寻找需要的 API。
Crypto Mode For English Version Is Here
Index For English Version Is Here
密文
- 密文类 API 请求的前缀为
http://api.forec.cn/crypto
,你可以使用 GET 或 POST 方式传递数据。 - 此模式目前可以提供如下类型密文格式:
- md5
- sha1
- sha224
- sha256
- sha384
- sha512
- sha512_224
- sha512_256
- 服务器将对针对你的请求返回 JSON 格式的数据,包含两个字段:
Code
说明了你的请求是否合法以及返回值是否正确,Result
字段为服务器针对你的数据返回的加密/解密结果。其中Code
可为如下四种指令字:200
:成功解密,返回值正确300
:成功加密,返回值正确400
:你的请求所包含的数据不合法500
:服务器内部错误
- 密文类请求均需要指定两个字段:
method=密文格式
:指定method
来告知服务器你要使用的密文格式plain=待加密文本
:此字段放置你要加密的字节串cipher=待解密字节串
:此字段放置你要解密的字节串plain
和cipher
字段不应同时被指定,否则服务器会默认忽视cipher
字段
- 注意,因为服务器会自动使用 UTF-8 格式为 JSON 数据编码,故接收到的结果如果包含 ASCII 以外字符需要使用 UTF-8 格式解码。
MD5 格式
- 你需要指定
method
类型为md5
或MD5
。因为 MD5 无法逆向求解,因此此格式不支持cipher
字段,如果你指定了该字段,服务器会自动忽略。 - MD5 格式有两个可选字段:
bits=结果长度
:指定返回结果的长度,默认为 32 字节。你可以将其指定为 16。如果你将此字段设定为 16 和 32 以外的数值或非法格式,服务器将默认长度为 32。format=大小写
:此字段可以为U
或L
。默认返回结果中的字母为大写,你可以将此字段设为L
来获得小写格式。如果你将此字段设为L
和U
以外的任何值,服务器将默认使用大写格式。
- 样例:
1 | > curl http://api.forec.cn/crypto?method=md5&plain=test |
SHA 系列格式
- 你需要指定
method
类型为sha*
或SHA*
,这里的*
是 SHA 格式的版本。因为 SHA 无法逆向求解,因此此格式不支持cipher
字段,如果你指定了该字段,服务器会自动忽略。 - 可使用的格式有:
method=sha1
method=sha224
method=sha256
method=sha384
method=sha512
method=sha512_224
method=sha512_256
- SHA 类型有一个可选字段:
format=大小写
,此字段可以为U
或L
。默认返回结果中的字母为大写,你可以将此字段设为L
来获得小写格式。如果你将此字段设为L
和U
以外的任何值,服务器将默认使用大写格式。 - 样例:
1 | > curl http://api.forec.cn/crypto?method=sha1&plain=testthismessage&format=L |