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
|
package rardecode
import (
"bytes"
"crypto/hmac"
"crypto/sha256"
"errors"
"hash"
"io"
"io/fs"
"math"
"sync"
"time"
)
// FileHeader HostOS types
const (
HostOSUnknown = 0
HostOSMSDOS = 1
HostOSOS2 = 2
HostOSWindows = 3
HostOSUnix = 4
HostOSMacOS = 5
HostOSBeOS = 6
)
const (
maxPassword = int(128)
)
var (
ErrShortFile = errors.New("rardecode: decoded file too short")
ErrInvalidFileBlock = errors.New("rardecode: invalid file block")
ErrUnexpectedArcEnd = errors.New("rardecode: unexpected end of archive")
ErrBadFileChecksum = errors.New("rardecode: bad file checksum")
ErrSolidOpen = errors.New("rardecode: solid files don't support Open")
ErrUnknownVersion = errors.New("rardecode: unknown archive version")
)
// FileHeader represents a single file in a RAR archive.
type FileHeader struct {
Name string // file name using '/' as the directory separator
IsDir bool // is a directory
Solid bool // is a solid file
Encrypted bool // file contents are encrypted
HeaderEncrypted bool // file header is encrypted
HostOS byte // Host OS the archive was created on
Attributes int64 // Host OS specific file attributes
PackedSize int64 // packed file size (or first block if the file spans volumes)
UnPackedSize int64 // unpacked file size
UnKnownSize bool // unpacked file size is not known
ModificationTime time.Time // modification time (non-zero if set)
CreationTime time.Time // creation time (non-zero if set)
AccessTime time.Time // access time (non-zero if set)
Version int // file version
}
// Mode returns an fs.FileMode for the file, calculated from the Attributes field.
func (f *FileHeader) Mode() fs.FileMode {
var m fs.FileMode
if f.IsDir {
m = fs.ModeDir
}
if f.HostOS == HostOSWindows {
if f.IsDir {
m |= 0777
} else if f.Attributes&1 > 0 {
m |= 0444 // readonly
} else {
m |= 0666
}
return m
}
// assume unix perms for all remaining os types
m |= fs.FileMode(f.Attributes) & fs.ModePerm
// only check other bits on unix host created archives
if f.HostOS != HostOSUnix {
return m
}
if f.Attributes&0x200 != 0 {
m |= fs.ModeSticky
}
if f.Attributes&0x400 != 0 {
m |= fs.ModeSetgid
}
if f.Attributes&0x800 != 0 {
m |= fs.ModeSetuid
}
// Check for additional file types.
if f.Attributes&0xF000 == 0xA000 {
m |= fs.ModeSymlink
}
return m
}
type byteReader interface {
io.Reader
io.ByteReader
}
type archiveFile interface {
byteReader
io.WriterTo
writeToN(w io.Writer, n int64) (int64, error)
currFile() *fileBlockHeader
nextFile() (*fileBlockList, error)
newArchiveFile(blocks *fileBlockList) (archiveFile, error)
Stat() (fs.FileInfo, error)
}
type archiveFileSeeker interface {
archiveFile
io.Seeker
}
type fileCloser struct {
archiveFile
io.Closer
}
type fileSeekCloser struct {
archiveFileSeeker
io.Closer
}
type errorFile struct {
archiveFile
err error
}
func (ef *errorFile) ReadByte() (byte, error) { return 0, ef.err }
func (ef *errorFile) Read(p []byte) (int, error) { return 0, ef.err }
func (ef *errorFile) WriteTo(w io.Writer) (int64, error) { return 0, ef.err }
func (ef *errorFile) writeToN(w io.Writer, n int64) (int64, error) { return 0, ef.err }
type fileBlockList struct {
mu sync.RWMutex
blocks []*fileBlockHeader
}
func (fl *fileBlockList) firstBlock() *fileBlockHeader {
fl.mu.RLock()
defer fl.mu.RUnlock()
return fl.blocks[0]
}
func (fl *fileBlockList) lastBlock() *fileBlockHeader {
fl.mu.RLock()
defer fl.mu.RUnlock()
return fl.blocks[len(fl.blocks)-1]
}
func (fl *fileBlockList) findBlock(offset int64) *fileBlockHeader {
fl.mu.RLock()
defer fl.mu.RUnlock()
for _, h := range fl.blocks {
if offset < h.PackedSize || (offset == h.PackedSize && h.last) {
return h
}
offset -= h.PackedSize
}
return nil
}
func (fl *fileBlockList) addBlock(h *fileBlockHeader) {
fl.mu.Lock()
defer fl.mu.Unlock()
if len(fl.blocks) == h.blocknum {
fl.blocks = append(fl.blocks, h)
}
}
func (fl *fileBlockList) isDir() bool {
fl.mu.RLock()
defer fl.mu.RUnlock()
return fl.blocks[0].IsDir
}
func (fl *fileBlockList) hasFileHash() bool {
fl.mu.RLock()
defer fl.mu.RUnlock()
return fl.blocks[0].hash != nil
}
func (fl *fileBlockList) removeFileHash() {
fl.mu.Lock()
defer fl.mu.Unlock()
h := *fl.blocks[0]
h.hash = nil
fl.blocks[0] = &h
}
func newFileBlockList(blocks ...*fileBlockHeader) *fileBlockList {
return &fileBlockList{blocks: blocks}
}
// packedFileReader provides sequential access to packed files in a RAR archive.
type packedFileReader struct {
v volume
h *fileBlockHeader // current file header
dr *decodeReader
offset int64
blocks *fileBlockList
opt *options
}
func (f *packedFileReader) init(blocks *fileBlockList) error {
h := blocks.firstBlock()
f.h = h
f.blocks = blocks
f.offset = 0
return nil
}
func (f *packedFileReader) Stat() (fs.FileInfo, error) {
if f.h == nil {
return nil, fs.ErrInvalid
}
return fileInfo{h: f.h}, nil
}
// nextBlock reads the next file block in the current file at the current
// archive file position, or returns an error if there is a problem.
// It is invalid to call this when already at the last block in the current file.
func (f *packedFileReader) nextBlock() error {
if f.h == nil {
return io.EOF
}
if f.h.last {
return io.EOF
}
h, err := f.v.nextBlock()
if err != nil {
if err == io.EOF {
// archive ended, but file hasn't
return ErrUnexpectedArcEnd
} else if err == errVolumeOrArchiveEnd {
return ErrMultiVolume
}
return err
}
if h.first || h.Name != f.h.Name {
return ErrInvalidFileBlock
}
h.packedOff = f.h.packedOff + f.h.PackedSize
h.blocknum = f.h.blocknum + 1
f.h = h
f.offset = h.dataOff
f.blocks.addBlock(h)
return nil
}
// next advances to the next packed file in the RAR archive.
func (f *packedFileReader) nextFile() (*fileBlockList, error) {
// skip to last block in current file
var err error
for err == nil {
err = f.nextBlock()
}
if err != io.EOF {
return nil, err
}
h, err := f.v.nextBlock() // get next file block
if err != nil {
if err == errVolumeOrArchiveEnd {
err = io.EOF
}
return nil, err
}
if !h.first {
return nil, ErrInvalidFileBlock
}
blocks := newFileBlockList(h)
err = f.init(blocks)
if err != nil {
return nil, err
}
return blocks, nil
}
func (f *packedFileReader) currFile() *fileBlockHeader { return f.h }
// Read reads the packed data for the current file into p.
func (f *packedFileReader) Read(p []byte) (int, error) {
for {
n, err := f.v.Read(p)
if err == io.EOF {
err = f.nextBlock()
}
if n > 0 || err != nil {
f.offset += int64(n)
return n, err
}
}
}
func (f *packedFileReader) ReadByte() (byte, error) {
for {
b, err := f.v.ReadByte()
if err == nil {
f.offset++
return b, nil
}
if err == io.EOF {
err = f.nextBlock()
if err == nil {
continue
}
}
return b, err
}
}
func (f *packedFileReader) writeToN(w io.Writer, n int64) (int64, error) {
if n == 0 {
return 0, nil
}
var err error
var tot int64
todo := n
for todo != 0 && err == nil {
var l int64
l, err = f.v.writeToAtMost(w, todo)
if todo > 0 {
todo -= l
}
tot += int64(l)
if err == nil && todo != 0 {
err = f.nextBlock()
}
}
if todo <= 0 && err == io.EOF {
err = nil
}
return tot, err
}
func (f *packedFileReader) WriteTo(w io.Writer) (int64, error) {
return f.writeToN(w, -1)
}
func (pr *packedFileReader) newArchiveFileFrom(r archiveFile, blocks *fileBlockList) (archiveFile, error) {
h := blocks.firstBlock()
err := pr.init(blocks)
if err != nil {
return nil, err
}
if h.Encrypted {
if h.key == nil {
r = &errorFile{archiveFile: r, err: ErrArchivedFileEncrypted}
} else {
r, err = newAesDecryptFileReader(r, h.key, h.iv) // decrypt
if err != nil {
return nil, err
}
}
}
// check for compression
if h.decVer > 0 {
if pr.dr == nil {
pr.dr = new(decodeReader)
}
// doesn't make sense for the dictionary to be larger than the file
if !h.UnKnownSize && h.winSize > h.UnPackedSize {
h.winSize = h.UnPackedSize
}
if h.winSize > maxDictSize || h.winSize > pr.opt.maxDictSize {
return nil, ErrDictionaryTooLarge
}
if h.winSize > math.MaxInt {
return nil, ErrPlatformIntSize
}
err := pr.dr.init(r, h.decVer, int(h.winSize), !h.Solid, h.arcSolid, h.UnPackedSize)
if err != nil {
return nil, err
}
r = pr.dr
}
if h.UnPackedSize >= 0 && !h.UnKnownSize {
// Limit reading to UnPackedSize as there may be padding
r = newLimitedReader(r, h.UnPackedSize)
}
if h.hash != nil && !pr.opt.skipCheck {
r = newChecksumReader(r, h.hash(), blocks.removeFileHash)
}
return r, nil
}
func (pr *packedFileReader) newArchiveFile(blocks *fileBlockList) (archiveFile, error) {
return pr.newArchiveFileFrom(pr, blocks)
}
type packedFileReadSeeker struct {
packedFileReader
}
func (f *packedFileReadSeeker) openBlock(h *fileBlockHeader, offset int64) (int64, error) {
err := f.v.openBlock(h.volnum, h.dataOff+offset, h.PackedSize-offset)
if err != nil {
return 0, err
}
f.h = h
f.offset = h.packedOff + offset
return f.offset, nil
}
func (f *packedFileReadSeeker) openNextBlock(h *fileBlockHeader) error {
_, err := f.openBlock(h, h.PackedSize)
if err != nil {
return err
}
return f.nextBlock()
}
func (f *packedFileReadSeeker) packedSize() (int64, error) {
h := f.blocks.lastBlock()
if h.last {
return h.packedOff + h.PackedSize, nil
}
err := f.openNextBlock(h)
for err == nil {
err = f.nextBlock()
}
if err != io.EOF {
return 0, err
}
if !f.h.last {
return 0, ErrInvalidFileBlock
}
return f.h.packedOff + f.h.PackedSize, nil
}
func (f *packedFileReadSeeker) Seek(offset int64, whence int) (int64, error) {
// calculate absolute offset
switch whence {
case io.SeekStart:
case io.SeekCurrent:
offset += f.offset
case io.SeekEnd:
size, err := f.packedSize()
if err != nil {
return 0, err
}
offset += size
default:
return 0, fs.ErrInvalid
}
if offset < 0 {
return 0, fs.ErrInvalid
}
// find block in existing list
h := f.blocks.findBlock(offset)
if h != nil {
offset -= h.packedOff
return f.openBlock(h, offset)
}
h = f.blocks.lastBlock()
if h.last {
return 0, fs.ErrInvalid
}
err := f.openNextBlock(h)
for err == nil {
off := offset - h.packedOff
if off < f.h.PackedSize || (off == f.h.PackedSize && f.h.last) {
return f.openBlock(f.h, off)
} else if h.last {
return 0, fs.ErrInvalid
}
err = f.nextBlock()
}
if err == io.EOF {
return 0, fs.ErrInvalid
}
return 0, err
}
func (pr *packedFileReadSeeker) newArchiveFile(blocks *fileBlockList) (archiveFile, error) {
return pr.newArchiveFileFrom(pr, blocks)
}
func newPackedFileReader(v volume, opts *options) archiveFile {
pr := packedFileReader{v: v, opt: opts}
if v.canSeek() {
return &packedFileReadSeeker{pr}
}
return &pr
}
type limitedReader struct {
archiveFile
size int64
offset int64
}
func (l *limitedReader) Read(p []byte) (int, error) {
diff := l.size - l.offset
if diff <= 0 {
return 0, io.EOF
}
if int64(len(p)) > diff {
p = p[0:diff]
}
n, err := l.archiveFile.Read(p)
l.offset += int64(n)
if err == io.EOF {
if l.offset < l.size {
return n, ErrShortFile
}
return n, nil
}
return n, err
}
func (l *limitedReader) ReadByte() (byte, error) {
if l.offset >= l.size {
return 0, io.EOF
}
b, err := l.archiveFile.ReadByte()
if err != nil {
if err == io.EOF {
return 0, ErrShortFile
}
return 0, err
}
l.offset++
return b, nil
}
func (l *limitedReader) writeToN(w io.Writer, n int64) (int64, error) {
diff := l.size - l.offset
m, err := l.archiveFile.writeToN(w, min(diff, n))
l.offset += m
if m < n && err == nil {
err = io.EOF
}
return m, err
}
func (l *limitedReader) WriteTo(w io.Writer) (int64, error) {
diff := l.size - l.offset
n, err := l.archiveFile.writeToN(w, diff)
l.offset += n
return n, err
}
type limitedReadSeeker struct {
limitedReader
sr io.Seeker
}
func (l *limitedReadSeeker) Seek(offset int64, whence int) (int64, error) {
// calculate absolute offset
switch whence {
case io.SeekStart:
case io.SeekCurrent:
offset += l.offset
case io.SeekEnd:
offset += l.size
default:
return 0, fs.ErrInvalid
}
if offset < 0 || offset > l.size {
return 0, fs.ErrInvalid
}
return l.sr.Seek(offset, io.SeekStart)
}
func newLimitedReader(f archiveFile, size int64) archiveFile {
lr := limitedReader{archiveFile: f, size: size}
if sr, ok := f.(io.Seeker); ok {
return &limitedReadSeeker{limitedReader: lr, sr: sr}
}
return &lr
}
type checksumReader struct {
archiveFile
hash hash.Hash
success func()
eofErr error
}
func (cr *checksumReader) eofError() error {
if cr.eofErr != nil {
return cr.eofErr
}
// calculate file checksum
h := cr.currFile()
sum := cr.hash.Sum(nil)
if len(h.hashKey) > 0 {
mac := hmac.New(sha256.New, h.hashKey)
_, _ = mac.Write(sum) // ignore error, should always succeed
sum = mac.Sum(sum[:0])
if len(h.sum) == 4 {
// CRC32
for i, v := range sum[4:] {
sum[i&3] ^= v
}
sum = sum[:4]
}
}
if !bytes.Equal(sum, h.sum) {
cr.eofErr = ErrBadFileChecksum
} else {
cr.eofErr = io.EOF
if cr.success != nil {
cr.success()
}
}
return cr.eofErr
}
func (cr *checksumReader) Read(p []byte) (int, error) {
n, err := cr.archiveFile.Read(p)
if n > 0 {
if n, err = cr.hash.Write(p[:n]); err != nil {
return n, err
}
}
if err != io.EOF {
return n, err
}
return n, cr.eofError()
}
func (cr *checksumReader) ReadByte() (byte, error) {
b, err := cr.archiveFile.ReadByte()
if err != nil {
if err != io.EOF {
return 0, err
}
return 0, cr.eofError()
}
_, err = cr.hash.Write([]byte{b})
if err != nil {
return 0, err
}
return b, err
}
func (cr *checksumReader) writeToN(w io.Writer, n int64) (int64, error) {
panic("checksumReader.writeToN should never be called")
}
func (cr *checksumReader) WriteTo(w io.Writer) (int64, error) {
mw := io.MultiWriter(w, cr.hash)
n, err := cr.archiveFile.WriteTo(mw)
if err == nil || err == io.EOF {
err = cr.eofError()
}
if err != nil && err != io.EOF {
return n, err
}
return n, nil
}
func newChecksumReader(f archiveFile, h hash.Hash, success func()) *checksumReader {
return &checksumReader{archiveFile: f, hash: h, success: success}
}
// Reader provides sequential access to files in a RAR archive.
type Reader struct {
f archiveFile
}
func (r *Reader) Read(p []byte) (int, error) { return r.f.Read(p) }
func (r *Reader) ReadByte() (byte, error) { return r.f.ReadByte() }
func (r *Reader) WriteTo(w io.Writer) (int64, error) { return r.f.WriteTo(w) }
// Next advances to the next file in the archive.
func (r *Reader) Next() (*FileHeader, error) {
blocks, err := r.f.nextFile()
if err != nil {
return nil, err
}
r.f, err = r.f.newArchiveFile(blocks)
if err != nil {
return nil, err
}
h := blocks.firstBlock()
return &h.FileHeader, nil
}
func newReader(v volume, opts *options) Reader {
pr := newPackedFileReader(v, opts)
return Reader{f: pr}
}
// NewReader creates a Reader reading from r.
// NewReader only supports single volume archives.
// Multi-volume archives must use OpenReader.
func NewReader(r io.Reader, opts ...Option) (*Reader, error) {
options := getOptions(opts)
v, err := newVolume(r, options, 0)
if err != nil {
return nil, err
}
rdr := newReader(v, options)
return &rdr, nil
}
// ReadCloser is a Reader that allows closing of the rar archive.
type ReadCloser struct {
Reader
cl io.Closer
vm *volumeManager
}
// Close closes the rar file.
func (rc *ReadCloser) Close() error { return rc.cl.Close() }
// Volumes returns the volume filenames that have been used in decoding the archive
// up to this point. This will include the current open volume if the archive is still
// being processed.
func (rc *ReadCloser) Volumes() []string {
return rc.vm.Files()
}
// OpenReader opens a RAR archive specified by the name and returns a ReadCloser.
func OpenReader(name string, opts ...Option) (*ReadCloser, error) {
options := getOptions(opts)
v, err := openVolume(name, options)
if err != nil {
return nil, err
}
rc := &ReadCloser{vm: v.vm, cl: v}
rc.Reader = newReader(v, options)
return rc, nil
}
// File represents a file in a RAR archive
type File struct {
FileHeader
blocks *fileBlockList
vm *volumeManager
}
// Open returns an io.ReadCloser that provides access to the File's contents.
// Open is not supported on Solid File's as their contents depend on the decoding
// of the preceding files in the archive. Use OpenReader and Next to access Solid file
// contents instead.
func (f *File) Open() (io.ReadCloser, error) {
return f.vm.openArchiveFile(f.blocks)
}
// List returns a list of File's in the RAR archive specified by name.
func List(name string, opts ...Option) ([]*File, error) {
vm, fileBlocks, err := listFileBlocks(name, opts)
if err != nil {
return nil, err
}
var fl []*File
for _, blocks := range fileBlocks {
h := blocks.firstBlock()
f := &File{
FileHeader: h.FileHeader,
blocks: blocks,
vm: vm,
}
fl = append(fl, f)
}
return fl, nil
}
|