PHP generiert die für die Tencent Cloud COS-Schnittstelle erforderliche Anforderungssignatur-PHP-Tutorial-php.cn

In diesem Artikel wird hauptsächlich die Anforderungssignatur vorgestellt, die zum Erstellen einer COS-Schnittstelle mit PHP erforderlich ist. Sie wird mit den in den offiziellen Dokumenten angegebenen Beispielen verglichen, um die Richtigkeit des Algorithmus zu überprüfen

Was sind COS und Anforderungssignaturen?

COS ist die Abkürzung für Tencent Cloud Object Storage. Anforderungssignaturen werden durch spezifische Algorithmen erstellt, die Dritte beim Aufruf von COS-bezogenen Schnittstellen auf Anfrage bereitstellen müssen . Eine Reihe von Zeichenfolgeninformationen, die die aktuelle Identität des Dritten eindeutig identifizieren und die Identifizierung beider kommunizierender Parteien ermöglichen. Nur gültige signierte COS stellen Dienste bereit

Ziel

Erstellen Sie mit PHP die für die COS-Schnittstelle erforderliche Anforderungssignatur, vergleichen Sie sie mit dem im offiziellen Dokument angegebenen Beispiel und überprüfen Sie die Richtigkeit des Algorithmus

Verstehen Sie die Anforderungssignatur

Kommen Sie zuerst. Schauen Sie sich die in einem offiziellen Dokument angegebene Anforderungssignatur an

q-sign-algorithm=sha1&q-ak=[SecretID]&q-sign-time=[SignTime]&q-key-time=[KeyTime]&q-header-list=[SignedHeaderList]&q-url-param-list=[SignedParameterList]&q-signature=[Signature]

Nach dem Login kopieren

Zusammenfassung der Merkmale der Anforderungssignatur

ist eine Zeichenfolge
Schlüssel=Wert-Schlüssel-Wert-Paarformat, Schlüssel ist ein fester Wert
Es gibt 7 Schlüssel=Wert-Paare
sha1 ist ebenfalls ein Parameter, aber seit der offiziellen Veröffentlichung wird nur sha1 unterstützt, sodass Sie Werte direkt zuweisen können
SignedHeaderList, SignedParameterList und Signatur. Die drei Werte müssen durch Algorithmen generiert werden.

Schlüsselwerte Eine detaillierte Beschreibung finden Sie in der offiziellen Dokumentation.

Nacheinander aufschlüsseln

Für die Anforderung einer Signatur sind insgesamt 7 Werte erforderlich. Nachfolgend wird jeder Wert einzeln aufgeschlüsselt.

Q-Sign-Algorithmus

Signaturalgorithmus, offiziell Derzeit wird nur sha1 unterstützt, also geben Sie den Wert einfach direkt an

q-ak

Die Konto-ID, die die SecretId des Benutzers ist, kann abgerufen werden auf der Cloud-API-Schlüsselseite der Konsole

q-sign-time

Die gültige Start- und Endzeit der aktuellen Signatur, Unix-Zeitstempelformat, englische Semikolon halber Breite, Format wie 1480932292;1481012298

q-key-time

Gleicher Wert wie q-sign-time

q-header-list

Persönliches Verständnis, es besteht Nehmen Sie bei HTTP-Anforderungsheadern alle oder einen Teil der Anforderungsheader und fordern Sie sie in der Form „key:value“ an. Der Schlüsselteil des Elements wird herausgenommen und in Kleinbuchstaben umgewandelt. Mehrere Schlüssel werden nach Wörterbuch sortiert und mit den Zeichen verbunden. um schließlich eine Zeichenfolge zu bilden

Der ursprüngliche Anforderungsheader hat beispielsweise zwei:

Host:bucket1-1254000000.cos.ap-beijing.myqcloud.com
Content-Type:image/jpeg

Nach dem Login kopieren

Schlüssel ist Host und Inhaltstyp, Ausgabeinhaltstyp nach Operation; >q-url-param-list

Persönliches Verständnis, es besteht aus HTTP-Anforderungsparametern, die alle oder einen Teil der Anforderungsparameter übernehmen und den Schlüsselteil des Anforderungsparameters in Form von =value übernehmen aus, in Kleinbuchstaben umgewandelt, werden mehrere Schlüssel nach dem Wörterbuch sortiert und mit den Zeichen verbunden, um schließlich einen String zu bilden

Die ursprüngliche HTTP-Anfrage lautet beispielsweise:

GET /?prefix=abc&max-keys=20

Nach dem Login kopieren

key Es handelt sich um prefix und max-keys. Wenn die Anfrage keine Parameter wie put und post enthält, ist sie leer >

Berechnet basierend auf der HTTP-Inhaltssignatur, der Algorithmus wird von COS bereitgestellt, geben Sie einfach den Wert nach Bedarf ein

Offizielles Beispiel und Referenzergebnis

Bevor Sie mit dem Schreiben der Logik beginnen, nehmen Sie zunächst eine Schauen Sie sich den im offiziellen Beispiel angegebenen Referenzwert und die berechnete Berechnung an. Das Endergebnis kann mit der von Ihnen selbst entwickelten Logik verglichen werden.

HTTP-Originalanforderung, die auch als HTTP-Anfrage vor der Berechnung der Signatur oder wann verstanden werden kann Es ist keine Signatur erforderlich:

PUT /testfile2 HTTP/1.1
Host: bucket1-1254000000.cos.ap-beijing.myqcloud.com
x-cos-content-sha1: 7b502c3a1f48c8609ae212cdfb639dee39673f5e
x-cos-storage-class: standard
Hello world

Nach dem Login kopieren

Nach der Berechnung der Signatur Die HTTP-Anfrage, die erhalten werden sollte:

PUT /testfile2 HTTP/1.1
Host: bucket1-1254000000.cos.ap-beijing.myqcloud.com
x-cos-content-sha1: 7b502c3a1f48c8609ae212cdfb639dee39673f5e
x-cos-storage-class: standard
Authorization: q-sign-algorithm=sha1&q-ak=AKIDQjz3ltompVjBni5LitkWHFlFpwkn9U5q&> q-sign-time=1417773892;1417853898&q-key-time=1417773892;1417853898&q-header-list=host;x-cos-content-sha1;x-cos-storage-class&q-url-param-list=&q-signature=14e6ebd7955b0c6da532151bf97045e2c5a64e10
Hello world

Nach dem Login kopieren

Schlussfolgerung: Der Algorithmus ist korrekt, wenn er die Zeichenfolge nach der Autorisierung erhalten kann

Vorbereitungsarbeiten

Lassen Sie uns einen Blick darauf werfen (offiziell bereitgestellt) Benutzerinformationen und HTTP-Informationen:

SecretId: AKIDQjz3ltompVjBni5LitkWHFlFpwkn9U5q

SecretKey: BQYIM75p8x0iWVFSIgqEKwFprpRSVHlz
Signatur gültige Startzeit: 1417773892
Signatur gültige Stoppzeit: 1417853898
HTTP-Originalanforderungsheader: Gemäß dem Beispiel im vorherigen Abschnitt ist es nicht schwierig, ihn zu erhalten. Die HTTP-Originalanforderung hat drei Inhalte: Host, x-cos-content-sha1 und x-cos-storage-class
HTTP-Anfrageparameter: Es handelt sich um eine PUT-Anfrage, es gibt keinen ?-Parameter
Signatur berechnen
Fügen Sie verschiedene Parameter in die Vorbereitungsarbeit ein Die Anforderungssignaturregeln befolgen, und Sie können die Ergebnisse einfach abrufen, wie in der folgenden Tabelle gezeigt:

但 q-signature 怎么来的？

刚才说到，q-signature 也需要特定算法计算得来，下面就说明如何计算

计算请求签名

先看代码：

/**
 * 计算签名
 * secretId、secretKey 为必需参数，qSignStart、qSignEnd为调试需要，测试通过后应取消，改为方法内自动创建
 */
function get_authorization( $secretId, $secretKey, $qSignStart, $qSignEnd, $fileUri, $headers ){
 /* 
 * 计算COS签名
 * 2018-05-17
 * author:cinlap <cash216@163>
 * ref:https://cloud.tencent.com/document/product/436/7778
 */

 $qSignTime = "$qSignStart;$qSignEnd"; //unix_timestamp;unix_timestamp
 $qKeyTime = $qSignTime;

 $header_list = get_q_header_list($headers);
 //如果 Uri 中带有 ?的请求参数，该处应为数组排序后的字符串组合
 $url_param_list = &#39;&#39;;

 //compute signature
 $httpMethod = &#39;put&#39;;
 $httpUri = $fileUri;

 //与 q-url-param-list 相同
 $httpParameters = $url_param_list;

 //将自定义请求头分解为 & 连接的字符串
 $headerString = get_http_header_string( $headers );

 // 计算签名中的 signature 部分
 $signTime = $qSignTime;
 $signKey = hash_hmac(&#39;sha1&#39;, $signTime, $secretKey);
 $httpString = "$httpMethod\n$httpUri\n$httpParameters\n$headerString\n";
 $sha1edHttpString = sha1($httpString);
 $stringToSign = "sha1\n$signTime\n$sha1edHttpString\n";
 $signature = hash_hmac(&#39;sha1&#39;, $stringToSign, $signKey);
 //组合结果
 $authorization = "q-sign-algorithm=sha1&q-ak=$secretId&q-sign-time=$qSignTime&q-key-time=$qKeyTime&q-header-list=$header_list&q-url-param-list=$url_param_list&q-signature=$signature";
 return $authorization;
}

Nach dem Login kopieren

为了测试，该方法参数应该是多过需要了，前六个参数是已经给出的，是来自用户的，因此直接赋值即可得到下边字符串：

$authorization = "q-sign-algorithm=sha1&q-ak=$secretId&q-sign-time=$qSignTime&q-key-time=$qKeyTime...

Nach dem Login kopieren

$header_list 这个值要符合 q-header-list 规则因此需要计算，逻辑是上文已经描述，是从既定的请求项中抽出 key 组成有序字符串，代码如下：

/**
 * 按COS要求对header_list内容进行转换
 * 提取所有key
 * 字典排序
 * key转换为小写
 * 多对key=value之间用连接符连接
 * 
 */
function get_q_header_list($headers){
 if(!is_array($headers)){
  return false;
 }

 try{
  $tmpArray = array();
  foreach( $headers as $key=>$value){
   array_push($tmpArray, strtolower($key));
  }
  sort($tmpArray);
  return implode(&#39;;&#39;, $tmpArray);
 }
 catch(Exception $error){
  return false;
 }
}

Nach dem Login kopieren

$url-param-list 上面讲过，这个值是HTTP请求参数，对于 PUT 方法没有 ? 参数，自然值为空，所以代码中“偷懒”直接给了空字符串。

Signature 的计算和需要小心的地方

官方已经给出了完整的算法，PHP 甚至还有写好的代码，应该是很幸福了（但！由于看官方文档看的头晕还是踩了坑，随后一起说明），先看一下 signature 的“格式”：

SignKey = HMAC-SHA1(SecretKey,"[q-key-time]")
HttpString = [HttpMethod]\n[HttpURI]\n[HttpParameters]\n[HttpHeaders]\n
StringToSign = [q-sign-algorithm]\n[q-sign-time]\nSHA1-HASH(HttpString)\n
Signature = HMAC-SHA1(SignKey,StringToSign)

Nach dem Login kopieren

再看一下 Signature 的完整算法：

$signTime = $qSignTime;
$signKey = hash_hmac(&#39;sha1&#39;, $signTime, $secretKey);
$httpString = "$httpMethod\n$httpUri\n$httpParameters\n$headerString\n";
$sha1edHttpString = sha1($httpString);
$stringToSign = "sha1\n$signTime\n$sha1edHttpString\n";
$signature = hash_hmac(&#39;sha1&#39;, $stringToSign, $signKey);

Nach dem Login kopieren

$signTime：很简单，起止时间组成的字符串，从上文拿来直接用
$signKey：HMAC-SHA1 算法直接计算即可
$httpString：四个部分组成需要分开说
1、$httpMethod：HTTP请求方法，小写，比如 put、get
2、$httpUri：HTTP请求的URI部分，从“/”虚拟根开始，如 /testfile 说明在存储桶根目录下创建一个叫 testfile 的文件，/image/face1.jpg 说明在根目录/image目录下建立一个叫 face1.jpg 的文件，至于是不是图片文件，不管
3、$httpParameters：这是第一个需要小心的地方。由HTTP原始请求参数组成，即请求 URI 中 ? 后面的部分，本例调用的是 PUT Object 接口，因此为空。如果不为空，需要把请求参数每一项的 key 和 value 均转换小写，多对 key=value 按字典排序并以 & 相连接
4、$headerString：这是第二个需要小心的地方，由 HTTP 原始请求头组成，根据请求头，选择全部或部分请求头，把每项的key都转换为小写，把value都进行URLEncode转换，每项格式都改为key=value，然后按照key进行字典排序，最后把它们用连接符 & 组成字符串。这是我整理的逻辑，代码如下：

/**
 * 按COS要求从数组中获取 Signature 中 [HttpString] 内容
 * 标准格式 key=value&key=value&... 
 * 数组元素按键字典排序 * 
 * key转换为小写
 * value进行UrlEncode转换
 * 转换为key=value格式
 * 多对key=value之间用连接符连接
 * 
 */
function get_http_header_string($headers){
 if(!is_array($headers)){
  return false;
 }

 try{
  $tmpArray = array();
  foreach($headers as $key => $value){
   $tmpKey = strtolower($key);
   $tmpArray[$tmpKey] = urlencode($value);
  }
  ksort($tmpArray);
  $headerArray = array();
  foreach( $tmpArray as $key => $value){
   array_push($headerArray, "$key=$value");
  }
  return implode(&#39;&&#39;, $headerArray);
 }
 catch(Exception $error){
  return false;
 }
}

Nach dem Login kopieren

为什么要小心？

HTTP原始请求头和请求参数用在了四个地方，分别是请求签名里的 q-header-list 和 Signature 里的 HttpHeaders——两者都用到了HTTP原始请求头；请求签名里的 q-url-param-list 和 Signature 里的 HttpParameters——两者都用到了HTTP请求参数。一定要保证HTTP请求头和请求参数所选用的数量和对象一致

相同：生成 q-header-list 的HTTP请求头数量和成员要和生成 HttpHeaders 的相同，生成 q-url-param-list 的HTTP请求参数数量和成员要和生成 HttpParameters 的相同
不同：q-header-list 和 q-url-param-list 只取 key 部分，HttpHeaders 和 HttpParameters 取 key 和 value 部分

输出结果和校验

至此，请求签名中7个值都有了，有的是来自用户信息，有的需要计算，需要计算的上面也给出了所有的计算方法和为什么如此计算的个人理解。最后只需要按照官方要求进行输出即可。看一下

Das obige ist der detaillierte Inhalt vonPHP generiert die für die Tencent Cloud COS-Schnittstelle erforderliche Anforderungssignatur. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!