A web-standards VPN marketplace with an emphasis on fast, secure internet everwhere. This project exists to create a trusted best-in-class technology for the "public VPN" market, that:
- Works on consumer devices from the normal app stores
- Allows consumer devices to tap into existing resources to enhance the public VPN. We believe a more ubiquitous and distributed VPN will be better for consumers.
- Emphasizes transparency, privacy, security, and performance
Protocol defintion: Protobuf messages for the realtime transport protocol
API definition: OpenAPI definition for the API for clients to interact with the marketplace
The Go codebase is cross-platform and meant to run on client and server. It can be packaged into mobile apps via gomobile, linked to native clients, and server code. Since it uses web-standards (HTTPS, WSS, WebRTC), it can also be compiled to WASM to embed in the web.
Provider Is a container that implements the provider service. The default is to build and deploy with Warp. See provider/README.md for how to deploy a provider to follow the community distribution.
instanceId := connect.NewId()
apiUrl := "https://api.bringyour.com"
platformUrl := "https://connect.bringyour.com"
// `byJwt` is allocated from the `/auth/login*` API
// `clientId` is allocated with the `/network/auth-client` API
connectClient := connect.NewClientWithDefaults(ctx, clientId)
routeManager := connect.NewRouteManager(connectClient)
contractManager := connect.NewContractManagerWithDefaults(connectClient)
go connectClient.Run(routeManager, contractManager)
auth := &connect.ClientAuth{
ByJwt: byJwt,
InstanceId: instanceId,
AppVersion: Version,
}
platformTransport := connect.NewPlatformTransportWithDefaults(cancelCtx, platformUrl, auth)
go platformTransport.Run(routeManager)
localUserNat := connect.NewLocalUserNatWithDefaults(cancelCtx)
remoteUserNatProvider := connect.NewRemoteUserNatProvider(connectClient, localUserNat)
// close
remoteUserNatProvider.Close()
localUserNat.Close()
connectClient.Cancel()A client acts like a socket that can address multiple destinations. The clientId is tantamount to an IPv6. New clientIds are allocated with /network/auth-client.
The transfer speed of each client is limited by its slowest destination. All traffic is multiplexed to a single connection, and blocking the connection ultimately limits the rate of SendWithTimeout.
instanceId := connect.NewId()
apiUrl := "https://api.bringyour.com"
platformUrl := "https://connect.bringyour.com"
// `byJwt` is allocated from the `/auth/login*` API
// `clientId` is allocated with the `/network/auth-client` API
connectClient := connect.NewClientWithDefaults(ctx, clientId)
routeManager := connect.NewRouteManager(connectClient)
contractManager := connect.NewContractManagerWithDefaults(connectClient)
go connectClient.Run(routeManager, contractManager)
auth := &connect.ClientAuth{
ByJwt: byJwt,
InstanceId: instanceId,
AppVersion: Version,
}
platformTransport := connect.NewPlatformTransportWithDefaults(cancelCtx, platformUrl, auth)
go platformTransport.Run(routeManager)
// this establishes a contract with `destinationId` as needed
connectClient.SendWithTimeout(frame, destinationId, func(err error) {
if (err == nil) {
// ack'd
} else {
// not ack'd
}
})
connectClient.AddReceiveCallback(func(sourceId Id, frames []*protocol.Frame, provideMode protocol.ProvideMode) {
// `frames` are received from client `sourceId`
// `provideMode` is the relationship between this client and the source (lower is more trusted)
})
// close
connectClient.Cancel()More security and speed can be achieved using multiple clientIds that add and balance traffic to multiple destinations based on throughput. Each clientId has a maximum lifespan to limit tracing. This is called continuous optimization and the default way to use the public market.
Submit issues on the issues page.
Product page for BringYour with roadmap items. Please add feature and enhancement discussions there.
The goals for the Connect open source are to enhance privacy, security, and performance; and to enhance the on-device packet parsing capabilities.
BringYour connect is licenced under the MPL 2.0.
BringYour: Fast and secure internet wherever you want to be