support to verify object name strictly. (#171)

aliyun · Dec 15, 2023 · 5d42522 · 5d42522
1 parent 1f9ebd7
commit 5d42522
Show file tree

Hide file tree

Showing 9 changed files with 90 additions and 2 deletions.
diff --git a/.github/workflows/linux-clang.yml b/.github/workflows/linux-clang.yml
@@ -20,6 +20,7 @@ jobs:
 
     - name: Install Dependencies
       run: |
+        sudo apt-get update 
         sudo apt-get install curl libssl-dev libcurl4-openssl-dev
               
     - name: configure cmake

diff --git a/.github/workflows/linux-gcc.yml b/.github/workflows/linux-gcc.yml
@@ -20,6 +20,7 @@ jobs:
 
     - name: Install Dependencies
       run: |
+        sudo apt-get update
         sudo apt-get install curl libssl-dev libcurl4-openssl-dev
 
     - name: checkout gcc version

diff --git a/sdk/include/alibabacloud/oss/client/ClientConfiguration.h b/sdk/include/alibabacloud/oss/client/ClientConfiguration.h
@@ -125,6 +125,10 @@ namespace OSS
         * enable or disable path style, default is false.
         */
         bool isPathStyle;
+        /**
+        * enable or disable verify object name strictly. defualt is true
+        */
+        bool isVerifyObjectStrict;
     };
 }
 }
diff --git a/sdk/src/OssClientImpl.cc b/sdk/src/OssClientImpl.cc
@@ -1288,7 +1288,7 @@ GetObjectTaggingOutcome OssClientImpl::GetObjectTagging(const GetObjectTaggingRe
 StringOutcome OssClientImpl::GeneratePresignedUrl(const GeneratePresignedUrlRequest &request) const
 {
     if (!IsValidBucketName(request.bucket_) ||
-        !IsValidObjectKey(request.key_)) {
+        !IsValidObjectKey(request.key_, configuration().isVerifyObjectStrict)) {
         return StringOutcome(OssError("ValidateError", "The Bucket or Key is invalid."));
     }
 

diff --git a/sdk/src/client/ClientConfiguration.cc b/sdk/src/client/ClientConfiguration.cc
@@ -116,7 +116,8 @@ ClientConfiguration::ClientConfiguration() :
     recvRateLimiter(nullptr),
     executor(nullptr),
     httpClient(nullptr),
-    isPathStyle(false)
+    isPathStyle(false),
+    isVerifyObjectStrict(true)
 {
 
 }

diff --git a/sdk/src/utils/Utils.cc b/sdk/src/utils/Utils.cc
@@ -598,6 +598,17 @@ bool AlibabaCloud::OSS::IsValidBucketName(const std::string &bucketName)
     return key.size() <= ObjectNameLengthLimit;
 }
 
+ bool AlibabaCloud::OSS::IsValidObjectKey(const std::string& key, bool strict)
+ {
+     if (key.empty() || !key.compare(0, 1, "\\", 1))
+         return false;
+
+     if (strict && !key.compare(0, 1, "?", 1))
+         return false;
+
+     return key.size() <= ObjectNameLengthLimit;
+ }
+
  bool AlibabaCloud::OSS::IsValidLoggingPrefix(const std::string &prefix)
  {
      if (prefix.empty())

diff --git a/sdk/src/utils/Utils.h b/sdk/src/utils/Utils.h
@@ -66,6 +66,7 @@ namespace OSS
     bool IsIp(const std::string &host);
     bool IsValidBucketName(const std::string &bucketName);
     bool IsValidObjectKey(const std::string &key);
+    bool IsValidObjectKey(const std::string& key, bool strict);
     bool IsValidLoggingPrefix(const std::string &prefix);
     bool IsValidChannelName(const std::string &channelName);
     bool IsValidPlayListName(const std::string &playListName);

diff --git a/test/src/Object/ObjectSignedUrlTest.cc b/test/src/Object/ObjectSignedUrlTest.cc
@@ -667,6 +667,56 @@ TEST_F(ObjectSignedUrlTest, UnencodedSlashTest)
 }
 
 
+TEST_F(ObjectSignedUrlTest, VerifyObjctNameStrictTest)
+{
+    std::string key = "123?";
+    GeneratePresignedUrlRequest request= GeneratePresignedUrlRequest(BucketName, key, Http::Put);
+    auto urlOutcome = Client->GeneratePresignedUrl(request);
+    EXPECT_EQ(urlOutcome.isSuccess(), true);
+    EXPECT_TRUE(urlOutcome.result().find("123%3F?") != std::string::npos);
+
+    key = "123?321";
+    request = GeneratePresignedUrlRequest(BucketName, key, Http::Put);
+    urlOutcome = Client->GeneratePresignedUrl(request);
+    EXPECT_EQ(urlOutcome.isSuccess(), true);
+    EXPECT_TRUE(urlOutcome.result().find("123%3F321?") != std::string::npos);
+
+    key = "?123";
+    request = GeneratePresignedUrlRequest(BucketName, key, Http::Put);
+    urlOutcome = Client->GeneratePresignedUrl(request);
+    EXPECT_EQ(urlOutcome.isSuccess(), false);
+    EXPECT_TRUE(urlOutcome.error().Message().find("The Bucket or Key is invalid.") != std::string::npos);
+
+    key = "?";
+    request = GeneratePresignedUrlRequest(BucketName, key, Http::Put);
+    urlOutcome = Client->GeneratePresignedUrl(request);
+    EXPECT_EQ(urlOutcome.isSuccess(), false);
+    EXPECT_TRUE(urlOutcome.error().Message().find("The Bucket or Key is invalid.") != std::string::npos);
+
+    ClientConfiguration conf;
+    EXPECT_TRUE(conf.isVerifyObjectStrict);
+    conf.isVerifyObjectStrict = false;
+    auto c = std::make_shared<OssClient>(Config::Endpoint, Config::AccessKeyId, Config::AccessKeySecret, conf);
+
+    key = "123?321";
+    request = GeneratePresignedUrlRequest(BucketName, key, Http::Put);
+    urlOutcome = c->GeneratePresignedUrl(request);
+    EXPECT_EQ(urlOutcome.isSuccess(), true);
+    EXPECT_TRUE(urlOutcome.result().find("/123%3F321?") != std::string::npos);
+
+    key = "?123";
+    request = GeneratePresignedUrlRequest(BucketName, key, Http::Put);
+    urlOutcome = c->GeneratePresignedUrl(request);
+    EXPECT_EQ(urlOutcome.isSuccess(), true);
+    EXPECT_TRUE(urlOutcome.result().find("/%3F123") != std::string::npos);
+
+    key = "?";
+    request = GeneratePresignedUrlRequest(BucketName, key, Http::Put);
+    urlOutcome = c->GeneratePresignedUrl(request);
+    EXPECT_EQ(urlOutcome.isSuccess(), true);
+    EXPECT_TRUE(urlOutcome.result().find("/%3F?") != std::string::npos);
+}
+
 
 }
 }
diff --git a/test/src/Other/UtilsFunctionTest.cc b/test/src/Other/UtilsFunctionTest.cc
@@ -1069,5 +1069,24 @@ TEST_F(UtilsFunctionTest, IsValidEndpointTest)
     EXPECT_EQ(IsValidEndpoint(""), false);
 }
 
+TEST_F(UtilsFunctionTest, IsValidObjectKeyTest)
+{
+    EXPECT_EQ(IsValidObjectKey("123"), true);
+    EXPECT_EQ(IsValidObjectKey(""), false);
+
+    EXPECT_EQ(IsValidObjectKey("123", true), true);
+    EXPECT_EQ(IsValidObjectKey("", true), false);
+
+    EXPECT_EQ(IsValidObjectKey("?123", true), false);
+    EXPECT_EQ(IsValidObjectKey("?", true), false);
+    EXPECT_EQ(IsValidObjectKey("1?23", true), true);
+    EXPECT_EQ(IsValidObjectKey(" ?", true), true);
+
+    EXPECT_EQ(IsValidObjectKey("?123", false), true);
+    EXPECT_EQ(IsValidObjectKey("?", false), true);
+    EXPECT_EQ(IsValidObjectKey("123?", false), true);
+    EXPECT_EQ(IsValidObjectKey(" ?", false), true);
+}
+
 }
 }