Documentation
¶
Overview ¶
Package vfile verifies files against a hash or signature.
vfile is not TOCTTOU-safe against the contents of the file changing.
Index ¶
- Variables
- func CalculateHash(b *bytes.Reader, h hash.Hash) ([]byte, error)
- func CheckHashedContent(b *bytes.Reader, wantHash []byte, h hash.Hash) (*bytes.Reader, error)
- func GetKeyRing(keyPath string) (openpgp.KeyRing, error)
- func GetRSAKeysFromRing(ring openpgp.KeyRing) ([]*rsa.PublicKey, error)
- func OpenHashedFile256(path string, wantSHA256Hash []byte) (*os.File, error)
- func OpenHashedFile512(path string, wantSHA512Hash []byte) (*os.File, error)
- func OpenSignedFile(keyring openpgp.KeyRing, path, pathSig string, opts ...OpenSignedFileOption) (*os.File, error)
- func OpenSignedSigFile(keyring openpgp.KeyRing, path string, opts ...OpenSignedFileOption) (*os.File, error)
- func WithIgnoreTimeConflict(o *openSignedFileOptions)
- type ErrHashMismatch
- type ErrInvalidHash
- type ErrUnsigned
- type ErrWrongSigner
- type OpenSignedFileOption
Constants ¶
This section is empty.
Variables ¶
var ErrNoExpectedHash = errors.New("OpenHashedFile: no expected hash given")
ErrNoExpectedHash is given when the caller did not specify a hash.
var ErrNoKeyRing = errors.New("no keyring given")
ErrNoKeyRing is returned when a nil keyring was given.
Functions ¶
func CalculateHash ¶
CalculateHash computes the hash of the input data b given a hash function.
func CheckHashedContent ¶
CheckHashedContent verifies a calculated hash against an expected hash array.
WARNING! Unlike many Go functions, this may return both the file and an error in case the expected hash does not match the contents.
If the contents match, the contents are returned with no error.
func GetKeyRing ¶
GetKeyRing returns an OpenPGP KeyRing loaded from the specified path.
keyPath must be an already trusted path, e.g. keys are included in the initramfs.
func GetRSAKeysFromRing ¶
GetRSAKeysFromRing iterates a PGP Keyring and extracts all rsa.PublicKey. An error is returned iff the keyring is not found or no RSA public keys were found on it.
func OpenHashedFile256 ¶
OpenHashedFile256 opens path and verifies whether its contents match the given sha256 hash.
WARNING! Unlike many Go functions, this may return both the file and an error in case the expected hash does not match the contents.
If the contents match, the opened file is returned with no error.
func OpenHashedFile512 ¶
OpenHashedFile512 opens path and verifies whether its contents match the given sha512 hash.
WARNING! Unlike many Go functions, this may return both the file and an error in case the expected hash does not match the contents.
If the contents match, the opened file is returned with no error.
func OpenSignedFile ¶
func OpenSignedFile(keyring openpgp.KeyRing, path, pathSig string, opts ...OpenSignedFileOption) (*os.File, error)
OpenSignedFile opens a file that is expected to be signed.
WARNING! Unlike many Go functions, this may return both the file and an error.
It expects pathSig to be available.
If the signature does not exist or does not match the keyring, both the file and a signature error will be returned.
func OpenSignedSigFile ¶
func OpenSignedSigFile(keyring openpgp.KeyRing, path string, opts ...OpenSignedFileOption) (*os.File, error)
OpenSignedSigFile calls OpenSignedFile expecting the signature to be in path.sig.
E.g. if path is /foo/bar, the signature is expected to be in /foo/bar.sig.
func WithIgnoreTimeConflict ¶ added in v0.12.0
func WithIgnoreTimeConflict(o *openSignedFileOptions)
Types ¶
type ErrHashMismatch ¶
ErrHashMismatch is returned when the file's hash does not match the expected hash.
func (ErrHashMismatch) Error ¶
func (e ErrHashMismatch) Error() string
type ErrInvalidHash ¶
type ErrInvalidHash struct {
// Path is the path to the file that was supposed to be verified.
Path string
// Err is some underlying error.
Err error
}
ErrInvalidHash is returned when hash verification failed.
func (ErrInvalidHash) Error ¶
func (e ErrInvalidHash) Error() string
func (ErrInvalidHash) Unwrap ¶
func (e ErrInvalidHash) Unwrap() error
type ErrUnsigned ¶
type ErrUnsigned struct {
// Path is the file that failed signature verification.
Path string
// Err is a nested error, if there was one.
Err error
}
ErrUnsigned is returned for a file that failed signature verification.
func (ErrUnsigned) Error ¶
func (e ErrUnsigned) Error() string
func (ErrUnsigned) Unwrap ¶
func (e ErrUnsigned) Unwrap() error
type ErrWrongSigner ¶
ErrWrongSigner represents a file signed by some key, but not the ones in the given key ring.
func (ErrWrongSigner) Error ¶
func (e ErrWrongSigner) Error() string
type OpenSignedFileOption ¶ added in v0.12.0
type OpenSignedFileOption func(*openSignedFileOptions)
OpenSignedFileOption is an optional argument to OpenSignedFile.
Source Files