問題背景

最近做了一個 ipv6 相關的功能，發現使用 getifaddrs 獲取的本地 ipv6 地址有可能不是真實的網路 ipv6 地址：

例如上圖中通過 getifaddrs 獲得了多個本地 ipv6 地址，其中 <fe80> 開頭的已知是本地 ipv6 地址，被排除；還有 <2408> 這種，其實也是 "假 ipv6" 地址，對應的裝置並不能存取 ipv6 網路。

對於這種假 v6 地址，無法通過遍歷的方式進行列舉排除，而一旦將 v4 網路環境錯認為是 v6 環境，對後面的網路操作影響比較大。需要引入一種準確判斷當前網路是否有 ipv6 存取能力的方法，為此 server 端同學專門給了一個判斷介面。

probe_v6_addr

出於安全考慮，這裡只列出介面名稱部分：

http://xxx.xxxxxxxxxx.xxxxxxx.xxxxx.xxx/xxx/probe_v6_addr

存取這個介面有兩種返回，當不存在 v6 網路環境時：

no v6 addr

當存在時，返回本機的 ipv6 地址：

$ curl -s http://xxx.xxxxxxxxxx.xxxxxxx.xxxxx.xxx/xxx/probe_v6_addr
+
%240e:304:8183:2bcc:c16d:22d0:74ba:23e??-
'2408:832e:c272:b36e:55bc:554a:8952:553e,
&240e:3a0:7005:6ae2:d05a:754a:c21b:6c35??+
%240e:310:915:d939:9041:c01c:82db:a043??-
'2408:832e:c271:3851:6926:e953:e741:b1a3??+
%240e:378:1e0c:db62:7088:a216:87c:4ccd??OP46C3:/

雖然有部分二進位制資訊干擾，但是 ipv6 地址部分還是看得比較清楚的。返回的地址和 ifconfig 的結果可以相互印證：

$ ifconfig | grep inet6
          inet6 addr: fe80::fc8e:84ff:fec0:1534/64 Scope: Link
          inet6 addr: 240e:505:7e01:2994:f43c:5fc9:609e:5de6/64 Scope: Global
          inet6 addr: fe80::f43c:5fc9:609e:5de6/64 Scope: Link
          inet6 addr: fe80::8fd0:cd9e:52cd:5bc3/64 Scope: Link
          inet6 addr: 2409:8100:7b00:5781:a4a8:71ce:b11:3c5e/64 Scope: Global
          inet6 addr: fe80::a4a8:71ce:b11:3c5e/64 Scope: Link
          inet6 addr: ::1/128 Scope: Host
          inet6 addr: fe80::29f8:41f:7564:501d/64 Scope: Link
          inet6 addr: 240e:404:7e01:5d77:29f8:41f:7564:501d/64 Scope: Global
          inet6 addr: fe80::3d14:7716:4771:88fa/64 Scope: Link
          inet6 addr: 240e:304:8183:2bcc:c16d:22d0:74ba:23e/64 Scope: Global
          inet6 addr: 240e:304:8183:2bcc:d8c5:dce4:a89c:8a88/64 Scope: Global

其中 ipv6 地址240e:304:8183:2bcc:c16d:22d0:74ba:23e/64在兩邊都存在。

protobuf

上面的介面確實是基於二進位制資料的協定，雖然是私有協定，但是採用了 protobuf 來進行規範，在提高效能的同時，也保留了一定的通用性。

但是這樣一來，往常慣用的 curl + shell 大法要失靈了，給測試和驗證工作帶來了不小的麻煩。

不過好在有 proto 檔案，生成一段解析的 c++ 程式碼也不是不可能：

> cat msg.proto
message ProbeIpv6Request {
    string xxxxx     = 1;
    string xxxx      = 2;
    string xxxxxxxx  = 3;
    string xxxxxxx   = 4;
}

message V6AddrType {
    string addrV6 = 1;
    uint32 portV6 = 2;
}

message ProbeIpv6Response {
    string              xxxxx    = 1;
    V6AddrType          selfAddr = 2;
    repeated V6AddrType brosAddr = 3;
}

這個 proto 檔案揭示了兩點：

該介面也是有請求的：ProbeIpv6Request，不過可以省略
該介面的響應 ProbeIpv6Response 主要包含兩部分：
- selfAddr 是裝置自己的地址，有且只有一個
- brosAddr 是裝置的廣播地址，可能存在多個 (repeated)
- 地址都是由一個字串地址和一個整型埠組成

如果使用 protoc 程式根據 msg.proto 生成 c++ 程式碼，再寫程式解析資料，就用不著寫這篇文章了。畢竟那種方式太牛刀殺雞了，下面演示一種使用 shell 指令碼就能搞定 protobuf 協定的新方法。

pbjs

在介紹新方法之前，先介紹本文的主角 pbjs。首先是在 mac 上的安裝：

brew install node
brew install npm
npm install -g protobufjs
npm install -g pbjs

pbjs 是 nodejs 提供的，用來將 protobuf 二進位制資料轉換為 json，所以需要先安裝 nodejs、npm 環境，linux 上的安裝大同小異，此處不再贅述。

執行成功後驗證 pbjs 是否安裝：

> pbjs
Usage: pbjs [options] <schema_path>

Options:
  -V, --version        output the version number
  --es5 <js_path>      Generate ES5 JavaScript code
  --es6 <js_path>      Generate ES6 JavaScript code
  --ts <ts_path>       Generate TypeScript code
  --decode <msg_type>  Decode standard input to JSON
  --encode <msg_type>  Encode standard input to JSON
  -h, --help           output usage information
> which pbjs
/Users/yunhai01/tools/node-v14.17.0-darwin-x64/bin/pbjs
> ls -lh /Users/yunhai01/tools/node-v14.17.0-darwin-x64/bin/pbjs
lrwxr-xr-x  1 yunhai01  staff    31B Apr 16 18:26 /Users/yunhai01/tools/node-v14.17.0-darwin-x64/bin/pbjs -> ../lib/node_modules/pbjs/cli.js

看起來這就是一個 node module 的軟連結。

pbjs 的功能有很多，help 資訊中已經羅列出來了，例如生成 js 程式碼 (--es5/--es6)，生成 ts 程式碼 (--ts)，不過最讓我感興趣的還是 --decode，意思是可以將資料解析為 json，下面用上一節的二進位制資料做個練手，假設資料已經儲存在名為 response.bin 的檔案：

> pbjs msg.proto --decode ProbeIpv6Response < response.bin
{
  "selfAddr": {
    "addrV6": "240e:304:8183:2bcc:c16d:22d0:74ba:23e",
    "portV6": 47832
  },
  "brosAddr": [
    {
      "addrV6": "240e:333:6b00:b00e:38db:2815:306b:3d9b",
      "portV6": 18947
    },
    {
      "addrV6": "240e:333:1707:ca6f:24d3:61ae:86cf:a6fa",
      "portV6": 18112
    },
    {
      "addrV6": "2409:8a38:9002:70b3:19a3:66a3:d778:65cc",
      "portV6": 18780
    },
    {
      "addrV6": "2408:8266:700:1a62:8ad0:4097:9220:577b",
      "portV6": 18595
    },
    {
      "addrV6": "240e:3a0:9001:4013:99c0:11c4:7d3b:e8e5",
      "portV6": 18319
    }
  ]
}

哈哈，果然成功，過程異常絲滑！

jq

有了 json 資料就好辦了，下面上 jq 提取裝置 IP，假設已經將資料儲存在了 response.json 檔案中：

> jq -r '.selfAddr.addrV6'  probe_v6.json
240e:304:8183:2bcc:c16d:22d0:74ba:23e

和之前猜測的 IP 地址結果一致。

結語

pbjs 不光可以用來解析響應，也可以用來構造 protobuf 格式的請求，主要就是依賴它的 --encode 引數：

pbjs msg.proto --encode ProbeIpv6Request < request.json > request.bin

注意 --decode/--encode 一次只能處理一個訊息型別，而協定檔案中可能包括多個，所以需要在這裡為它們進行指定，之前指定的是 ProbeIpv6Response 訊息，這裡改為 ProbeIpv6Request 訊息。

關於 request.json 檔案，簡單的可以直接手動構造，複雜的可以藉助 jq --arg 動態生成，這方面詳細的資訊可以參考我之前寫的這幾篇文章：《用 shell 指令碼做 tcp 協定模擬》、《使用 shell 指令碼自動申請進京證 (六環外) 》。

至此 protobuf 二進位制資料也不再是指令碼不可觸控的區域，有這方面介面測試需求的同學們快用起來吧 ~

後記

使用基於 pbjs 的指令碼在 android 裝置上驗證上述介面後，能正確返回結果，並且發現了幾個小問題，為後面寫 c++ 程式碼接入鋪平了道路，比起直接使用 adb 跑指令碼，編譯 sdk 再打 apk 包驗證成本實在是太高了，pbjs 確確實實提升了我的效率。

參考

[1]. Protocol Buffers for JavaScript

[2]. 工作筆記：protobufjs使用教學，支援proto檔案打包成typescript或javascript指令碼

使用指令碼收發 protobuf 協定資料

問題背景

probe_v6_addr

protobuf

pbjs

jq

結語

後記

參考