tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
API 网关
    文档
    Download PDF

    Java（密钥对认证）

    最后更新时间：2023-12-22 10:08:24
    下载PDF

      操作场景

      该任务指导您使用 Java 语言，通过密钥对鉴权来对您的 API 进行认证管理。

      操作步骤

      1. 在 API 网关控制台，创建一个 API，选择鉴权类型为“密钥对鉴权”（参考 创建 API 概述）。
      2. 将 API 所在服务发布至发布环境（参考 服务发布与下线）。
      3. 在控制台密钥管理界面创建密钥对。
      4. 在控制台使用计划界面创建使用计划，并将使用计划与已创建的密钥对绑定（参考 使用计划示例）。
      5. 将使用计划与 API 或 API 所在服务进行绑定。
      6. 参考 示例代码，使用 Java 语言生成签名内容。

      注意事项

      最终发送的 HTTP 请求内至少包含两个 Header：Date 和 X-Date 二选一以及 Authorization，可以包含更多 header。如果使用 Date Header，服务端将不会校验时间；如果使用 X-Date Header，服务端将校验时间。
      Source Header 是签名水印值，可以填写任意值，也可不填写，Demo 中默认使用“xxxxxx”。
      Date Header 的值为格林威治时间（GMT）格式的 HTTP 请求构造时间，例如 Fri, 09 Oct 2015 00:00:00 GMT。
      X-Date Header 的值为格林威治时间（GMT）格式的 HTTP 请求构造时间，例如 Mon, 19 Mar 2018 12:08:40 GMT。X-Date Header 里的时间和当前时间的差值不能超过15分钟。
      如果是微服务 API，Header 中需要添加 “X-NameSpace-Code” 和 “X-MicroService-Name” 两个字段，通用 API 不需要添加，Demo 中默认添加了这两个字段。
      本 Demo 中包含了 GET 方法和 POST 方法的示例，您可以根据自己的需求选用。

      示例代码

      Base64.java

      package apigatewayDemo;
      
      import java.io.UnsupportedEncodingException;
      
      public class Base64 {
          private static char[] base64EncodeChars = new char[] { 'A', 'B', 'C', 'D',
                  'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q',
                  'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd',
                  'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q',
                  'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3',
                  '4', '5', '6', '7', '8', '9', '+', '/' };
      
          private static byte[] base64DecodeChars = new byte[] { -1, -1, -1, -1, -1,
                  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
                  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
                  -1, -1, -1, -1, 62, -1, -1, -1, 63, 52, 53, 54, 55, 56, 57, 58, 59,
                  60, 61, -1, -1, -1, -1, -1, -1, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,
                  10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1,
                  -1, -1, -1, -1, -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37,
                  38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, -1, -1, -1,
                  -1, -1 };
      
          public static String encode(byte[] data) {
              StringBuffer sb = new StringBuffer();
              int len = data.length;
              int i = 0;
                                      int b1, b2, b3;
              while (i < len) {
                  b1 = data[i++] & 0xff;
                  if (i == len) {
                      sb.append(base64EncodeChars[b1 >>> 2]);
                      sb.append(base64EncodeChars[(b1 & 0x3) << 4]);
                      sb.append("==");
                      break;
                  }
                  b2 = data[i++] & 0xff;
                  if (i == len) {
                      sb.append(base64EncodeChars[b1 >>> 2]);
                      sb.append(base64EncodeChars[((b1 & 0x03) << 4)
                              | ((b2 & 0xf0) >>> 4)]);
                      sb.append(base64EncodeChars[(b2 & 0x0f) << 2]);
                      sb.append("=");
                      break;
                  }
                  b3 = data[i++] & 0xff;
                  sb.append(base64EncodeChars[b1 >>> 2]);
                  sb.append(base64EncodeChars[((b1 & 0x03) << 4)
                          | ((b2 & 0xf0) >>> 4)]);
                  sb.append(base64EncodeChars[((b2 & 0x0f) << 2)
                          | ((b3 & 0xc0) >>> 6)]);
                              sb.append(base64EncodeChars[b3 & 0x3f]);
              }
              return sb.toString();
          }
      
          public static byte[] decode(String str) throws UnsupportedEncodingException {
              StringBuffer sb = new StringBuffer();
              byte[] data = str.getBytes("US-ASCII");
              int len = data.length;
              int i = 0;
              int b1, b2, b3, b4;
              while (i < len) {
                  /* b1 */
                  do {
                      b1 = base64DecodeChars[data[i++]];
                  } while (i < len && b1 == -1);
                  if (b1 == -1)
                      break;
                  /* b2 */
                  do {
                      b2 = base64DecodeChars[data[i++]];
                  } while (i < len && b2 == -1);
                  if (b2 == -1)
                      break;
                  sb.append((char) ((b1 << 2) | ((b2 & 0x30) >>> 4)));
                  /* b3 */
                  do {
                      b3 = data[i++];
                      if (b3 == 61)
                          return sb.toString().getBytes("ISO-8859-1");
                      b3 = base64DecodeChars[b3];
                  } while (i < len && b3 == -1);
                  if (b3 == -1)
                      break;
                  sb.append((char) (((b2 & 0x0f) << 4) | ((b3 & 0x3c) >>> 2)));
                  /* b4 */
                  do {
                      b4 = data[i++];
                      if (b4 == 61)
                          return sb.toString().getBytes("ISO-8859-1");
                      b4 = base64DecodeChars[b4];
                  } while (i < len && b4 == -1);
                  if (b4 == -1)
                      break;
                  sb.append((char) (((b3 & 0x03) << 6) | b4));
              }
              return sb.toString().getBytes("ISO-8859-1");
          }
      }

      SignAndSend.java

      package apigatewayDemo;
      import java.io.UnsupportedEncodingException;
      import java.security.InvalidKeyException;
      import java.security.NoSuchAlgorithmException;
      import javax.crypto.Mac;
      import javax.crypto.spec.SecretKeySpec;
      import java.text.SimpleDateFormat;
      import java.util.*;
      import java.io.BufferedReader;
      import java.io.IOException;
      import java.io.InputStreamReader;
      import java.io.PrintWriter;
      import java.net.URL;
      import java.net.URLConnection;
      import java.net.HttpURLConnection;
      import java.io.OutputStreamWriter;
      
      public class SignAndSend {
          private static final String CONTENT_CHARSET = "UTF-8";
          private static final String HMAC_ALGORITHM = "HmacSHA1";
          public static String sign(String secret, String timeStr)
                  throws NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException
          {
              //获取签名字符串，Source是签名水印值，可填写任意值，Demo中使用“xxxxxx”
              String signStr = "date: "+timeStr+"\\n"+"source: "+"xxxxxx";
              //获取接口签名
              String sig = null;
              Mac mac1 = Mac.getInstance(HMAC_ALGORITHM);
              byte[] hash;
              SecretKeySpec secretKey = new SecretKeySpec(secret.getBytes(CONTENT_CHARSET), mac1.getAlgorithm());
              mac1.init(secretKey);
              hash = mac1.doFinal(signStr.getBytes(CONTENT_CHARSET));
              sig = new String(Base64.encode(hash));
              System.out.println("signValue--->" + sig);
              return sig;
          }
      
          public static HttpURLConnection NewHttpUrlCon(String url, String secretId, String secretKey) {
              //获取当前 GMT 时间
              Calendar cd = Calendar.getInstance();
              SimpleDateFormat sdf = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss 'GMT'", Locale.US);
              sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
              String timeStr = sdf.format(cd.getTime());
              HttpURLConnection httpUrlCon = null;
              try {
                  String urlNameString = url;
                  URL realUrl = new URL(urlNameString);
                  // 打开和 URL 之间的连接
                  URLConnection connection = realUrl.openConnection();
                  httpUrlCon = (HttpURLConnection)connection;
                  // 设置通用的请求属性，Source 是签名水印值，可填写任意值，Demo 中使用“xxxxxx”
                  httpUrlCon.setRequestProperty("Host", url);
                  httpUrlCon.setRequestProperty("Accept", "text/html, */*; q=0.01");
                  httpUrlCon.setRequestProperty("Source","xxxxxx");
                  httpUrlCon.setRequestProperty("Date",timeStr);
                  String sig = sign(secretKey,timeStr);
                  String authen = "hmac id=\\""+secretId+"\\", algorithm=\\"hmac-sha1\\", headers=\\"date source\\", signature=\\""+sig+"\\"";
                  System.out.println("authen --->" + authen);
                  httpUrlCon.setRequestProperty("Authorization",authen);
                  httpUrlCon.setRequestProperty("X-Requested-With","XMLHttpRequest");
                  httpUrlCon.setRequestProperty("Accept-Encoding","gzip, deflate, sdch");
      
                  // 如果是微服务 API，Header 中需要添加'X-NameSpace-Code'、'X-MicroService-Name'两个字段，通用 API 不需要添加。
                  httpUrlCon.setRequestProperty("X-NameSpace-Code","testmic");
                  httpUrlCon.setRequestProperty("X-MicroService-Name","provider-demo");
              } catch (Exception e) {
                  System.out.println("新建连接异常！" + e);
                  e.printStackTrace();
              }
              return httpUrlCon;
          }
      
          public static String sendGet(String url, String secretId, String secretKey) {
              String result = "";
              BufferedReader in = null;
              try {
                  // 新建连接
                  HttpURLConnection httpUrlCon = NewHttpUrlCon(url, secretId, secretKey);
      
                  // 建立实际的连接
                  httpUrlCon.connect();
      
                  // 获取所有响应头字段
                  Map<String, List<String>> map = httpUrlCon.getHeaderFields();
      
                  // 遍历所有的响应头字段
                  for (String key : map.keySet()) {
                      System.out.println(key + "--->" + map.get(key));
                  }
      
                  // 定义 BufferedReader 输入流来读取 URL 的响应
                  in = new BufferedReader(new InputStreamReader(
                          httpUrlCon.getInputStream()));
                  String line;
                  while ((line = in.readLine()) != null) {
                      result += line;
                  }
              } catch (Exception e) {
                  System.out.println("发送GET请求出现异常！" + e);
                  e.printStackTrace();
              }
      
              // 使用 finally 块来关闭输入流
              finally {
                  try {
                      if (in != null) {
                          in.close();
                      }
                  } catch (Exception e2) {
                      e2.printStackTrace();
                  }
              }
              return result;
          }
      
          public static String sendPost(String url, String secretId, String secretKey) {
              String result = "";
              BufferedReader in = null;
              try {
      
                  // 新建连接
                  HttpURLConnection httpUrlCon = NewHttpUrlCon(url, secretId, secretKey);
      
                  //设置 post 请求
                  httpUrlCon.setRequestMethod("POST");
                  httpUrlCon.setUseCaches(false);  //Post 请求不能使用缓存
                  httpUrlCon.setDoOutput(true);
                  httpUrlCon.setDoInput(true);
      
                  //将请求数据放到 body 里
                  OutputStreamWriter out = new OutputStreamWriter(httpUrlCon.getOutputStream());
                  String jsonStr = "{\\"caller\\":\\"apigw\\", \\"data\\":\\"test post\\"}";
                  out.write(jsonStr);
                  out.flush();
                  out.close();
      
                  // 建立实际的连接
                  httpUrlCon.connect();
      
                  // 获取所有响应头字段
                  Map<String, List<String>> map = httpUrlCon.getHeaderFields();
      
                  // 遍历所有的响应头字段
                  for (String key : map.keySet()) {
                      System.out.println(key + "--->" + map.get(key));
                  }
      
                  // 定义 BufferedReader 输入流来读取 URL 的响应
                  in = new BufferedReader(new InputStreamReader(
                          httpUrlCon.getInputStream()));
                  String line;
                  while ((line = in.readLine()) != null) {
                      result += line;
                  }
              } catch (Exception e) {
                  System.out.println("发送POST请求出现异常！" + e);
                  e.printStackTrace();
              }
      
              // 使用 finally 块来关闭输入流
              finally {
                  try {
                      if (in != null) {
                          in.close();
                      }
                  } catch (Exception e2) {
                      e2.printStackTrace();
                  }
              }
              return result;
          }
      }

      Demo.java

      package apigatewayDemo;
      public class Demo {
          public static void main(String[] args) {
              String secretId = "your secretId"; // 密钥对的 SecretId
              String secretKey = "your secretKey"; // 密钥对的 SecretKey
              SignAndSend signAndSendInstance = new SignAndSend();
      
              //get 请求
              String getUrl = "http://service-xxxxxxxx-1234567890.gz.apigw.tencentcs.com:80/get"; // 用户 API 的访问路径
              String getResult = SignAndSend.sendGet(getUrl, secretId, secretKey);
              System.out.println(getResult);
      
              //post 请求
              String postUrl = "http://service-xxxxxxxx-1234567890.gz.apigw.tencentcs.com:80/post"; // 用户 API 的访问路径
              String postResult = SignAndSend.sendPost(postUrl, secretId, secretKey);
              System.out.println(postResult);
          }
      }
      
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款