Soracom

soratun が提供するコマンドのリファレンスです。各コマンドで --help フラグで同様の情報を参照できます。

$ soratun --help

soratun -- SORACOM Arc Client

Usage:
  soratun [command]

Available Commands:
  bootstrap   Create virtual SIM and configure soratun
  config      Create initial soratun configuration file without bootstrapping
  help        Help about any command
  status      Display SORACOM Arc interface status
  up          Setup SORACOM Arc interface
  version     Show version
  wg-config   Dump soratun configuration file as WireGuard format

Flags:
      --config string   Specify path to SORACOM Arc client configuration file (default "arc.json")
  -h, --help            help for soratun

Use "soratun [command] --help" for more information about a command.

soratun の次に指定できるコマンドは、以下のとおりです。

• soratun bootstrap: バーチャル SIM/Subscriber と soratun 設定ファイルを作成します。
• soratun config: soratun 設定ファイルのテンプレートを標準出力に表示します。
• soratun help: ヘルプを表示します。
• soratun status: soratun が作成した WireGuard インターフェースの状態を表示します。
• soratun up: soratun 設定ファイルに基づいて WireGuard インターフェースを作成します。
• soratun version: バージョン情報を表示します。
• soratun wg-config: soratun 設定ファイルの内容を、WireGuard の設定ファイル形式で標準出力に表示します。

soratun bootstrap コマンド

バーチャル SIM/Subscriber をブートストラップして、soratun 設定ファイルを作成します。soratun は、バーチャル SIM/Subscriber をブートストラップする方式として、認証方式が異なる 3 種類のブートストラップ方式を支援します。詳しくは、ブートストラップの種類 を参照してください。

soratun bootstrap の次に指定できるコマンドは、以下のとおりです。

• soratun bootstrap authkey: SORACOM API の認証キーを使用するブートストラップ方式です。
• soratun bootstrap cellular: SORACOM Air for セルラーのセルラー回線認証を使用するブートストラップ方式です。
• soratun bootstrap sim: Krypton の「Endorse による SIM 認証」を使用するブートストラップ方式です。

soratun bootstrap authkey コマンド

SORACOM API の認証キーを使用してブートストラップします。詳しくは、soratun で SORACOM API の認証キーを使用してバーチャル SIM/Subscriber をブートストラップする を参照してください。

コマンド固有のフラグは、以下のとおりです。

• --auth-key-id string: string に、SAM ユーザーの認証キー ID を指定します。
• --auth-key string : string に、SAM ユーザーの認証キーシークレットを指定します。
• --coverage-type string: string に、バーチャル SIM/Subscriber を作成するカバレッジタイプ (g または jp) を指定します。

soratun bootstrap cellular コマンド

SORACOM Air for セルラーのセルラー回線を使用してブートストラップします。詳しくは、soratun でセルラー回線認証を使用してバーチャル SIM/Subscriber をブートストラップする を参照してください。

コマンド固有のフラグは、以下のとおりです。

• --endpoint string: string に、Krypton プロビジョニング API のエンドポイント (https://krypton.soracom.io:8036) を指定します。省略できます。
• --dump-config: ブートストラップが完了した際に作成される soratun 設定ファイルの内容を、標準出力に出力します。なお、--config と --dump-config を同時に使用した場合、soratun 設定ファイルは作成 / 更新されません。

soratun bootstrap sim コマンド

Krypton の「Endorse による SIM 認証」を使用してブートストラップします。詳しくは、soratun で SIM 認証を使用してバーチャル SIM/Subscriber をブートストラップする を参照してください。

コマンド固有のフラグは、以下のとおりです。

• --baud-rate uint: uint に、デバイスと通信する際のボーレートを指定します。
• --clear-key-cache: 鍵のキャッシュから、すべてのアイテムを削除します。
• --data-bits uint: uint に、デバイスと通信する際のデータビットを指定します。
• --disable-key-cache: 鍵のキャッシュに、認証結果を保存しない
• --dump-config: ブートストラップが完了した際に作成される soratun 設定ファイルの内容を、標準出力に出力します。なお、--config と --dump-config を同時に使用した場合、soratun 設定ファイルは作成 / 更新されません。
• --interface string: string に、使用する UICC インターフェースとして、iso7816、comm (シリアルポート)、mmcli、または autoDetect (自動認識) を指定します。
• --keys-api-endpoint-url: IoT SIM のカバレッジタイプに合わせて、以下のいずれかを指定します。
  • グローバルカバレッジ: https://g.api.soracom.io/v1/keys (デフォルト)
  • 日本カバレッジ: https://api.soracom.io/v1/keys
• --krypton-cli-path: krypton-cli コマンドのパスを指定します。デフォルトは、/usr/local/bin/krypton-cli です。
• --params string: string に、プロビジョニング要求の際に追加で渡す JSON を指定します。
• --parity-mode uint: uint に、デバイスと通信する際のパリティモード (0: None、1: Odd、2: Even) を指定します。デフォルトは、0 です。
• --port-name string: デバイスと通信する際のポート名 (COM1、/dev/tty1、/dev/ttyUSB3 など) を指定します。あわせて、--interface string にも対応する UICC インターフェースを指定してください。たとえば、/dev/ttyUSB3 を指定する場合は、--interface comm を指定します。
• --provisioning-api-endpoint-url string: IoT SIM のカバレッジタイプに合わせて、Krypton プロビジョニング API のエンドポイントを指定します。
  • グローバルカバレッジ: https://g.api.soracom.io/ (デフォルト)
  • 日本カバレッジ: https://api.soracom.io/
• --signature-algorithm string: string に、署名の生成アルゴリズムを指定します。
• --stop-bits uint: uint に、デバイスと通信する際のストップビットを指定します。

soratun config コマンド

SORACOM ユーザーコンソールでバーチャル SIM/Subscriber を作成して soratun で接続する 際に、設定ファイルのテンプレートを標準出力に表示します。

$ soratun config > /path/to/arc.json

soratun status コマンド

soratun が作成した WireGuard インターフェースの状態を表示します。

$ sudo soratun status
Password:

interface: utun7 (userspace)
  public key: GHIJKLMN__CLIENT_PEER_PUBLIC_KEY__OPQRSTUVW=
  private key: (hidden)
  listening port: 45678

peer: XYZabcde__SERVER_PEER_PUBLIC_KEY__fghijklmn=
  endpoint: xxxxx.arc.soracom.io:11010
  allowed ips: 100.127.0.0/21, 100.127.10.0/28, 100.127.10.128/25, 100.127.10.17/32, 100.127.10.18/31, 100.127.10.20/30, 100.127.10.24/29, 100.127.10.32/27, 100.127.10.64/26, 100.127.11.0/24, 100.127.12.0/22, 100.127.128.0/17, 100.127.16.0/20, 100.127.32.0/19, 100.127.64.0/18, 100.127.8.0/23, 54.250.252.67/32
  latest handshake: 2021-06-17 13:30:20.186527 +0900 JST
  transfer: 92 B received, 180 B sent

soratun で WireGuard インターフェースを作成していない場合は以下のように表示されます。

$ sudo soratun status

no SORACOM Arc device found

soratun up コマンド

soratun で WireGuard インターフェースを作成し、ルーティングテーブルを設定します。詳しくは、soratun で WireGuard インターフェースを作成 / 更新する を参照してください。

コマンド固有のフラグは、以下のとおりです。

• --read-stdin: WireGuard の接続情報を、標準入力から読み込みます。デフォルトは、soratun 設定ファイル (カレントディレクトリの arc.json) から読み込みます。
• --additional-allowed-ips string: string に、WireGuard インターフェースを作成する際に WireGuard の AllowedIPs に追加する CIDR を指定します。複数指定する場合は , で区切って入力します (例: --additional-allowed-ips='192.0.2.1/32,192.0.2.2/32')。ここに指定した CIDR 宛の通信も、soratun で作成された WireGuard インターフェース経由に変更されます。
• --mtu int: int に、soratun で作成した WireGuard インターフェースの MTU を指定します。
• --persistent-keepalive int: int に、Arc サーバーとの接続における KeepAlive パケットの送信間隔 (秒) を指定します。例: --persistent-keepalive 25。詳しくは、KeepAlive パケットの送信間隔について を参照してください。

soratun version コマンド

soratun のバージョン情報を表示します。

soratun wg-config コマンド

--config フラグで指定した設定ファイルを WireGuard の設定ファイル形式で標準出力に表示します。詳しくは、soratun 設定ファイルから WireGuard の設定ファイルを作成する を参照してください。