Soracom

soratun (sora-com tun-nel。ソラタン) は、バーチャル SIM/Subscriber の作成、設定、および接続を支援する SORACOM Arc 用のクライアントエージェントです。デバイスにインストールして使用します。ソラコムが、soratun/LICENSE に基づいて as-is で提供しています。

soratun と WireGuard の比較

ソラコムでは、Arc を利用する際は soratun の使用を推奨します。一方で、Arc は Linux カーネルに含まれる WireGuard 実装でも動作します。以下のような観点で、使用する実装を選択してください。

soratun の主な機能

soratun は、以下のような機能を提供します。

• Arc で SORACOM プラットフォームに接続するための WireGuard インターフェースを作成します。

• SORACOM プラットフォームへの通信が WireGuard インターフェースを経由するように、OS のルーティングテーブルを設定します。具体的には、以下のネットワーク宛の通信を WireGuard インターフェース経由に設定します。すでに同じルートが定義されている場合は、上書きされます。

  • バーチャル SIM/Subscriber を作成したときに、SORACOM プラットフォームから提供される arcAllowedIPs
  • soratun 設定ファイルにお客様が指定する additionalAllowedIPs。詳しくは、AllowedIPs の設定 を参照してください。

• systemd の watchdog をサポートします。定期的に Arc の接続状況を systemd にレポートします。詳しくは、systemd を利用してデバイス起動時に WireGuard インターフェースを作成する を参照してください。

• バーチャル SIM/Subscriber のブートストラップを支援します。

  soratun は、認証方式が異なる 3 種類のブートストラップ方式を支援します。詳しくは、ブートストラップの種類 を参照してください。

• enableMetrics が True に設定されている場合、60 秒ごとに以下のようなメトリックスをログに出力します。詳しくは、soratun 設定ファイルリファレンス を参照してください。

  soratun_sent_bytes_total{simId="バーチャル SIM/Subscriber の SIM ID",interface="インターフェース名",endpoint="SORACOM Arc エンドポイント"} 送信バイト数
  soratun_received_bytes_total{simId="バーチャル SIM/Subscriber の SIM ID",interface="インターフェース名",endpoint="SORACOM Arc エンドポイント"} 受信バイト数
  soratun_latest_handshake_epoch{simId="バーチャル SIM/Subscriber の SIM ID",interface="インターフェース名",endpoint="SORACOM Arc エンドポイント"} 最終ハンドシェイク時刻
  

ブートストラップの種類

soratun は、バーチャル SIM/Subscriber をブートストラップする方式として、認証方式が異なる 3 種類のブートストラップ方式を支援します。

サポート対象プラットフォーム

soratun は、以下のプラットフォームをサポートします。

• Linux amd64
  • Ubuntu 20.04.2 LTS
• Linux arm (Raspberry Pi 32-bit)
  • Raspberry Pi OS 2021-05-07
  • Ubuntu 20.04.2 LTS