Soracom

Users

ドキュメント

soratun で SORACOM API の認証キーを使用してバーチャル SIM/Subscriber をブートストラップする

デバイスにインストールした soratun を使ってバーチャル SIM/Subscriber を作成し、SORACOM プラットフォームへ接続します。soratun については、soratun の概要と機能 を参照してください。

ここでは、soratun がサポートする 3 種類のブートストラップ方法 のうち、SORACOM API の認証キーを使用する方法 を説明します。

この方法の特徴は以下のとおりです。

  • SORACOM API の認証キーを、デバイスに安全に配布および保存する必要があります。そのため、デバイスが盗難された際に、認証キーが漏洩するリスクがあります。安全に保存するための セキュアエレメント を用意するなど、対策を検討してください。
  • プライマリサブスクションとして作成されるため、IoT SIM は必要ありません。
操作を始める前に準備が必要です (クリックして確認してください)

(1) デバイスをインターネットに接続する

SORACOM Air 以外の方法で、デバイスをインターネットに接続します。ここでは、soratunサポート対象プラットフォーム として、Linux を対象としています。

(2) デバイスに soratun をインストールする

インターネットに接続したデバイスに、soratun をインストールします

準備完了

ステップ 1: SAM ユーザーを作成する

soratun は、認証キー ID と認証キーシークレットを使用した認証方式のみをサポートします。SAM ユーザーを作成する を参考に、以下の設定で soratun を使用するための SAM ユーザーを作成してください。

項目説明
[名前]任意
[概要]任意
[権限設定]

最低限以下の権限を付与してください。構文の詳細は 権限設定のためのパーミッション構文 を参照してください。

{
  "statements": [
    {
      "api": [
        "Sim:createSim",
        "Sim:createArcSession"
      ],
      "effect": "allow"
    }
  ]
}
[認証設定][認証キー]生成し、認証キー ID (AuthKeyId) と 認証キーシークレット (AuthKey) を手元にコピーしてください。
[認証設定][コンソールログインパスワード]設定不要

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

ブートストラップが完了すると、Arc の料金が発生します。詳しくは、SORACOM Arc の料金プラン を参照してください。

ブートストラップとは

デバイスからリクエストして SORACOM でバーチャル SIM/Subscriber を作成し、デバイスをプロビジョニングする (デバイスに WireGuard の接続情報などを保存する) ことを「ブートストラップ」と言います。

  1. SORACOM API の認証キーを使用する方法で、ブートストラップを開始します。

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

    $ soratun bootstrap authkey --config /path/to/arc.json
    
    Not enough information to bootstrap. Launching wizard.
    ✗ SORACOM API auth key ID (starts with "keyId-"): █
    
    2 回目以降は認証情報の入力は必要ありません
    --config フラグで既存の soratun 設定ファイルを指定すると、1 回目に入力した認証情報 (profile) を使用して WireGuard の接続情報 (arcSessionStatus) が更新されます。認証キー ID と認証キーシークレットを入力し直す場合は、soratun 設定ファイルのパスを変更してください。
    インタラクティブな質問をスキップできます

    --auth-key-id / --auth-key / --coverage-type フラグと、それぞれに必要な情報を指定すると、手順 2 ~ 3 をスキップできます。

    例:

    $ soratun bootstrap authkey --auth-key-id keyId-xxx --auth-key secret-xxx --coverage-type jp --config /path/to/arc.json
    

    各フラグについては、soratun コマンドリファレンスの soratun bootstrap authkey コマンド を参照してください。

  2. SORACOM API auth key ID および SORACOM API auth key を入力します。

    項目説明
    SORACOM API auth key IDSAM ユーザーの認証キー ID を入力して、Enter キーを押します。入力した内容は、* で表示されます。
    SORACOM API auth keySAM ユーザーの認証キーシークレットを入力して、Enter キーを押します。入力した内容は、* で表示されます。

    以下のメッセージが表示されます。

    Use the arrow keys to navigate: ↓ ↑ → ← 
    ? Coverage to create a new virtual SIM: 
      ▸ Global coverage (g.api.soracom.io)
        Japan coverage (api.soracom.io)
    
  3. カーソルキーを押してバーチャル SIM/Subscriber を作成するカバレッジタイプを選択して、Enter キーを押します。

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

    Virtual subscriber SIM ID: 1234567890123456789
    Created/updated configuration file: /path/to/arc.json
    

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

ステップ 3: SORACOM プラットフォームにアクセスする

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

再度 SORACOM API の認証キーを使用してブートストラップする

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

ステップ 2: ブートストラップする 以降の手順を行ってください。