About

BringYour is a web-standards VPN marketplace with an emphasis on fast, secure internet everwhere.

The API for BringYour bootstraps the connect protocol, and is the source of JWTs and other match-making transactions.

The JWT returned by /auth routes does not have a clientId. The connect protocol requires a JWT with a clientId. Use the /network routes to obtain a JWT with a clientId.

In the BringYour network:

• a network name is a globally unique subnet (xyz.bringyour.network)

• a clientId is a globally unique 16-byte address

• clientIds are equivalent to IPv6, but are expressed as UDID

• clients also have an IPv6 and IPv4 mapped to their clientId

Outside of IP translation like taptun/utun, clients are typically addressed via their clientId.

Unless otherwise specified, time/date strings will be formatted in the Go default 2006-01-02 15:04:05.999999999 -0700 MST.