readlimit

Documentation

Overview

Package readlimit provides bounded reads for user-controlled files, stdin, and HTTP bodies.

Index

• Constants
• func All(r io.Reader, max int64, label string) ([]byte, error)
• func File(path string, max int64, label string) ([]byte, error)
• func SecretPermissionWarning(path, label string) string

Constants

const (
	Config      int64 = 4 << 20
	Secret      int64 = 1 << 20
	Document    int64 = 64 << 20
	APIResponse int64 = 64 << 20
)

Functions

func All

func All(r io.Reader, max int64, label string) ([]byte, error)

All reads at most max bytes and returns an actionable error if more data is available. label identifies the input in the error message.

func File

func File(path string, max int64, label string) ([]byte, error)

File opens path and reads it through All.

func SecretPermissionWarning

func SecretPermissionWarning(path, label string) string

SecretPermissionWarning reports a regular secret file that is readable or writable by group/other users. It is advisory because mounted container secrets do not always permit chmod.