tencentyun / qcloud-cos-sts-sdk

QCloud COS STS SDK for Backend Server

QCloud COS 服务临时密钥 SDK

本 SDK 可以帮助您在后台快速搭建一个临时密钥服务，用于访问腾讯云 COS 下的资源。

访问管理

腾讯云 COS 服务在使用时需要对请求进行访问管理。通过临时密钥机制，您可以临时授权您的 App 访问您的存储资源，而不会泄露您的永久密钥。密钥的有效期由您指定，过期后自动失效。**通常，我们都不建议您把永久密钥放到客户端代码中。**本文主要介绍如何在后台快速搭建一个临时密钥服务，通过生成的临时密钥来对上传或者下载请求进行签名，从而保证您数据的安全性。

架构

整体架构图如下所示：

其中：

• 应用 APP：即用户手机上的 App。

• COS：腾讯云对象存储，负责存储 App 上传的数据。

• CAM：腾讯云访问管理，用于生成 COS 的临时密钥。

• 应用服务器：用户自己的后台服务器，这里用于获取临时密钥，并返回给应用 App。

获取永久密钥

临时密钥需要通过永久密钥才能生成。请登录 腾讯云访问管理控制台 获取，包含：

• SecretId
• SecretKey

如何快速搭建临时密钥服务

集成 SDK 到 您的后台服务

如果您已经有独立的后台服务，我们建议您直接集成我们提供的 SDK 到现在的后台服务中。

第一步：集成服务器 SDK

目前我们提供了以下语言的 SDK，帮忙您快速在后台集成生成密钥的功能，您可以根据自己后台的架构自行选择：

• Java
• Node.js
• PHP
• Python
• Go
• .NET

第二步：发布 Web API

将您的服务以 Web API 的方式发布出去，这样您授权的客户端 App，如 Android、iOS，Web端，都可以通过标准的 HTTP 协议请求到临时密钥，访问 COS 服务。

高级功能

您可以通过 Scope 的方式更细粒度的控制返回密钥的权限，详细请看 细粒度控制权限。

其他语言

如果您需要其他语言的 SDK，可以参考社区提供的版本。

语言	作者	仓库
elixir	@scottming	scottming/qcloud_cos_sts

qcloud-cos-sts-sdk's Issues

PHP的没有命名空间？

PHP的没有命名空间？

没法自动加载

没法自动加载

急需 go sdk

找了一圈居然没有 Go 的 SDK。。。急需啊 please help！

3.0.7才支持allowPrefixes数组

test里有用到了allowPrefixes，但readme是3.0.6，这个版本还不支持数组。

.net 的SDK一直报错提示加载不了TencentCloud.Sts.V20180813.Models.GetFederationTokenResponse

未能从程序集“TencentCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null”中加载类型“TencentCloud.Sts.V20180813.Models.GetFederationTokenResponse”。

腾讯的接口没有全局架构

腾讯的接口都是不同团队各自为政，一个cos接口搞出两套，咱就不能全局统筹整合一下吗？微信的接口也是，有的是xml格式，有的是json格式，我服了u。cos抄袭了七牛云，不过咱api是否也能抄下七牛云呢，七牛api是真心好用。
<groupId>com.qcloud</groupId> <artifactId>cos_api</artifactId>
<groupId>com.tencent.cloud</groupId> <artifactId>cos-sts-java</artifactId>

go版本SDK接口返回报错

直接使用go里面的demo去创建token的

Code: InvalidParameter.GrantOtherResource, Message: [QC_STS] cant grant other resource, RequestId

代码

	opt := &sts.CredentialOptions{
		DurationSeconds: expiredAt,
		Region:          region,
		Policy: &sts.CredentialPolicy{
			Statement: []sts.CredentialPolicyStatement{
				{
					Action: []string{
						"name/cos:PostObject",
						"name/cos:PutObject",
					},
					Effect: "allow",
					Resource: []string{
                                                  // 这里的uid是腾讯云后台的APPID？
						"qcs::cos:" + region + ":uid/" + uid + ":" + bucket + "/tmp",
					},
				},
			},
		},
	}

Java的maven依赖可以提供一下吗

wiki里为什么放了个json的依赖

Where can I get teh SDK for .Net?

Where can I get teh SDK for .Net?

+ 这个符号的url encode结果与你们客户端SDK的可能存在差异，导致签名不匹配

java sdk 5.6.54, go sdk 0.7.33

用以上两个SDK进行上传或生成预签名连接操作，只要文件名中包含"+"都会发生“签名不匹配”错误，其它情况正常。

经调查测试，服务端对"+"号编码为%2b，客户端编码为"+"，由此猜测服务端的url encode可能不标准。

没有golang版本的sdk吗？

如题

python sdk生成的签名无法和cos-wx-sdk-v5中的示例配合使用吗？

使用此sdk生成的签名，与https://github.com/tencentyun/cos-wx-sdk-v5中的示例无法配合使用吗？
即使返回的是小写
data.credentials.tmpSecretId = data.credentials.tmpsecretid
data.credentials.tmpSecretKey = data.credentials.tmpsecretkey
data.credentials.sessionToken = data.credentials.token
COS也会返回ACCESS DENIED

demo没有显示呀

点击demo后没有显示查看实例

为什么用python的sdk会报错‘cannot concatenate 'str' and 'dict' objects’

我是直接下载了整个project然后修改了sts_demo.py中相关的id、key、bucket等。然后执行python sts_demo.py会报错‘cannot concatenate 'str' and 'dict' objects’。python2.7.5的环境

DotNet Framework 4.7.2获取临时令牌报错，非dotnet Core

错误信息：

TencentCloud.Common.TencentCloudSDKException:“code:InvalidParameter.GrantOtherResource message:[QC_STS] cant grant other resource ”

两次尝试都报此错误:
1.nuget: Tencent.QCloud.Cos.Sts.Sdk 3.0.1
2.直接github复制Master 的STSClient源码，放进源文件跑

测试过吗？？

永远都是
Code: AuthFailure.SignatureFailure, Message: The provided credentials could not be validated. Please check your signature is correct.

代码转换成python3.X 就报错了，求3.x版本的SDK

文档里面有错误，credentials不是String，而是Object

文档里面有错误，credentials不是String，而是Object

how to set proxy？

nodejs 版本的可以设置proxy java版本的怎么设置代理呢？

StartTime 的解释

StartTime:文档上说是密钥的起止时间, 个人理解应该是起始时间吧.

java sdk 3.0.8报错

Exception in thread "main" java.lang.NoSuchMethodError: org.json.JSONObject.keySet()Ljava/util/Set;
at com.tencent.cloud.CosStsClient.downCompat(CosStsClient.java:96)
at com.tencent.cloud.CosStsClient.getCredential(CosStsClient.java:63)

javascript直传cos时怎么对上传的文件进行重命名

使用过程中发现不能自动重命名，难道需要上传成功后再调用移动文件接口的方法实现重命名吗？
cos.moveFile(successCallBack, errorCallBack, bucket, path, destPath, overWrite);
https://cloud.tencent.com/document/product/436/8095#.E6.9B.B4.E6.96.B0.E6.96.87.E4.BB.B6.E5.B1.9E.E6.80.A7

java sdk jar maven仓库下载不下来

java sdk jar包只能下载下来3.0.3的版本，3.0.5下载不下来

使用demo获取临时密钥接口，报错

Response -> {JSONObject@1904} "{"RequestId":"fae48023-fb79-46b8-ad9e-9610a6f5752c","Error":{"Message":"resource error","Code":"InvalidParameter.ResouceError"}}"

关于 sdk 选择的问题

除了这里的 sdk，还在 https://console.cloud.tencent.com/api/explorer?Product=ms&Version=2018-04-08&Action=CreateCosSecKeyInstance&SignVersion= 这里看到了获取云 COS 临时密钥的一个示例代码。代码如下：

import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;

import com.tencentcloudapi.ms.v20180408.MsClient;

import com.tencentcloudapi.ms.v20180408.models.CreateCosSecKeyInstanceRequest;
import com.tencentcloudapi.ms.v20180408.models.CreateCosSecKeyInstanceResponse;

public class CreateCosSecKeyInstance
{
    public static void main(String [] args) {
        try{

            Credential cred = new Credential("", "");
            
            HttpProfile httpProfile = new HttpProfile();
            httpProfile.setEndpoint("ms.tencentcloudapi.com");

            ClientProfile clientProfile = new ClientProfile();
            clientProfile.setHttpProfile(httpProfile);            
            
            MsClient client = new MsClient(cred, "", clientProfile);
            
            String params = "{}";
            CreateCosSecKeyInstanceRequest req = CreateCosSecKeyInstanceRequest.fromJsonString(params, CreateCosSecKeyInstanceRequest.class);
            
            CreateCosSecKeyInstanceResponse resp = client.CreateCosSecKeyInstance(req);
            
            System.out.println(CreateCosSecKeyInstanceRequest.toJsonString(resp));
        } catch (TencentCloudSDKException e) {
                System.out.println(e.toString());
        }

    }
    
}

想问一下，两种生成 COS 临时密钥的方式都是正确的吗？

我们服务器端当前代码使用的是上面示例代码的这种，然后前端计算 Authorization 上传文件总是返回 AccessDenied

Urgent notice！ 成功回调后，不能输出信息给前端

前提：我用的是egg.js框架
调用sdk成功回调后，不能正常输入内容给前端

这Java版本的sdk，呃

能不能严肃点啊，java版本的sdk完全就是一个demo啊。。。

gradle项目引入加载不到jar包

方便提供一份gradle引入jar包的示例么,修改仓库地址和引入相应的jar包均提示找不到jar包

获取临时KEY报签名错误

• 环境
  PHP ：7.2.4
  qcloud_sts/qcloud-sts-sdk：3.0.5

• 代码

use QCloud\COSSTS\Sts;

class CosUploadController extends Controller
{

    /**
     * 获取 COS 临时KEY
     *
     * @return \Illuminate\Http\JsonResponse
     * @throws \Exception
     *
     * @desc https://cloud.tencent.com/document/product/436/14048
     */
    public function tempKey()
    {
        $sts = new Sts();
        $config = [
            'url' => 'https://sts.tencentcloudapi.com/',
            'domain' => 'sts.tencentcloudapi.com',
            'proxy' => '',
            // 固定密钥
            'secretId' => config('cos.credentials.secretId'),
            // 固定密钥
            'secretKey' => config('cos.credentials.secretKey'),
            // 换成你的 bucket
            'bucket' => config('cos.credentials.bucket'),
            // 换成 bucket 所在园区
            'region' => config('cos.credentials.region'),
            // 密钥有效期
            'durationSeconds' => 1800,
            // 这里改成允许的路径前缀，可以根据自己网站的用户登录态判断允许上传的具体路径，例子： a.jpg 或者 a/* 或者 * (使用通配符*存在重大安全风险, 请谨慎评估使用)
            'allowPrefix' => '*',
            // 密钥的权限列表。简单上传和分片需要以下的权限，其他权限列表请看 https://cloud.tencent.com/document/product/436/31923
            'allowActions' => [
                // 简单上传
                'name/cos:PutObject',
                'name/cos:PostObject',
                // 分片上传
                'name/cos:InitiateMultipartUpload',
                'name/cos:ListMultipartUploads',
                'name/cos:ListParts',
                'name/cos:UploadPart',
                'name/cos:CompleteMultipartUpload'
            ]
        ];

        $tempKeys = $sts->getTempKeys(array_filter($config));

        $tempKeys['bucket'] = config('cos.credentials.bucket');
        $tempKeys['region'] = config('cos.credentials.region');

        return $this->success($tempKeys);
    }
}

• 响应内容

{
	"Error": {
		"Code": "AuthFailure.SignatureFailure",
		"Message": "The provided credentials could not be validated. Please check your signature is correct."
	},
	"RequestId": "af83286b-9c13-4c73-a62e-ba151b60ca5b"
}

soc-sts-java获取临时令牌失败

sdk使用3.0.8版本，参考官方Demo编写，日志报错如下

java.io.IOException: result = {"Response":{"Error":{"Code":"InvalidParameter.ResouceError","Message":"[QC_STS] resource error"},"RequestId":"90d7e639-4068-4735-8da3-beeef74cda27"}}
对比官网错误码描述，说是策略resource字段不合法。
然后我反复对照了官网针对resource的要求，完全符合规定啊，为何还是报错

java版本CosStsClient第96行resultJson.keySet()

提示java.lang.NoSuchMethodError: org.json.JSONObject.keySet()Ljava/util/Set;

sts.php 文件 在linux上会识别大小写 导致类找不到

文件名 sts.php 类名 STS 当使用 use QCloud\COSSTS\STS引入时 在mac和win上没问题 ，再linux上就会出现找不到类

能否设置将返回服务器时间作为签名的开始时间？

PHP包没有命名空间就算了，自动加载还是psr-0

"autoload": {
"psr-0": {
"php\": "sts/"
}
}

是否需要其他语言的 pr？

写了一个 elixir 的版本，我们公司生产环境有在使用，需要的话，我可以提交 pr 到这边，如果需要改动，可以提建议

scottming/qcloud_cos_sts
https://github.com/scottming/qcloud_cos_sts

获取 sts 一直报AuthFailure.SignatureFailure

The provided credentials could not be validated. Please check your signature is correct.

更改了demo的appid等配置信息，运行发现如下错误

panic: Code: AuthFailure.SignatureFailure, Message: The provided credentials could not be validated. Please check your signature is correct., RequestId: 976345b3-e9e9-4270-9ebf-b0d87adc16f2

sts_client_test.py request_sts()服务端报错

Hi，你好！测试python sdk 的demo中的sts_client_test.py request_sts()
服务端程序报错如下：
Exception: ("result: {u'RequestId': u'1167ba7c-f4e5-4b36-9bfe-80b3a64a86fa', u'Error': {u'Message': u'The provided credentials could not be validated. Please check your signature is correct.', u'Code': u'AuthFailure.SignatureFailure'}}", KeyError('ExpiredTime',))
服务端成secretkey和secretid都已换成自己申请的了。
request_sts2()是没有问题。服务器端修改方法和request_sts一致。
请问这是什么原因呢？

php获取临时密钥 AuthFailure.SignatureFailure

php 7.2.13

Fatal error: Uncaught Exception: {"Error":{"Code":"AuthFailure.SignatureFailure","Message":"The provided credentials could not be validated. Please check your signature is correct."},"RequestId":"9939e6a5-cc6e-41fe-a316-3fcf64771243"}

依照例程，只改了关键信息.

`<?php

require 'vendor/autoload.php';

use QCloud\COSSTS\Sts;

$sts = new Sts();
$config = array(
'url' => 'https://sts.tencentcloudapi.com/',
'domain' => 'sts.tencentcloudapi.com',
'proxy' => '',
'secretId' => getenv('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'), // 固定密钥
'secretKey' => getenv('xxxxxxxxxxxxxxxxxxxxxxxx'), // 固定密钥
'bucket' => 'xxxxxxxxxxxxxxxxx-1252375781', // 换成你的 bucket
'region' => 'ap-nanjing', // 换成 bucket 所在园区
'durationSeconds' => 1800, // 密钥有效期
'allowPrefix' => '*',
'allowActions' => array (
// 简单上传
'name/cos:PutObject',
'name/cos:PostObject',
// 分片上传
'name/cos:InitiateMultipartUpload',
'name/cos:ListMultipartUploads',
'name/cos:ListParts',
'name/cos:UploadPart',
'name/cos:CompleteMultipartUpload'
)
);
// 获取临时密钥，计算签名
$tempKeys = $sts->getTempKeys($config);
echo json_encode($tempKeys);`

糟糕的API设计

A non-numeric value encountered

我使用PHP版本为：PHP 7.3.11
当获取调用临时上传key时，出现A non-numeric value encountered 错误。需要将 sts.php 源码的 130行 ”$result = "error: " . + $e->getMessage();“ 中的加号去掉

这sdk设计的糟糕透了

这sdk设计的糟糕透了，内网简直不能用

SDK设计问题

Go语言SDK的Resource能解释一下吗？为什么别的语言版本都是allowPrefix，唯独Go语言不一样，而且还需要个appid？别的都不用的，能解释一下这个问题吗

dotnet 版SDK报资源错误

STSClient.cs文件中，在getPolicy 有一段代码：
foreach (string action in allowActions) {
Dictionary<string, string> dic = new Dictionary<string, string>();
dic.Add("action", action);
dic.Add("effect", "allow");

            string[] splitParts = bucket.Split('-');
            string appId = splitParts[splitParts.Length - 1];
            string bucketName = bucket.Substring(0, bucket.Length - appId.Length - 1);
            if (!allowPrefix.StartsWith("/")) {
                allowPrefix = "/" + allowPrefix;
            }
            dic.Add("resource", string.Format("qcs::cos:{0}:uid/{1}:{2}{3}",
                region, appId, bucketName, allowPrefix));
            states.Add(dic);
        }

bucketName 是截取掉ID之后的存储桶名称，测试生成凭证的时候会报错，实际上需要用到完整的存储桶名称，把代码
dic.Add("resource", string.Format("qcs::cos:{0}:uid/{1}:{2}{3}",
region, appId, bucketName, allowPrefix));
替换成:
dic.Add("resource", string.Format("qcs::cos:{0}:uid/{1}:{2}{3}",
region, appId, bucket, allowPrefix));
最后成功获取临时凭证。

是否支持.net framework 4.0及以下版本?

我们项目是.net framework 4.0版本，无法正常引入cos sdk。
web前端直传资源到腾讯云，需要后端产生临时credential，现在cos的sdk都无法正常引入。
请问有.net framework 4.0及以下版本的sdk吗？

cant grant other resource是什么原因导致的

InvalidParameter.GrantOtherResource

STS Class Not Found php composer版本sdk无法自动加载

PHP版本sdk 无法通过composer安装 自动加载的方式引入STS Class

php版本composer 没有qcloud

"qcloud": ">=5.3.0"

哎 这什么文档啊 简直服了

durationSeconds这个东西设置了一点用没有，？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？？

文档里写的getPolicy使用例子问题

实测getPolicy必须带bucket和region,但是带了那2属性出来的权限再计算出的临时授权给到前端,所有的接口都是403!
所以最好的办法就是别用getPolicy构造授权权限结构,自己手写!!!