0x01 概述
使用electron開進(jìn)行桌面程序的開發(fā)撒璧，似乎成了WEB前端開發(fā)人員轉(zhuǎn)桌面程序開發(fā)的首選只锻。近期有一些使用在electron中使用加密鎖的需求友瘤，學(xué)習(xí)了一下在Node.js中通過ffi-napi模塊調(diào)用動(dòng)態(tài)鏈接庫基公，把幾款加密鎖產(chǎn)品的動(dòng)態(tài)庫使用javascript封裝了一下条篷，實(shí)現(xiàn)了electron中使用加密鎖功能。
開發(fā)過程中遇到了一些問題芦倒，踩了一些坑艺挪，這里總結(jié)記錄一下。這里使用接口函數(shù)參數(shù)類型比較復(fù)雜的ROCKEY-ARM的動(dòng)態(tài)鏈接庫來進(jìn)行開發(fā)兵扬。
NOTE: javascript封裝的ROCKEY-ARM接口模塊源碼麻裳，我已經(jīng)分享出來，如果只是需要electron或者Node.js工程中使用ROCKEY-ARM的網(wǎng)友器钟，可以直接使用津坑。
# 克隆
$ git clone https://github.com/youngbug/js-rockeyarm.git
0x02 準(zhǔn)備
1. 安裝依賴模塊
首先需要在node.js項(xiàng)目中安裝調(diào)用動(dòng)態(tài)鏈接庫時(shí)需要依賴的模塊ffi-napi,ref-napi,ref-array-napi,ref-struct-napi。
npm install ffi-napi
npm install ref-napi
npm install ref-array-napi
npm install struct-napi
下面大概介紹一下這幾個(gè)模塊的用途：
ffi-napi: 在javascript中調(diào)用動(dòng)態(tài)鏈接庫（.dll/.so）俱箱，在Node.js中使用這個(gè)模塊可以不寫任何C/C++代碼來創(chuàng)建一個(gè)對(duì)本地庫的綁定国瓮。
ref-napi: 這個(gè)模塊定義了很多C/C++的常見數(shù)據(jù)類型，可以在聲明和調(diào)用動(dòng)態(tài)庫的時(shí)候直接使用狞谱。
ref-array-napi: 這個(gè)模塊在Node.js中提供了一個(gè)數(shù)組的實(shí)現(xiàn)乃摹，在聲明和調(diào)用函數(shù)中，所有的指針都可以聲明成一個(gè)uchar數(shù)組跟衅。
ref-struct-napi: 這個(gè)模塊在Node.js中提供了一個(gè)結(jié)構(gòu)體類型的實(shí)現(xiàn)孵睬。ROCKEY-ARM的函數(shù)很多參數(shù)都是結(jié)構(gòu)體指針，如果聲明稱uchar的數(shù)組伶跷，那么傳出的數(shù)據(jù)都是uchar數(shù)組掰读，解析的時(shí)候不方便，需要自己拼接叭莫，除了麻煩蹈集，還要考慮字節(jié)序的問題。如果使用結(jié)構(gòu)體雇初，并定義一個(gè)結(jié)構(gòu)體數(shù)組來作為指針傳入拢肆，函數(shù)返回的結(jié)構(gòu)體參數(shù)，就可以直接用結(jié)構(gòu)體進(jìn)行解析，會(huì)比較方便郭怪。
2.準(zhǔn)備調(diào)用的動(dòng)態(tài)庫
向飛天誠信購買ROCKEY-ARM加密鎖產(chǎn)品支示，可以獲得ROCKEY-ARM的SDK，可以獲得Windows和Linux的動(dòng)態(tài)鏈接庫鄙才，文件名一般為Dongle_d.和libRockeyARM.so.0.3颂鸿。
0x03 聲明函數(shù)接口
ffi-napi支持Windows，Linux系統(tǒng)攒庵，所以.dll和.so都可以支持嘴纺，在不同的操作系統(tǒng)下去加載不同的動(dòng)態(tài)庫文件就可以了。加載動(dòng)態(tài)庫的方法如下:
import { Library as ffi_Library } from 'ffi-napi'
libRockey = new ffi_Library('d:/rockey/x64/Dongle_d.dll',rockeyInterface)
Library()第一個(gè)參數(shù)是.dll的路徑叙甸，Linux系統(tǒng)是.so的路徑颖医。第二個(gè)參數(shù)rockeyInterface是動(dòng)態(tài)庫導(dǎo)出函數(shù)的聲明位衩，ROCKEY-ARM的導(dǎo)出函數(shù)比較多裆蒸，我單獨(dú)拿出來定義。具體下面會(huì)講到糖驴。
1. 聲明幾個(gè)簡單函數(shù)
首先從ROCKEY-ARM中找?guī)讉€(gè)參數(shù)簡單的函數(shù)來聲明一下僚祷。
typedef void * DONGLE_HANDLE;
DWORD WINAPI Dongle_Open(DONGLE_HANDLE * phDongle, int nIndex);
DWORD WINAPI Dongle_ResetState(DONGLE_HANDLE hDongle);
DWORD WINAPI Dongle_Close(DONGLE_HANDLE hDongle);
DWORD WINAPI Dongle_GenRandom(DONGLE_HANDLE hDongle, int nLen, BYTE * pRandom);
首先看一下上面幾個(gè)接口用到的數(shù)據(jù)類型有:DONGLE_HANDLE,DWORD,DONGLE_HANDLE,int,BYTE這幾種。
再看下ffi-napi支持的ref-napi支持的數(shù)據(jù)類型有以下類型：
void,int64,ushort,int,uint64,float,uint,long,
double,int8,ulong,Object,uint8,longlong,CString,
int16,char,byte,int32,uchar,size_t,uint32,short
參數(shù)這里應(yīng)該用長度一致的數(shù)據(jù)類型贮缕，可以有以下匹配辙谜。
| C類型 | 長度 | ref-napi類型 | 說明 |
|---|---|---|---|
| DONGLE_HANDLE | 4/8 | uint | C的定義是void*，是一個(gè)指針長度是4/8字節(jié)感昼，用uint |
| DONGLE_HANDLE* | 4/8 | ptrHandle | 定義一個(gè)指向DONGLE_HANDLE的指針装哆，用uint應(yīng)該也是可以，但我沒測試 |
| int | 4 | int | |
| BYTE* | 4/8 | prtByte | 定義一個(gè)指向uchar的指針定嗓，用uint應(yīng)該也是可以蜕琴，但我沒測試 |
聲明的寫法如下：
const rockeyInterface = {
'Dongle_Open' : ['int', [ptrHandle, 'int']],
'Dongle_ResetState' : ['int', [ryHandle]],
'Dongle_Close': ['int', [ryHandle]],
'Dongle_GenRandom' : ['int', [ryHandle, 'int', ptrByte]]
}
一個(gè)json，key是動(dòng)態(tài)庫導(dǎo)出函數(shù)名宵溅，比如'Dongle_Open'凌简，value是個(gè)列表，第一個(gè)元素是返回值恃逻，第二個(gè)元素是參數(shù)雏搂。其中參數(shù)還是個(gè)列表。這個(gè)ref-napi中有適合類型的寇损，直接寫稱具體類型即可凸郑，比如返回值DWORD和傳入的長度int，我這里都用'int'矛市。其他的參數(shù)我額外定義了句柄ryHandle芙沥、句柄的指針ptrHandle、字節(jié)的指針ptrByte。其中ryHandle憨愉，ptrryHandle烦绳，ptrByte的定義如下：
const refArray = require('ref-array-napi')
var ryHandle = refArray(ref.types.uint)
var ptrHandle = refArray(ryHandle)
var ptrByte = refArray(ref.types.uchar)
2. void*類型參數(shù)
DONGLE_HANDLE本質(zhì)是void *類型, void* 類型最開始的時(shí)候妄圖定義一個(gè)void的數(shù)組，然后用void數(shù)組來表示void配紫，然后發(fā)現(xiàn)報(bào)斷言錯(cuò)誤径密，數(shù)組不支持void類型。所以就直接用無符號(hào)數(shù)來表示void指針躺孝，在64位系統(tǒng)是8字節(jié)享扔，32位系統(tǒng)是4字節(jié)，使用uint類型就可以了植袍。DONGLE_HANDLE惧眠。
3. 結(jié)構(gòu)體數(shù)組類型參數(shù)
在ROCKEY-ARM的函數(shù)中也有很多帶參數(shù)的接口，比如：
typedef struct {
unsigned int bits;
unsigned int modulus;
unsigned char exponent[256];
} RSA_PUBLIC_KEY;
typedef struct {
unsigned int bits;
unsigned int modulus;
unsigned char publicExponent[256];
unsigned char exponent[256];
} RSA_PRIVATE_KEY;
typedef struct
{
unsigned short m_Ver;
unsigned short m_Type;
unsigned char m_BirthDay[8];
unsigned long m_Agent;
unsigned long m_PID;
unsigned long m_UserID;
unsigned char m_HID[8];
unsigned long m_IsMother;
unsigned long m_DevType;
} DONGLE_INFO;
DWORD WINAPI Dongle_Enum(DONGLE_INFO * pDongleInfo, int * pCount);
DWORD WINAPI Dongle_RsaGenPubPriKey(DONGLE_HANDLE hDongle, WORD wPriFileID, RSA_PUBLIC_KEY * pPubBakup, RSA_PRIVATE_KEY * pPriBakup);
拿以上兩個(gè)函數(shù)接口舉例于个，Dongle_Enum中的第一個(gè)參數(shù)是一個(gè)指向DONGLE_INFO結(jié)構(gòu)體的指針氛魁，運(yùn)行后返回設(shè)備信息的列表，使用ROCKEY-ARM的時(shí)候需要通過枚舉函數(shù)獲得設(shè)備信息列表厅篓，然后比較產(chǎn)品ID或者硬件ID決定打開哪一個(gè)設(shè)備秀存。為了方便從枚舉函數(shù)返回的設(shè)備信息中方便的解析出產(chǎn)品ID或者硬件ID等信息，需要把DONGLE_INFO* pDongleInfo這個(gè)參數(shù)聲明成一個(gè)結(jié)構(gòu)體數(shù)組羽氮。Dongle_RsaGenPubPriKey()函數(shù)中有RSA_PUBLIC_KEY,RSA_PRIVATE_KEIY兩個(gè)結(jié)構(gòu)體指針參數(shù)或链，因?yàn)樵谶@里一般用戶并不需要解析RSA密鑰中的n,d,e等分量，可以直接做作為一個(gè)字節(jié)數(shù)組档押，直接聲明成上面的ptrByte類型即可澳盐。所以在聲明如下：
const ref = require('ref-napi')
const refArray = require('ref-array-napi')
const StructType = require ('ref-struct-napi')
var dongleInfo = StructType({
m_VerL: ref.types.uchar,
m_VerR: ref.types.uchar,
m_Type: ref.types.ushort,
m_BirthdayL:ref.types.uint32,
m_BirthdayR:ref.types.uint32,
m_Agent: ref.types.uint32,
m_PID: ref.types.uint32,
m_UserID: ref.types.uint32,
m_HIDL: ref.types.uint32,
m_HIDR: ref.types.uint32,
m_IsMother: ref.types.uint32,
m_DevType: ref.types.uint32
})
var ptrInt = refArray(ref.types.int)
var ryHandle = refArray(ref.types.uint)
var ptrHandle = refArray(ryHandle)
var ptrDongleInfo = refArray(dongleInfo)
var ptrByte = refArray(ref.types.uchar)
const rockeyInterface = {
'Dongle_Enum' : ['int', [ptrDongleInfo, ptrInt]],
'Dongle_RsaGenPubPriKey' : ['int', [ryHandle, 'ushort', ptrByte, ptrByte]]
}
0x04 調(diào)用聲明的函數(shù)
調(diào)用ffi-napi聲明的函數(shù)，主要是給自己定義的數(shù)據(jù)類型賦初值以及獲得自定義參數(shù)的返回值令宿。下面分別說明叼耙。
1. int*
這里的int*，是讓函數(shù)返回設(shè)備的數(shù)量掀淘，或者傳入輸入數(shù)據(jù)的長度或者傳出輸出數(shù)據(jù)的長度旬蟋，所以只要定義一個(gè)長度為1的int數(shù)組即可，如下：
var piCount = new ptrInt(1) //
piCount[0] = 0
給傳入的數(shù)據(jù)賦值革娄，只要給下標(biāo)為0的元素賦值即可倾贰。
2. DONGLE_INFO*
這個(gè)參數(shù)是枚舉函數(shù)傳出枚舉到設(shè)備信息的列表，枚舉到多少設(shè)備拦惋，就傳出多少個(gè)DONGLE_INFO匆浙，所以需要傳入足夠數(shù)量的的DONGLE_INFO，如下：
libRockey.Dongle_Enum(null, piCount)//獲得設(shè)備的數(shù)量
var DongleList = new ptrDongleInfo(piCount[0])
libRockey.Dongle_Enum(DongleList, piCount)
console.log(DongleList[0].m_PID) //輸出枚舉到的第一個(gè)設(shè)備的PID
3. BYTE*
這個(gè)參數(shù)一般是作為傳入傳出數(shù)據(jù)的緩沖區(qū)的厕妖，所以創(chuàng)建數(shù)組的時(shí)候首尼，需要?jiǎng)?chuàng)建足夠長的空間，如下：
var buffer = new ptrByte(len)
0x05 踩坑總結(jié)
開發(fā)的過程中，踩到一些坑耽誤了不少時(shí)間软能，這里總結(jié)一下迎捺。
ROCKEY-ARM的結(jié)構(gòu)體是按字節(jié)對(duì)齊的，ref-struct-napi沒有找到設(shè)置字節(jié)對(duì)齊的方法查排。當(dāng)時(shí)聲明的結(jié)構(gòu)體如下：
var dongleInfo = StructType({
m_VerL: ref.types.uchar,
m_VerR: ref.types.uchar,
m_Type: ref.types.ushort,
m_Birthday: ref.types.uint64,
m_Agent: ref.types.uint32,
m_PID: ref.types.uint32,
m_UserID: ref.types.uint32,
m_HID: ref.types.uint64,
m_IsMother: ref.types.uint32,
m_DevType: ref.types.uint32
})
測試的時(shí)候會(huì)發(fā)現(xiàn)定義的結(jié)構(gòu)體和ROCKEY-ARM定義的結(jié)構(gòu)體對(duì)齊方式不一樣凳枝，于是把m_Birthday和m_HID兩個(gè)成員從ref.types.uint64，拆分成左右兩個(gè)uint32跋核，這樣就可以讓結(jié)構(gòu)體對(duì)齊方式和ROCKEY-ARM的一致岖瑰。使用m_Birthday和m_HID的時(shí)候，需要講左右兩個(gè)uint32拼接一些砂代，稍微麻煩一點(diǎn)蹋订，但是在沒找到配置StructType對(duì)齊方的情況，保證結(jié)果正確刻伊，還是可以接受的露戒。
