网关 askwalking

版本关系

Spring Cloud Version	Spring Cloud Alibaba Version	Spring Boot Version
Greenwich.SR6	2.1.2.RELEASE	2.1.5.RELEASE

集成说明注：网关调用服务应用需要集成client包

 1:maven导入坐标 ${version}根据自己编译的版本选择导入
 
         <dependency>
            <groupId>com.cloud.askwalking</groupId>
            <artifactId>askwalking-client</artifactId>
            <version>${version}</version>
         </dependency>
   
 # 使用说明
 
   1）通用响应：
      
      1>成功
      R.success()
      
      2>失败 注：此方法会响应系统编码，配置编码请在 
                bootStrap.properties中配置属性 system.code 编码为4位整数不配置为-1
      R.fail(ErrorCode.SYSTEM_ERROR)
    
 # 脚本配置相关 请查看doc目录

说明

1）当前版本为1.0.0版本

2）不支持集群部署，原因：集群部署存在api更新时在集群间产生脑裂问题

2.版本计划

1） 1.1.0版本加入UI、管理后台编写、完善一些使用中的bug、api管理功能相关钩子代码优化

2） 2.0.0版本支持集群部署，feign接口api支持

功能列表(1.0.0版本)

1）dubbo接口http暴露

2）根据不同api配置限流规则

3）用户鉴权

4） ras签名验证

5）用户资源权限(仅管理后台使用)

6）通用配置下发特殊参数、参数转化、动态赋值等(需要定义业务规则)

7） API管理接口支持操作：列表、添加、修改、下线、上线、mock

8） saas商户平台接入

配置说明(1.0版本)

配置项	key	默认值	可选	说明
应用名称	applicationName		必选	调用服务注册名
api类型	apiType		必选	参数 API：(外部接口) ADMIN：(管理后台接口) SAAS：(开放平台接口)
请求URI	requestUri		必选	自定义请求URI必须不能重复,建议url加入版本号方便后续接口升级例：/uid/v1/generator
请求方式	requestMethod	GET	可选	参数 GET、POST
接口地址	apiInterface		必选	接口全类名,例：com.awservice.openapi.service.TestService
接口版本	apiVersion		可选	接口上定义的版本号必须与此配置版本号对应
请求对象	apiRequestClass		必选	接口请求参数对象全类名,例：com.awservice.account.AddAccountRequest
方法名称	apiMethod		必选	接口方法,例：test
接口分组	apiGroup		可选	接口上定义的分组必须与此配置分组对应
接口名称	apiName		可选	参考根据自己提供接口功能定义
异步支持	apiAsync	0	可选	参数 0：同步 1：异步
重载支持	apiReload	1	可选	参数 0：不支持 1：支持注：对参数qps 、avgTt、maxThread生效
mock数据	mockResponse		可选	此数据必须为json格式,否则网关报错：json序列化失败
系统保护	systemGuard	1	可选	开启系统保护后限流规则生效,参数 0：开启 1：不开启
限流类型	flowControlRuleType	2	可选	参数 1：系统限流目前不支持 2：api限流
每秒请求数	qps	-1	可选	类型为浮点类型
平均响应时间	avgTt	-1	可选	单位为毫秒ms
最大并发数	maxThread	-1	可选	入口流量的最大并发数
签名校验	signCheck	0	必选	参数 0：不校验，1：校验
接口状态	status	2	可选	参数 0：mock_response报文，1：待发布，2：已发布

网关saas平台接入指南

流程

生成rsa秘钥对 --> 添加商户 --> 商户秘钥发送 --> 商户资源分配 --> 商户接入

流程说明:

1.生成rsa秘钥对调用网关商户密钥对生成接口生成密钥对inner开头内部公私钥和outer开头外部公私钥(注:保存好秘钥对，商户外泄后责任由商户自己承担)

2.添加商户调用网关添加商户接口指定商户openId和商户名称，将inner开头内部公私钥配置传入和outer开头外部公钥配置传入，status为商户状态1:准入/2:禁止

3.给商户秘钥钉钉或者邮件等方式将outer开头外部公私钥给予商户

4.商户资源分配调用网关添加商户资源接口给商户分配资源，openId传入添加商户时分配的，requestUri商户所属的资源接口，status商户资源状态1:准入/2:禁止

5.商户接入

参考:rsa签名示例代码

rsa签名示例代码：

1.java版本:

 package com.trafficbu.etc.gateway.util;
 
 import javax.crypto.Cipher;
 import java.io.ByteArrayOutputStream;
 import java.security.*;
 import java.security.spec.PKCS8EncodedKeySpec;
 import java.security.spec.X509EncodedKeySpec;
 import Base64Utils;import org.apache.commons.codec.binary.Base64;
 
 /**
  * RSA公钥/私钥/签名工具包
  *
  * <p>
  * 字符串格式的密钥在未在特殊说明情况下都为BASE64编码格式<br/>
  * 由于非对称加密速度极其缓慢，一般文件不使用它来加密而是使用对称加密，<br/>
  * 非对称加密算法可以用来对对称加密的密钥加密，这样保证密钥的安全也就保证了数据的安全
  *
  * @author niuzhiwei
  */
 public class RSAUtils {
 
     /**
      * 加密算法RSA
      */
     private static final String KEY_ALGORITHM = "RSA";
 
     /**
      * 签名算法
      */
     private static final String SIGNATURE_ALGORITHM = "MD5withRSA";
  
     /**
      * RSA最大加密明文大小
      */
     private static final int MAX_ENCRYPT_BLOCK = 117;
 
     /**
      * RSA最大解密密文大小
      */
     private static final int MAX_DECRYPT_BLOCK = 128;
     
     /**
      * <p>
      * 用私钥对信息生成数字签名
      * </p>
      *
      * @param source     已加密数据字符串
      * @param timestamp  时间戳，毫秒
      * @param privateKey 私钥(BASE64编码)
      * @return
      * @throws Exception
      */
     public static String sign(String source, String timestamp, String privateKey) throws Exception {
         String temp = source + timestamp;
         return sign(temp.getBytes(), privateKey);
     }
 
     /**
      * <p>
      * 用私钥对信息生成数字签名
      * </p>
      *
      * @param data       已加密数据
      * @param privateKey 私钥(BASE64编码)
      * @return
      * @throws Exception
      */
     public static String sign(byte[] data, String privateKey) throws Exception {
         byte[] keyBytes = Base64Utils.decode(privateKey);
         PKCS8EncodedKeySpec pkcs8KeySpec = new PKCS8EncodedKeySpec(keyBytes);
         KeyFactory keyFactory = KeyFactory.getInstance(KEY_ALGORITHM);
         PrivateKey privateK = keyFactory.generatePrivate(pkcs8KeySpec);
         Signature signature = Signature.getInstance(SIGNATURE_ALGORITHM);
         signature.initSign(privateK);
         signature.update(data);
         return encode(signature.sign());
     }
     
     /**
      * <p>
      * 校验数字签名
      * </p>
      *
      * @param source    已加密数据字符串
      * @param timestamp 时间戳，毫秒
      * @param publicKey 公钥(BASE64编码)
      * @param sign      数字签名
      * @return
      * @throws Exception
      */
     public static boolean verify(String source, String timestamp, String publicKey, String sign)
             throws Exception {
         String temp = source + timestamp;
         return verify(temp.getBytes(), publicKey, sign);
     }
 
     /**
      * <p>
      * 校验数字签名
      * </p>
      *
      * @param data      已加密数据
      * @param publicKey 公钥(BASE64编码)
      * @param sign      数字签名
      * @return
      * @throws Exception
      */
     public static boolean verify(byte[] data, String publicKey, String sign)
             throws Exception {
         byte[] keyBytes = Base64Utils.decode(publicKey);
         X509EncodedKeySpec keySpec = new X509EncodedKeySpec(keyBytes);
         KeyFactory keyFactory = KeyFactory.getInstance(KEY_ALGORITHM);
         PublicKey publicK = keyFactory.generatePublic(keySpec);
         Signature signature = Signature.getInstance(SIGNATURE_ALGORITHM);
         signature.initVerify(publicK);
         signature.update(data);
         return signature.verify(decode(sign));
     }
 
     /**
      * <p>
      * 私钥加密
      * </p>
      *
      * @param source     源数据字符串
      * @param privateKey 私钥(BASE64编码)
      * @return
      * @throws Exception
      */
     public static String encryptByPrivateKey(String source, String privateKey)
             throws Exception {
         byte[] bytes = encryptByPrivateKey(source.getBytes(), privateKey);
         return encode(bytes);
     }
 
     /**
      * <p>
      * 私钥加密
      * </p>
      *
      * @param data       源数据
      * @param privateKey 私钥(BASE64编码)
      * @return
      * @throws Exception
      */
     public static byte[] encryptByPrivateKey(byte[] data, String privateKey)
             throws Exception {
         byte[] keyBytes = decode(privateKey);
         PKCS8EncodedKeySpec pkcs8KeySpec = new PKCS8EncodedKeySpec(keyBytes);
         KeyFactory keyFactory = KeyFactory.getInstance(KEY_ALGORITHM);
         Key privateK = keyFactory.generatePrivate(pkcs8KeySpec);
         Cipher cipher = Cipher.getInstance(keyFactory.getAlgorithm());
         cipher.init(Cipher.ENCRYPT_MODE, privateK);
         int inputLen = data.length;
         ByteArrayOutputStream out = new ByteArrayOutputStream();
         int offSet = 0;
         byte[] cache;
         int i = 0;
         // 对数据分段加密  
         while (inputLen - offSet > 0) {
             if (inputLen - offSet > MAX_ENCRYPT_BLOCK) {
                 cache = cipher.doFinal(data, offSet, MAX_ENCRYPT_BLOCK);
             } else {
                 cache = cipher.doFinal(data, offSet, inputLen - offSet);
             }
             out.write(cache, 0, cache.length);
             i++;
             offSet = i * MAX_ENCRYPT_BLOCK;
         }
         byte[] encryptedData = out.toByteArray();
         out.close();
         return encryptedData;
     }
 
     /**
      * <p>
      * 公钥解密
      * </p>
      *
      * @param data      已加密数据
      * @param publicKey 公钥(BASE64编码)
      * @return
      * @throws Exception
      */
     public static String decryptByPublicKey(String data,
                                             String publicKey) throws Exception {
         byte[] bytes = decryptByPublicKey(decode(data), publicKey);
         return new String(bytes);
     }
 
     /**
      * <p>
      * 公钥解密
      * </p>
      *
      * @param encryptedData 已加密数据
      * @param publicKey     公钥(BASE64编码)
      * @return
      * @throws Exception
      */
     public static byte[] decryptByPublicKey(byte[] encryptedData,
                                             String publicKey) throws Exception {
         byte[] keyBytes = decode(publicKey);
         X509EncodedKeySpec x509KeySpec = new X509EncodedKeySpec(keyBytes);
         KeyFactory keyFactory = KeyFactory.getInstance(KEY_ALGORITHM);
         Key publicK = keyFactory.generatePublic(x509KeySpec);
         Cipher cipher = Cipher.getInstance(keyFactory.getAlgorithm());
         cipher.init(Cipher.DECRYPT_MODE, publicK);
         int inputLen = encryptedData.length;
         ByteArrayOutputStream out = new ByteArrayOutputStream();
         int offSet = 0;
         byte[] cache;
         int i = 0;
         // 对数据分段解密
         while (inputLen - offSet > 0) {
             if (inputLen - offSet > MAX_DECRYPT_BLOCK) {
                 cache = cipher
                         .doFinal(encryptedData, offSet, MAX_DECRYPT_BLOCK);
             } else {
                 cache = cipher
                         .doFinal(encryptedData, offSet, inputLen - offSet);
             }
             out.write(cache, 0, cache.length);
             i++;
             offSet = i * MAX_DECRYPT_BLOCK;
         }
         byte[] decryptedData = out.toByteArray();
         out.close();
         return decryptedData;
     }
 
     /**
     * 处理saas平台参数混淆
     *
     * @param openId
     * @param timestamp
     * @param param
     * @throws Exception
     */
    public static String handleSaasParamConfusion(String openId, String timestamp, String param) throws Exception {

        StringJoiner confusionParam = new StringJoiner("&");
        confusionParam.add(openId);
        confusionParam.add(param);
        confusionParam.add(timestamp);
        confusionParam.add(param);

        return confusionParam.toString();
    }
    
    /**  
    * <p>  
    * 二进制数据编码为BASE64字符串  
    * </p>  
    *   
    * @param bytes  
    * @return  
    * @throws Exception  
    */  
    public static String encode(byte[] bytes) throws Exception {  
       return new String(Base64.encodeBase64(bytes));  
    }  
      
    /**  
    * <p>  
    * BASE64字符串解码为二进制数据  
    * </p>  
    *   
    * @param base64  
    * @return  
    * @throws Exception  
    */  
     public static byte[] decode(String base64) throws Exception {  
            return Base64.decodeBase64(base64.getBytes());
     }  
          

     public static void main(String[] args) throws Exception {
         // 外部加解密公私钥
         String outerPrivateKey = "MIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBAMNMJCykbBQ3PamSqCYSkJgaM1m2OuwGZC4N3ahhECMV02pyVzHcOu+G1CgyZu5UnlnaSiGSFN94hGDckQSmOxmBbSRancqMlsVu2TCmga6Ud3TX8l+A/oR04CnucZghYW+xeqggcvHl2Zas98qPZMao7r0EMu0nCooZ0zet9J9HAgMBAAECgYAgu1o0wTn8CWYkTZgxCVuCoqGIn6owdMHFlj1YQyxZNQdCB/flO2wFSSu1sPzfZP9FP/i8t6cX7TMCqPUFOncc/CYxcMPcrdJaIJ26G6mk/OvC70bdbtG0am6xwR0yfxifXTmvH6ISUXNtgjn5eErHtPN7KKWKS/ajZF1k2tkrwQJBAO1qV49DEus/Isq3+JXBb8HtOg6XToNMxEVhxyzRsIBWLauXtYlT9LmFzbSoinRXnZPVMYs4vuGLASzgF3nNWu0CQQDSlcf4ifMRy8v26xWKC17s/7LKnnPddUO5lTjPEty2+QV51fsi7tauhibPfQgd74O0cVyTn66z20jm9wNMQHiDAkEArR8HXDsv14UBbMs8JI+aW9INrMgeg1X+JQ3IvGDnkJ3GzcJhqRMkeAge2SaxV2bwS/WBHCEz56mCIOQDmljpfQJAApzDD00+y7C4hgaijMTZV51QbX0LuOqUfX/hZYg5Xre2Hq3N4MAPv7iAUMCfUie/fYSOfnJTq32D6QGVc+O02wJBAMplo5X+IE3gKwMM+AcyanM5cWZfycDS4ZLop3Er6GAoEU+pY9ZrzKZsAt2B7x9NoXzke2g5IYybAtk5tN5heZY=";
         String outerPublicKey="MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDTCQspGwUNz2pkqgmEpCYGjNZtjrsBmQuDd2oYRAjFdNqclcx3DrvhtQoMmbuVJ5Z2kohkhTfeIRg3JEEpjsZgW0kWp3KjJbFbtkwpoGulHd01/JfgP6EdOAp7nGYIWFvsXqoIHLx5dmWrPfKj2TGqO69BDLtJwqKGdM3rfSfRwIDAQAB";
         // 内部公钥，给外部的
         String innerPublicKey = "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDX44wPId6Sknix7/lgzH59/z00eEQkti7tiKuzkQdxerYIpAO7KrnkZr7NBWPc++NvvKrxQZ1y5XSGXvnh4KiqOtPxhSOM/ylXMxShgCAZzGiGs1QW7o9Er9AtnpvTkX3cn713YOWx796ooUmXSRd3+8XhbSO0NeEuEI1VKsQ3wIDAQAB";
        
         //时间戳
         long timestamp = System.currentTimeMillis();
         System.out.println("timdstamp:" + timestamp);
         
         //商户openId
         String openId = "masget20200628";
         
        //使用私钥加密请求数据并对加密数据使用base64编码
         String param = "{\"highwayCode\":\"JIANGSU\",\"orderId\":\"NO123456789\"}";
         String signStr = encryptByPrivateKey(param, outerPrivateKey);
         String encode = encode(signStr.getBytes());
         System.out.println("编码密文 encode: " + encode);         
         
         //生成数据签名
         String confusionParam = handleSaasParamConfusion(openId, String.valueOf(timestamp), signStr);
         System.out.println("confusionParam :" + confusionParam);
         String sign = sign(confusionParam, String.valueOf(timestamp), outerPrivateKey);
         System.out.println("数字签名 sign: " + sign);
 
         //公钥验签  
         boolean verify = verify(confusionParam, String.valueOf(timestamp), outerPublicKey, sign);
         System.out.println("验证签名 verify:"+verify);
 
     }
 }

AngryMills / askwalking

网关 askwalking

版本关系

集成说明注：网关调用服务应用需要集成client包

说明

1）当前版本为1.0.0版本

2）不支持集群部署，原因：集群部署存在api更新时在集群间产生脑裂问题

2.版本计划

1） 1.1.0版本加入UI、管理后台编写、完善一些使用中的bug、api管理功能相关钩子代码优化

2） 2.0.0版本支持集群部署，feign接口api支持

功能列表(1.0.0版本)

1）dubbo接口http暴露

2）根据不同api配置限流规则

3）用户鉴权

4） ras签名验证

5）用户资源权限(仅管理后台使用)

6）通用配置下发特殊参数、参数转化、动态赋值等(需要定义业务规则)

7） API管理接口支持操作：列表、添加、修改、下线、上线、mock

8） saas商户平台接入

配置说明(1.0版本)

网关saas平台接入指南

流程

流程说明:

rsa签名示例代码：

About

Languages

网关 askwalking

版本关系

集成说明 注：网关调用服务应用需要集成client包

说明

1） 当前版本为1.0.0版本

2） 不支持集群部署，原因：集群部署存在api更新时在集群间产生脑裂问题

2.版本计划

1） 1.1.0版本加入UI、管理后台编写、完善一些使用中的bug、api管理功能相关钩子代码优化

2） 2.0.0版本支持集群部署，feign接口api支持

功能列表(1.0.0版本)

1）dubbo接口http暴露

2） 根据不同api配置限流规则

3） 用户鉴权

4） ras签名验证

5） 用户资源权限(仅管理后台使用)

6） 通用配置下发 特殊参数、参数转化、动态赋值等(需要定义业务规则)

7） API管理接口 支持操作：列表、添加、修改、下线、上线、mock

8） saas商户平台接入

配置说明(1.0版本)

网关saas平台接入指南

流程

流程说明:

rsa签名示例代码：

About

Languages

集成说明注：网关调用服务应用需要集成client包

1）当前版本为1.0.0版本

2）不支持集群部署，原因：集群部署存在api更新时在集群间产生脑裂问题

2）根据不同api配置限流规则

3）用户鉴权

5）用户资源权限(仅管理后台使用)

6）通用配置下发特殊参数、参数转化、动态赋值等(需要定义业务规则)

7） API管理接口支持操作：列表、添加、修改、下线、上线、mock