Structure(d) output of wg?

Structure(d) output of wg?

[Dan Lüdtke]

Hi Jason, everyone,

I'd like to discuss the topic of structured output. I am working on =
luci-app-wireguard* which aims to provide status information via the =
user-friendly LUCI interface in LEDE. While writing code to parse the =
output I realized that I may not be the only one who needs to structure =
wg's output. Would it make sense to add support for structured output =
now and thus prevent/reduce parsers and half-baked solutions popping up =
in higher level software in the future?

Something like wg show --json
[
	{
		interface: "foo"
		private_key: "(hidden)",
		preshared_key: "(hidden)",
		listen_port: "12345",
		peers: [
			{
				public_key: "dfkdjkfjslfkd...",
				bandwith: "...",
				last_handshake: "..."
			},
			{
				public_key: "sdj9ad....",
				allowed_ips: "2001:db8::/64",
				bandwith: "..."
			}
		]
	},
	{
		interface: "foo2",
		...you get the idea...
	}
]

JSON is just one idea because it allows nice structuring. CSV, TSV or =
whatever is lean and easy to implement may be an equally good option. =
While structuring, we could also provide even more structure than the =
usual stdout of wg provides. Candidate for lists: allowed_ips
Candidate for sub-structures: bandwith (rx, tx)

What do you think?

Cheers,

Dan


*: Not to be confused with luci-proto-wireguard, kmod-wireguard, and =
wireguard-tools. They provide functionality and configuration =
interfaces, but not monitoring/fancy output.=

Re: Structure(d) output of wg?

[Jason A. Donenfeld]

Hi Dan,

This already exists. While `wg show wg0` gives some hipster colorized
output, `wg show wg0 [CATEGORY]` gives very structured output meant
for parsing with bash or grep or sed or cut or whatever you want. For
example:

[zx2c4@demo ~]$ sudo wg show wg0 bandwidth | tail
l8gKhi5rvJChhDWHl+C7Ubj8hSHfW0HbkOOA9GQPL3Y=    13272   43056
CpX3sUNoLSofE6V6X+uHnFqF5+g/fXwJeY6ploPbgV0=    9425    5785
NkUUqbqhh+VV2IZYdAuVIdjpx0UopRRgO7hZju7+DW0=    145     89
S3/UokM7yvoKCYOvGdyi0IiiqvrUWXsIX8FTSFl0i2E=    46101   152415
FPqY/W8Z6LTgZLu69CqF1WtIPwUoG52pNNno4BRDtR0=    145     89
ULFNzzUznzXzMrjRvWUlz9dQsIzEAtIG7o3s9oHRJHk=    145     89
qbTrp7yhdqrvLnMg9kZNxNTd7FQRvV6jMr18G63zDhA=    13299   28787
p0rDK1UEx7siGp061hekJFYkjTs3qY08TBaTfSk86TM=    5075    3434
NZSZ7/JTraQ6eOseLIMQBo38cfQL8SXarfO/g99xYUI=    0       0
pX7cS/weolOD5GKHhrNqtqKT4nZto50ZXczacQ5iklM=    95210   58850

(Quit hoggin my bandwidth, yall ;-) )

Jason

Re: Structure(d) output of wg?

[Jason A. Donenfeld]

Hey Dan,

Yea, but that's usually the case with command line tools and shell
processing. If you're in a position to be calling json, then why not
just also call the ioctl directly? I guess json might be easier for
some consumers? Hmm...

> Nice bandwidth, though :)

That's just the first ten too...
[zx2c4@demo ~]$ sudo wg show wg0 peers | wc -l
232

Jason

Re: Structure(d) output of wg?

[Dan Lüdtke]

Hi,

that would mean multiple calls to `wg` to get the desired structure =
filled, one for each [CATEGORY]. I can live with that, but was looking =
for a more efficient solution.

Cheers,

Dan

Nice bandwidth, though :)
=20
> On 14 Dec 2016, at 22:09, Jason A. Donenfeld <Jason@zx2c4.com> wrote:
>=20
> Hi Dan,
>=20
> This already exists. While `wg show wg0` gives some hipster colorized
> output, `wg show wg0 [CATEGORY]` gives very structured output meant
> for parsing with bash or grep or sed or cut or whatever you want. For
> example:
>=20
> [zx2c4@demo ~]$ sudo wg show wg0 bandwidth | tail
> l8gKhi5rvJChhDWHl+C7Ubj8hSHfW0HbkOOA9GQPL3Y=3D    13272   43056
> CpX3sUNoLSofE6V6X+uHnFqF5+g/fXwJeY6ploPbgV0=3D    9425    5785
> NkUUqbqhh+VV2IZYdAuVIdjpx0UopRRgO7hZju7+DW0=3D    145     89
> S3/UokM7yvoKCYOvGdyi0IiiqvrUWXsIX8FTSFl0i2E=3D    46101   152415
> FPqY/W8Z6LTgZLu69CqF1WtIPwUoG52pNNno4BRDtR0=3D    145     89
> ULFNzzUznzXzMrjRvWUlz9dQsIzEAtIG7o3s9oHRJHk=3D    145     89
> qbTrp7yhdqrvLnMg9kZNxNTd7FQRvV6jMr18G63zDhA=3D    13299   28787
> p0rDK1UEx7siGp061hekJFYkjTs3qY08TBaTfSk86TM=3D    5075    3434
> NZSZ7/JTraQ6eOseLIMQBo38cfQL8SXarfO/g99xYUI=3D    0       0
> pX7cS/weolOD5GKHhrNqtqKT4nZto50ZXczacQ5iklM=3D    95210   58850
>=20
> (Quit hoggin my bandwidth, yall ;-) )
>=20
> Jason