securitytest

Documentation

Overview

Package securitytest embeds the TLS test certificates.

Index

• Variables
• func Asset(name string) ([]byte, error)
• func AssetDigest(name string) ([sha256.Size]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func AssetReadDir(name string) ([]os.FileInfo, error)
• func AssetStat(name string) (os.FileInfo, error)
• func AssetString(name string) (string, error)
• func Digests() (map[string][sha256.Size]byte, error)
• func MustAsset(name string) []byte
• func MustAssetString(name string) string
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func RestrictedCopy(t testing.TB, path, tempdir, name string) string

Variables

var EmbeddedAssets = security.AssetLoader{
	ReadDir:  AssetReadDir,
	ReadFile: Asset,
	Stat:     AssetStat,
}

EmbeddedAssets is an AssetLoader pointing to embedded asset functions.

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDigest

func AssetDigest(name string) ([sha256.Size]byte, error)

AssetDigest returns the digest of the file with the given name. It returns an error if the asset could not be found or the digest could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"}, AssetDir("data/img") would return []string{"a.png", "b.png"}, AssetDir("foo.txt") and AssetDir("notexist") would return an error, and AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func AssetReadDir

func AssetReadDir(name string) ([]os.FileInfo, error)

AssetReadDir mimics ioutil.ReadDir, returning a list of []os.FileInfo for the specified directory. Contrary to ioutil.ReadDir however, it skips sub- directories.

func AssetStat

func AssetStat(name string) (os.FileInfo, error)

AssetStat wraps AssetInfo, but returns os.ErrNotExist if the requested file is not found.

func AssetString

func AssetString(name string) (string, error)

AssetString returns the asset contents as a string (instead of a []byte).

func Digests

func Digests() (map[string][sha256.Size]byte, error)

Digests returns a map of all known files and their checksums.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func MustAssetString

func MustAssetString(name string) string

MustAssetString is like AssetString but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory.

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively.

func RestrictedCopy

func RestrictedCopy(t testing.TB, path, tempdir, name string) string

RestrictedCopy creates an on-disk copy of the embedded security asset with the provided path. The copy will be created in the provided directory. Returns the path of the file and a cleanup function that will delete the file.

The file will have restrictive file permissions (0600), making it appropriate for usage by libraries that require security assets to have such restrictive permissions.