-
Notifications
You must be signed in to change notification settings - Fork 758
/
binary_xml.go
784 lines (720 loc) · 19 KB
/
binary_xml.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
// Copyright 2015 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package main
import (
"encoding/xml"
"fmt"
"io"
"sort"
"strconv"
"strings"
"unicode/utf16"
)
// binaryXML converts XML into Android's undocumented binary XML format.
//
// The best source of information on this format seems to be the source code
// in AOSP frameworks-base. Android "resource" types seem to describe the
// encoded bytes, in particular:
//
// ResChunk_header
// ResStringPool_header
// ResXMLTree_node
//
// These are defined in:
//
// https://android.googlesource.com/platform/frameworks/base/+/master/include/androidfw/ResourceTypes.h
//
// The rough format of the file is a resource chunk containing a sequence of
// chunks. Each chunk is made up of a header and a body. The header begins with
// the contents of the ResChunk_header struct, which includes the size of both
// the header and the body.
//
// Both the header and body are 4-byte aligned.
//
// Values are encoded as little-endian.
//
// The android source code for encoding is done in the aapt tool. Its source
// code lives in AOSP:
//
// https://android.googlesource.com/platform/frameworks/base.git/+/master/tools/aapt
//
// A sample layout:
//
// File Header (ResChunk_header, type XML)
// Chunk: String Pool (type STRING_POOL)
// Sequence of strings, each with the format:
// uint16 length
// uint16 extended_length -- only if top bit set on length
// UTF-16LE string
// two zero bytes
// Resource Map
// The [i]th 4-byte entry in the resource map corresponds with
// the [i]th string from the string pool. The 4-bytes are a
// Resource ID constant defined:
// http://developer.android.com/reference/android/R.attr.html
// This appears to be a way to map strings onto enum values.
// Chunk: Namespace Start (ResXMLTree_node; ResXMLTree_namespaceExt)
// Chunk: Element Start
// ResXMLTree_node
// ResXMLTree_attrExt
// ResXMLTree_attribute (repeated attributeCount times)
// Chunk: Element End
// (ResXMLTree_node; ResXMLTree_endElementExt)
// ...
// Chunk: Namespace End
func binaryXML(r io.Reader) ([]byte, error) {
lr := &lineReader{r: r}
d := xml.NewDecoder(lr)
pool := new(binStringPool)
depth := 0
elements := []chunk{}
namespaceEnds := make(map[int][]binEndNamespace)
for {
line := lr.line(d.InputOffset())
tok, err := d.Token()
if err != nil {
if err == io.EOF {
break
}
return nil, err
}
switch tok := tok.(type) {
case xml.StartElement:
// uses-sdk is synthesized by the writer, disallow declaration in manifest.
if tok.Name.Local == "uses-sdk" {
return nil, fmt.Errorf("unsupported manifest tag <uses-sdk .../>")
} else if tok.Name.Local == "application" {
// synthesize <uses-sdk/> before handling <application> token
attr := xml.Attr{
Name: xml.Name{
Space: "http://schemas.android.com/apk/res/android",
Local: "minSdkVersion",
},
Value: "15",
}
ba, err := pool.getAttr(attr)
if err != nil {
return nil, fmt.Errorf("failed to synthesize attr minSdkVersion=\"15\"")
}
elements = append(elements,
&binStartElement{
line: line - 1, // current testing strategy is not friendly to synthesized tags, -1 for would-be location
ns: pool.getNS(""),
name: pool.get("uses-sdk"),
attr: []*binAttr{ba},
},
&binEndElement{
line: line - 1,
ns: pool.getNS(""),
name: pool.get("uses-sdk"),
})
}
// Intercept namespace definitions.
var attr []*binAttr
for _, a := range tok.Attr {
if a.Name.Space == "xmlns" {
elements = append(elements, binStartNamespace{
line: line,
prefix: pool.get(a.Name.Local),
url: pool.get(a.Value),
})
namespaceEnds[depth] = append([]binEndNamespace{{
line: line,
prefix: pool.get(a.Name.Local),
url: pool.get(a.Value),
}}, namespaceEnds[depth]...)
continue
}
ba, err := pool.getAttr(a)
if err != nil {
return nil, fmt.Errorf("%d: %s: %v", line, a.Name.Local, err)
}
attr = append(attr, ba)
}
depth++
elements = append(elements, &binStartElement{
line: line,
ns: pool.getNS(tok.Name.Space),
name: pool.get(tok.Name.Local),
attr: attr,
})
case xml.EndElement:
elements = append(elements, &binEndElement{
line: line,
ns: pool.getNS(tok.Name.Space),
name: pool.get(tok.Name.Local),
})
depth--
if nsEnds := namespaceEnds[depth]; len(nsEnds) > 0 {
delete(namespaceEnds, depth)
for _, nsEnd := range nsEnds {
elements = append(elements, nsEnd)
}
}
case xml.CharData:
// The aapt tool appears to "compact" leading and
// trailing whitepsace. See XMLNode::removeWhitespace in
// https://android.googlesource.com/platform/frameworks/base.git/+/master/tools/aapt/XMLNode.cpp
if len(tok) == 0 {
continue
}
start, end := 0, len(tok)
for start < len(tok) && isSpace(tok[start]) {
start++
}
for end > start && isSpace(tok[end-1]) {
end--
}
if start == end {
continue // all whitespace, skip it
}
// Preserve one character of whitespace.
if start > 0 {
start--
}
if end < len(tok) {
end++
}
elements = append(elements, &binCharData{
line: line,
data: pool.get(string(tok[start:end])),
})
case xml.Comment:
// Ignored by Anroid Binary XML format.
case xml.ProcInst:
// Ignored by Anroid Binary XML format?
case xml.Directive:
// Ignored by Anroid Binary XML format.
default:
return nil, fmt.Errorf("apk: unexpected token: %v (%T)", tok, tok)
}
}
sortPool(pool)
for _, e := range elements {
if e, ok := e.(*binStartElement); ok {
sortAttr(e, pool)
}
}
resMap := &binResMap{pool}
size := 8 + pool.size() + resMap.size()
for _, e := range elements {
size += e.size()
}
b := make([]byte, 0, size)
b = appendHeader(b, headerXML, size)
b = pool.append(b)
b = resMap.append(b)
for _, e := range elements {
b = e.append(b)
}
return b, nil
}
func isSpace(b byte) bool {
switch b {
case '\t', '\n', '\v', '\f', '\r', ' ', 0x85, 0xA0:
return true
}
return false
}
type headerType uint16
const (
headerXML headerType = 0x0003
headerStringPool = 0x0001
headerResourceMap = 0x0180
headerStartNamespace = 0x0100
headerEndNamespace = 0x0101
headerStartElement = 0x0102
headerEndElement = 0x0103
headerCharData = 0x0104
)
func appendU16(b []byte, v uint16) []byte {
return append(b, byte(v), byte(v>>8))
}
func appendU32(b []byte, v uint32) []byte {
return append(b, byte(v), byte(v>>8), byte(v>>16), byte(v>>24))
}
func appendHeader(b []byte, typ headerType, size int) []byte {
b = appendU16(b, uint16(typ))
b = appendU16(b, 8)
b = appendU16(b, uint16(size))
b = appendU16(b, 0)
return b
}
// Attributes of the form android:key are mapped to resource IDs, which are
// embedded into the Binary XML format.
//
// http://developer.android.com/reference/android/R.attr.html
var resourceCodes = map[string]uint32{
"versionCode": 0x0101021b,
"versionName": 0x0101021c,
"minSdkVersion": 0x0101020c,
"windowFullscreen": 0x0101020d,
"theme": 0x01010000,
"label": 0x01010001,
"hasCode": 0x0101000c,
"debuggable": 0x0101000f,
"name": 0x01010003,
"screenOrientation": 0x0101001e,
"configChanges": 0x0101001f,
"value": 0x01010024,
}
// http://developer.android.com/reference/android/R.attr.html#configChanges
var configChanges = map[string]uint32{
"mcc": 0x0001,
"mnc": 0x0002,
"locale": 0x0004,
"touchscreen": 0x0008,
"keyboard": 0x0010,
"keyboardHidden": 0x0020,
"navigation": 0x0040,
"orientation": 0x0080,
"screenLayout": 0x0100,
"uiMode": 0x0200,
"screenSize": 0x0400,
"smallestScreenSize": 0x0800,
"layoutDirection": 0x2000,
"fontScale": 0x40000000,
}
// http://developer.android.com/reference/android/R.attr.html#screenOrientation
var screenOrientation = map[string]int{
"unspecified": -1,
"landscape": 0,
"portrait": 1,
"user": 2,
"behind": 3,
"sensor": 4,
"nosensor": 5,
"sensorLandscape": 6,
"sensorPortrait": 7,
"reverseLandscape": 8,
"reversePortrait": 9,
"fullSensor": 10,
"userLandscape": 11,
"userPortrait": 12,
"fullUser": 13,
"locked": 14,
}
// reference is an alias used to write out correct type in bin.
type reference uint32
// http://developer.android.com/reference/android/R.style.html
var theme = map[string]reference{
"Theme": 0x01030005,
"Theme_NoTitleBar": 0x01030006,
"Theme_NoTitleBar_Fullscreen": 0x01030007,
"Theme_Black": 0x01030008,
"Theme_Black_NoTitleBar": 0x01030009,
"Theme_Black_NoTitleBar_Fullscreen": 0x0103000a,
"Theme_Light": 0x0103000c,
"Theme_Light_NoTitleBar": 0x0103000d,
"Theme_Light_NoTitleBar_Fullscreen": 0x0103000e,
"Theme_Translucent": 0x0103000f,
"Theme_Translucent_NoTitleBar": 0x01030010,
"Theme_Translucent_NoTitleBar_Fullscreen": 0x01030011,
}
type lineReader struct {
off int64
lines []int64
r io.Reader
}
func (r *lineReader) Read(p []byte) (n int, err error) {
n, err = r.r.Read(p)
for i := 0; i < n; i++ {
if p[i] == '\n' {
r.lines = append(r.lines, r.off+int64(i))
}
}
r.off += int64(n)
return n, err
}
func (r *lineReader) line(pos int64) int {
return sort.Search(len(r.lines), func(i int) bool {
return pos < r.lines[i]
}) + 1
}
type bstring struct {
ind uint32
str string
enc []byte // 2-byte length, utf16le, 2-byte zero
}
type chunk interface {
size() int
append([]byte) []byte
}
type binResMap struct {
pool *binStringPool
}
func (p *binResMap) append(b []byte) []byte {
b = appendHeader(b, headerResourceMap, p.size())
for _, bstr := range p.pool.s {
c, ok := resourceCodes[bstr.str]
if !ok {
break
}
b = appendU32(b, c)
}
return b
}
func (p *binResMap) size() int {
count := 0
for _, bstr := range p.pool.s {
if _, ok := resourceCodes[bstr.str]; !ok {
break
}
count++
}
return 8 + 4*count
}
type binStringPool struct {
s []*bstring
m map[string]*bstring
}
func (p *binStringPool) get(str string) *bstring {
if p.m == nil {
p.m = make(map[string]*bstring)
}
res := p.m[str]
if res != nil {
return res
}
res = &bstring{
ind: uint32(len(p.s)),
str: str,
}
p.s = append(p.s, res)
p.m[str] = res
if len(str)>>16 > 0 {
panic(fmt.Sprintf("string lengths over 1<<15 not yet supported, got len %d for string that starts %q", len(str), str[:100]))
}
strUTF16 := utf16.Encode([]rune(str))
res.enc = appendU16(nil, uint16(len(strUTF16)))
for _, w := range strUTF16 {
res.enc = appendU16(res.enc, w)
}
res.enc = appendU16(res.enc, 0)
return res
}
func (p *binStringPool) getNS(ns string) *bstring {
if ns == "" {
// Register empty string for inclusion in output (like aapt),
// but do not reference it from namespace elements.
p.get("")
return nil
}
return p.get(ns)
}
func (p *binStringPool) getAttr(attr xml.Attr) (*binAttr, error) {
a := &binAttr{
ns: p.getNS(attr.Name.Space),
name: p.get(attr.Name.Local),
}
if attr.Name.Space != "http://schemas.android.com/apk/res/android" {
a.data = p.get(attr.Value)
return a, nil
}
// Some android attributes have interesting values.
switch attr.Name.Local {
case "versionCode", "minSdkVersion":
v, err := strconv.Atoi(attr.Value)
if err != nil {
return nil, err
}
a.data = int(v)
case "hasCode", "debuggable":
v, err := strconv.ParseBool(attr.Value)
if err != nil {
return nil, err
}
a.data = v
case "configChanges":
v := uint32(0)
for _, c := range strings.Split(attr.Value, "|") {
v |= configChanges[c]
}
a.data = v
case "screenOrientation":
v := 0
for _, c := range strings.Split(attr.Value, "|") {
v |= screenOrientation[c]
}
a.data = v
case "theme":
v := attr.Value
// strip prefix if present as only platform themes are supported
if idx := strings.Index(attr.Value, "/"); idx != -1 {
v = v[idx+1:]
}
v = strings.Replace(v, ".", "_", -1)
a.data = theme[v]
default:
a.data = p.get(attr.Value)
}
return a, nil
}
const stringPoolPreamble = 0 +
8 + // chunk header
4 + // string count
4 + // style count
4 + // flags
4 + // strings start
4 + // styles start
0
func (p *binStringPool) unpaddedSize() int {
strLens := 0
for _, s := range p.s {
strLens += len(s.enc)
}
return stringPoolPreamble + 4*len(p.s) + strLens
}
func (p *binStringPool) size() int {
size := p.unpaddedSize()
size += size % 0x04
return size
}
// overloaded for testing.
var (
sortPool = func(p *binStringPool) {
sort.Sort(p)
// Move resourceCodes to the front.
s := make([]*bstring, 0)
m := make(map[string]*bstring)
for str := range resourceCodes {
bstr := p.m[str]
if bstr == nil {
continue
}
bstr.ind = uint32(len(s))
s = append(s, bstr)
m[str] = bstr
delete(p.m, str)
}
for _, bstr := range p.m {
bstr.ind = uint32(len(s))
s = append(s, bstr)
}
p.s = s
p.m = m
}
sortAttr = func(e *binStartElement, p *binStringPool) {}
)
func (b *binStringPool) Len() int { return len(b.s) }
func (b *binStringPool) Less(i, j int) bool { return b.s[i].str < b.s[j].str }
func (b *binStringPool) Swap(i, j int) {
b.s[i], b.s[j] = b.s[j], b.s[i]
b.s[i].ind, b.s[j].ind = b.s[j].ind, b.s[i].ind
}
func (p *binStringPool) append(b []byte) []byte {
stringsStart := uint32(stringPoolPreamble + 4*len(p.s))
b = appendU16(b, uint16(headerStringPool))
b = appendU16(b, 0x1c) // chunk header size
b = appendU16(b, uint16(p.size()))
b = appendU16(b, 0)
b = appendU32(b, uint32(len(p.s)))
b = appendU32(b, 0) // style count
b = appendU32(b, 0) // flags
b = appendU32(b, stringsStart)
b = appendU32(b, 0) // styles start
off := 0
for _, bstr := range p.s {
b = appendU32(b, uint32(off))
off += len(bstr.enc)
}
for _, bstr := range p.s {
b = append(b, bstr.enc...)
}
for i := p.unpaddedSize() % 0x04; i > 0; i-- {
b = append(b, 0)
}
return b
}
type binStartElement struct {
line int
ns *bstring
name *bstring
attr []*binAttr
}
func (e *binStartElement) size() int {
return 8 + // chunk header
4 + // line number
4 + // comment
4 + // ns
4 + // name
2 + 2 + 2 + // attribute start, size, count
2 + 2 + 2 + // id/class/style index
len(e.attr)*(4+4+4+4+4)
}
func (e *binStartElement) append(b []byte) []byte {
b = appendU16(b, uint16(headerStartElement))
b = appendU16(b, 0x10) // chunk header size
b = appendU16(b, uint16(e.size()))
b = appendU16(b, 0)
b = appendU32(b, uint32(e.line))
b = appendU32(b, 0xffffffff) // comment
if e.ns == nil {
b = appendU32(b, 0xffffffff)
} else {
b = appendU32(b, e.ns.ind)
}
b = appendU32(b, e.name.ind)
b = appendU16(b, 0x14) // attribute start
b = appendU16(b, 0x14) // attribute size
b = appendU16(b, uint16(len(e.attr)))
b = appendU16(b, 0) // ID index (none)
b = appendU16(b, 0) // class index (none)
b = appendU16(b, 0) // style index (none)
for _, a := range e.attr {
b = a.append(b)
}
return b
}
type binAttr struct {
ns *bstring
name *bstring
data interface{} // either int (INT_DEC) or *bstring (STRING)
}
func (a *binAttr) append(b []byte) []byte {
if a.ns != nil {
b = appendU32(b, a.ns.ind)
} else {
b = appendU32(b, 0xffffffff)
}
b = appendU32(b, a.name.ind)
switch v := a.data.(type) {
case int:
b = appendU32(b, 0xffffffff) // raw value
b = appendU16(b, 8) // size
b = append(b, 0) // unused padding
b = append(b, 0x10) // INT_DEC
b = appendU32(b, uint32(v))
case bool:
b = appendU32(b, 0xffffffff) // raw value
b = appendU16(b, 8) // size
b = append(b, 0) // unused padding
b = append(b, 0x12) // INT_BOOLEAN
if v {
b = appendU32(b, 0xffffffff)
} else {
b = appendU32(b, 0)
}
case uint32:
b = appendU32(b, 0xffffffff) // raw value
b = appendU16(b, 8) // size
b = append(b, 0) // unused padding
b = append(b, 0x11) // INT_HEX
b = appendU32(b, uint32(v))
case reference:
b = appendU32(b, 0xffffffff) // raw value
b = appendU16(b, 8) // size
b = append(b, 0) // unused padding
b = append(b, 0x01) // REFERENCE
b = appendU32(b, uint32(v))
case *bstring:
b = appendU32(b, v.ind) // raw value
b = appendU16(b, 8) // size
b = append(b, 0) // unused padding
b = append(b, 0x03) // STRING
b = appendU32(b, v.ind)
default:
panic(fmt.Sprintf("unexpected attr type: %T (%v)", v, v))
}
return b
}
type binEndElement struct {
line int
ns *bstring
name *bstring
attr []*binAttr
}
func (*binEndElement) size() int {
return 8 + // chunk header
4 + // line number
4 + // comment
4 + // ns
4 // name
}
func (e *binEndElement) append(b []byte) []byte {
b = appendU16(b, uint16(headerEndElement))
b = appendU16(b, 0x10) // chunk header size
b = appendU16(b, uint16(e.size()))
b = appendU16(b, 0)
b = appendU32(b, uint32(e.line))
b = appendU32(b, 0xffffffff) // comment
if e.ns == nil {
b = appendU32(b, 0xffffffff)
} else {
b = appendU32(b, e.ns.ind)
}
b = appendU32(b, e.name.ind)
return b
}
type binStartNamespace struct {
line int
prefix *bstring
url *bstring
}
func (binStartNamespace) size() int {
return 8 + // chunk header
4 + // line number
4 + // comment
4 + // prefix
4 // url
}
func (e binStartNamespace) append(b []byte) []byte {
b = appendU16(b, uint16(headerStartNamespace))
b = appendU16(b, 0x10) // chunk header size
b = appendU16(b, uint16(e.size()))
b = appendU16(b, 0)
b = appendU32(b, uint32(e.line))
b = appendU32(b, 0xffffffff) // comment
b = appendU32(b, e.prefix.ind)
b = appendU32(b, e.url.ind)
return b
}
type binEndNamespace struct {
line int
prefix *bstring
url *bstring
}
func (binEndNamespace) size() int {
return 8 + // chunk header
4 + // line number
4 + // comment
4 + // prefix
4 // url
}
func (e binEndNamespace) append(b []byte) []byte {
b = appendU16(b, uint16(headerEndNamespace))
b = appendU16(b, 0x10) // chunk header size
b = appendU16(b, uint16(e.size()))
b = appendU16(b, 0)
b = appendU32(b, uint32(e.line))
b = appendU32(b, 0xffffffff) // comment
b = appendU32(b, e.prefix.ind)
b = appendU32(b, e.url.ind)
return b
}
type binCharData struct {
line int
data *bstring
}
func (*binCharData) size() int {
return 8 + // chunk header
4 + // line number
4 + // comment
4 + // data
8 // junk
}
func (e *binCharData) append(b []byte) []byte {
b = appendU16(b, uint16(headerCharData))
b = appendU16(b, 0x10) // chunk header size
b = appendU16(b, 0x1c) // size
b = appendU16(b, 0)
b = appendU32(b, uint32(e.line))
b = appendU32(b, 0xffffffff) // comment
b = appendU32(b, e.data.ind)
b = appendU16(b, 0x08)
b = appendU16(b, 0)
b = appendU16(b, 0)
b = appendU16(b, 0)
return b
}