rardecode

package module

Go to main page

Versions in this module

v2

v2.2.2

Dec 6, 2025

v2.2.1

Oct 12, 2025

v2.2.0

Sep 28, 2025

Changes in this version

+ const DefaultMaxDictionarySize

+ var ErrBadVolumeNumber = errors.New("rardecode: bad volume number")

+ var ErrInvalidHeaderOff = errors.New("rardecode: invalid filed header offset")

+ var ErrMultiVolume = errors.New("rardecode: multi-volume archive continues in next file")

+ var ErrNegativeRead = errors.New("rardecode: negative read from Reader")

+ var ErrNoArchiveBlock = errors.New("rardecode: missing archive block")

+ func OpenFSCheck(o *options)

+ func SkipCheck(o *options)

type Option

+ func MaxDictionarySize(size int64) Option

+ type RarFS struct

+ func OpenFS(name string, opts ...Option) (*RarFS, error)

+ func (rfs *RarFS) Open(name string) (fs.File, error)

+ func (rfs *RarFS) ReadDir(name string) ([]fs.DirEntry, error)

+ func (rfs *RarFS) ReadFile(name string) ([]byte, error)

+ func (rfs *RarFS) Stat(name string) (fs.FileInfo, error)

+ func (rfs *RarFS) Sub(dir string) (fs.FS, error)

type ReadCloser

+ func (rc *ReadCloser) Volumes() []string

type Reader

+ func (r *Reader) ReadByte() (byte, error)

v2.1.1

Feb 22, 2025 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

v2.1.0

Jan 26, 2025 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

Changes in this version

type FileHeader

+ HeaderEncrypted bool

v2.0.1

Nov 30, 2024 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

Changes in this version

+ var ErrArchiveEncrypted = errors.New("rardecode: archive encrypted, password required")

+ var ErrArchivedFileEncrypted = errors.New("rardecode: archived files encrypted, password required")

+ var ErrDictionaryTooLarge = errors.New("rardecode: decode dictionary too large")

+ var ErrPlatformIntSize = errors.New("rardecode: platform integer size too small")

type FileHeader

+ Encrypted bool

v2.0.0

Nov 12, 2024 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

Changes in this version

+ const HostOSBeOS

+ const HostOSMSDOS

+ const HostOSMacOS

+ const HostOSOS2

+ const HostOSUnix

+ const HostOSUnknown

+ const HostOSWindows

+ var ErrArchiveNameEmpty = errors.New("rardecode: archive name empty")

+ var ErrBadFileChecksum = errors.New("rardecode: bad file checksum")

+ var ErrBadHeaderCRC = errors.New("rardecode: bad header crc")

+ var ErrBadPassword = errors.New("rardecode: incorrect password")

+ var ErrCorruptBlockHeader = errors.New("rardecode: corrupt block header")

+ var ErrCorruptDecodeHeader = errors.New("rardecode: corrupt decode header")

+ var ErrCorruptEncryptData = errors.New("rardecode: corrupt encryption data")

+ var ErrCorruptFileHeader = errors.New("rardecode: corrupt file header")

+ var ErrCorruptPPM = errors.New("rardecode: corrupt ppm data")

+ var ErrDecoderOutOfData = errors.New("rardecode: decoder expected more data than is in packed file")

+ var ErrFileNameRequired = errors.New("rardecode: filename required for multi volume archive")

+ var ErrHuffDecodeFailed = errors.New("rardecode: huffman decode failed")

+ var ErrInvalidFileBlock = errors.New("rardecode: invalid file block")

+ var ErrInvalidFilter = errors.New("rardecode: invalid filter")

+ var ErrInvalidLengthTable = errors.New("rardecode: invalid huffman code length table")

+ var ErrInvalidVMInstruction = errors.New("rardecode: invalid vm instruction")

+ var ErrMultipleDecoders = errors.New("rardecode: multiple decoders in a single archive not supported")

+ var ErrNoSig = errors.New("rardecode: RAR signature not found")

+ var ErrShortFile = errors.New("rardecode: decoded file too short")

+ var ErrSolidOpen = errors.New("rardecode: solid files don't support Open")

+ var ErrTooManyFilters = errors.New("rardecode: too many filters")

+ var ErrUnexpectedArcEnd = errors.New("rardecode: unexpected end of archive")

+ var ErrUnknownDecoder = errors.New("rardecode: unknown decoder version")

+ var ErrUnknownEncryptMethod = errors.New("rardecode: unknown encryption method")

+ var ErrUnknownFilter = errors.New("rardecode: unknown V5 filter")

+ var ErrUnknownVersion = errors.New("rardecode: unknown archive version")

+ var ErrUnsupportedDecoder = errors.New("rardecode: unsupported decoder version")

+ var ErrVerMismatch = errors.New("rardecode: volume version mistmatch")

+ type File struct

+ func List(name string, opts ...Option) ([]*File, error)

+ func (f *File) Open() (io.ReadCloser, error)

+ type FileHeader struct

+ AccessTime time.Time

+ Attributes int64

+ CreationTime time.Time

+ HostOS byte

+ IsDir bool

+ ModificationTime time.Time

+ Name string

+ PackedSize int64

+ Solid bool

+ UnKnownSize bool

+ UnPackedSize int64

+ Version int

+ func (f *FileHeader) Mode() os.FileMode

+ type Option func(*option)

+ func BufferSize(size int) Option

+ func FileSystem(fs fs.FS) Option

+ func Password(pass string) Option

+ type ReadCloser struct

+ func OpenReader(name string, opts ...Option) (*ReadCloser, error)

+ func (rc *ReadCloser) Close() error

+ type Reader struct

+ func NewReader(r io.Reader, opts ...Option) (*Reader, error)

+ func (r *Reader) Next() (*FileHeader, error)

+ func (r *Reader) Read(p []byte) (int, error)

+ func (r *Reader) WriteTo(w io.Writer) (int64, error)

v2.0.0-beta.4

Oct 27, 2024 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

v2.0.0-beta.3

Oct 12, 2024 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

v2.0.0-beta.2

Aug 8, 2021 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

v2.0.0-beta.1

Jul 17, 2021 GO-2025-4020

GO-2025-4020: DoS risk due to unrestricted RAR dictionary sizes in github.com/nwaples/rardecode

Other modules containing this package

github.com/nwaples/rardecode

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL