package aczip

import "github.com/forensicanalysis/artifactcollector/store/aczip"

Package zip provides support for reading and writing ZIP archives.

See: http://www.pkware.com/documents/casestudies/APPNOTE.TXT

This package does not support disk spanning.

A note about ZIP64:

To be backwards compatible the FileHeader has both 32 and 64 bit Size fields. The 64 bit fields will always contain the correct value and for normal archives both fields will be the same. For files requiring the ZIP64 format the 32 bit fields will be 0xffffffff and the 64 bit fields must be used instead.

Index ¶

• Constants
• type Writer
• func NewWriter(f *os.File) *Writer
• func (w *Writer) Close() error
• func (w *Writer) Create(name string) (io.Writer, error)
• func (w *Writer) CreateHeader(fh *zip.FileHeader) (io.Writer, error)
• func (w *Writer) Exists(path string) (bool, error)
• func (w *Writer) Read(name string) ([]byte, error)
• func (w *Writer) WriteFile(name string, data []byte) (int, error)

Examples ¶

• Writer

Constants ¶

const Deflate uint16 = 8

Types ¶

type Writer ¶

type Writer struct {
	// contains filtered or unexported fields
}

Writer implements a zip file writer.

package main

import (
	"log"
	"os"

	"github.com/forensicanalysis/artifactcollector/store/aczip"
)

func main() {
	// Create a buffer to write our archive to.
	f, err := os.CreateTemp("", "test.zip")
	if err != nil {
		log.Fatal(err)
	}

	// Create a new zip archive.
	w := aczip.NewWriter(f)

	// Add some files to the archive.
	files := []struct {
		Name, Body string
	}{
		{"readme.txt", "This archive contains some text files."},
		{"gopher.txt", "Gopher names:\nGeorge\nGeoffrey\nGonzo"},
		{"todo.txt", "Get animal handling licence.\nWrite more examples."},
	}
	for _, file := range files {
		f, err := w.Create(file.Name)
		if err != nil {
			log.Fatal(err)
		}

		_, err = f.Write([]byte(file.Body))
		if err != nil {
			log.Fatal(err)
		}
	}

	// Make sure to check the error on Close.
	if err := w.Close(); err != nil {
		log.Fatal(err)
	}
}

func NewWriter ¶

func NewWriter(f *os.File) *Writer

NewWriter returns a new Writer writing a zip file to w.

func (*Writer) Close ¶

func (w *Writer) Close() error

Close finishes writing the zip file by writing the central directory. It does not (and can not) close the underlying writer.

func (*Writer) Create ¶

func (w *Writer) Create(name string) (io.Writer, error)

Create adds a file to the zip file using the provided name. It returns a Writer to which the file contents should be written. The name must be a relative path: it must not start with a drive letter (e.g. C:) or leading slash, and only forward slashes are allowed. The file's contents must be written to the io.Writer before the next call to Create, CreateHeader, or Close.

func (*Writer) CreateHeader ¶

func (w *Writer) CreateHeader(fh *zip.FileHeader) (io.Writer, error)

CreateHeader adds a file to the zip file using the provided FileHeader for the file metadata. It returns a Writer to which the file contents should be written. The file's contents must be written to the io.Writer before the next call to Create, CreateHeader, or Close.

func (*Writer) Exists ¶

func (w *Writer) Exists(path string) (bool, error)

func (*Writer) Read ¶

func (w *Writer) Read(name string) ([]byte, error)

func (*Writer) WriteFile ¶

func (w *Writer) WriteFile(name string, data []byte) (int, error)

Source Files ¶

extra.go struct.go writer.go