メインコンテンツまでスキップ

顧客セットアップ — オンプレミスライセンスのインストール

このガイドは、ベンダーからライセンストークンを受け取り、自社の Yabanin ゲートウェイまたは管理サーバーへ導入する必要がある オンプレミスの顧客 向けです。

受け取るもの​

ベンダー担当者から、次のものを受け取ります。

  1. ライセンストークンファイル — 組織識別子、有効期限、暗号署名を含む JSON ファイル(例: acme-corp.json)。
  2. ルート公開鍵 — ベンダーの Ed25519 ルート公開鍵を表す 64 文字の 16 進数(32 バイト)。すべての本番バイナリに、ビルド時に埋め込まれます。
  3. (任意) 中間証明書ファイル — intermediate.json
  4. (任意) CRL(証明書失効リスト)ファイル — crl.json

手順 1 — ライセンスファイルを配置する​

ライセンストークンをサーバーへコピーします。

mkdir -p /etc/yabanin/license
cp acme-corp.json /etc/yabanin/license/
chmod 600 /etc/yabanin/license/acme-corp.json # restrict access

手順 2 — 環境変数を設定する​

サービスの環境に、次の環境変数を追加します。

systemd サービスの場合​

/etc/systemd/system/yabanin-admin.service(または yabanin-gateway.service)を編集します。

[Service]
Environment="YABANIN_LICENSE_FILE=/etc/yabanin/license/acme-corp.json"
Environment="YABANIN_LICENSE_ROOT_PUBKEY=a1b2c3d4e5f6a1b2c3d4e5f6..."
# Optional:
Environment="YABANIN_LICENSE_CRL_FILE=/etc/yabanin/license/crl.json"

その後、再読み込みして再起動します。

systemctl daemon-reload
systemctl restart yabanin-admin

Docker / docker-compose の場合​

docker-compose.yml の中:

services:
admin:
environment:
- YABANIN_LICENSE_FILE=/data/license/acme-corp.json
- YABANIN_LICENSE_ROOT_PUBKEY=a1b2c3d4e5f6a1b2c3d4e5f6...
- YABANIN_LICENSE_CRL_FILE=/data/license/crl.json
volumes:
- ./license:/data/license:ro

バイナリを直接実行する場合​

export YABANIN_LICENSE_FILE=/etc/yabanin/license/acme-corp.json
export YABANIN_LICENSE_ROOT_PUBKEY=a1b2c3d4e5f6a1b2c3d4e5f6...
./yabanin-admin

手順 3 — 起動を確認する​

サービスを起動したら、ログを確認します。

# Successful startup:
# License verified successfully
# admin panel running addr=:8086

# Failed startup (license invalid):
# FATAL: LICENSE INVALID — license expired at 2025-01-01T00:00:00Z — service cannot start without a valid license
# (exit code 1)

手順 4 — ライセンスの有効性を確認する(任意)​

導入の前後に、ライセンスを独立して検証できます。

./yabanin license verify \
--license-file=/etc/yabanin/license/acme-corp.json \
--root-pubkey=a1b2c3d4e5f6a1b2c3d4e5f6... \
--crl-file=/etc/yabanin/license/crl.json

# Output: LICENSE VALID

ライセンスの有効期限と猶予期間​

有効期限からの経過時間動作
期限前通常運用
0 — 7 日縮退モード("expired" として記録)
> 7 日完全失効。サービスは起動を拒否します

7 日間の猶予期間により、サービスを直ちに中断せず、ベンダーへ更新ライセンスを依頼する時間を確保できます。

ライセンスの更新​

ライセンスの有効期限が近づいたとき:

  1. ライセンス JSON にある customer_id を添えて、ベンダーへ連絡します。
  2. ベンダーが、更新された有効期限の新しいトークンを発行します。
  3. 古いファイルを置き換えて、サービスを再起動します。
cp new-license.json /etc/yabanin/license/acme-corp.json
systemctl restart yabanin-admin

トラブルシューティング​

症状原因と対処
"LICENSE INVALID — license expired"トークンの期限切れです。ベンダーへ新しいトークンを依頼してください。
"LICENSE INVALID — intermediate verification"ルート公開鍵が一致しません。このバイナリビルド向けにベンダーが提供した 16 進値が一致するか確認してください。
"read license file: no such file or directory"YABANIN_LICENSE_FILE のパスとファイル権限を確認してください(サービスユーザーから読み取れる必要があります)。
"parse root pub: encoding/hex: invalid byte"ルート公開鍵の 16 進が不正です。スペースなしで、ちょうど 64 文字の 16 進である必要があります。
"intermediate cert serial X is revoked"ベンダーが中間証明書を失効させる CRL を公開しています。ベンダーへ新しいライセンスを依頼してください。

セキュリティのベストプラクティス​

  • ファイル権限: ライセンスファイルは 0600(所有者の読み書きのみ)に保ちます。
  • 読み取り専用マウント: Docker を使う場合、ライセンスディレクトリを :ro でマウントします。
  • ライセンスファイルをバージョン管理に 決してコミットしない でください。
  • 更新トークンを受け取ったら 速やかにローテーション してください。古いトークンは、有効期限まで有効なままです。