Soracom

soratun がサポートする 3 種類のブートストラップ方法 のうち、Krypton の「Endorse による SIM 認証」を使用する方法 を説明します。soratun について詳しくは、soratun の概要と機能 を参照してください。

この方法では、IoT SIM に保管された認証情報を使用するため、ほかのブートストラップ方法と比べて、以下の特徴があります。

• soratun で SORACOM API の認証キーを使用してバーチャル SIM/Subscriber をブートストラップする とは異なり、デバイスに認証情報を入力する操作は必要ありません。
• soratun でセルラー回線認証を使用してバーチャル SIM/Subscriber をブートストラップする方法 とは異なり、ブートストラップのために、SORACOM Air for セルラーで SORACOM に接続する必要はありません。
• ブートストラップに使用した IoT SIM に、セカンダリサブスクリプションとしてバーチャル SIM/Subscriber が追加されます。

ステップ 1: SORACOM Krypton を有効化する

準備した IoT SIM に対して、Krypton を有効化します。詳しくは、SORACOM Krypton を有効化する を参照してください。

ステップ 2: SORACOM Air メタデータサービスを有効化する

準備した IoT SIM に対して、メタデータサービスを有効化します。詳しくは、メタデータサービスを設定する を参照してください。

ステップ 3: デバイスにパッケージをインストールする

IoT SIM に保管された認証情報を読み取るために、必要なパッケージをデバイス (例: Raspberry Pi OS Bookworm) にインストールします。

1. デバイスにログインします。

2. 必要なパッケージをインストールして、デバイスを再起動します。

   $ sudo apt install -y libpcsclite-dev pcscd libpcsclite1 cu
   

ステップ 4: SORACOM Krypton client (Golang version) をインストールする

IoT SIM に保管された認証情報を読み取るために、SORACOM Krypton client (Golang version) (以下、Krypton CLI) をデバイスにインストールします。

1. デバイスにログインします。

2. Krypton CLI を公開する GitHub レポジトリ の Releases ページ から、SORACOM Arc のブートストラップをサポートする v0.3.0 以降のファイルをダウンロードします。

   利用するプラットフォームにあわせたファイルをダウンロードしてください。たとえば、Raspberry Pi OS Bookworm (32 bit) の場合は krypton-cli_x.x.x_linux_arm.tar.gz、Raspberry Pi OS Bookworm (64 bit) の場合は krypton-cli_x.x.x_linux_arm64.tar.gz です。

   コマンド例:

   $ wget https://github.com/soracom/krypton-client-go/releases/download/vx.x.x/krypton-cli_x.x.x_linux_yyyyy.tar.gz
   

   ダウンロードするための URL (上記のコマンドの場合は wget のあとに指定する URL) は、リンクを右クリックして [リンクのコピー] を選択すると取得できます

   

3. ダウンロードしたファイルを展開し、実行形式ファイル krypton-cli を任意のディレクトリにコピーします。

   $ tar xvf krypton-cli_x.x.x_linux_yyyyy.tar.gz
   $ sudo cp krypton-cli /usr/local/bin
   

4. krypton-cli が実行できることを確認します。

   $ krypton-cli -h
   

   Usage of krypton-cli:
       -baud-rate uint
           Baud rate for communication device (e.g. -b 57600) (default 57600)
       -clear-key-cache
           Remove all items in the key cache
       -data-bits uint
           Data bits for communication device (e.g. -s 8) (default 8)
       :
   

   以上で、krypton-cli のインストールは完了です。

$ krypton-cli -h

-bash: /usr/local/bin/krypton-cli: cannot execute binary file: Exec format error

$ go install github.com/soracom/krypton-client-go/cmd/krypton-cli@latest

ステップ 5: Soracom Onyx - LTE™ USB ドングル (SC-QGLC4-C1) を取り付けて機内モードを有効化する

IoT SIM を取り付けた USB ドングルをデバイスに取り付ける

USB ドングルに IoT SIM を取り付けてから、デバイスに接続します。詳しくは、Soracom Onyx - LTE™ USB ドングルをセットアップする を参照してください。

$ sudo ifdown wwan0
$ ping -c 4 pong.soracom.io # SORACOM から応答が返ってこないことを確認

$ sudo ifconfig wwan0 down
$ ping -c 4 pong.soracom.io # SORACOM から応答が返ってこないことを確認

USB ドングルの機内モードを有効化する

1. デバイスで AT コマンドを実行できる状態にします。

   Raspberry Pi (Raspberry Pi OS) で USB ドングルを利用する場合は、cu コマンドを利用できます。詳しくは、AT コマンドを実行する を参照してください。

2. ATE1 コマンドと、AT+CFUN=4 コマンドを実行して、機内モードを有効化します。

   ATE1
   

   OK
   

   AT+CFUN=4
   

   OK
   

   はじめて入力するときは、ATE1 は表示されません。

3. AT コマンドを実行できる状態を終了します。

   たとえば、cu コマンドを利用していた場合は、Enter キーを押してから ~. を入力します。

ステップ 6: Krypton CLI で IoT SIM のメタデータを取得できることを確認する

以下のコマンドを実行して、imsi などが取得できることを確認します。

$ krypton-cli -operation getSubscriberMetadata

{
  "imsi": "295051234567890",
  "msisdn": "423612345678",
  "ipAddress": null,
  "operatorId": "OP1234567890",
  "apn": "soracom.io",
  "type": "s1.4xfast",
  "groupId": "12345678-abcd-1234-abcd-123456789010",
  "createdAt": 1640962800000,
  "lastModifiedAt": 1643641200000,
    :
}

ステップ 7: ブートストラップする

Krypton CLI で IoT SIM のメタデータを取得できたら、ブートストラップします。

1. Krypton の「Endorse による SIM 認証」を使用する方式でブートストラップします。

   --config フラグのあとに指定する soratun 設定ファイルのパス (/path/to/arc.json) は、任意のパスを指定してください。

   $ soratun bootstrap sim --config /path/to/arc.json
   

   ブートストラップが完了すると、soratun 設定ファイルが作成され、ファイルのパスが表示されます。

   Created/updated configuration file: /path/to/arc.json
   

   soratun 設定ファイルについて詳しくは、soratun 設定ファイルリファレンス を参照してください。

   soratun bootstrap sim がエラーで終了する場合

   ステップ 6: Krypton CLI で IoT SIM のメタデータを取得できることを確認する の手順で追加したオプション (-operation getSubscriberMetadata を除く) を、soratun bootstrap sim を実行するときにも追加してください。たとえば、 -keys-api-endpoint-url https://api.soracom.io/v1/keys -provisioning-api-endpoint-url https://api.soracom.io を指定した場合は、各オプションの先頭の - を 2 つに変更して、以下のように指定します。

   $ soratun bootstrap sim --config /path/to/arc.json --keys-api-endpoint-url https://api.soracom.io/v1/keys --provisioning-api-endpoint-url https://api.soracom.io
   

2. USB ドングルを取り外します。

ステップ 8: SORACOM にアクセスする

soratun で WireGuard インターフェースを作成すると、SORACOM にアクセスできます。詳しくは、以下のページを参照してください。

• soratun で WireGuard インターフェースを作成 / 更新する
• SORACOM にアクセスできることを確認する

再度 SIM 認証を使用してブートストラップする

以下のようなときは再度ブートストラップする必要があります。

• バーチャル SIM/Subscriber のセッションを再確立したとき
• バーチャル SIM/Subscriber の認証情報を更新したとき
• バーチャル SIM/Subscriber を再初期化したとき

ステップ 5: Soracom Onyx - LTE™ USB ドングル (SC-QGLC4-C1) を取り付けて機内モードを有効化する 以降の手順を行ってください。