Qiita全国学生対抗戦Advent Calendar 2024

【Unity×NFCカード】で脱出ゲームを作る

Last updated at 2024-12-06Posted at 2024-12-06

はじめに

総コンAdventCalender2024 の6日目の記事です！

この記事では，
1.Unityを用いた NFCカード を読み取る方法
2.Untiyを用いた 交通系ICカード を読み取る方法
3.脱出ゲームの制作過程
を記述します．

この記事で用いた方法の利点として，PCSC-Sharpを用いるため，
Windows, MacOSX, Linux(ubuntu)のOSで動作します．

制作した脱出ゲームの概要とGitHubリポジトリ

PCとNFCカードリーダーを2台ずつ用意して，
"もの"を読み込んで謎解きをする脱出ゲームを制作しました．
2チームに分かれて協力しながら進めていきます．

制作したUnityファイルのソースコードは以下のGitHubリポジトリに置いておきます．
AmanatsuTouko/EscapeGameUsingUDPAndNFC - GitHub

対象読者

NFCカードを読み込んで，固有ID(UID/IDm)を取得したい人
Unity(.Net)に組み込んで実装したい人

実行環境と使用したライブラリ

Unity 2022.3.11f1
Visual Studio 2022
PCSC-Sharp
Windows10 / MaxOS Sonoma 14.6 / ubuntu 20.04

物理的に準備するもの

NFCカードリーダー
NFCカード
交通系ICカード(Suicaなど)
（* NFCコインタグ）
（* 脱出ゲームに使う小物）
(*) は任意です．NFCの読み取りだけであれば必要ありません．
(リンク先は実際に使用したamazonの商品リンクです．)

NFCについての基礎知識

NFCについての基礎知識（クリックして展開）

まず，NFCカードを読み取る前に必要な予備知識を簡単に記述します．

NFC(Near Field Communication)とは近距離無線通信を意味します．
例を挙げると，交通系ICやクレジットカード、スマートフォン端末などに搭載されています．（社員証や，アーケードゲームのデータ保存用カード，amiiboなどにも使われています．）

通信の規格

主に4種類あり，以下の特徴を持ちます．

ISO14443 Type-A：比較的安価
FeliCa Type-F ：交通系ICで使用．セキュリティ面で優れ，処理速度が早い
ISO14443 Type-B：セキュリティ面で優れる
ISO15693 ：メモリ少なめだが安価．通信距離が近傍型(約10～70cm の交信距離)

（参考：NFCとは?-NFC基礎知識|トッパンインフォメディア）

通信の仕組み

NFCカードの構成要素は，ICチップとアンテナです．
通信の流れは以下になるようです．

1.ICカードをかざすことで、磁界による誘導電流が発生
- これを起電力とすることでICチップを起動させる
2.相互認証ののち、データの読み書きを行う
- 2-1.リーダーから電磁波を送信
- 2-2.ライターのアンテナで電磁波を受信、電磁波を返す
- 2-3.リーダーで受信する

相互に認証を行った後に通信を行うことだけ覚えておきましょう．

（記事の本題とそこまで関連がないので折りたたんであります）

UnityでNFCカードを読み取る方法の概要

今回は以下の方法で読み取っていきます．

1.PCSC-Sharpをダウンロード
PCSC-Sharpは，PCSCライブラリ[*1]をC#(.NET)向けにラッパーしたライブラリ
WindowsとUnixの両方で実行できる[*2]
2.PCSC-Sharpを dllファイル にする
3.Unityのプラグインとして読み込む
4.NFCカードリーダーへの通信，NFCカードから情報を取得するコードを書く

[*1] PCSC(Personal Computer / Smart Card) : ICカードをWindows環境上で相互利用できるようにするためのインターフェース仕様
[*2] Windows向けにwinscard.dll，Unix向けにPC/SC liteをラップしている

1.PCSC-Sharpをダウンロード

PCSC-Sharp - GitHub
こちらのリンク先からPCSC-Sharpをダウンロードしてください．
自分がやった際は，version 6.2.0 にて行いましたが，最新版で問題ないと思われます．
Releasesのtag一覧から，最新版をクリックしてソースコードをzipでダウンロードして展開します．

2.PCSC-SharpをDLLにする

ターゲットフレームワーク(.Net Standard2.0)の指定

Windowsでの手順を示します．

Visual Studio 2022などのVSを開き，プロジェクト/ソリューションを開くを選択して，pcsc-sharp.sln を開きます．

次に，ビルド対象のターゲットフレームワークのバージョンの指定をします．
ソリューションエクスプローラーからPCSCを右クリックして，プロパティを開きます．

（参考：対象となる .NET Framework を指定する - Visual Studio (Windows) | Microsoft Learn）

今回は .Net Standard2.0 向けのビルドを行いたいので，
ターゲットフレームワークの欄に netstandard2.0 が入っていれば問題ありません．

注意
使用するUnityがどの.Net Frameworkに対応しているかを確認する必要があります．
Unity2022以外を用いる場合は，.Net Standard2.0に対応していない可能性があります．

ちなみに，大体のバージョンは，.Net Standard 2.1 に対応しているようです．
（参考：Unity - Manual: .NET profile support）

ビルドを行う

画面上部のビルド -> ソリューションのビルドを選択してビルドを行います．

参考記事

3.DLLをUnityにプラグインとして読み込む

Untiyの.NetStandardのバージョンの指定

書き出した dll の .net standard のバージョンに合わせて Unity側で .net standard のバージョン指定をする必要があります．

File -> Build Settings -> Player Settings -> Playerの項目内にある Other Settingsの欄から
Configuration -> Api Compatibility Level が .Net Standard 2.1 であることを確認します．

参考：【Unity】.NetFrameWorkのバージョン変更 - たまごネコは夢を見る

dllファイルの読み込み

Assets直下に"Plugins"というフォルダを作成します．
先ほど作成したdllファイルは，

pcsc-sharp-RELEASE_6_2_0\src\PCSC\obj\Debug\netstandard2.0\PCSC.dll

のパスにビルドされています．
このファイルを Plugins フォルダにドラッグ&ドロップでコピーします．

適当なスクリプトを作成し，using PCSC; と記述してimport Errorが出なければdllをUnityから使うことができる準備が整いました．

同様に，
PCSC.Iso7816.dll と PCSC.Reactive.dll も Pluginsに入れておきましょう．
2つとも以下のパスに生成されています．

pcsc-sharp-RELEASE_6_2_0\src\PCSC.Iso7816\obj\Debug\netstandard2.0\PCSC.Iso7816.dll
pcsc-sharp-RELEASE_6_2_0\src\PCSC.Reactive\obj\Debug\netstandard2.0\PCSC.Reactive.dll

4.NFCカードとの通信を行うコード

4-1.NFCカードの固有IDを取得しよう

UIDの取得方法の流れ

1.ISO7816規格の APDU(Application Protocol Data Unit)コマンドを用いて
カードリーダーからNFCカードへ情報を送信
2.NFCカードがデータに応じて情報を返却
3.返却されたレスポンスデータのBit列を文字列に戻すことでUIDが取得できる

APDUコマンドについて

APDUコマンドは，カードリーダーが送る場合と，NFCカードが送る場合とで2種類のタイプを使います．それぞれ見ていきましょう．

Command APDU (NFCカードリーダーが送る情報)

ここで，図の用語の意味はこちらになります．

CLA: Class of Instruction(命令クラス)
INS: Instruction Code(命令コード)
P1 / P2 : Parameter(引数)
Lc : Length of data field(データの長さ)
Data Field : Cardへ送るデータ
Le : 期待する返却データの長さ

Response APDU (NFCカードが返却する情報)

SWとは，Status Wordを意味します．
SW1とSW2を合わせて正常にデータの受信ができたかなどの状態を表します．
例：SW1 = 0x90, SW2 = 0x00 で正常に操作が完了したことを意味します．

Status word の一覧はこちらのサイトでまとめてくれていました．
APDUコマンドの返り値をメッセージで表示する | 晴耕雨読

（参考：APDU Application Protocol Data Unit プロトコル - Smart Card Guy）

UIDを取得するコード

実際に，UIDを取得するコードを記述していきましょう．

以下をCommand APDUに指定して送信します．

CLA(命令クラス) : 0xFF
INS(命令コード) : Instruction.GetData
P1/P2(引数) : 0x00
Le(期待されるレスポンスの長さ) : 0

StatusWordに0x9000(正常)が返ってきたときにバイト列から戻すことでUIDを取得できます．

UIDを取得するソースコード(一部)

GitHubのソースコード全文のリンク

以下は，処理のコアとなる部分を切り出しています，
実際に用いる場合は，GitHubのソースコードを参考にしてください．

GetUID.cs

ICardReader reader = context.ConnectReader(mainReaderName, SCardShareMode.Shared, SCardProtocol.Any);

// ISO7816のAPDUコマンドを使用してカードからデータを読み取る
var apdu = new CommandApdu(IsoCase.Case2Short, reader.Protocol) {
    CLA = 0xFF,
    Instruction = InstructionCode.GetData,
    P1 = 0x00,
    P2 = 0x00,
    Le = 0 // We don't know the ID tag size
};

using (reader.Transaction(SCardReaderDisposition.Leave)) {
    Debug.Log("Retrieving the UID .... ");

    var sendPci = SCardPCI.GetPci(reader.Protocol);
    var receivePci = new SCardPCI(); // IO returned protocol control information.

    var receiveBuffer = new byte[256];
    var command = apdu.ToArray();

    var bytesReceived = reader.Transmit(
        sendPci,             // Protocol Control Information (T0, T1 or Raw)
        command,             // command APDU
        command.Length,
        receivePci,          // returning Protocol Control Information
        receiveBuffer,
        receiveBuffer.Length // data buffer
    );

    var responseApdu = new ResponseApdu(receiveBuffer, bytesReceived, IsoCase.Case2Short, reader.Protocol);
    Debug.Log(
        string.Format("SW1: {0:X2}, SW2: {1:X2}\nUid: {2}",
        responseApdu.SW1,
        responseApdu.SW2,
        responseApdu.HasData ? BitConverter.ToString(responseApdu.GetData()) : "No uid received")
    );
    
    // UUIDを返却する
    // 操作が正常に完了した かつ データを持っているとき
    if(responseApdu.HasData && responseApdu.SW1 == 0x90 && responseApdu.SW2 == 0x00)
    {
        return BitConverter.ToString(responseApdu.GetData());
    }
    else
    {
        Debug.LogError("NFCカードのデータの読み取り操作が正常に完了しませんでした．");
        return "";
    }
}

動かしてみた結果

4-2.交通系ICかどうかを判別して残高を読み出す

次に，読み込んだカードが交通系ICかどうかを判別します．
UIDを読み取った時と同様にAPDUコマンドを用いて判定を行います．

交通系ICかどうかの判定と残高の読み出しには，SelectFile と ReadBinary という2つのAPDUコマンドを用います．SelectFileモードでは，どのアプリケーションのデータを読み出すかをSelectFileコマンドで指定し，どの領域のデータを読み出すかをReadBinaryコマンドで指定します．SuicaなどのFelicaでは，1枚のカードに複数のサービスを記憶させることができるので，そのための構造だと思われます．

交通系ICかどうかを判別して，残高を読み出すコードは以下になります．
NFCReader.cs
以下に解説を記述していきます．