com.qcloud.cos.auth.COSSigner Maven / Gradle / Ivy
/*
* Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
* According to cos feature, we modify some class，comment, field name, etc.
*/
package com.qcloud.cos.auth;
import static com.qcloud.cos.auth.COSSignerConstants.LINE_SEPARATOR;
import static com.qcloud.cos.auth.COSSignerConstants.Q_AK;
import static com.qcloud.cos.auth.COSSignerConstants.Q_HEADER_LIST;
import static com.qcloud.cos.auth.COSSignerConstants.Q_KEY_TIME;
import static com.qcloud.cos.auth.COSSignerConstants.Q_SIGNATURE;
import static com.qcloud.cos.auth.COSSignerConstants.Q_SIGN_ALGORITHM_KEY;
import static com.qcloud.cos.auth.COSSignerConstants.Q_SIGN_ALGORITHM_VALUE;
import static com.qcloud.cos.auth.COSSignerConstants.Q_SIGN_TIME;
import static com.qcloud.cos.auth.COSSignerConstants.Q_URL_PARAM_LIST;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TreeMap;
import com.qcloud.cos.Headers;
import com.qcloud.cos.exception.CosClientException;
import com.qcloud.cos.http.CosHttpRequest;
import com.qcloud.cos.http.HttpMethodName;
import com.qcloud.cos.internal.CosServiceRequest;
import com.qcloud.cos.utils.UrlEncoderUtils;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.codec.digest.HmacUtils;
public class COSSigner {
private static Set needSignedHeaderSet = new HashSet<>();
private Boolean isCIWorkflowRequest = false;
// Time offset between local and server
private int localTimeDelta = 0;
static {
needSignedHeaderSet.add("cache-control");
needSignedHeaderSet.add("content-disposition");
needSignedHeaderSet.add("content-encoding");
needSignedHeaderSet.add("content-length");
needSignedHeaderSet.add("content-md5");
needSignedHeaderSet.add("content-type");
needSignedHeaderSet.add("expect");
needSignedHeaderSet.add("expires");
needSignedHeaderSet.add("host");
needSignedHeaderSet.add("if-match");
needSignedHeaderSet.add("if-modified-since");
needSignedHeaderSet.add("if-none-match");
needSignedHeaderSet.add("if-unmodified-since");
needSignedHeaderSet.add("origin");
needSignedHeaderSet.add("range");
needSignedHeaderSet.add("transfer-encoding");
needSignedHeaderSet.add(Headers.PIC_OPERATIONS.toLowerCase());
}
private boolean isAnonymous(COSCredentials cred) {
return cred instanceof AnonymousCOSCredentials;
}
public void sign(CosHttpRequest request, COSCredentials cred, Date expiredTime) {
if (isAnonymous(cred)) {
return;
}
String authoriationStr =
buildAuthorizationStr(request.getHttpMethod(), request.getResourcePath(),
request.getHeaders(), request.getParameters(), cred, expiredTime, true);
request.addHeader(Headers.COS_AUTHORIZATION, authoriationStr);
if (cred instanceof COSSessionCredentials) {
request.addHeader(Headers.SECURITY_TOKEN,
((COSSessionCredentials) cred).getSessionToken());
}
}
public String buildPostObjectSignature(String secretKey, String keyTime, String policy) {
String signKey = HmacUtils.hmacSha1Hex(secretKey, keyTime);
String stringToSign = DigestUtils.sha1Hex(policy);
return HmacUtils.hmacSha1Hex(signKey, stringToSign);
}
public String buildAuthorizationStr(HttpMethodName methodName, String resouce_path,
COSCredentials cred,
Date expiredTime) {
Date startTime = new Date();
return buildAuthorizationStr(methodName, resouce_path, new HashMap<>(), new HashMap<>(), cred, startTime, expiredTime, true);
}
public String buildAuthorizationStr(HttpMethodName methodName, String resouce_path,
Map headerMap, Map paramMap, COSCredentials cred,
Date expiredTime) {
Date startTime = new Date();
return buildAuthorizationStr(methodName, resouce_path, headerMap, paramMap,
cred, startTime, expiredTime,true);
}
public String buildAuthorizationStr(HttpMethodName methodName, String resouce_path,
Map headerMap, Map paramMap, COSCredentials cred,
Date expiredTime, Boolean signHost) {
Date startTime = new Date();
return buildAuthorizationStr(methodName, resouce_path, headerMap, paramMap,
cred, startTime, expiredTime, signHost);
}
public String buildAuthorizationStr(HttpMethodName methodName, String resouce_path,
Map headerMap, Map paramMap, COSCredentials cred,
Date startTime, Date expiredTime, Boolean signHost) {
if (isAnonymous(cred)) {
return null;
}
//万象工作流接口会出现uri带问号的情况 例如 /workflow/xxxxxx?active 这种情况?后面的参数不参与鉴权
if (isCIWorkflowRequest){
resouce_path = resouce_path.split("\\?")[0];
}
Map signHeaders = buildSignHeaders(headerMap, signHost);
// 签名中的参数和http 头部 都要进行字符串排序
//对请求中的参数和http头部进行处理：对key先urlencode再小写处理，对value进行urlencode处理;
//生成 key 到 value 的映射 Map,根据key按照字典序排序
TreeMap encodedSortedSignHeaders = buildEncodeSortedMemberMap(signHeaders);
TreeMap encodedSortedParams = buildEncodeSortedMemberMap(paramMap);
//生成keylist
String qHeaderListStr = buildSignMemberStr(encodedSortedSignHeaders);
String qUrlParamListStr = buildSignMemberStr(encodedSortedParams);
String qKeyTimeStr, qSignTimeStr;
qKeyTimeStr = qSignTimeStr = buildTimeStr(startTime, expiredTime);
String signKey = HmacUtils.hmacSha1Hex(cred.getCOSSecretKey(), qKeyTimeStr);
String formatMethod = methodName.toString().toLowerCase();
String formatUri = resouce_path;
String formatParameters = formatMapToStr(encodedSortedParams);
String formatHeaders = formatMapToStr(encodedSortedSignHeaders);
String formatStr = new StringBuilder().append(formatMethod).append(LINE_SEPARATOR)
.append(formatUri).append(LINE_SEPARATOR).append(formatParameters)
.append(LINE_SEPARATOR).append(formatHeaders).append(LINE_SEPARATOR).toString();
String hashFormatStr = DigestUtils.sha1Hex(formatStr);
String stringToSign = new StringBuilder().append(Q_SIGN_ALGORITHM_VALUE)
.append(LINE_SEPARATOR).append(qSignTimeStr).append(LINE_SEPARATOR)
.append(hashFormatStr).append(LINE_SEPARATOR).toString();
String signature = HmacUtils.hmacSha1Hex(signKey, stringToSign);
String authoriationStr = new StringBuilder().append(Q_SIGN_ALGORITHM_KEY).append("=")
.append(Q_SIGN_ALGORITHM_VALUE).append("&").append(Q_AK).append("=")
.append(cred.getCOSAccessKeyId()).append("&").append(Q_SIGN_TIME).append("=")
.append(qSignTimeStr).append("&").append(Q_KEY_TIME).append("=").append(qKeyTimeStr)
.append("&").append(Q_HEADER_LIST).append("=").append(qHeaderListStr).append("&")
.append(Q_URL_PARAM_LIST).append("=").append(qUrlParamListStr).append("&")
.append(Q_SIGNATURE).append("=").append(signature).toString();
return authoriationStr;
}
public boolean needSignedHeader(String header) {
return needSignedHeaderSet.contains(header) || header.startsWith("x-cos-");
}
private Map buildSignHeaders(Map originHeaders, Boolean signHost) {
Boolean hasHost = false;
Map signHeaders = new HashMap<>();
for (Entry headerEntry : originHeaders.entrySet()) {
String key = headerEntry.getKey().toLowerCase();
if (key.equals("host")) {
hasHost = true;
}
if(needSignedHeader(key)) {
String value = headerEntry.getValue();
signHeaders.put(key, value);
}
}
if (!hasHost && signHost) {
String msg = String.format("buildAuthorization missing header: host. %s", originHeaders);
throw new CosClientException(msg);
}
return signHeaders;
}
private TreeMap buildEncodeSortedMemberMap(Map signElements){
TreeMap encodeSortedSignElements = new TreeMap<>();
for (Entry header : signElements.entrySet()) {
if (header.getKey() == null) {
continue;
}
String encodeLowerKey = UrlEncoderUtils.encode(header.getKey().trim()).toLowerCase();
String value = "";
if (header.getValue()!=null){
value = header.getValue().trim();
}
String encodeValue = UrlEncoderUtils.encode(value);
encodeSortedSignElements.put(encodeLowerKey, encodeValue);
}
return encodeSortedSignElements;
}
private String buildSignMemberStr(Map signHeaders) {
StringBuilder strBuilder = new StringBuilder();
boolean seenOne = false;
for (String key : signHeaders.keySet()) {
if (!seenOne) {
seenOne = true;
} else {
strBuilder.append(";");
}
strBuilder.append(key);
}
return strBuilder.toString();
}
private String formatMapToStr(Map kVMap) {
StringBuilder strBuilder = new StringBuilder();
boolean seeOne = false;
for (Entry entry : kVMap.entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
if (!seeOne) {
seeOne = true;
} else {
strBuilder.append("&");
}
strBuilder.append(key).append("=").append(value);
}
return strBuilder.toString();
}
private String buildTimeStr(Date startTime, Date endTime) {
StringBuilder strBuilder = new StringBuilder();
long startTimestamp = startTime.getTime() / 1000 + localTimeDelta;
long endTimestamp = endTime.getTime() / 1000 + localTimeDelta;
strBuilder.append(startTimestamp).append(";").append(endTimestamp);
return strBuilder.toString();
}
public static Set getNeedSignedHeaderSet() {
return needSignedHeaderSet;
}
public static void setNeedSignedHeaderSet(Set needSignedHeaderSet) {
COSSigner.needSignedHeaderSet = needSignedHeaderSet;
}
public void setCIWorkflowRequest(Boolean CIRequest) {
isCIWorkflowRequest = CIRequest;
}
public int getLocalTimeDelta() {
return localTimeDelta;
}
public void setLocalTimeDelta(int localTimeDelta) {
this.localTimeDelta = localTimeDelta;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy