普段業務外では LINE 株式会社 (以下 LINE 社) が提供する LINE というメッセンジャーアプリ上でやり取りをすることが多いので, そのインタフェース上で色々と動かせたりするとそれなりに便利かもと最近思い始めた. そこで, 筆者の考える基本的な機能を備えた LINE Bot を一旦作ってみることとした. 本エントリはその備忘録である. 下記のリポジトリに成果物を公開している.

基本構成

今回は個人利用/小規模であり特別な費用を発生させたくなかったので, Oracle Cloud Infrastructure (以下 OCI) の Always Free 枠である Ubuntu インスタンス上にサーバを構成した¹. 同インスタンス上では Jitsi Meet² という別のウェブサービスを nginx を用いて運用していたので, それをそのままリバースプロキシとしても利用し, Bot サーバへの通信を HTTPS 化した. これらはサブドメインに従ってリクエストを振り分けているが, それぞれの SSL 証明書を作成するのは手間がかかるので, 今回は (let’s encrypt の) ワイルドカード証明書で管理することとした. ドメイン管理には Google Domains を使っているが, TXT レコードを随時更新する API が用意されておらず, 現状手動更新が必須となっている. これは追々なんとかしたい³.

LINE Bot の実装

LINE Bot を実装するにあたって, 特徴的ないくつかのトピックについて取り上げる.

$ line-bot-kiirotori --help
Usage: line-bot-kiirotori [--version] [-c|--config <config file path>] 
                          [-s|--cron-schedule <cron-schedule file path>] 
                          [-q|--quiet] COMMAND
  line-bot-kiirotori

Available options:
  -h,--help                Show this help text
  --version                Prints the line-bot-kiirotori suite version
  -q,--quiet               Quiet log output

Available commands:
  serve                    boot server
$ line-bot-kiirotori --version
　　　　 Ｖ
　　 ／￣￣￣＼　/|
　　 　●＿＿●  Ｖ |     __   _ _            __             _
　 ｜　 (･＿･)　 ノ    / /__(_|_)________  / /_____  _____(_)
　 /　　 ヽノ　 ｜    / //_/ / / ___/ __ \/ __/ __ \/ ___/ /
　(_ノ　　　　　ﾉ    / ,< / / / /  / /_/ / /_/ /_/ / /  / /
　　＼＿＿＿＿／    /_/|_/_/_/_/   \____/\__/\____/_/  /_/
　　　 ｜　｜
　　　 个　个


version: 0.1.0.0
built commit hash: 6efc35754150917de47bdf5ef3a56e4d81322098

チャネルアクセストークン v2.1 の発行と管理

LINE Bot を作成するのには LINE 社の提供する Messaging API を利用する. LINE Messaging API を利用したボットは, LINE プラットフォームから送信される Webhook イベントに対して LINE プラットフォームへ応答する必要がある.

この LINE プラットフォーム間のやりとりでは, 通信している相手がサービスの利用権限を持つ本人であることを証明するために, LINE 社の提供するチャネルアクセストークンを用いた認証プロセスを経る. チャネルアクセストークンには, 任意の有効期限が指定できるチャネルアクセストークン v2.1, 短期のチャネルアクセストークン, 長期のチャネルアクセストークンという 3 つの種類がある. これらの中でも LINE 社はチャネルアクセストークン v2.1 を推奨しており, その特徴として発行に JSON Web Token (以下 JWT) 使用し, 期限を任意 (最大 30 日) に指定できる点が挙げられる. 今回は個人利用ではあるものの, 期限を良い感じに短くしたアクセストークンを使って無駄にセキュリティを強化したいところであったので, チャネルアクセストークン v2.1 を使用することとした⁴.

チャネルアクセストークン v2.1 の発行方法/概要はドキュメントを参照頂くとして, まずは Haskell での JWT の生成例から順に示す. Haskell で行う場合, jose パッケージを利用すると楽である. ドキュメントの要請するオブジェクトに従うと, ヘッダーとペイロードは, 例えば以下のように定義できる.

これとアサーション署名キー⁵の秘密鍵を使って署名してやれば, JWT が出来上がる.

指定のエンドポイントへ 生成した JWT を使って以下のようなリクエストを投げれば, チャネルアクセストークンが発行される.

レスポンスには発行されたチャネルアクセストークンの他にキー ID や有効期限が切れるまでの秒数等が含まれている. 本実装においては, 予め有効期限を時刻に変換したりキー ID を含めたり等して Redis に保存するようにしている. アクセストークンを使用する際は, 有効なアクセストークンが保管できている場合そのキーを流用し, そうでなければ再度取得する. 概ね, ドキュメント記載の下図の構造となっている.

生のリクエストボディを Servant で扱う

リクエストが LINE プラットフォームから送信されたことを検証するためには, チャネルシークレットを秘密鍵とした HMAC-SHA256 アルゴリズムによるリクエストボディのダイジェスト値を Base64 エンコードした値と, リクエストヘッダーに含まれる x-line-signature の値を比較する⁶. 今回 Bot の WEB API 開発に servant というライブラリを用いているが, 便利なことに API の定義で ReqBody '[JSON] B.ByteString とすると, データ型に落とし込まれた状態でリクエストボディを扱うことができる. しかし, 今回のように生のリクエストボディを扱いたい場合は余計なお世話であったので, 以下のように生のリクエストボディを扱うための型を新たに定義して使用した.

SO に同様の Q.A. があるがこの回答には具体的な実装例が記載されていなかったので, 上述のとおり記載することとした.

起動と停止の制御

ボットの動作は下記のように systemd ユニットとして管理することとした.

nginx の再起動や sites-available, sites-enable への一連の処理も含めてしまうことでサービスとしての管理を簡素なものとして完結させることができる. 欲をいうと, LINE Developers コンソールの Webhook 設定画面では Webhook 利用のオン/オフを切り替えることができるようになっているが, 例えばこれに対する WEB API でもあれば, 起動時に API を叩いてオン, 停止時に API を叩いてオフというふうにしたかったところであるが, 現状 LINE 社はこれに対する API 提供しているか, 定かでなかった.

LINE Messagin API, Webhook URL を設定する API はあるんだけど, Webhook の有効/無効を切り替える API はないのかな

— Roki (@530506) December 25, 2021

簡易認証

LINE 公式アカウントのアカウント種別に記載があるように, 未認証アカウントは LINE アプリ内の検索結果に露出されることはない. 従って, 認証しない限り勝手に検索された上で使われるといったことは起こらない. しかし, 同じグループ内に所属して友達追加し, 他のグループに招待するといった使い方で他ユーザが勝手に使用することはできてしまう. よって, 特定グループ内のみで使用できるよう制限するためには何らかの認証の仕組みが必要である. これに伴い, 今回は 1 対 1 のトークルーム, グループ, ルーム ($\fallingdotseq$ グループ⁷) のいずれにおいてもまず第一に認証に成功しなければボットの全ての機能を利用できない仕組みをつくった. といってもその仕組みは一定間隔でランダムに文字列を生成, redis に書き込み, その文字列と合致するか否かで認証判定するという非常に簡素なものである. 以下にその認証文字列の生成機構の部分を抜粋して記載する.

この仕組み上 redis が動いているホストに SSH 接続できなければ生成されるランダム文字列を取得できないので, ボット機能の使用可否は SSH 認証が担保することとなる.

指定時間実行

指定時間に決まったプッシュメッセージを送りたいといったことは割とあるので, それを実現する機能についても実装してみた. 実行内容は, 下記のように crontab の亜種のような形式でファイルに記載して定義する.

この定義には crontab のように変数を使用することもできる. 実装は, cron パッケージにより提供されているパーサと, パーサコンビネータの組み合わせにより成っている.

結

基盤作りはできたので, 追って色々と Bot として便利そうな機能を追加していきたい.