認証とセッションの保存

Vylinejs は、パスワード、QR コード、既存の認証トークンによるログインと、永続ストレージからのセッション復元に対応しています。認証プロトコルは LINE が管理しており、追加の端末認証を求められる場合があります。

パスワードによるログインは、対話的なログインが必要な場合にのみ使用してください。 pincode を省略すると、Vylinejs が E2EE ログインのハンドシェイク用にランダムな6桁の PIN を生成します。次の例は Deno の環境変数にアクセスするため、必要な環境変数へのアクセス権限だけを付与してください。

ログイン方式は、選択したデバイスが対応するプロトコルから自動選択されます。ログインオプションに v3: false を指定すると旧方式を選べます。 e2ee は旧パスワードログインでの E2EE ハンドシェイクを制御します。

ログイン時の端末識別情報は Vyline 方式が既定です。セキュア QR ログインでは実行ホスト名と汎用モデル名を送信します。 QR ログインで loginMode: "linejs" を指定すると、LINEJS の従来値（linejs-v2 / evex-device）を使用します。 v3 は認証プロトコルを、loginMode はセキュア QR の端末識別情報を選ぶ別々の設定です。 QR ログインでは systemName と modelName、パスワードログインではmodelNameを個別に指定できます。

import { loginWithPassword } from "@nezumi0627/vylinejs";

const client = await loginWithPassword({
	email: Deno.env.get("LINE_EMAIL")!,
	password: Deno.env.get("LINE_PASSWORD")!,
	v3: false,
	modelName: "System Product Name",
	onPincodeRequest(pin) {
		console.log("Enter this PIN in LINE:", pin);
	},
}, {
	device: "IOSIPAD",
});

認証情報は、非公開のシークレットストアや環境設定から取得してください。ソースコードに直接記述したり、トークンや PIN を共有ログに出力したりしないでください。

QR ログインでは、ライブラリにパスワードを渡す必要がありません。 Vylinejs は onReceiveQRUrl を通じて URL を返します。その URL を QR コードとして表示する処理は、ホストアプリケーションが実装します。

v3: false を指定すると旧 QR ログイン方式を選択できます。省略時はデバイスに応じて自動選択します。

import { loginWithQR } from "@nezumi0627/vylinejs";

const client = await loginWithQR({
	loginMode: "vyline",
	systemName: "MY-DESKTOP",
	modelName: "System Product Name",
	onReceiveQRUrl(url) {
		showQrCode(url);
	},
	onPincodeRequest(pin) {
		showPinForLineConfirmation(pin);
	},
}, {
	device: "ANDROIDSECONDARY",
});

showQrCode と showPinForLineConfirmation は、アプリケーション側の関数です。ライブラリは UI や QR 画像の描画機能を提供しません。

保存済みセッションを復元する

FileStorage は、アクセス用と更新用の認証情報を、E2EE の状態およびプロトコルの状態とともに保存します。セッションの復元には、同じ永続ストレージを再利用してください。復元ヘルパーは、サーバーが指定した有効期限が近づくと認証情報を更新します。保存済みセッションが存在しない場合や LINE に拒否された場合は例外を送出し、暗黙にパスワードログインへ切り替えることはありません。

import {
	loginWithPassword,
	loginWithStoredAuthToken,
} from "@nezumi0627/vylinejs";
import { FileStorage } from "@nezumi0627/vylinejs/storage";

const storage = new FileStorage("./private/line-session.json");
const init = { device: "IOSIPAD" as const, storage };

let client;
if (await storage.get("accessToken") || await storage.get("refreshToken")) {
	client = await loginWithStoredAuthToken(init);
} else {
	client = await loginWithPassword({
		email: Deno.env.get("LINE_EMAIL")!,
		password: Deno.env.get("LINE_PASSWORD")!,
		onPincodeRequest(pin) {
			console.log("Enter this PIN in LINE:", pin);
		},
	}, init);
}

FileStorage を使用する場合、認証情報は平文で保存されます。ファイルのアクセス権限を制限し、バージョン管理や暗号化されていないバックアップの対象から除外して、他者と共有しないでください。 EncryptedStorage は AES-GCM で値を暗号化できますが、アプリケーション側でエクスポート不可の鍵を OS のキーチェーンや別のシークレット管理サービスに保管する必要があります。 Vylinejs は、その鍵の保存や導出を行いません。

import { EncryptedStorage, FileStorage } from "@nezumi0627/vylinejs/storage";

const key = await loadNonExportableAesKeyFromSecretStore();
const storage = new EncryptedStorage(
	new FileStorage("./private/line-session.enc.json"),
	key,
);

loadNonExportableAesKeyFromSecretStore はアプリケーション側の処理を表す関数です。 Vylinejs は、プラットフォーム固有のキーチェーンアダプターを提供しません。

既存の認証トークンでログインする

loginWithAuthToken は、トークンの値、または対応する構造化されたトークン入力を受け取ります。認証トークンだけでは E2EE の秘密鍵は取り込まれません。必要な E2EE 鍵を含む永続ストレージがある場合は、それを再利用してください。復号エラーの調査のために鍵の履歴を消去しないでください。

import { loginWithAuthToken } from "@nezumi0627/vylinejs";
import { FileStorage } from "@nezumi0627/vylinejs/storage";

const client = await loginWithAuthToken(Deno.env.get("LINE_AUTH_TOKEN")!, {
	device: "IOSIPAD",
	storage: new FileStorage("./private/line-session.json"),
});

認証情報が失効した場合は、対話的なログインをやり直してください。過去の E2EE 鍵やアカウント固有の制限については、機能とサポート状況および安定性に関する注記を参照してください。

認証とセッションの保存 ​

パスワードでログインする ​

QR コードでログインする ​

保存済みセッションを復元する ​

既存の認証トークンでログインする ​

認証とセッションの保存

パスワードでログインする

QR コードでログインする

保存済みセッションを復元する

既存の認証トークンでログインする