1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
|
package command
import (
"flag"
"fmt"
"github.com/hashicorp/errwrap"
sockaddr "github.com/hashicorp/go-sockaddr"
"github.com/mitchellh/cli"
"github.com/ryanuber/columnize"
)
type DumpCommand struct {
Ui cli.Ui
// attrNames is a list of attribute names to include in the output
attrNames []string
// flags is a list of options belonging to this command
flags *flag.FlagSet
// machineMode changes the output format to be machine friendly
// (i.e. tab-separated values).
machineMode bool
// valueOnly changes the output format to include only values
valueOnly bool
// ifOnly parses the input as an interface name
ifOnly bool
// ipOnly parses the input as an IP address (either IPv4 or IPv6)
ipOnly bool
// v4Only parses the input exclusively as an IPv4 address
v4Only bool
// v6Only parses the input exclusively as an IPv6 address
v6Only bool
// unixOnly parses the input exclusively as a UNIX Socket
unixOnly bool
}
// Description is the long-form command help.
func (c *DumpCommand) Description() string {
return `Parse address(es) or interface and dumps various output.`
}
// Help returns the full help output expected by `sockaddr -h cmd`
func (c *DumpCommand) Help() string {
return MakeHelp(c)
}
// InitOpts is responsible for setup of this command's configuration via the
// command line. InitOpts() does not parse the arguments (see parseOpts()).
func (c *DumpCommand) InitOpts() {
c.flags = flag.NewFlagSet("dump", flag.ContinueOnError)
c.flags.Usage = func() { c.Ui.Output(c.Help()) }
c.flags.BoolVar(&c.machineMode, "H", false, "Machine readable output")
c.flags.BoolVar(&c.valueOnly, "n", false, "Show only the value")
c.flags.BoolVar(&c.v4Only, "4", false, "Parse the input as IPv4 only")
c.flags.BoolVar(&c.v6Only, "6", false, "Parse the input as IPv6 only")
c.flags.BoolVar(&c.ifOnly, "I", false, "Parse the argument as an interface name")
c.flags.BoolVar(&c.ipOnly, "i", false, "Parse the input as IP address (either IPv4 or IPv6)")
c.flags.BoolVar(&c.unixOnly, "u", false, "Parse the input as a UNIX Socket only")
c.flags.Var((*MultiArg)(&c.attrNames), "o", "Name of an attribute to pass through")
}
// Run executes this command.
func (c *DumpCommand) Run(args []string) int {
if len(args) == 0 {
c.Ui.Error(c.Help())
return 1
}
c.InitOpts()
addrs, err := c.parseOpts(args)
if err != nil {
if errwrap.Contains(err, "flag: help requested") {
return 0
}
return 1
}
for _, addr := range addrs {
var sa sockaddr.SockAddr
var ifAddrs sockaddr.IfAddrs
var err error
switch {
case c.v4Only:
sa, err = sockaddr.NewIPv4Addr(addr)
case c.v6Only:
sa, err = sockaddr.NewIPv6Addr(addr)
case c.unixOnly:
sa, err = sockaddr.NewUnixSock(addr)
case c.ipOnly:
sa, err = sockaddr.NewIPAddr(addr)
case c.ifOnly:
ifAddrs, err = sockaddr.GetAllInterfaces()
if err != nil {
break
}
ifAddrs, _, err = sockaddr.IfByName(addr, ifAddrs)
default:
sa, err = sockaddr.NewSockAddr(addr)
}
if err != nil {
c.Ui.Error(fmt.Sprintf("Unable to parse %+q: %v", addr, err))
return 1
}
if sa != nil {
c.dumpSockAddr(sa)
} else if ifAddrs != nil {
c.dumpIfAddrs(ifAddrs)
} else {
panic("bad")
}
}
return 0
}
// Synopsis returns a terse description used when listing sub-commands.
func (c *DumpCommand) Synopsis() string {
return `Parses input as an IP or interface name(s) and dumps various information`
}
// Usage is the one-line usage description
func (c *DumpCommand) Usage() string {
return `sockaddr dump [options] input [...]`
}
// VisitAllFlags forwards the visitor function to the FlagSet
func (c *DumpCommand) VisitAllFlags(fn func(*flag.Flag)) {
c.flags.VisitAll(fn)
}
func (c *DumpCommand) dumpIfAddrs(ifAddrs sockaddr.IfAddrs) {
for _, ifAddr := range ifAddrs {
c.dumpSockAddr(ifAddr.SockAddr)
}
}
func (c *DumpCommand) dumpSockAddr(sa sockaddr.SockAddr) {
reservedAttrs := []sockaddr.AttrName{"Attribute"}
const maxNumAttrs = 32
output := make([]string, 0, maxNumAttrs+len(reservedAttrs))
allowedAttrs := make(map[sockaddr.AttrName]struct{}, len(c.attrNames)+len(reservedAttrs))
for _, attr := range reservedAttrs {
allowedAttrs[attr] = struct{}{}
}
for _, attr := range c.attrNames {
allowedAttrs[sockaddr.AttrName(attr)] = struct{}{}
}
// allowedAttr returns true if the attribute is allowed to be appended
// to the output.
allowedAttr := func(k sockaddr.AttrName) bool {
if len(allowedAttrs) == len(reservedAttrs) {
return true
}
_, found := allowedAttrs[k]
return found
}
// outFmt is a small helper function to reduce the tedium below. outFmt
// returns a new slice and expects the value to already be a string.
outFmt := func(o []string, k sockaddr.AttrName, v interface{}) []string {
if !allowedAttr(k) {
return o
}
switch {
case c.valueOnly:
return append(o, fmt.Sprintf("%s", v))
case !c.valueOnly && c.machineMode:
return append(o, fmt.Sprintf("%s\t%s", k, v))
case !c.valueOnly && !c.machineMode:
fallthrough
default:
return append(o, fmt.Sprintf("%s | %s", k, v))
}
}
if !c.machineMode {
output = outFmt(output, "Attribute", "Value")
}
// Attributes for all SockAddr types
for _, attr := range sockaddr.SockAddrAttrs() {
output = outFmt(output, attr, sockaddr.SockAddrAttr(sa, attr))
}
// Attributes for all IP types (both IPv4 and IPv6)
if sa.Type()&sockaddr.TypeIP != 0 {
ip := *sockaddr.ToIPAddr(sa)
for _, attr := range sockaddr.IPAttrs() {
output = outFmt(output, attr, sockaddr.IPAddrAttr(ip, attr))
}
}
if sa.Type() == sockaddr.TypeIPv4 {
ipv4 := *sockaddr.ToIPv4Addr(sa)
for _, attr := range sockaddr.IPv4Attrs() {
output = outFmt(output, attr, sockaddr.IPv4AddrAttr(ipv4, attr))
}
}
if sa.Type() == sockaddr.TypeIPv6 {
ipv6 := *sockaddr.ToIPv6Addr(sa)
for _, attr := range sockaddr.IPv6Attrs() {
output = outFmt(output, attr, sockaddr.IPv6AddrAttr(ipv6, attr))
}
}
if sa.Type() == sockaddr.TypeUnix {
us := *sockaddr.ToUnixSock(sa)
for _, attr := range sockaddr.UnixSockAttrs() {
output = outFmt(output, attr, sockaddr.UnixSockAttr(us, attr))
}
}
// Developer-focused arguments
{
arg1, arg2 := sa.DialPacketArgs()
output = outFmt(output, "DialPacket", fmt.Sprintf("%+q %+q", arg1, arg2))
}
{
arg1, arg2 := sa.DialStreamArgs()
output = outFmt(output, "DialStream", fmt.Sprintf("%+q %+q", arg1, arg2))
}
{
arg1, arg2 := sa.ListenPacketArgs()
output = outFmt(output, "ListenPacket", fmt.Sprintf("%+q %+q", arg1, arg2))
}
{
arg1, arg2 := sa.ListenStreamArgs()
output = outFmt(output, "ListenStream", fmt.Sprintf("%+q %+q", arg1, arg2))
}
result := columnize.SimpleFormat(output)
c.Ui.Output(result)
}
// parseOpts is responsible for parsing the options set in InitOpts(). Returns
// a list of non-parsed flags.
func (c *DumpCommand) parseOpts(args []string) ([]string, error) {
if err := c.flags.Parse(args); err != nil {
return nil, err
}
conflictingOptsCount := 0
if c.v4Only {
conflictingOptsCount++
}
if c.v6Only {
conflictingOptsCount++
}
if c.unixOnly {
conflictingOptsCount++
}
if c.ifOnly {
conflictingOptsCount++
}
if c.ipOnly {
conflictingOptsCount++
}
if conflictingOptsCount > 1 {
return nil, fmt.Errorf("Conflicting options specified, only one parsing mode may be specified at a time")
}
return c.flags.Args(), nil
}
|