update qcloud sdk to 5.9.15

jordanqin · jordanqin · commit 9b2a9bf83b91 · 2023-08-16T21:15:26.000+08:00
diff --git a/QCloudCosXml/cos-android/build.gradle b/QCloudCosXml/cos-android/build.gradle
@@ -33,7 +33,7 @@ android {
 
         consumerProguardFiles 'proguard-rules.pro'
 
-//        multiDexEnabled true
+        multiDexEnabled true
     }
 
     buildTypes {
diff --git a/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/core/MyCOSXmlSignSourceProvider.java b/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/core/MyCOSXmlSignSourceProvider.java
@@ -179,7 +179,7 @@ public <T> String source(HttpRequest<T> request) throws QCloudClientException {
         // 默认URL参数字段参与计算，需要减去设置的不需要签名的 params
         if (parametersRequiredToSign.size() < 1) {
             Map<String, List<String>> queryNameValues = QCloudHttpUtils.getQueryPair(request.url());
-            for (String noSignParam : request.getNoSignHeaders()) {
+            for (String noSignParam : request.getNoSignParams()) {
                 queryNameValues.remove(QCloudHttpUtils.urlDecodeString(noSignParam));
             }
             parametersRequiredToSign.addAll(queryNameValues.keySet());
diff --git a/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/MyCOSXmlSignSourceProvider.java b/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/MyCOSXmlSignSourceProvider.java
@@ -31,13 +31,10 @@
 import android.util.Log;
 
 import com.tencent.qcloud.core.auth.AuthConstants;
-import com.tencent.qcloud.core.auth.QCloudCredentials;
-import com.tencent.qcloud.core.auth.QCloudSignSourceProvider;
 import com.tencent.qcloud.core.auth.Utils;
 import com.tencent.qcloud.core.common.QCloudClientException;
 import com.tencent.qcloud.core.http.HttpConfiguration;
 import com.tencent.qcloud.core.http.HttpRequest;
-import com.tencent.qcloud.core.http.QCloudHttpRequest;
 import com.tencent.qcloud.core.util.QCloudHttpUtils;
 import com.tencent.qcloud.core.util.QCloudStringUtils;
 
@@ -57,18 +54,19 @@
 import java.util.TreeSet;
 
 /**
+ * 签名物料source计算器
  * 提供COS请求中参与签名的字段
  * <p>
  * 具体请参考：<a href="https://cloud.tencent.com/document/product/436/7778#.E7.AD.BE.E5.90.8D.E6.AD.A5.E9.AA.A4">签名步骤</a>中的 步骤6：生成 StringToSign
  */
 
-public class MyCOSXmlSignSourceProvider implements QCloudSignSourceProvider {
+public class MyCOSXmlSignSourceProvider {
 
-    private Set<String> parametersRequiredToSign;
-    private Set<String> parametersSigned;
+    private final Set<String> parametersRequiredToSign;
+    private final Set<String> parametersSigned;
 
-    private Set<String> headerKeysRequiredToSign;
-    private Set<String> headerKeysSigned;
+    private final Set<String> headerKeysRequiredToSign;
+    private final Set<String> headerKeysSigned;
     private Map<String, List<String>> headerPairs;
 
     private String signTime;
@@ -85,35 +83,12 @@ public MyCOSXmlSignSourceProvider() {
         noSignParams = new HashSet<>();
     }
 
-    public void parameter(String key) {
-        parametersRequiredToSign.add(key);
-    }
-
-    public void parameters(Set<String> keys) {
-        if(keys != null){
-            parametersRequiredToSign.addAll(keys);
-        }
-    }
-
-    public void header(String key) {
-        headerKeysRequiredToSign.add(key);
-    }
-
     public void headers(Set<String> keys) {
         if(keys != null){
             headerKeysRequiredToSign.addAll(keys);
         }
     }
 
-    /**
-     * 设置签名使用的 headers 参数，默认读取的是 {@link QCloudHttpRequest#headers()}
-     *
-     * @param headerPairs 键值对，签名使用的 headers 参数
-     */
-    public void setHeaderPairsForSign(Map<String, List<String>> headerPairs) {
-        this.headerPairs = headerPairs;
-    }
-
     void setSignTime(String signTime) {
         this.signTime = signTime;
     }
@@ -126,12 +101,6 @@ public void addNoSignParam(String key){
         noSignParams.add(key);
     }
 
-    @Override
-    public <T> void onSignRequestSuccess(HttpRequest<T> request, QCloudCredentials credentials,
-                                         String authorization) {
-
-    }
-
     // 只会签名如下 header
     private final List<String> needToSignHeaders = Arrays.asList(
             "cache-control",
@@ -152,7 +121,6 @@ public <T> void onSignRequestSuccess(HttpRequest<T> request, QCloudCredentials c
             "transfer-encoding"
     );
 
-    @Override
     public <T> String source(HttpRequest<T> request) throws QCloudClientException {
         if (request == null) {
             return null;
@@ -187,7 +155,7 @@ public <T> String source(HttpRequest<T> request) throws QCloudClientException {
         // 默认URL参数字段参与计算，需要减去设置的不需要签名的 params
         if (parametersRequiredToSign.size() < 1) {
             Map<String, List<String>> queryNameValues = QCloudHttpUtils.getQueryPair(request.url());
-            for (String noSignParam : request.getNoSignHeaders()) {
+            for (String noSignParam : request.getNoSignParams()) {
                 queryNameValues.remove(QCloudHttpUtils.urlDecodeString(noSignParam));
             }
             for (String noSignParam : noSignParams) {
diff --git a/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/MyCOSXmlSigner.java b/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/MyCOSXmlSigner.java
@@ -28,7 +28,9 @@
 import com.tencent.qcloud.core.common.QCloudAuthenticationException;
 import com.tencent.qcloud.core.common.QCloudClientException;
 
+import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 
 /**
  * COS签名器<br>
@@ -38,19 +40,134 @@
  */
 public class MyCOSXmlSigner {
     /**
-     * 写死的签名
+     * 临时秘钥
      */
     public static final SessionQCloudCredentials credentials = new SessionQCloudCredentials(
-            "xxxxxxxxxxxxxxxxxxxxxxxxx",
-            "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-            "xxxxxxxxxxxxxxxxxxxxxxxxxx",
-            1111111111, 222222222
+            "xxxxxxxxxxxxxxxxxxxxxxxx",
+            "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+            "xxxxxxxxxxxxxxxxxxxxxxx",
+            111111111, 11111111
     );
 
-    public static MyQCloudSelfSigner.SignResult sign(String source, String realHeaderList, String realParameterList) throws QCloudClientException{
+    /**
+     * 简单上传最大size
+     * 限定上传文件大小最大值，单位Byte。大于限制上传文件大小的最大值会被判为上传失败
+     */
+    public final static long SIMPLE_MAX_SIZE = 100 * 1024 * 1024;
+    /**
+     * 简单上传最大size header key
+     */
+    public final static String SIMPLE_MAX_SIZE_HEADER_KEY = "x-cos-fsize-max";
+    /**
+     * Upload Part最大size
+     * 用于UploadPart，限定上传分块大小最大值，单位 Byte。大于限制上传文件大小的最大值会被判为上传失败
+     */
+    public final static long UPLOAD_PART_MAX_SIZE = 1024 * 1024;
+    /**
+     * Upload Part最大size header key
+     */
+    public final static String UPLOAD_PART_MAX_SIZE_HEADER_KEY = "x-cos-psize-max";
+    /**
+     * CompleteMultipartUpload最多分块数量
+     * 用于CompleteMultipartUpload，限定上传分块的数量。分块数量超过限制，请求会被拒绝。
+     */
+    public final static int Complete_MAX_NUM = 100;
+    /**
+     * CompleteMultipartUpload最多分块数量 header key
+     */
+    public final static String Complete_MAX_NUM_HEADER_KEY = "x-cos-pnum-max";
+
+    /**
+     * 限定放通或不放通若干类型的 mimetype(可以限制上传文件的类型。一些比较常用的类型可以，特别少见的类型可能不太准确)
+     */
+//    public final static String MIME_LIMIT = "text/plain;img/jpg;img/*";
+    public final static String MIME_LIMIT = "!text/plain";
+
+    /**
+     * mimetype header key
+     */
+    public final static String MIME_LIMIT_HEADER_KEY = "x-cos-mime-limit";
+
+    /**
+     * 签名方法
+     * @param source 签名物料 采用了客户端拼source的方法，原因是需要端侧需要根据source进行分块上传签名缓存，如果服务端拼source的话可能和端侧不一致导致缓存失效
+     * @param realHeaderList 要签名的header key集合字符串
+     * @param realParameterList 要签名的param key集合字符串
+     * @param httpMethod http请求方法
+     * @param path http请求path
+     * @param headers http请求header map
+     * @param queryNameValues http请求query map
+     * @return 签名结果
+     */
+    public static MyQCloudSelfSigner.SignResult sign(String source, String realHeaderList, String realParameterList,
+                                                     String httpMethod, String path,
+                                                     Map<String, List<String>> headers, Map<String, List<String>> queryNameValues) throws QCloudClientException{
         if (credentials == null) {
             throw new QCloudClientException(new QCloudAuthenticationException("Credentials is null."));
         }
+
+        // 上传各api接口格式请参考：
+        // PUT Object （简单上传） https://cloud.tencent.com/document/product/436/7749
+        // Initiate Multipart Upload（初始化分块上传） https://cloud.tencent.com/document/product/436/7746
+        // List Parts（查询特定分块上传中的已上传的块） https://cloud.tencent.com/document/product/436/7747
+        // Upload Part（将对象按照分块的方式上传到 COS） https://cloud.tencent.com/document/product/436/7750
+        // Complete Multipart Upload（完成整个分块上传） https://cloud.tencent.com/document/product/436/7742
+        // Abort Multipart Upload（舍弃一个分块上传并删除已上传的块） https://cloud.tencent.com/document/product/436/7740
+
+        // --------------- 处理业务逻辑 开始 ------------------
+        // 如果是简单Put或Upload Part请求
+        if("put".equals(httpMethod)){
+            if(!queryNameValues.containsKey("partNumber")){
+                // 简单put
+                // 限制大小 判断x-cos-fsize-max是否存在并限制
+                if(headers.containsKey(SIMPLE_MAX_SIZE_HEADER_KEY)){
+                    long simpleMaxSize = Long.parseLong(headers.get(SIMPLE_MAX_SIZE_HEADER_KEY).get(0));
+                    if(simpleMaxSize > SIMPLE_MAX_SIZE){
+                        throw new QCloudClientException(new QCloudAuthenticationException("x-cos-fsize-max exceed the limit"));
+                    }
+                } else {
+                    throw new QCloudClientException(new QCloudAuthenticationException("x-cos-fsize-max can not be empty"));
+                }
+            } else {
+                // Upload Part
+                // 限制大小 判断x-cos-psize-max是否存在并限制
+                if(headers.containsKey(UPLOAD_PART_MAX_SIZE_HEADER_KEY)){
+                    long uploadPartMaxSize = Long.parseLong(headers.get(UPLOAD_PART_MAX_SIZE_HEADER_KEY).get(0));
+                    if(uploadPartMaxSize > UPLOAD_PART_MAX_SIZE){
+                        throw new QCloudClientException(new QCloudAuthenticationException("x-cos-psize-max exceed the limit"));
+                    }
+                } else {
+                    throw new QCloudClientException(new QCloudAuthenticationException("x-cos-psize-max can not be empty"));
+                }
+            }
+
+            // 限制格式 判断x-cos-mime-limit是否存在并限制
+            if(headers.containsKey(MIME_LIMIT_HEADER_KEY)){
+                String mimeLimit = (headers.get(MIME_LIMIT_HEADER_KEY).get(0));
+                if(!MIME_LIMIT.equals(mimeLimit)){
+                    throw new QCloudClientException(new QCloudAuthenticationException("x-cos-mime-limit incorrect"));
+                }
+            } else {
+                throw new QCloudClientException(new QCloudAuthenticationException("x-cos-mime-limit can not be empty"));
+            }
+        }
+        // 如果是CompleteMultipartUpload请求 限制大小 判断x-cos-pnum-max是否存在并限制
+        if("post".equals(httpMethod) && queryNameValues.containsKey("uploadId")){
+            if(headers.containsKey(Complete_MAX_NUM_HEADER_KEY)){
+                long completeMaxNum = Integer.parseInt(headers.get(Complete_MAX_NUM_HEADER_KEY).get(0));
+                if(completeMaxNum > Complete_MAX_NUM){
+                    throw new QCloudClientException(new QCloudAuthenticationException("x-cos-pnum-max exceed the limit"));
+                }
+            } else {
+                throw new QCloudClientException(new QCloudAuthenticationException("x-cos-pnum-max can not be empty"));
+            }
+        }
+
+
+        // 可以使用httpMethod、path、headers、queryNameValues做其他业务处理
+        // --------------- 处理业务逻辑 结束 ------------------
+
+        // --------------- 计算签名开始 ------------------
         StringBuilder authorization = new StringBuilder();
 
         String keyTime = credentials.getKeyTime();
@@ -69,6 +186,7 @@ public static MyQCloudSelfSigner.SignResult sign(String source, String realHeade
                 .append(realParameterList.toLowerCase(Locale.ROOT)).append("&")
                 .append(AuthConstants.Q_SIGNATURE).append("=").append(signature);
         String auth = authorization.toString();
+        // --------------- 计算签名结束 ------------------
         return new MyQCloudSelfSigner.SignResult(auth, credentials.getToken());
     }
 
diff --git a/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/MyQCloudSelfSigner.java b/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/MyQCloudSelfSigner.java
@@ -6,15 +6,19 @@
 import com.tencent.qcloud.core.common.QCloudClientException;
 import com.tencent.qcloud.core.http.HttpConstants;
 import com.tencent.qcloud.core.http.QCloudHttpRequest;
+import com.tencent.qcloud.core.util.QCloudHttpUtils;
 
 import java.util.HashMap;
 import java.util.Iterator;
+import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 
 /**
+ * 实现自签名器
  * <p>
  * Created by jordanqin on 2023/8/11 17:20.
- * Copyright 2010-2020 Tencent Cloud. All Rights Reserved.
+ * Copyright 2010-2023 Tencent Cloud. All Rights Reserved.
  */
 public class MyQCloudSelfSigner implements QCloudSelfSigner {
     private static final String TAG = "MyQCloudSelfSigner";
@@ -41,7 +45,7 @@ public void sign(QCloudHttpRequest request) throws QCloudClientException {
         int sourceId = source.hashCode();
         SignResult signResult = lookupValidSignResult(sourceId);
         if (signResult == null) {
-            signResult = fetchNewSignResult(sourceProvider, source);
+            signResult = fetchNewSignResult(sourceProvider, source, request);
             Log.d(TAG, signResult.authorization);
             cacheSignResultAndCleanUp(sourceId, signResult);
         }
@@ -58,9 +62,17 @@ public void sign(QCloudHttpRequest request) throws QCloudClientException {
     /**
      * 远程获取签名结果
      */
-    private SignResult fetchNewSignResult(MyCOSXmlSignSourceProvider sourceProvider, String source) throws QCloudClientException {
+    private SignResult fetchNewSignResult(MyCOSXmlSignSourceProvider sourceProvider, String source, QCloudHttpRequest request) throws QCloudClientException {
         Log.d(TAG, "fetchNewSignResult");
-        return MyCOSXmlSigner.sign(source, sourceProvider.getRealHeaderList(), sourceProvider.getRealParameterList());
+
+        // 获取请求内容传给服务端，用于做业务处理
+        String httpMethod = request.method().toLowerCase(Locale.ROOT);
+        String path = QCloudHttpUtils.urlDecodeString(request.url().getPath());
+        Map<String, List<String>> headers = request.headers();
+        Map<String, List<String>> queryNameValues = QCloudHttpUtils.getQueryPair(request.url());
+
+        return MyCOSXmlSigner.sign(source, sourceProvider.getRealHeaderList(), sourceProvider.getRealParameterList(),
+                httpMethod, path, headers, queryNameValues);
     }
 
     /**
diff --git a/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/SelfUploadTest.java b/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/server_sign/SelfUploadTest.java

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ android {`
`33`	`33`
`34`	`34`	`consumerProguardFiles 'proguard-rules.pro'`
`35`	`35`
`36`		`-// multiDexEnabled true`
	`36`	`+ multiDexEnabled true`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`buildTypes {`
Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ public <T> String source(HttpRequest<T> request) throws QCloudClientException {`
`179`	`179`	`// 默认URL参数字段参与计算，需要减去设置的不需要签名的 params`
`180`	`180`	`if (parametersRequiredToSign.size() < 1) {`
`181`	`181`	`Map<String, List<String>> queryNameValues = QCloudHttpUtils.getQueryPair(request.url());`
`182`		`- for (String noSignParam : request.getNoSignHeaders()) {`
	`182`	`+ for (String noSignParam : request.getNoSignParams()) {`
`183`	`183`	`queryNameValues.remove(QCloudHttpUtils.urlDecodeString(noSignParam));`
`184`	`184`	`}`
`185`	`185`	`parametersRequiredToSign.addAll(queryNameValues.keySet());`