From 12bb46bae1feaef808f85b4ea13f9186ae46555a Mon Sep 17 00:00:00 2001 From: Apex Liu Date: Wed, 1 Mar 2017 02:54:48 +0800 Subject: [PATCH] . --- TELEPORT-CORE-JSON-RPC.md | 24 +++++++++++++----------- TELEPORT-WEB-JSON-RPC.md | 18 +++++++++++------- 2 files changed, 24 insertions(+), 18 deletions(-) diff --git a/TELEPORT-CORE-JSON-RPC.md b/TELEPORT-CORE-JSON-RPC.md index 7fc0c53..e76d7fa 100644 --- a/TELEPORT-CORE-JSON-RPC.md +++ b/TELEPORT-CORE-JSON-RPC.md @@ -4,11 +4,19 @@ TELEPORT CORE服务默认在 127.0.0.1:52080 上监听，其访问格式如下： -`http://127.0.0.1:52080/method/params` +**GET 方式** + +- URL格式 `http://127.0.0.1:52089/rpc?params` +- 示例：`curl http://127.0.0.1:52089/rpc?{"method":"enc","param":["p":"a message"]}` + +**POST方式** + +- URL格式 `http://127.0.0.1:52089/rpc` +- 示例：`curl -X POST --data '{"method":"enc","param":["p":"a message"]}' http://127.0.0.1:52089/rpc` 其中，params是经过urlencode后的json格式的字符串。 -所有的返回数据均为json格式，其中包含`code`域指明执行情况，如果有附加返回数据，则包含在`data`域中。如果发生错误，则`code`域为非0值，并且由`message`域指明错误原因。例如： +所有的返回数据均为json格式，其中包含`code`域指明执行情况，如果有附加返回数据，则包含在`data`域中。如果发生错误，则`code`域为非0值，并由**可选**的`message`域指明错误原因。例如： ```json // 成功返回 @@ -26,12 +34,6 @@ TELEPORT CORE服务默认在 127.0.0.1:52080 上监听，其访问格式如下 } ``` - - -注意：接口中的认证信息是使用AES加密算法加密的，解密密钥来自配置文件，详情请查阅WEB服务的JSON-RPC接口文档。 - - - ## JSON-RPC methods - [request_session](#request_session) @@ -102,7 +104,7 @@ TELEPORT CORE服务默认在 127.0.0.1:52080 上监听，其访问格式如下 "port": 23, "uname": "root", "uauth": "b903239f8543d04b5d13b143087c68d1b2168786408fcbce5f5374fce5edbc8e2a8697c15331677e6ebf0b", - "authmode": 1 + "authmode": 1, "protocol": 2 } @@ -123,11 +125,11 @@ TELEPORT CORE服务默认在 127.0.0.1:52080 上监听，其访问格式如下 #### 参数 -1. `p` - 被加密的明文字符串 +1. `p` - 被加密的明文字符串（Plain） #### 返回 -1. `c` - 加密后的密文的base64编码字符串 +1. `c` - 加密后的密文的base64编码字符串 （Cipher） #### 示例 diff --git a/TELEPORT-WEB-JSON-RPC.md b/TELEPORT-WEB-JSON-RPC.md index e325047..34cac52 100644 --- a/TELEPORT-WEB-JSON-RPC.md +++ b/TELEPORT-WEB-JSON-RPC.md @@ -4,7 +4,15 @@ TELEPORT WEB服务在 7190 上监听，其JSON-RPC接口也在此端口上访问，但出于安全性考虑，JSON-RPC仅允许本机内部访问，其访问格式如下： -`http://127.0.0.1:7190/rpc/method/params` +**GET 方式** + +- URL格式 `http://127.0.0.1:7190/rpc?params` +- 示例：`curl http://127.0.0.1:7190/rpc?{"method":"test","param":[]}` + +**POST方式** + +- URL格式 `http://127.0.0.1:7190/rpc` +- 示例：`curl -X POST --data '{"method":"test","param":[]}' http://127.0.0.1:7190/rpc` 其中，params是经过urlencode后的json格式的字符串。 @@ -26,11 +34,7 @@ TELEPORT WEB服务在 7190 上监听，其JSON-RPC接口也在此端口上访问 } ``` - - -注意：数据库中认证信息的密码和私钥是使用AES加密算法加密存放的，而且JSON-RPC接口在传递认证信息时，密码或私钥也是加密传输的。此密钥由WEB服务在首次运行时创建并保存在配置文件中，CORE服务和WEB服务均会读取此配置文件。因为密钥用于加密数据库中的字段，因此一经创建就不允许修改。 - - +注意：数据库中认证信息的密码和私钥是使用AES加密算法加密存放的，加密服务由核心服务提供，可以调用核心服务的JSON-PRC接口 `enc` 来加密要保存的密文数据。 ## JSON-RPC methods @@ -130,7 +134,7 @@ TELEPORT WEB服务在 7190 上监听，其JSON-RPC接口也在此端口上访问 ```json // Request { - "rsid": 123, + "rid": 123, "code": 0 }