getter

package module

Go to main page

Versions in this module

v2

v2.2.2

May 17, 2024

v2.2.1

Mar 13, 2023

Changes in this version

+ func LimitedDecompressors(filesLimit int, fileSizeLimit int64) map[string]Decompressor

v2.2.0

Feb 13, 2023

Changes in this version

type Bzip2Decompressor

+ FileSizeLimit int64

type GzipDecompressor

+ FileSizeLimit int64

type TarBzip2Decompressor

+ FileSizeLimit int64

+ FilesLimit int

type TarDecompressor

+ FileSizeLimit int64

+ FilesLimit int

type TarGzipDecompressor

+ FileSizeLimit int64

+ FilesLimit int

type TarXzDecompressor

+ FileSizeLimit int64

+ FilesLimit int

+ type TarZstdDecompressor struct

+ FileSizeLimit int64

+ FilesLimit int

+ func (d *TarZstdDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

type XzDecompressor

+ FileSizeLimit int64

type ZipDecompressor

+ FileSizeLimit int64

+ FilesLimit int

+ type ZstdDecompressor struct

+ FileSizeLimit int64

+ func (d *ZstdDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

v2.1.1

Nov 29, 2022 GO-2023-1578

GO-2023-1578: Denial of service in github.com/hashicorp/go-getter/v2

Changes in this version

type SmbClientGetter

+ Timeout int

v2.1.0

May 23, 2022 GO-2023-1578

GO-2023-1578: Denial of service in github.com/hashicorp/go-getter/v2

Changes in this version

+ var ErrSymlinkCopy = errors.New("copying of symlinks has been disabled")

+ func NewContextWithClient(ctx context.Context, client *Client) context.Context

type Client

+ DisableSymlinks bool

+ func ClientFromContext(ctx context.Context) *Client

type GitGetter

+ Timeout time.Duration

type HgGetter

+ Timeout time.Duration

type HttpGetter

+ DoNotCheckHeadFirst bool

+ HeadFirstTimeout time.Duration

+ MaxBytes int64

+ ReadTimeout time.Duration

+ XTerraformGetDisabled bool

+ XTerraformGetLimit int

type Request

+ DisableSymlinks bool

v2.0.2

Mar 21, 2022 GO-2022-0586GO-2023-1578

GO-2022-0586: Resource exhaustion in github.com/hashicorp/go-getter and related modules

GO-2023-1578: Denial of service in github.com/hashicorp/go-getter/v2

v2.0.1

Feb 1, 2022 GO-2022-0586GO-2023-1578

GO-2022-0586: Resource exhaustion in github.com/hashicorp/go-getter and related modules

GO-2023-1578: Denial of service in github.com/hashicorp/go-getter/v2

Changes in this version

+ type TarDecompressor struct

+ func (d *TarDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

v2.0.0

Jan 4, 2021 GO-2022-0586GO-2023-1578

GO-2022-0586: Resource exhaustion in github.com/hashicorp/go-getter and related modules

GO-2023-1578: Denial of service in github.com/hashicorp/go-getter/v2

Changes in this version

+ var Decompressors map[string]Decompressor

+ var DefaultClient = &Client

+ var ErrUnauthorized = os.ErrPermission — darwin/amd64, js/wasm, linux/amd64

+ var ErrUnauthorized = syscall.ERROR_PRIVILEGE_NOT_HELD — windows/amd64

+ var Getters []Getter

+ var SymlinkAny = os.Symlink — darwin/amd64, js/wasm, linux/amd64

+ func Copy(ctx context.Context, dst io.Writer, src io.Reader) (int64, error)

+ func Detect(req *Request, getter Getter) (bool, error)

+ func SourceDirSubdir(src string) (string, string)

+ func SubdirGlob(dst, subDir string) (string, error)

+ func SymlinkAny(oldname, newname string) error — windows/amd64

+ func TestDecompressor(t testing.T, d Decompressor, cases []TestDecompressCase)

+ type BitBucketDetector struct

+ func (d *BitBucketDetector) Detect(src, _ string) (string, bool, error)

+ type Bzip2Decompressor struct

+ func (d *Bzip2Decompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

+ type ChecksumError struct

+ Actual []byte

+ Expected []byte

+ File string

+ Hash hash.Hash

+ func (cerr *ChecksumError) Error() string

+ type Client struct

+ Decompressors map[string]Decompressor

+ Getters []Getter

+ func (c *Client) Get(ctx context.Context, req *Request) (*GetResult, error)

+ func (c *Client) GetChecksum(ctx context.Context, req *Request) (*FileChecksum, error)

+ type Decompressor interface

+ Decompress func(dst, src string, dir bool, umask os.FileMode) error

+ type Detector interface

+ Detect func(string, string) (string, bool, error)

+ type FileChecksum struct

+ Filename string

+ Hash hash.Hash

+ Type string

+ Value []byte

+ func (c *FileChecksum) Checksum(filePath string) error

+ func (c *FileChecksum) String() string

+ type FileDetector struct

+ func (d *FileDetector) Detect(src, pwd string) (string, bool, error)

+ type FileGetter struct

+ func (g *FileGetter) Detect(req *Request) (bool, error)

+ func (g *FileGetter) Get(ctx context.Context, req *Request) error

+ func (g *FileGetter) GetFile(ctx context.Context, req *Request) error

+ func (g *FileGetter) Mode(ctx context.Context, u *url.URL) (Mode, error)

+ type FolderStorage struct

+ StorageDir string

+ func (s *FolderStorage) Dir(key string) (d string, e bool, err error)

+ func (s *FolderStorage) Get(ctx context.Context, key string, source string, update bool) error

+ type GetResult struct

+ Dst string

+ func Get(ctx context.Context, dst, src string) (*GetResult, error)

+ func GetAny(ctx context.Context, dst, src string) (*GetResult, error)

+ func GetFile(ctx context.Context, dst, src string) (*GetResult, error)

+ type Getter interface

+ Detect func(*Request) (bool, error)

+ Get func(context.Context, *Request) error

+ GetFile func(context.Context, *Request) error

+ Mode func(context.Context, *url.URL) (Mode, error)

+ type GitDetector struct

+ func (d *GitDetector) Detect(src, _ string) (string, bool, error)

+ type GitGetter struct

+ Detectors []Detector

+ func (g *GitGetter) Detect(req *Request) (bool, error)

+ func (g *GitGetter) Get(ctx context.Context, req *Request) error

+ func (g *GitGetter) GetFile(ctx context.Context, req *Request) error

+ func (g *GitGetter) Mode(_ context.Context, u *url.URL) (Mode, error)

+ type GitHubDetector struct

+ func (d *GitHubDetector) Detect(src, _ string) (string, bool, error)

+ type GitLabDetector struct

+ func (d *GitLabDetector) Detect(src, _ string) (string, bool, error)

+ type GzipDecompressor struct

+ func (d *GzipDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

+ type HgGetter struct

+ func (g *HgGetter) Detect(req *Request) (bool, error)

+ func (g *HgGetter) Get(ctx context.Context, req *Request) error

+ func (g *HgGetter) GetFile(ctx context.Context, req *Request) error

+ func (g *HgGetter) Mode(ctx context.Context, _ *url.URL) (Mode, error)

+ type HttpGetter struct

+ Client *http.Client

+ Header http.Header

+ Netrc bool

+ func (g *HttpGetter) Detect(req *Request) (bool, error)

+ func (g *HttpGetter) Get(ctx context.Context, req *Request) error

+ func (g *HttpGetter) GetFile(ctx context.Context, req *Request) error

+ func (g *HttpGetter) Mode(ctx context.Context, u *url.URL) (Mode, error)

+ type MockGetter struct

+ GetCalled bool

+ GetDst string

+ GetErr error

+ GetFileCalled bool

+ GetFileDst string

+ GetFileErr error

+ GetFileURL *url.URL

+ GetURL *url.URL

+ Proxy Getter

+ func (g *MockGetter) Detect(req *Request) (bool, error)

+ func (g *MockGetter) Get(ctx context.Context, req *Request) error

+ func (g *MockGetter) GetFile(ctx context.Context, req *Request) error

+ func (g *MockGetter) Mode(ctx context.Context, u *url.URL) (Mode, error)

+ type Mode uint

+ const ModeAny

+ const ModeDir

+ const ModeFile

+ const ModeInvalid

+ type ProgressTracker interface

+ TrackProgress func(src string, currentSize, totalSize int64, stream io.ReadCloser) (body io.ReadCloser)

+ type Request struct

+ Copy bool

+ Dst string

+ Forced string

+ GetMode Mode

+ Inplace bool

+ ProgressListener ProgressTracker

+ Pwd string

+ Src string

+ Umask os.FileMode

+ func (req *Request) CopyReader(dst string, src io.Reader, fmode os.FileMode) error

+ func (req *Request) Mode(m os.FileMode) os.FileMode

+ func (req *Request) URL() *url.URL

+ type SmbClientGetter struct

+ func (g *SmbClientGetter) Detect(req *Request) (bool, error)

+ func (g *SmbClientGetter) Get(ctx context.Context, req *Request) error

+ func (g *SmbClientGetter) GetFile(ctx context.Context, req *Request) error

+ func (g *SmbClientGetter) Mode(ctx context.Context, u *url.URL) (Mode, error)

+ type SmbMountGetter struct

+ func (g *SmbMountGetter) Detect(req *Request) (bool, error)

+ func (g *SmbMountGetter) Get(ctx context.Context, req *Request) error

+ func (g *SmbMountGetter) GetFile(ctx context.Context, req *Request) error

+ func (g *SmbMountGetter) Mode(ctx context.Context, u *url.URL) (Mode, error)

+ type Storage interface

+ Dir func(string) (string, bool, error)

+ Get func(context.Context, string, string, bool) error

+ type TarBzip2Decompressor struct

+ func (d *TarBzip2Decompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

+ type TarGzipDecompressor struct

+ func (d *TarGzipDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

+ type TarXzDecompressor struct

+ func (d *TarXzDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

+ type TestDecompressCase struct

+ Dir bool

+ DirList []string

+ Err bool

+ FileMD5 string

+ Input string

+ Mtime *time.Time

+ type XzDecompressor struct

+ func (d *XzDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

+ type ZipDecompressor struct

+ func (d *ZipDecompressor) Decompress(dst, src string, dir bool, umask os.FileMode) error

Other modules containing this package

github.com/hashicorp/go-getter

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