tar
packagestandard library
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Report a Vulnerability
Documentation¶
Overview¶
Package tar implements access to tar archives.
Tape archives (tar) are a file format for storing a sequence of files thatcan be read and written in a streaming manner.This package aims to cover most variations of the format,including those produced by GNU and BSD tar tools.
Example (Minimal)¶
package mainimport ("archive/tar""bytes""fmt""io""log""os")func main() {// Create and add some files to the archive.var buf bytes.Buffertw := tar.NewWriter(&buf)var 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 license."},}for _, file := range files {hdr := &tar.Header{Name: file.Name,Mode: 0600,Size: int64(len(file.Body)),}if err := tw.WriteHeader(hdr); err != nil {log.Fatal(err)}if _, err := tw.Write([]byte(file.Body)); err != nil {log.Fatal(err)}}if err := tw.Close(); err != nil {log.Fatal(err)}// Open and iterate through the files in the archive.tr := tar.NewReader(&buf)for {hdr, err := tr.Next()if err == io.EOF {break // End of archive}if err != nil {log.Fatal(err)}fmt.Printf("Contents of %s:\n", hdr.Name)if _, err := io.Copy(os.Stdout, tr); err != nil {log.Fatal(err)}fmt.Println()}}Output:Contents of readme.txt:This archive contains some text files.Contents of gopher.txt:Gopher names:GeorgeGeoffreyGonzoContents of todo.txt:Get animal handling license.
Index¶
Examples¶
Constants¶
const (// Type '0' indicates a regular file.TypeReg = '0'// Deprecated: Use TypeReg instead.TypeRegA = '\x00'// Type '1' to '6' are header-only flags and may not have a data body.TypeLink = '1'// Hard linkTypeSymlink = '2'// Symbolic linkTypeChar = '3'// Character device nodeTypeBlock = '4'// Block device nodeTypeDir = '5'// DirectoryTypeFifo = '6'// FIFO node// Type '7' is reserved.TypeCont = '7'// Type 'x' is used by the PAX format to store key-value records that// are only relevant to the next file.// This package transparently handles these types.TypeXHeader = 'x'// Type 'g' is used by the PAX format to store key-value records that// are relevant to all subsequent files.// This package only supports parsing and composing such headers,// but does not currently support persisting the global state across files.TypeXGlobalHeader = 'g'// Type 'S' indicates a sparse file in the GNU format.TypeGNUSparse = 'S'// Types 'L' and 'K' are used by the GNU format for a meta file// used to store the path or link name for the next file.// This package transparently handles these types.TypeGNULongName = 'L'TypeGNULongLink = 'K')
Type flags for Header.Typeflag.
Variables¶
var (ErrHeader =errors.New("archive/tar: invalid tar header")ErrWriteTooLong =errors.New("archive/tar: write too long")ErrFieldTooLong =errors.New("archive/tar: header field too long")ErrWriteAfterClose =errors.New("archive/tar: write after close")ErrInsecurePath =errors.New("archive/tar: insecure file path"))
Functions¶
This section is empty.
Types¶
typeFileInfoNames¶added ingo1.23.0
type FileInfoNames interface {fs.FileInfo// Uname should give a user name.Uname() (string,error)// Gname should give a group name.Gname() (string,error)}FileInfoNames extendsfs.FileInfo.Passing an instance of this toFileInfoHeader permits the callerto avoid a system-dependent name lookup by specifying the Uname and Gname directly.
typeFormat¶added ingo1.10
type Formatint
Format represents the tar archive format.
The original tar format was introduced in Unix V7.Since then, there have been multiple competing formats attempting tostandardize or extend the V7 format to overcome its limitations.The most common formats are the USTAR, PAX, and GNU formats,each with their own advantages and limitations.
The following table captures the capabilities of each format:
| USTAR | PAX | GNU------------------+--------+-----------+----------Name | 256B | unlimited | unlimitedLinkname | 100B | unlimited | unlimitedSize | uint33 | unlimited | uint89Mode | uint21 | uint21 | uint57Uid/Gid | uint21 | unlimited | uint57Uname/Gname | 32B | unlimited | 32BModTime | uint33 | unlimited | int89AccessTime | n/a | unlimited | int89ChangeTime | n/a | unlimited | int89Devmajor/Devminor | uint21 | uint21 | uint57------------------+--------+-----------+----------string encoding | ASCII | UTF-8 | binarysub-second times | no | yes | nosparse files | no | yes | yes
The table's upper portion shows theHeader fields, where each format reportsthe maximum number of bytes allowed for each string field andthe integer type used to store each numeric field(where timestamps are stored as the number of seconds since the Unix epoch).
The table's lower portion shows specialized features of each format,such as supported string encodings, support for sub-second timestamps,or support for sparse files.
The Writer currently provides no support for sparse files.
const (// FormatUnknown indicates that the format is unknown.FormatUnknown Format// FormatUSTAR represents the USTAR header format defined in POSIX.1-1988.//// While this format is compatible with most tar readers,// the format has several limitations making it unsuitable for some usages.// Most notably, it cannot support sparse files, files larger than 8GiB,// filenames larger than 256 characters, and non-ASCII filenames.//// Reference://http://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_06FormatUSTAR// FormatPAX represents the PAX header format defined in POSIX.1-2001.//// PAX extends USTAR by writing a special file with Typeflag TypeXHeader// preceding the original header. This file contains a set of key-value// records, which are used to overcome USTAR's shortcomings, in addition to// providing the ability to have sub-second resolution for timestamps.//// Some newer formats add their own extensions to PAX by defining their// own keys and assigning certain semantic meaning to the associated values.// For example, sparse file support in PAX is implemented using keys// defined by the GNU manual (e.g., "GNU.sparse.map").//// Reference://http://pubs.opengroup.org/onlinepubs/009695399/utilities/pax.htmlFormatPAX// FormatGNU represents the GNU header format.//// The GNU header format is older than the USTAR and PAX standards and// is not compatible with them. The GNU format supports// arbitrary file sizes, filenames of arbitrary encoding and length,// sparse files, and other features.//// It is recommended that PAX be chosen over GNU unless the target// application can only parse GNU formatted archives.//// Reference://https://www.gnu.org/software/tar/manual/html_node/Standard.htmlFormatGNU)
Constants to identify various tar formats.
typeHeader¶
type Header struct {// Typeflag is the type of header entry.// The zero value is automatically promoted to either TypeReg or TypeDir// depending on the presence of a trailing slash in Name.TypeflagbyteNamestring// Name of file entryLinknamestring// Target name of link (valid for TypeLink or TypeSymlink)Sizeint64// Logical file size in bytesModeint64// Permission and mode bitsUidint// User ID of ownerGidint// Group ID of ownerUnamestring// User name of ownerGnamestring// Group name of owner// If the Format is unspecified, then Writer.WriteHeader rounds ModTime// to the nearest second and ignores the AccessTime and ChangeTime fields.//// To use AccessTime or ChangeTime, specify the Format as PAX or GNU.// To use sub-second resolution, specify the Format as PAX.ModTimetime.Time// Modification timeAccessTimetime.Time// Access time (requires either PAX or GNU support)ChangeTimetime.Time// Change time (requires either PAX or GNU support)Devmajorint64// Major device number (valid for TypeChar or TypeBlock)Devminorint64// Minor device number (valid for TypeChar or TypeBlock)// Xattrs stores extended attributes as PAX records under the// "SCHILY.xattr." namespace.//// The following are semantically equivalent:// h.Xattrs[key] = value// h.PAXRecords["SCHILY.xattr."+key] = value//// When Writer.WriteHeader is called, the contents of Xattrs will take// precedence over those in PAXRecords.//// Deprecated: Use PAXRecords instead.Xattrs map[string]string// PAXRecords is a map of PAX extended header records.//// User-defined records should have keys of the following form://VENDOR.keyword// Where VENDOR is some namespace in all uppercase, and keyword may// not contain the '=' character (e.g., "GOLANG.pkg.version").// The key and value should be non-empty UTF-8 strings.//// When Writer.WriteHeader is called, PAX records derived from the// other fields in Header take precedence over PAXRecords.PAXRecords map[string]string// Format specifies the format of the tar header.//// This is set by Reader.Next as a best-effort guess at the format.// Since the Reader liberally reads some non-compliant files,// it is possible for this to be FormatUnknown.//// If the format is unspecified when Writer.WriteHeader is called,// then it uses the first format (in the order of USTAR, PAX, GNU)// capable of encoding this Header (see Format).FormatFormat}A Header represents a single header in a tar archive.Some fields may not be populated.
For forward compatibility, users that retrieve a Header from Reader.Next,mutate it in some ways, and then pass it back to Writer.WriteHeadershould do so by creating a new Header and copying the fieldsthat they are interested in preserving.
funcFileInfoHeader¶added ingo1.1
FileInfoHeader creates a partially-populatedHeader from fi.If fi describes a symlink, FileInfoHeader records link as the link target.If fi describes a directory, a slash is appended to the name.
Since fs.FileInfo's Name method only returns the base name ofthe file it describes, it may be necessary to modify Header.Nameto provide the full path name of the file.
If fi implementsFileInfoNamesHeader.Gname and Header.Unameare provided by the methods of the interface.
typeReader¶
type Reader struct {// contains filtered or unexported fields}Reader provides sequential access to the contents of a tar archive.Reader.Next advances to the next file in the archive (including the first),and then Reader can be treated as an io.Reader to access the file's data.
func (*Reader)Next¶
Next advances to the next entry in the tar archive.The Header.Size determines how many bytes can be read for the next file.Any remaining data in the current file is automatically discarded.At the end of the archive, Next returns the error io.EOF.
If Next encounters a non-local name (as defined byfilepath.IsLocal)and the GODEBUG environment variable contains `tarinsecurepath=0`,Next returns the header with anErrInsecurePath error.A future version of Go may introduce this behavior by default.Programs that want to accept non-local names can ignoretheErrInsecurePath error and use the returned header.
func (*Reader)Read¶
Read reads from the current file in the tar archive.It returns (0, io.EOF) when it reaches the end of that file,until [Next] is called to advance to the next file.
If the current file is sparse, then the regions marked as a holeare read back as NUL-bytes.
Calling Read on special types likeTypeLink,TypeSymlink,TypeChar,TypeBlock,TypeDir, andTypeFifo returns (0,io.EOF) regardless of whatthe [Header.Size] claims.
typeWriter¶
type Writer struct {// contains filtered or unexported fields}Writer provides sequential writing of a tar archive.Writer.WriteHeader begins a new file with the providedHeader,and then Writer can be treated as an io.Writer to supply that file's data.
func (*Writer)AddFS¶added ingo1.22.0
AddFS adds the files from fs.FS to the archive.It walks the directory tree starting at the root of the filesystemadding each file to the tar archive while maintaining the directory structure.
func (*Writer)Close¶
Close closes the tar archive by flushing the padding, and writing the footer.If the current file (from a prior call toWriter.WriteHeader) is not fully written,then this returns an error.
func (*Writer)Flush¶
Flush finishes writing the current file's block padding.The current file must be fully written before Flush can be called.
This is unnecessary as the next call toWriter.WriteHeader orWriter.Closewill implicitly flush out the file's padding.
func (*Writer)Write¶
Write writes to the current file in the tar archive.Write returns the errorErrWriteTooLong if more thanHeader.Size bytes are written afterWriter.WriteHeader.
Calling Write on special types likeTypeLink,TypeSymlink,TypeChar,TypeBlock,TypeDir, andTypeFifo returns (0,ErrWriteTooLong) regardlessof what the [Header.Size] claims.
func (*Writer)WriteHeader¶
WriteHeader writes hdr and prepares to accept the file's contents.The Header.Size determines how many bytes can be written for the next file.If the current file is not fully written, then this returns an error.This implicitly flushes any padding necessary before writing the header.
Source Files