4G eNBを5GCに対して接続するためのプロトコル変換器。
| 項目 | 仕様 |
|---|---|
| ホストマシン | Intel NUC7i7BNH |
| eNB(基地局) | Baicells Nova430x (sXGP対応 4G基地局) |
| UE(端末) | Google Pixel 8a |
NOTE: eNB の詳細設定は Wiki: eNB Setup Guide を参照。 eSIM の登録・設定手順は Wiki: eSIM Setup Guide を参照。 Simlessly の操作手順は公式マニュアルも参照: https://docs.simlessly.com/rsp/user-manual/simlessly/simlessly.html
| ソフトウェア | 最低バージョン |
|---|---|
| OS | Ubuntu 22.04 LTS |
| Docker Engine | 24+ |
| Docker Compose | v2 |
ビルドツール・ライブラリのインストールは不要 (Dockerfile 内で自動取得)。
1. リポジトリ配置 → 下記「リポジトリの配置」
2. .env 設定 → 下記「環境変数の設定」
3. 加入者登録 → Open5GS WebUI + auth_keys.yaml（Wiki: eSIM Setup Guide）
4. eNB 設定 → MCC/MNC/TAC・S1接続先を合わせる（Wiki: eNB Setup Guide）
5. 端末 eSIM/APN設定 → Wiki: eSIM Setup Guide
6. ビルド＆起動 → 下記「ビルド・実行」
本リポジトリは open5gs-compose（Open5GS 簡易 Docker 環境）のサブディレクトリとして動作する。
docker-compose.yml は親ディレクトリの資材を参照する（例: ../config/5g, ../webui, ../log, base/Dockerfile）。
以下の手順で配置すること。
# 1. 親リポジトリをクローン
git clone https://github.com/Ytaihei/open5gs-compose.git
cd open5gs-compose
# 2. 本リポジトリを s1n2-gateway/ ディレクトリにクローン
git clone https://github.com/Ytaihei/s1n2-gateway.git
cd s1n2-gateway最終的なディレクトリ構成：
open5gs-compose/ ← 親リポジトリ (Open5GS Docker環境)
├── base/ ← Open5GS ベース Dockerfile
├── config/
│ └── 5g/ ← 5G NF 設定ファイル (AMF, SMF, UPF, ...)
├── webui/ ← Open5GS WebUI 初期化資材
├── log/ ← Open5GS ログ出力先
├── script/
│ └── exclusive_mode.sh ← 排他制御の共通関数
└── s1n2-gateway/ ← 本リポジトリ
├── docker-compose.yml
├── Dockerfile
├── .env ← .env.example からコピーして作成（Git管理外）
├── config/
│ └── auth_keys.yaml ← auth_keys.example.yaml からコピーして作成（Git管理外）
└── src/ ← s1n2-converter ソースコード
start.sh はローカル運用用の補助スクリプト（Git管理外）として扱う。
open5gs-compose側のs1n2-gatewaysubmodule で固定されるコミットを、統合運用の正とする。s1n2-gateway単体のmainは、常に親の最新mainと互換とは限らない。- 統合運用時は、親リポジトリを
git clone --recursiveで取得し、親が指す submodule コミットを使う。
.env.example をコピーして .env を作成する。
cp .env.example .env通常はデフォルト値のまま動作する。変更が必要な場合の主要変数：
| 変数 | デフォルト | 説明 |
|---|---|---|
MCC / MNC / TAC |
001 / 01 / 1 |
PLMN・TAC（eNB側の設定と一致させる） |
UE_IPV4_INTERNET |
192.168.100.0/24 |
UE に割り当てる IP プール |
MAX_NUM_UE |
1024 |
最大 UE 数 |
start.sh と scripts/protect_local_configs.sh はローカル環境専用で運用し、Git 管理対象外とする。
実装・運用メモは docs/ 配下に保存する。
NOTE:
S1C_BIND_ADDR,N2_REMOTE_ADDR等のインターフェース設定はdocker-compose.yml内で自動設定されるため、.envでの設定は不要。
config/auth_keys.yaml に Open5GS WebUI で登録した加入者の Ki ・ OPc を記載する。テンプレートは config/auth_keys.example.yaml を参照。
cp config/auth_keys.example.yaml config/auth_keys.yaml
# config/auth_keys.yaml を編集し、imsi / ki / opc を Open5GS WebUI の値に合わせるWARNING:
auth_keys.yamlにはマスター鍵 (Ki ・ OPc) が含まれる。Git 管理外 (.gitignoreに登録済み) であり、テスト・開発環境限定 で使用すること。
# ビルド
docker compose build s1n2
# 起動 (公開リポジトリのみで再現可能な標準手順)
docker compose up -d --build
# ログ確認
docker compose logs s1n2 -f
# 停止
docker compose down
# リビルド (コード変更後)
docker compose build s1n2 --no-cache && docker compose up -dローカル専用の start.sh を使う場合は、NIC 切替や排他制御を含む追加処理を実行できる。
NOTE:
start.shは環境変数でカスタマイズ可能。デフォルト値は検証環境 (Intel NUC + Baicells Nova430x) に合わせてある。 別環境では以下のように上書きする：PHYS_NIC=eth0 ENB_IP=172.24.0.200 ./start.sh詳細は Wiki: eNB Setup Guide を参照。 スクリプト実装のローカル管理は
docs/を参照。
# 1) 構成解決
docker compose config --quiet
# 2) 最小起動
docker compose up -d --build
# 3) 初期ヘルス確認
docker compose ps
docker logs s1n2 | grep -E 'listening S1C|N2 connected'
# 4) eNB 接続時の確認
docker logs s1n2 | grep -E 'S1SetupRequest detected|NGSetupResponse -> S1SetupResponse sent'NGSetupResponse -> S1SetupResponse sent は eNB から S1SetupRequest が到来した場合に出力される。
- README: 公開リポジトリのみで再現できる最小手順（clone / env / compose 起動 / 最小ログ確認）。
- Wiki: eNB 機種別設定、eSIM 運用、物理ネットワーク調整、詳細設計、運用トラブルシュート。
Wiki: s1n2-gateway Wiki
eNB ──S1AP/GTP-U──► s1n2-converter ──NGAP/GTP-U──► AMF / UPF
(4G) ↕ NAS変換 (5G)
C-Plane は S1AP↔NGAP を変換し、NAS PDU 内部の EPS↔5GS も同時に変換する。 U-Plane は GTP-U ヘッダの TEID を書き換えて中継する。
プロジェクト構成・モジュール設計・命名規則などの詳細は Wiki を参照。
AGPL-3.0 — See LICENSE for details.
This project includes code from Open5GS (AGPL-3.0) and asn1c (BSD-2-Clause).