2021年2月11日

M5CORE2を元に戻したい

さて、前回はM5CORE2に適当なプログラムを焼いて、再起動を繰り返す状態になった。
元に戻したいです……

さっき気付いたのだが、Core2の名称は"M5CORE2"なのかな。

まあ、買ったときのケースにはM5STACKと書いてあったし、発売元のシールにもM5Stack CORE2と書いてあるから、略称なのかもしれん。


まず、M5StackのダウンロードページからM5Burnerというアプリをダウンロードする。
私はWindows環境なのでWindows版をダウンロードした。

https://m5stack.com/pages/download

zipファイルの中にexeファイルがあったので起動する。

起動するとネットに接続して、焼けそうなファームウェアの一覧が出てくる。
もしファイアウォールの設定をしたりして起動時に接続できないと一覧が出てこないので注意だ。

一覧のどこかにCre2FactoryTestというやつがあるので、それをダウンロードして焼けば良い。
もしM5Stackを

image

画像ではBurnボタンだが、最初はDownloadなのだ。ダウンロードしてBurnすると元に戻った。

もう怖くない!

M5Stack Core2

 

image

M5Stack Core2 IoT開発キット - スイッチサイエンス
https://www.switch-science.com/catalog/6530/

 

M5Stack Core2を購入した。

このM5Stackだが、シリーズがたくさんある。
今回も最初はM5Stack Fireというものを買うつもりだったのだが、どこかの記事で、今はCore2だ、というようなのを見かけた気がするのでこちらを選んだのだ。PSRAMが載っていれば良かったので、Core2でもよいのだ。

 

届いたCore2の電源を入れて出てきたのが写真の画面だ。
音センサが付いているようで、FFTしてるのかどうかは知らんが音を拾ってグラフがリアルタイムで動いていた。ESP32ってそのくらいの性能はあるんだねぇ。
立方体が描かれていたので、何軸か分からないけど加速度センサも載っているのだろう。

そして何より、この価格でタッチパネル式のカラー液晶画面が付いているということに驚きを隠せない。


さて、ハードウェアはともかく、ソフト屋さんとして気になるのは開発環境だ。

M5Stack Docs - The reference docs for M5Stack products.
https://docs.m5stack.com/#/en/core/core2

ここには、UIFlow, MicroPython, Arduinoとなっている。

  • UIFlow: ブラウザベースのブロック形ビジュアルプログラミング開発環境
  • MicryPython: 組み込み向けPython
  • Arduino: あのArduino

うーん、ESP8266のようにC言語でやれんのだろうか。Arduinoがあるから、そこから直接APIをたたけるようになってるのかな?

M5Stack Core2 SDK でメガドライブエミュレーターをビルドする | hiromasa.another :o)
https://another.maple4ever.net/archives/2881/

できることはできるようだ。

 

今回やろうとしているのはGitHubで公開されていたもので、どうもM5Stack FIREを想定しているようだった。esp-idfなんて文字も出てくるから、たぶんいけるだろう。まあ、センサの類は使えないかもしれないが、M5Stackは有名どころだしサポートしてくれていることを期待しよう。

 

Get Started - ESP32 - — ESP-IDF Programming Guide v4.2 documentation
https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/get-started/index.html

私はWindows使いなのだが、ここではVirtualBox上に作っているLubuntu環境を使う。
Windowsでの開発環境も用意されているのだけど、やっぱり手になじむ方が安心なのだ。

gitでv4.2を取ってくる。。。835MBもある。過去はいらないから--depth 1にすると・・・変わらん。
どうもsubmoduleで取ってきているようで、そっちには--depthが反映されないようなのだ。

--single-branchを追加すると・・・741MB。
--shallow-submodulesも追加して・・・446MB。

git clone -b v4.2 --depth 1 --single-branch --recursive --shallow-submodules https://github.com/espressif/esp-idf.git

ありがとう、この記事を書いた人!

[Git] とにかく速く特定のブランチをgit cloneしたい場合のTips - Qiita
https://qiita.com/koara-local/items/8b90162637593456433b

で、次はinstall.shを実行するのだが、pipでエラーになった。というかインストールされていなかった。。
どうも私の環境はpython 2.7がインストールされているようなので、"sudo apt install python-pip"でよかろう。

その後はかなり進んだのだが、またエラーになった。
"ERROR: Could not find a version that satisfies the requirement bidict>=0.21.0"とか言われるんだけど、

https://github.com/espressif/esp-idf/issues/6262

requirements.txtに追加すれば良いそうだが、python2がデフォルトである理由もないので、そっちを変更しよう。

$ sudo update-alternatives --config python
There is only one alternative in link group python (providing /usr/bin/python): /usr/bin/python3
Nothing to configure.
update-alternatives: warning: forcing reinstallation of alternative /usr/bin/python3 because link group python is broken

? 壊れているのか??
再設定がいるようだが、 /usr/bin/python3があって、そいつはpython3.6のシンボリックリンクらしい。

$ sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.6 1
$ sudo update-alternatives --config python
There are 2 choices for the alternative python (providing /usr/bin/python).

  Selection    Path                Priority   Status
------------------------------------------------------------
* 0            /usr/bin/python3     10        auto mode
  1            /usr/bin/python3     10        manual mode
  2            /usr/bin/python3.6   1         manual mode

急に増えやがった。。。
消そう。

$ sudo update-alternatives --remove python /usr/bin/python3.6
$ sudo update-alternatives --config python
There is only one alternative in link group python (providing /usr/bin/python): /usr/bin/python3
Nothing to configure.

$ python -V
Python 3.6.9

古いが、まあいいや。
python3にすると、終わった。

". ./export.sh"と出てくるので、環境変数の読込はexport.shを使うのだろう。
いつも思うが、なんでsourceコマンドと.が同じなんだろうね。

あとはチュートリアル通り、hello_worldをコピーして、idf.pyでesp32に設定してmenuconfigする。
make menuconfigでも画面は出たのだが、きっと何か前処理をしてから行ったりしているのだろう。

image

何を設定すればよいのかわからん・・・・。

Serial flasher config: Flash sizeを16MBにする
Component config -> ESP32-specific
  CPU frequencyを240MHzにする
  Support for external, SPI-connected RAMを有効にする
    SPI RAM configは何を選べばよいの?

Linuxのカーネルだと、targetファイルみたいなのを指定するとそのターゲットデフォルトの設定にできていたように思うのだが、そういうしくみは無いのだろうか? M5StackのGitHubを見てもArduinoライブラリが並んでいるだけのようだ。

こちらの方はCore2用のテンプレートを用意されている。
GitHubにTemplateなんて分類があるのか・・・。

M5Stack Core2 SDK でメガドライブエミュレーターをビルドする | hiromasa.another :o)
https://another.maple4ever.net/archives/2881/

これを使うかどうかは別として、Core2向けの環境を作るということについての情報が役立つ。そして読んでいくほどに、これを自分でやるのはつらいというのがわかってくる。
しかし、今回使いたいesp-idfのバージョンが指定されてて、4.2なのだ。
うーむ……


あ、これはCore2 for AWS用みたいだけど、idf.pyを使ってる。

https://github.com/m5stack/Core2-for-AWS-IoT-EduKit

こちらの紹介を読んだが、Core2にセキュアエレメントが載ったセットのようだ(あと黄色い)から、なんとかなるんじゃないだろうか。

git clone --depth 1 https://github.com/m5stack/Core2-for-AWS-IoT-EduKit.git
cd Core2-for-AWS-IoT-EduKit/Hardware-Features-Demo
idf.py menuconfig
idf.py build

esp-idf v4.2でビルドできた。
さて、焼くか。

Windowsのデバイスマネージャでは、こう見えている。
今回はVirtualBoxから焼くので、VirtualBoxのデバイス設定で指定する。

image

dmesgで見ると/dev/ttyUSB0となっていた。

idf.py -p /dev/ttyUSB0 flash

はい、Permission deniedで失敗! いつも通りですな。
sudoするとexport.shで設定したものが見えないから、アクセス権を追加した。

[小ネタ]Ubuntu でttyUSB0(USBシリアル変換)が権限関連で使えない場合の対処方法 - Qiita
https://qiita.com/chromabox/items/b3ceaab6efa6edde2bda

さて、これでPermission deniedは解消したのだが、接続に失敗する。
タイムアウトしているのだが、それが終わるとCore2本体も再起動しているから、まったく分かっていないわけでもなさそうだ。
connecting中にCore2のリセットボタンを押してみたら進んだのだが、うちのノートPCはUSBの接続が甘いので、ちょうど接続がよくなっただけかもしれん。

 

ともかく、焼けた!
そして、なんか画面に出てきた!
そしてそして、再起動を繰り返すようになった……

まあ、セキュアエレメントのチップが載っていないから、そのアクセスに失敗したからだろう。

なんとなくいけそうな気がするので、このままがんばってみよう。

2021年2月7日

私はHTTPをよく知らない

「自分、組み込み屋ですので」でネットワークのことから逃げられる時代はもう終わった・・・。
いや、ずいぶん前に終わっていたのだが、認める勇気がなかったのだろう。

ネットワークは、socketを開いてlistenさせ、相手側はconnectすればあとはプロトコルで勝手にやればよい、くらいの知識で十分だったのだが、もうちょっと上の方も知らないと話に追いつけないのだ。

MQTTは実装したことがあるので調べ直せば思い出しそうだが、やはりHTTPをスルーはできまい。
というわけで、今回はHTTPについてさらっとまとめよう。


HTTPといえば、やはりブラウザだろう。
昔はMosaicというブラウザがあってね、SunのSS10で見せてもらったことが記憶に残っているよ。

HyperText Transfer Protocolの略で、HTTP。

https://ja.wikipedia.org/wiki/Hypertext_Transfer_Protocol
https://tools.ietf.org/html/rfc2616
https://developer.mozilla.org/ja/docs/Web/HTTP/Overview

3番目に載せたMozillaの説明がわかりやすそうだ。

  • クライアント・サーバプロトコル
  • クライアントのメッセージ:リクエスト
  • サーバのメッセージ:レスポンス
  • 直接クライアントとサーバが接続することもあるし、間にプロシキが挟まることもある。
  • プロトコルとしてはリクエスト間に関係性は無い(ステートレス)。ただCookieによってセッションという概念を持ち込むことはできる。

 

クライアントとサーバのフローはそれぞれメッセージを投げるだけなので、あとはメッセージの仕様を確認すればなんとなくHTTPがわかったと思ってよいのでは無かろうか。

HTTPメッセージ
https://developer.mozilla.org/ja/docs/Web/HTTP/Overview#http_messages

 

リンク先の画像ではちょっと分かりづらいかもしれんが、1行目はこう。

Method + (space) + Path + (space) + Version of the protocol

Pathは、たとえばcurlコマンドで "curl http://127.0.0.1/time" とアクセスしたとすると、

GET /time HTTP/1.1

となった。


むかし組み込みのHTTPサーバをデバッグしたこともあるし、デバッグ用にHTTPサーバをPocoライブラリ使って作業したことがあるのだが、暗号の処理と同じ感じ匂いがしている。
危ないので自分で実装するものじゃ無いよね、というやつだ。

ただ、自分で実装しない=自分で知っておく必要はない、ではないのだ。まあ万人が知っておく必要があるというものでもないとは思うが、知っていると楽しいと思うのだよ。

2021年1月23日

Pi Pico

2021年になって何の記事を書こうかと悩んでいたところ、こういう情報を見つけた。

Raspberry Pi財団が550円の「Raspberry Pi Pico」発表、日本でもスイッチサイエンスが発売 | TechCrunch Japan
https://jp.techcrunch.com/2021/01/21/raspberry-pi-pico-raspberry-silicon/

Raspberry Piの系統と言うことはArmだろうけど、550円ってことはCortex-Aは難しいだろうな・・・と思ったら、M0+であった。

基板を見た感じでは、小さく整列したようなチップがなさそうだから、無線は使えないのだろう。無線があるんだったらスイッチサイエンスさんも発売に時間かかるだろうし。

本家はこちらか。

Meet Raspberry Silicon: Raspberry Pi Pico now on sale at $4 - Raspberry Pi
https://www.raspberrypi.org/blog/raspberry-pi-silicon-pico-now-on-sale/

やはり無線ものはなさそうだ。

 

USBでFLASHが焼けるとなると、これMbedじゃないの?と思ったのだけど、そういう単語はコメントにしか出てきてない。ということは違うのだろう。
まあ、Mbed enabledにもできるのかもしれんが、この情報では分からんな。

 

Raspberry Piは教育用(現実がどうかはさておき)だったと思っていたのだが、これも教育用なのだろうか。Arduinoなどと分野が重なるので、ちょっと不思議な気がしたのだ。「our first microcontroller-class product」とあるから、ラインナップとして必要と感じたのかもしれない。あるいはRaspberry Piの冠で市場を奪えるという目算が取れたのか。

 

そういうのはさておき、M0+の133MHzで、RAMも264KBというのはなかなかのスペックだ。特にRAMね。
サイプレスさんのFAQにM0とM0+の違いが載っていた。

Cortex-M0 と Cortex-M0+ - Community Translated (JA) - Cypress Developer Community
https://community.cypress.com/t5/Knowledge-Base-Articles/Cortex-M0-%E3%81%A8-Cortex-M0-Community-Translated-JA/ta-p/256652

パイプラインが3段から2段になると性能が落ちるような気がしたのだが、M0クラスだとそんなにパイプラインがあってもねぇ、ということなのだろうか。

 

CortexのM4はほとんど触っていないのだが、最初に出たM3やM0には良い印象を持っている。というよりも、それ以前の8bitや16bitのCPUの置き換えになってありがたいというのが正直なところだ。とにかく、デフォルトで32bitという安心感がある。intが32bitなのだ。私も実装するまで全然気に留めていなかったのだけど、意外と16bit CPUだと無意識のうちに範囲を超えてしまっていたりしたのだ。

ああ、理解不足だと笑いたければ笑うがよい。だが、こういう感覚でうまくいっているときもあるので、なかなか馬鹿にはできないのだ。まあ、失敗することもあるんだけど、そういうのはテストで、ね。

ともかく、最近は組み込みっぽいことをやってないので、こういうニュースに触れるのはうれしいところだ。

2020年12月6日

[js]Buffer.from()に'hex'を使えるが0xはいらない

いらないというか、付けたらいかん、という話だ。
JavaScriptとしたが、Node.jsだけの話かもしれん(違いがよくわからん)。

 

ハッシュ関数にBufferを引数に使うものがあった。

最初は文字列のハッシュを取っていたのだが、16進数のハッシュを取りたくなった。
あれこれ調べていたのだが、Buffer.from()の第2引数にencodingで'hex'とすればよさそうだ。
かんたんかんたん。

 

と思ったのだが、なんかハッシュ値がサンプルと違う結果になった。
Bufferがおかしい?

01: const value = '0x0000000000000000000000000000000000000000000000000000000000000000';
02: console.log(Buffer.from(value, 'hex'))

$ node buf.js
<Buffer >

あれ?

01: const value = '0000000000000000000000000000000000000000000000000000000000000000';
02: console.log(Buffer.from(value, 'hex'))

$ node buf.js
<Buffer 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00>

 

あー、第1引数を"0x"で始めてしまうと16進数ではない文字列ということでエラーにもならず処理してしまうのね・・・。

 

いくつか試してみたが、こんな感じだ。

"123" → 12
"1234jk56" → 12 34
"1y34" → (無し)

雰囲気だけでいえば、こうだ。

  • 先頭から偶数文字数で16進数文字列(0-9, A-F, a-f)だけ処理する
  • 文字列の途中で16進数文字列以外が現れたら、それより前の文字列を有効とする
    • それによって奇数文字数になるなら切り捨てる
  • エラーは出さない

 

Node.jsにも、その辺りのルールは書いてなかったのだが、共通仕様なのだろうか。

Buffer | Node.js v15.3.0 Documentation
https://nodejs.org/api/buffer.html#buffer_static_method_buffer_from_string_encoding

慎重にやるなら第1引数が16進数文字列かつ偶数であることをチェックするのだろうけど、JavaScript界隈の人なら格好良く処理できるのかもしれん。

2020年11月15日

[node]バイナリをHEX形式でconsole.logする

まだまだ初心者の域を出ない・・・というか、出るつもりがあまりなさそうなNode.js。
なんとなく書いて、なんとなく動いてしまうので、もういいんじゃないか、と思ってしまってね・・・。
それに、困ったらCやgolangで書きゃいいんじゃないの、と割り切ってしまっているのも原因だろう。
そもそも、必要がない限りNode.js使ってないし。

 

というわけで、今回はバイナリをHEX文字列でダンプしたいことについてだ。
Pythonのときもいろいろやったのだが、文字列ではないデータを扱うことが多いので、16進数を16進数のままコンソールに出力する手段がほしいのだ。


最初に出てきたのが、Bufferを使うやり方。

01: const data = "abc\x12\x34\x56def";
02: const dbuf = Buffer.from(data);
03: console.log(dbuf.toString("hex"));

$ node xx.js
616263123456646566

デバッグのためにBufferオブジェクトを作るのは嫌なのだが、デバッグと割り切ってしまえば良かろう。
デバッグ用の関数にしてしまうとかすれば心も痛むまい。

 

次に、文字列を1つ1つ16進数文字列に置き換える方式を考えたのだけど、こうなった。

01: const data = "abc\x12\x34\x56def";
02: for (let lp = 0; lp < data.length; lp++) {
03:     process.stdout.write(data.charCodeAt(lp).toString(16));
04: }
05: console.log();

$ node xx.js
616263123456646566

これのテストで「data.charCodeAt(lp)」をprocess.stdout.write()で出力させようとしていて、ずっとエラーになっていてね・・・。
consol.log()だと出力されるということに気付くのにかなり時間がかかった。
文字化けしたら考えよう、というやり方はよくないのだろう。

 

けど、「変なデータでも何でもいいから出力しやがれ」とは思ってしまうのだ。
それで動いてしまうと危険だから、ということなんだろうから、まあ文化の違いだろうね。

2020年11月4日

[vbox]おそるべしネステッド

数日前、WSL2とVirtualBoxを両方動かすためにネステッドなんとかをオフにした。

これはオンに戻した後の設定だが、この2つ。

image

image

 

ネステッドVT-x/AMD-Vを無効にすると両方とも無効になる。

で、その状態でゲストOS(ホストはWindows10で、ゲストはLubuntu18.04)を起動したのだが、どうにも遅い。
動いている間は気にならないのだが、起動するまでがとても遅い。

ただ、いつも立ち上がるまで他のことをしているので、ネステッドは関係ないかもしれない。

 

というわけで、目視で計測した。

  • ネステッドを両方オフ:2分くらい
  • ネステッドを両方オン:40秒くらい

うん、ここまで違うとは思わんかったよ。

 

ネステッドを一度オフにすると、GUIからはオンにできないようだ。
コンソールからできる。
Windowsだとパスも通ってるし、管理者権限とかもいらん。

virtualization - Virtualbox enable nested vtx/amd-v greyed out - Stack Overflow
https://stackoverflow.com/questions/54251855/virtualbox-enable-nested-vtx-amd-v-greyed-out

2020年11月3日

WSL2とVirtualBox 6.1.16(11月あたま)

前回、WSL2とVirtualBoxを試して失敗した。

hiro99ma blog: [wsl]何も考えずにWSL2にしたらVirtualBoxが起動しなくなった
https://hiro99ma.blogspot.com/2020/08/wslwsl2virtualbox.html

あれから2ヶ月ちょっと経ったが、どうなっただろうか?
失敗しても問題ない環境があったので、そこで試そう。

 

image

image

まず、「Windowsの機能の有効化または無効化」

  • Linux用Windowsサブシステム
  • Windowsハイパーバイザープラットフォーム

 

再起動して、まずWSL2をインストールする前にVirtualBoxのゲストOSを起動させる。
・・・エラーダイアログは表示されないが、起動の途中で止まったままになってしまった。

 

ネステッドページングをオフにしたら起動した。
前回もそうだったが、ネステッドVT-x/AMD-Vを有効化しないようになったおかげかもしれない。

そして、立ち上がりはするのだが、ゲストOSの動作が遅く感じる。
気のせいだろうか・・・。


元に戻す気がするので、ベンチマークを測っておこう。
そういえばLinuxでベンチマーク計測を行おうとするのは初めてだな。

CPUやメモリなどのシステム性能を比較するベンチマークツール | さくらのナレッジ
https://knowledge.sakura.ad.jp/1048/

こちらで、UnixBenchというものが紹介されていた。

https://github.com/kdlucas/byte-unixbench

cloneして、cdして、makeしたら"./Run"を走らせるだけで自動的にテストが開始される。

テストしたまま忘れて数時間放置していたが、最後は1218.8というスコアが出ていた。

 

次は、WindowsハイパーバイザープラットフォームだけをOFFにして、ゲストOSのネステッドVT-x/AMD-Vを有効化し、ネステッドページングも有効にした。

OFFにしても再起動を促されなかったが、ゲストOSを起動すると怒られた。
再起動すると起動できたので、まあよかろう。

今度のスコアは1278.4だった。
約60上がったのだが、これは有意な差なのだろうか?

正直なところ、このくらいだとよくわからんな・・・。

[node]base64urlのデコード

データで、base64urlでエンコードされている項目があった。

base64は、主にバイナリを文字列に置き換えたいときに使うものだ。
8bitの3バイトデータを、6bitの4バイトデータにする。同じ24bitだから。
6bitは64個なので、64個の文字列に当てはめる。A~Zとa~zで52個、0~9で10個。あと2個は”+”と”/”。

base64urlは、”+”と”/”を、”-“と”_”にしただけのものだ。
base64も最初からそうしておけば・・・と思わなくもないが、まあ時代的に仕方なかろう。

 

最初、base64urlというライブラリを使っていた。

https://www.npmjs.com/package/base64url

でも、なんか結果がおかしい(使い方が悪かっただけなのだが、このときはわからなかった)。

自信がないので、普通のbase64デコード方法で試そうとBufferを使うことにした。

https://nodejs.org/api/buffer.html#buffer_static_method_buffer_from_string_encoding

Buffer.from()にエンコードとして”base64”を指定すると、うまいことやってくれる。
固定文字列だったので、自分で”-“や”_”を置き換え、4文字ごとになっていなかったので”=”を追加。
そうすると、ちゃんと期待した値になった。

せっかくなので、base64urlの文字列でどういう例外が出るのかを確認しようとしたのだが・・・エラーにならない。
変な値になるわけでもなく、ちゃんとデコードできている。
あれ、そういうものなの??

仕様としてできるのか、偶然できただけなのか、APIの説明では分からんな。。。

 

ちなみに、base64urlライブラリでもちゃんとできた。

Buffer.from(base64url.decode(“base64url文字列”))

のようにやっていたのだが、

base64url.toBuffer(“base64url文字列”)

だけでよかった。

でも、

Buffer.from(“base64url文字列”, "base64")

だけで済むのなら、それに越したことはないな。

 

GitHubを検索したら、base64はURLやファイル名で安全な文字列もいけるようなことが書いてあった。

https://github.com/nodejs/node/pull/5243/files

creatingとかencodingしか書いてないけど、decodeもいけるよね・・・?

探しづらいのだが、Node.jsのページだとここら辺だ。

https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings

 

'base64': Base64 encoding. When creating a Buffer from a string, this encoding will also correctly accept "URL and Filename Safe Alphabet" as specified in RFC 4648, Section 5. Whitespace characters such as spaces, tabs, and new lines contained within the base64-encoded string are ignored.

ここのencodingは、エンコード・デコードの方じゃなくて、いわゆるエンコーディングだろう(そのまんまだが)。
それに、リンクが載っているRFC-4648 section5の表には"-"と"_"の方も載っているから、心配しなくても大丈夫だろう。

2020年11月1日

JWT

JWTという形式のデータが現れた。
現れたといっても、仕事の中で言葉が出てきたというだけだが。

JWTのJはJSONのJ、ということがわかって満足していたのだが、どうもちゃんと調べないとダメらしい。
ちっ。


JSON Web Tokenの略で、JWT。

JSON Web Tokens - jwt.io
https://jwt.io/

RFC 7519にもなっているので、私が知らなかっただけで巷では有名なのかもしれん。
AbstractだけDeepLで翻訳しておこう。

JSON Web Token (JWT) は、2 つの当事者間で転送されるクレームを表現するためのコンパクトで URL 安全な手段です。JWTのクレームは、JSON Web Signature(JWS)構造体のペイロードとして、またはJSON Web Encryption(JWE)構造体の平文として使用されるJSONオブジェクトとしてエンコードされ、クレームがデジタル署名されるか、メッセージ認証コード(MAC)で保護されるか、および/または暗号化されることを可能にする。

クレームというと、お店に文句を付けるというネガティブなイメージになるのだが、”claim”という単語としては「主張、要求、権利、資格」のようなもので、苦情っぽい要素はない。
和製英語だったら別に構わないのだけど、日本語で使うときに意味が変わるというのは止めてほしいな・・・。

 

JSON-RPCのリクエストみたいな使い方をするのだろうか?
使い道は後で調べるとして、まずは文法というかフォーマットを知っておきたい。


RFCは長いのでまだ読みたくない・・・ので、導入のドキュメントを見ておく。
無料のEBOOKもあるようなのだが、メールアドレスだけじゃなくてCompanyとかの入力もあったので、面倒なのでやめた。

JSON Web Token Introduction - jwt.io
https://jwt.io/introduction/

Introductionでは署名するタイプのJWTに焦点を当てるそうだ。まあ、単にJSONをJWTのフォーマットにするだけだとありがたみがあまり無いのだろう。

JWTの使いどころは、AuthorizationとInformation Exchange。承認と情報交換。
他にもあるのだろうけど、まあよかろう。

 

そしてフォーマット。

<Header>.<Payload>.<Signature>と、3つの部分をドットで区切ってあるそうだ。

Header

Base64Urlでエンコードされる。
エンコードするのはJSONデータで、JSONのところは署名アルゴリズムとトークンのタイプを載せる想定のようだ。他にitemがあってもよいのだろうが、”alg”と”typ”はたぶん必須だ。

”typ”は”JWT”でよいとして、”alg”は何が使えるかというと、RFC-7518の3.1章にJWSの”alg”ヘッダパラメータの一覧があった。
サンプルは“HS256”となっているが、これはHMAC SHA-256のことのようだ。

https://www.rfc-editor.org/rfc/rfc7518.html#section-3.1

 

そういえばHMACのしくみをよく知らない。
いつも使う署名といえば、署名する人が秘密鍵を持っていて、データをSHA256のようなハッシュ関数でハッシュ値を求め、それに対して署名計算している。データ長を気にせず署名できる計算があるのかどうか知らないが、私が知っているタイプはデータ長が決まっているので事前にハッシュ計算してデータ長を整えるのだ。

 

HMACの場合は共通鍵のようだ。
じゃあ、JWTというかJWSというか、署名がついてHMACの場合には事前に鍵を決めるというシーケンスがいるのだろうか?
それはそれで面倒だ。

ただ、署名は無視することもできる。
送っている方が「俺だよ、おれおれ」っていう証明を付けてきて、確かに俺さんの秘密鍵を持っていないと作ることが難しいデータを付加しているだけなので、その人が受信した人が思っている俺さんかどうかわからないし、そのデータが正常かどうかなどというのはさらに関係が無い。

“HS256”だけはRequiredなので、これだけはどの環境でも使えないとRFC-7518を名乗ることができないはずだ。

 

Payload

ここにはclaimが入っている。claimには3タイプある。

  • Registered claims
  • Public claims
  • Private claims

PayloadもBase64Urlでエンコードされている。

 

 

Signature

HeaderとPayloadをまとめて署名する。
HMAC-SHA256の例が載っているのがわかりやすかろう。

HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret)

かなり省略した。。。すまぬ。
HMACのときにどうやって署名検証するかが気になって、残りがどうでも良くなってきたのだ。

JSON Web Token(JWT)の紹介とYahoo! JAPANにおけるJWTの活用 - Yahoo! JAPAN Tech Blog
https://techblog.yahoo.co.jp/advent-calendar-2017/jwt/

ここを読むと、”kid”というところで公開鍵を参照したりするそうだ。
しかし、HMACって共通鍵だから・・・?

 

まあ、今回は概要を知りたかっただけなので、これでよしとしよう。
あとは会社で詳しい人に聞くとするかね。