filter

README

⚠️ DEPRECATED: Filters have been migrated to multiformats/go-multiaddr.

go-maddr-filter

A library to perform filtering of multiaddrs.

Table of Contents

• Install
• Usage
• API
• Contribute
• License

Install

make install

Examples

// make a new filterset
f := NewFilters()

// filter out addresses on the 192.168 subnet
_, ipnet, _ := net.ParseCIDR("192.168.0.0/16")
f.AddFilter(ipnet, ActionDeny)

// check if an address is blocked
lanaddr, _ := ma.NewMultiaddr("/ip4/192.168.0.17/tcp/4050")
fmt.Println(f.AddrBlocked(lanaddr))

// the default for a filter is accept, but we can change that
f.RemoveLiteral(ipnet)
f.DefaultAction = ActionDeny
fmt.Println(f.AddrBlocked(lanaddr))

// we can now allow the local LAN, denying everything else
f.AddFilter(ipnet, ActionAccept)
fmt.Println(f.AddrBlocked(lanaddr))

Contribute

PRs are welcome!

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Jeromy Johnson

---

The last gx published version of this module was: 1.1.13: QmT6C5ebDy92zyRzdmSNyda5q7zkNXy68X47RDJiHpvaxd

Documentation

Index

• Constants
• func NewFilters() *multiaddr.Filters
• type Action
• type Filters

Constants

const (
	// Deprecated. Use "github.com/multiformats/go-multiaddr".ActionNone instead.
	ActionNone = multiaddr.ActionNone
	// Deprecated. Use "github.com/multiformats/go-multiaddr".ActionAccept instead.
	ActionAccept = multiaddr.ActionAccept
	// Deprecated. Use "github.com/multiformats/go-multiaddr".ActionDeny instead.
	ActionDeny = multiaddr.ActionDeny
)

Functions

func NewFilters

func NewFilters() *multiaddr.Filters

Deprecated. Use "github.com/multiformats/go-multiaddr".NewFilters instead.

Types

type Action

type Action = multiaddr.Action

Deprecated. Use "github.com/multiformats/go-multiaddr".Action instead.

type Filters

type Filters = multiaddr.Filters

Deprecated. Use "github.com/multiformats/go-multiaddr".Filters instead.