Pythonで書かれたLINE Ads APIのサンプルコードをGAS(JavaScript)に翻訳したい

Question

解決したいこと

LINE広告APIドキュメントにてPythonで書かれているサンプルコードを、GAS(JavaScript)で書き直して使いたい

開発の背景

• LINE広告のパフォーマンスレポートをスプレッドシートに自動で書き出したい
• 他プラットフォーム（GoogleやYahoo!）の広告データ抽出も行っていることもあり、GASで書きたい

発生しているエラー

{"errors":[{"reason":"Unauthorized","message":"JWT signature does not match locally computed signature. JWT validity cannot be asserted and should not be trusted."}]}

「JWT署名がローカルで計算された署名と一致しません。 JWTが有効である確証がないため、信頼すべきではありません」とのこと。

今動かしているソースコード

ドキュメントのPythonのコードを見て、自力でGASに翻訳してみたものが以下です。
サンプルコードは GET /v3/groups/{groupId}/children を使っていたので、 GET /v3/adaccounts/{adaccountId}/campaigns に変えています。

function importAdsReport() {
  const today = new Date();
  const access_key = "xxxxxxxxxxxx";
  const secretKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
  const accountId = "xxxxxxxxxxx";

  const header = `{"alg": "HS256", "kid": "${access_key}", "typ": "text/plain"}`;

  const hex_digest = sha256("");
  const content_type = "";
  const payload_date = Utilities.formatDate(today, 'GMT', 'yyyyMMdd');
  const canonical_url = `/api/v3/adaccounts/${accountId}/campaigns`;
  const payload = `${hex_digest}\n${content_type}\n${payload_date}\n${canonical_url}`;

  const inputValue = `${base64(header)}.${base64(payload)}`;
  const signature = hmacSha256(inputValue, secretKey);
  const calculatedSignature = `${inputValue}.${signature}`;

  const request_headers = {
    "Date": Utilities.formatDate(today, 'GMT', 'E, dd MMM yyyy HH:mm:ss z'),
    "Authorization": `Bearer ${calculatedSignature}`
  }

  const options = {
    "method": "GET",
    "headers": request_headers,
    "muteHttpExceptions": true
  };

  const response = UrlFetchApp.fetch('https://ads.line.me' + canonical_url, options);
}

/**
 * base64エンコード
 * @param {string} input - エンコードしたい文字列
 * @return {string} - base64エンコードされた文字列
 */
function base64(input) {
  return Utilities.base64Encode(input, Utilities.Charset.UTF_8)
}

/**
 * HMAC SHA 256でハッシュ化
 * @param {string} text - ハッシュ化する文字列
 * @param {string} key - ハッシュ化するシークレットキー
 * @return {string} - ハッシュ値
 */
function hmacSha256(text, key) {
  const rowHash = Utilities.computeHmacSignature(Utilities.MacAlgorithm.HMAC_SHA_256, text, key);
  let txtHash = '';
  for (i = 0; i < rowHash.length; i++) {
    let hashVal = rowHash[i];
    if (hashVal < 0) {
      hashVal += 256;
    }
    if (hashVal.toString(16).length == 1) {
      txtHash += '0';
    }
    txtHash += hashVal.toString(16);
  }
  return txtHash;
};

/**
 * SHA 256でハッシュ化
 * @param {string} input - ハッシュ化する文字列
 * @return {string} - ハッシュ値
 */
function sha256(input) {
  const rawHash = Utilities.computeDigest(Utilities.DigestAlgorithm.SHA_256, input, Utilities.Charset.UTF_8);
  let txtHash = '';
  for (i = 0; i < rawHash.length; i++) {
    let hashVal = rawHash[i];
    if (hashVal < 0) {
      hashVal += 256;
    }
    if (hashVal.toString(16).length == 1) {
      txtHash += '0';
    }
    txtHash += hashVal.toString(16);
  }
  return txtHash
}

エラーの原因っぽいところ

signature が間違っているんだろうと思っています。
HTTPリクエストに渡す calculatedSignature は inputValue と signatureから成っているのですが、 inputValue はPythonで生成したものと一致していました。

Pythonのサンプルコードで

signature = hmac.new(
        secret_key.encode(),
        signing_input.encode(),
        hashlib.sha256
    ).digest()

のように書かれているところを、GASで

const signature = hmacSha256(inputValue, secretKey);

としているのですが、このhmacSha256()がよくないのかなと...。

今試していること

「要するにHS256形式での電子署名生成をGAS(JavaScript)でできればいいのでは」と思い、それらしき記事を見てみたりしているのですが、結局同じエラーが返ってきてしまっています…。

誤っている箇所がお分かりになる方いらっしゃいましたら、ご指摘いただけるととてもありがたいです…。

Answer 1

下記ではいかがでしょうか。

function importAdsReport() {
  const today = new Date();
  const access_key = "xxxxxxxxxxxx";
  const secretKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
  const accountId = "xxxxxxxxxxx";

  const header = `{"alg":"HS256","kid":"${access_key}","typ":"text/plain"}`;

  const hex_digest = sha256("");
  const content_type = "";
  const payload_date = Utilities.formatDate(today, 'GMT', 'yyyyMMdd');
  const canonical_url = `/api/v3/adaccounts/${accountId}/campaigns`;
  const payload = `${hex_digest}\n${content_type}\n${payload_date}\n${canonical_url}`;

  const inputValue = `${base64(header)}.${base64(payload)}`;
  const signature = hmacSha256(inputValue, secretKey);
  const calculatedSignature = `${inputValue}.${signature}`;

  const request_headers = {
    "Date": Utilities.formatDate(today, 'GMT', 'E, dd MMM yyyy HH:mm:ss z'),
    "Authorization": `Bearer ${calculatedSignature}`
  }

  const options = {
    "method": "GET",
    "headers": request_headers,
    "muteHttpExceptions": true
  };

  const response = UrlFetchApp.fetch('https://ads.line.me' + canonical_url, options);
}

/**
 * base64エンコード
 * @param {string} input - エンコードしたい文字列
 * @return {string} - base64エンコードされた文字列
 */
function base64(input) {
  return Utilities.base64Encode(input, Utilities.Charset.UTF_8)
}

/**
 * HMAC SHA 256でハッシュ化
 * @param {string} text - ハッシュ化する文字列
 * @param {string} key - ハッシュ化するシークレットキー
 * @return {string} - ハッシュ値
 */
function hmacSha256(text, key) {
  const rowHash = Utilities.computeHmacSignature(Utilities.MacAlgorithm.HMAC_SHA_256, text, key);
  return Utilities.base64Encode(rowHash);
};

/**
 * SHA 256でハッシュ化
 * @param {string} input - ハッシュ化する文字列
 * @return {string} - ハッシュ値
 */
function sha256(input) {
  const rawHash = Utilities.computeDigest(Utilities.DigestAlgorithm.SHA_256, input, Utilities.Charset.UTF_8);
  let txtHash = '';
  for (i = 0; i < rawHash.length; i++) {
    let hashVal = rawHash[i];
    if (hashVal < 0) {
      hashVal += 256;
    }
    if (hashVal.toString(16).length == 1) {
      txtHash += '0';
    }
    txtHash += hashVal.toString(16);
  }
  return txtHash
}

---

変えたところ

• header の半角スペースを削除（こちらは関係ないかもしれません。ただドキュメントのサンプルは、JSON文字列の半角スペースが削除された文字列をBASE64エンコードしたものになっていました。）

-  const header = `{"alg": "HS256",  "kid": "${access_key}", "typ": "text/plain"}`;
+  const header = `{"alg":"HS256","kid":"${access_key}","typ":"text/plain"}`;

　

• hmacSha256 関数 → バイト列をBASE64エンコードしたものを返すように修正。

こちらは、途中途中で GAS のデバッグ出力と、サンプルの python コードでのデバッグ出力とを比較して検証してみました。

    signature = hmac.new(
        secret_key.encode(),
        signing_input.encode(),
        hashlib.sha256
    ).digest()   # ---(1)
    encoded_signature = encode_with_base64(signature)   # ---(2)
    token = "%s.%s.%s" % (jws_header, jws_payload, encoded_signature)   # ---(3)

(1) は Utilities.computeHmacSignature(Utilities.MacAlgorithm.HMAC_SHA_256, text, key);　の結果に一致しています。
また(3)は、質問者さんのGASコードを最初から読んでいくと、

  const calculatedSignature = `${inputValue}.${signature}`;

に該当しています。

inputValue は 前2つ（jws_header, jws_payload）をピリオドで連結した文字列に一致しています。

したがって calculatedSignature の後ろ部分に連結している signature は、pythonサンプルコードの encoded_signature [=上記 (２) の行] に該当することになるので、
上記のように、

function hmacSha256(text, key) {
  const rowHash = Utilities.computeHmacSignature(Utilities.MacAlgorithm.HMAC_SHA_256, text, key);
  return Utilities.base64Encode(rowHash);
};

というコードにすればよいのではないでしょうか。

つまり元の GAS コードでは、HMAC_SHA_256 で得られたバイト列を Hex 文字列に変えていますが、そうではなくて、得られたバイト列を BASE64 エンコードするのが正解かと思います。

Comments

[退会済みユーザー]

ご回答いただきありがとうございます...！
早速試してみましたところ、以下のようなエラーが返ってきています。

Exception: The parameters (Utilities.MacAlgorithm,String,number[]) don't match the method signature for Utilities.computeHmacSignature.

第三引数で使っているsecretKeyの形式がよくないのでしょうか...？

[退会済みユーザー]

修正しました。

[退会済みユーザー]

ご指摘いただいた箇所を修正し、正しく動きました！！！
感動しています...ご丁寧な解説までありがとうございます...！！
Pythonコードの意味も理解しながら、GASへの変換ができた気がします。
ほんとうにありがとうございました。

[退会済みユーザー]

解決してよかったです。御自分でここまで翻訳されたのはすごいと思いました。

[退会済みユーザー]

度々のメッセージですみません...。
こちらでいただいたご回答を参考に、おかげさまで次のステップへ進めているのですが、再び次のステップでもつまづいてしまっている箇所がありまして。。。
もし読んでいただけるお時間がありましたら、以下で投稿させていただきましたので、アドバイスいただけますととても幸いです...どうぞよろしくお願いいたします...。
https://teratail.com/questions/7te4auy5i4q1m6