KDOC 721: S3 の署名付きURLでタグがクエリパラメータで渡せることは明記されていない

S3 のアップロード用に署名付きURLを AWS SDK for JavaScript v3 で生成する機会があった。オブジェクトにタグをつける必要があったので、 getSignedUrl に渡す PutObjectCommand の Tagging にタグを指定した。生成したURLのクエリパラメータにタグ(x-amz-tagging)が含まれていて、そのURLでアップロードするとタグが付与された状態でオブジェクトをアップロードできた。

https://example.s3.ap-northeast-1.amazonaws.com/file.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential={cred}%2F20260101%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260101T000000Z&X-Amz-Expires=600&X-Amz-Signature={sig}&X-Amz-SignedHeaders=host&x-amz-checksum-crc32=AAAAAA%3D%3D&x-amz-sdk-checksum-algorithm=CRC32&x-amz-tagging=key%3Dvalue&x-id=PutObject

クエリパラメータでタグを受け付けるのは S3 の仕様だと考えていたが、調べても S3 のドキュメントに記載を見つけられなかった。タグは x-amz-tagging リクエストヘッダで指定すると書いてある(PutObject、オブジェクトのタグ付け)。署名付きURLの説明でも、 x-amz-* はヘッダとして署名に含めるものとして書かれていて、クエリパラメータで渡せるとは書かれていない(Authenticating Requests: Using Query Parameters)。

JavaScript の SDK は署名付きURLを作るとき、 x-amz- で始まるヘッダを原則クエリパラメータに移す(moveHeadersToQuery)。S3 はそれを受け付けてタグを付けたが、その動きは S3 の仕様としてドキュメントに明記されていない。

https://github.com/smithy-lang/smithy-typescript/blob/67b94cc461a7fea6a4ffe1e4b03a54841af39c21/packages/signature-v4/src/moveHeadersToQuery.ts#L8-L30

export const moveHeadersToQuery = (
  request: IHttpRequest,
  options: { unhoistableHeaders?: Set<string>; hoistableHeaders?: Set<string> } = {}
): IHttpRequest & { query: QueryParameterBag } => {
  const { headers, query = {} as QueryParameterBag } = HttpRequest.clone(request);
  for (const name in headers) {
    if (!hasOwn(headers, name)) continue;
    const lname = name.toLowerCase();
    if (
      (lname.slice(0, 6) === "x-amz-" && !options.unhoistableHeaders?.has(lname)) ||
      options.hoistableHeaders?.has(lname)
    ) {
      query[name] = headers[name];
      delete headers[name];
    }
  }

  return {
    ...request,
    headers,
    query,
  };
};

KDOC 721: S3 の署名付きURLでタグがクエリパラメータで渡せることは明記されていない

この文書のステータス

概要

関連