zipz

Documentation

Index

• Variables
• func AddFileToZip(dstZipFile string, entryName string, src io.Reader, opts ...AddFileToZipOption) error
• func UnzipFile(srcZipFilePath, dstDir string, opts ...UnzipFileOption) (paths []string, err error)
• func ZipDir(dst io.Writer, srcDir string, opts ...ZipDirOption) error
• type AddFileToZipOption
  • func WithAddFileToZipOptionDecompressionBombLimit(decompressionBombLimit int64) AddFileToZipOption
• type UnzipFileOption
  • func WithUnzipFileOptionFileInZipHandler(f func(zipfile *zip.File, dstDir string) error) UnzipFileOption
• type ZipDirOption
  • func WithZipDirOptionPathInZipHandlerFunc(f func(path string) string) ZipDirOption
  • func WithZipDirOptionWalkFunc(f func(path string, info os.FileInfo, err error) error) ZipDirOption

Variables

var ErrDoNotUnzipAFileAtRiskOfZipSlip = errors.New("zipz: do not unzip a file at risk of zip slip")

Functions

func AddFileToZip

func AddFileToZip(dstZipFile string, entryName string, src io.Reader, opts ...AddFileToZipOption) error

AddFileToZip is a function to add a file to an existing zip file.

For Decompression Bomb protection, files larger than the size limit will cause an error using io.LimitReader. If a value less than or equal to 0 is specified for decompressionBombLimit, no Decompression Bomb protection will be performed.

func UnzipFile

func UnzipFile(srcZipFilePath, dstDir string, opts ...UnzipFileOption) (paths []string, err error)

func ZipDir

func ZipDir(dst io.Writer, srcDir string, opts ...ZipDirOption) error

Types

type AddFileToZipOption

type AddFileToZipOption interface {
	// contains filtered or unexported methods
}

func WithAddFileToZipOptionDecompressionBombLimit

func WithAddFileToZipOptionDecompressionBombLimit(decompressionBombLimit int64) AddFileToZipOption

type UnzipFileOption

type UnzipFileOption interface {
	// contains filtered or unexported methods
}

func WithUnzipFileOptionFileInZipHandler

func WithUnzipFileOptionFileInZipHandler(f func(zipfile *zip.File, dstDir string) error) UnzipFileOption

type ZipDirOption

type ZipDirOption interface {
	// contains filtered or unexported methods
}

func WithZipDirOptionPathInZipHandlerFunc

func WithZipDirOptionPathInZipHandlerFunc(f func(path string) string) ZipDirOption

WithZipDirOptionPathInZipHandlerFunc is a function to specify the path in the zip file.

func WithZipDirOptionWalkFunc

func WithZipDirOptionWalkFunc(f func(path string, info os.FileInfo, err error) error) ZipDirOption