verifcid

Documentation

Index

• Variables
• func ValidateCid(allowlist Allowlist, c cid.Cid) error
• type Allowlist
  • func NewAllowlist(allowset map[uint64]bool) Allowlist
  • func NewOverridingAllowlist(override Allowlist, allowset map[uint64]bool) Allowlist

Variables

var (
	ErrPossiblyInsecureHashFunction = fmt.Errorf("potentially insecure hash functions not allowed")
	ErrBelowMinimumHashLength       = fmt.Errorf("hashes must be at least %d bytes long", minimumHashLength)
	ErrAboveMaximumHashLength       = fmt.Errorf("hashes must be at most %d bytes long", maximumHashLength)
)

var DefaultAllowlist defaultAllowlist

DefaultAllowlist is the default list of hashes allowed in IPFS.

Functions

func ValidateCid

func ValidateCid(allowlist Allowlist, c cid.Cid) error

ValidateCid validates multihash allowance behind given CID.

Types

type Allowlist

type Allowlist interface {
	// IsAllowed checks for multihash allowance by the code.
	IsAllowed(code uint64) bool
}

Allowlist defines an interface containing list of allowed multihashes.

func NewAllowlist

func NewAllowlist(allowset map[uint64]bool) Allowlist

NewAllowlist constructs new Allowlist from the given map set.

func NewOverridingAllowlist

func NewOverridingAllowlist(override Allowlist, allowset map[uint64]bool) Allowlist

NewOverridingAllowlist is like NewAllowlist but it will fallback to an other [AllowList] if keys are missing. If override is nil it will return unsecure for unknown things.