本文剖析asn-bits.h/c，從源代碼來(lái)學(xué)習(xí)eSNACC對(duì)BIT STRING的編碼和解碼。
比特字符串的編碼和解碼比較復(fù)雜，我們來(lái)仔細(xì)分析一下代碼吧。
eSNACC用一個(gè)結(jié)構(gòu)體來(lái)表示BIT STRING，定義如下：
typedef struct AsnBits
{
int bitLen;//bit位總長(zhǎng)度
char *bits;
} AsnBits;這兩個(gè)參數(shù)分別是：
bitlen代表這個(gè)比特串的bit位的總長(zhǎng)度，注意是bit位，不是字節(jié)數(shù)！
bits用來(lái)存放比特串；要注意這是一個(gè)bit串，不是字符串，也就是說(shuō)中間可以有0.這不是一個(gè)要求以null結(jié)尾的字符串！
在頭文件中其他的就是BER、DER的編碼解碼的聲明，還有一些幫助函數(shù)的聲明和宏定義。
來(lái)研究一下主要實(shí)現(xiàn)：
先看最外層編碼和解碼函數(shù)：
/**//*
* encodes universal TAG LENGTH and Contents of and ASN.1 BIT STRING
*/
AsnLen
BEncAsnBits PARAMS ((b, data),
GenBuf *b _AND_
AsnBits *data)
{
AsnLen len;
len = BEncAsnBitsContent (b, data);
len += BEncDefLen (b, len);
len += BEncTag1 (b, UNIV, PRIM, BITSTRING_TAG_CODE);
return len;
} /**//* BEncAsnInt */
/**//*
* decodes universal TAG LENGTH and Contents of and ASN.1 BIT STRING
*/
void
BDecAsnBits PARAMS ((b, result, bytesDecoded, env),
GenBuf *b _AND_
AsnBits *result _AND_
AsnLen *bytesDecoded _AND_
jmp_buf env)
{
AsnTag tag;
AsnLen elmtLen;
if (((tag =BDecTag (b, bytesDecoded, env)) !=
MAKE_TAG_ID (UNIV, PRIM, BITSTRING_TAG_CODE)) &&
(tag != MAKE_TAG_ID (UNIV, CONS, BITSTRING_TAG_CODE)))
{
Asn1Error ("BDecAsnBits: ERROR - wrong tag on BIT STRING.\n");
longjmp (env, -40);
}
elmtLen = BDecLen (b, bytesDecoded, env);
BDecAsnBitsContent (b, tag, elmtLen, result, bytesDecoded, env);
} /**//* BDecAsnBits */
我們發(fā)現(xiàn)在BEncAsnBits中編碼時(shí)對(duì)比特串的標(biāo)簽只可能是UNIV-PRIM-BITSTRING_TAG_CODE，但是解碼時(shí)卻支持兩種標(biāo)簽：UNIV-PRIM-BITSTRING_TAG_CODE和UNIV-CONS-BITSTRING_TAG_CODE。
第一個(gè)UNIV-PRIM-BITSTRING_TAG_CODE就是原生的比特串，而第二個(gè)UNIV-CONS-BITSTRING_TAG_CODE是對(duì)應(yīng)多個(gè)原生或者連接型比特串構(gòu)造而成的比特串（嵌套）。這種數(shù)據(jù)是在什么時(shí)候編碼形成的就留到以后的文章來(lái)研究了。反正在當(dāng)前這對(duì)文件的編碼中肯定不會(huì)產(chǎn)生。
我們看一下真正編碼比特串內(nèi)容的函數(shù)：
/**//*
* Encodes the BIT STRING value (including the unused bits
* byte) to the given buffer.
*/
AsnLen
BEncAsnBitsContent PARAMS ((b, bits),
GenBuf *b _AND_
AsnBits *bits)
{
unsigned long unusedBits;
unsigned long byteLen;
int i = 0;
/**//* Check for a dumb special case */
for (i=0; i <bits->bitLen/8 + 1; i++)
{
if (bits->bits[i] != 0)
break;
}
if (i == bits->bitLen/8 + 1)
{
bits->bitLen = 1;
unusedBits = 7;
}
/**//* Work out number of unused bits */
unusedBits = (bits->bitLen % 8);
if (unusedBits != 0)
unusedBits = 8 - unusedBits;
/**//* Work out number of bytes */
if (bits->bitLen == 0) {
byteLen = 0;
}
else {
byteLen = ((bits->bitLen-1) / 8) + 1;
/**//* Ensure last byte is zero padded */
if (unusedBits) {
//此處為什么只在字節(jié)長(zhǎng)度為1時(shí)才做這個(gè)處理呢？
if ((byteLen == 1) && (bits->bits[0] != 0))
{
bits->bits[byteLen-1] = (char)(bits->bits[byteLen-1] &
(0xff << unusedBits));
}
}
}
BufPutSegRvs (b, bits->bits, byteLen);
/**//* check for special DER encoding rules to return 03 01 00 not
03 02 07 00 RWC */
if ( ((bits->bits[0] != 0) || (byteLen > 1))
&& (unusedBits != 7) )
{
BufPutByteRvs (b, (unsigned char)unusedBits);
return byteLen + 1;
}
else
return byteLen;//如果未用的位的數(shù)目為7，并且長(zhǎng)度大于1，或者第一字節(jié)不為0，就不在填充了，這是為什么呢？這不就和解碼時(shí)相沖突了嗎？
} /**//* BEncAsnBitsContent */
我對(duì)這個(gè)函數(shù)還存在幾個(gè)問(wèn)題，就如同在上面注釋中寫(xiě)的。
首先我們看到他判斷要編碼的串是不是就是一個(gè)空串，如果是空串，就把長(zhǎng)度設(shè)為1，未使用字節(jié)數(shù)設(shè)為7。然后計(jì)算了一下將位長(zhǎng)度轉(zhuǎn)為字節(jié)（8位）時(shí)會(huì)產(chǎn)生的未使用的字節(jié)數(shù)。
接著就是實(shí)戰(zhàn)了，根據(jù)bit長(zhǎng)度來(lái)取得要保存這些bit需要的字節(jié)數(shù)：byteLen = ((bits->bitLen-1) / 8) + 1;然后如果根據(jù)前面計(jì)算的如果有未使用的字節(jié)數(shù)，就要用0填充。但是這里不知道他為什么要把這步操作放到if中：只在字節(jié)長(zhǎng)度為1時(shí)才做這個(gè)處理??？除非就是外部傳進(jìn)來(lái)的bits->bits本來(lái)就是用0填充好了的，所以不需要修正。但是如果是填充好了的，那對(duì)1個(gè)字節(jié)長(zhǎng)度的也不需要做這個(gè)操作了。
另外就是，在填充無(wú)效位數(shù)時(shí)，為什么是這樣一個(gè)條件？因?yàn)樵诮獯a函數(shù)（下面分析）中，都始終會(huì)減去代表這個(gè)未用位字節(jié)。
我們來(lái)看看解碼函數(shù)
/**//*
* Decodes the content of a BIT STRING (including the unused bits octet)
* Always returns a single contiguous bit string
*/
void
BDecAsnBitsContent PARAMS ((b, tagId, len, result, bytesDecoded, env),
GenBuf *b _AND_
AsnTag tagId _AND_
AsnLen len _AND_
AsnBits *result _AND_
AsnLen *bytesDecoded _AND_
jmp_buf env)
{
/**//*
* tagId is encoded tag shifted into long int.
* if CONS bit is set then constructed bit string
*/
if (TAG_IS_CONS (tagId))
BDecConsAsnBits (b, len, result, bytesDecoded, env);
else /**//* primitive octet string */
{
if (len == INDEFINITE_LEN)
{
Asn1Error ("BDecAsnBitsContent: ERROR - indefinite length on primitive\n");
longjmp (env, -65);
}
(*bytesDecoded) += len;
len--;//減去代表未用位的那個(gè)字節(jié)
result->bitLen = (len * 8) - (unsigned int)BufGetByte (b);//得到有效位。
result->bits = Asn1Alloc (len);
CheckAsn1Alloc (result->bits, env);
BufCopy (result->bits, b, len);
if (BufReadError (b))
{
Asn1Error ("BDecAsnBitsContent: ERROR - decoded past end of data\n");
longjmp (env, -4);
}
}
} /**//* BDecAsnBitsContent */
他通過(guò)標(biāo)簽走了兩條分支，對(duì)應(yīng)原生比特串，解碼過(guò)程如下：
必須定義確定的長(zhǎng)度，否則報(bào)錯(cuò)。然后數(shù)據(jù)指針先加上指定長(zhǎng)度。
注意此時(shí)先將len--！為什么呢？這是對(duì)應(yīng)這個(gè)len還包含了存放那個(gè)說(shuō)明未使用位的值的1個(gè)字節(jié)，所以len先減去這個(gè)。而下一句就是用BufGetByte獲取那個(gè)字節(jié)，從而得到未使用的bit位的數(shù)目。所以用字節(jié)數(shù)len*8減去這個(gè)值就是全部有用的bit位的數(shù)了。而后面的邏輯就很清楚了：分配一個(gè)len個(gè)字節(jié)的空間并且把bit串拷貝進(jìn)去。
eSNACC對(duì)應(yīng)ConsAsnBits解碼的兩個(gè)函數(shù)就不深入分析了，其原理構(gòu)造了一個(gè)結(jié)構(gòu)體，里面包含一些長(zhǎng)度信息等，和一張指針表，表中有128個(gè)指針，用于指向比特串碎片，所以先對(duì)分散的比特串分別解析，最后分配一整塊大內(nèi)存，再把指針指向的碎片的中內(nèi)容拷貝過(guò)來(lái)。詳細(xì)代碼剖析可以參見(jiàn)eSNACC對(duì)OCTET STRING 的編碼和解碼。
文件中其他的一些幫助函數(shù)理解起來(lái)都比較簡(jiǎn)單，但是似乎發(fā)現(xiàn)AsnBitsEquiv中存在一個(gè)bug：
/**//*
* Returns TRUE if the given BIT STRINGs are identical.
* Otherwise returns FALSE.
*/
int
AsnBitsEquiv PARAMS ((b1, b2),
AsnBits *b1 _AND_
AsnBits *b2)
{
int octetsLessOne;
int unusedBits;
if ((b1->bitLen == 0) && (b2->bitLen == 0))
return TRUE;
octetsLessOne = (b1->bitLen-1)/8;//字節(jié)長(zhǎng)度減一
unusedBits = b1->bitLen % 8;
if (unusedBits != 0)
unusedBits = 8 - unusedBits;
/**//* trailing bits may not be significant */
//此處應(yīng)該是一個(gè)bug。。
/**//*return b1->bitLen == b2->bitLen && !memcmpeq (b1->bits, b2->bits, octetsLessOne) &&
((b1->bits[octetsLessOne] & (0xFF << unusedBits)) == (b1->bits[octetsLessOne] & (0xFF << unusedBits)));*/
return b1->bitLen == b2->bitLen && !memcmpeq (b1->bits, b2->bits, octetsLessOne) &&
((b1->bits[octetsLessOne] & (0xFF << unusedBits)) == (b2->bits[octetsLessOne] & (0xFF << unusedBits)));
} /**//* AsnBitsEquiv */
bug就是函數(shù)最后這句話，原來(lái)那句我就是被注釋的那句，他目的是比較：1、兩個(gè)比特串長(zhǎng)度要相等；2、有效bit位長(zhǎng)度字節(jié)數(shù)減1的串要相同（也就是不考慮后面可能需要補(bǔ)齊的字節(jié)）；3、檢查可能需要被補(bǔ)齊的那個(gè)字節(jié)的對(duì)應(yīng)有效位是否相等。很明顯，應(yīng)該是b1和b2的，所以修正在注釋下面。
分析到此，發(fā)現(xiàn)比特串的編碼解碼模塊存在bug，似乎還有上面說(shuō)的設(shè)計(jì)問(wèn)題，比較困惑：是不是作者在寫(xiě)這個(gè)模塊時(shí)處在XXX時(shí)期？呵呵~