burrow/proto/burrowweb.proto
2024-11-21 17:12:30 +08:00

90 lines
2 KiB
Protocol Buffer

syntax = "proto3";
package burrowweb;
// TODO: Frontend sends slack token → receive JWT
// TODO: create/delete/list routes
service BurrowWeb {
rpc SlackAuth (SlackAuthRequest) returns (JWTInfo);
// Server assigns a IP address, generates a token, saves a user entry,
// then responds back with WireGuard configuration
rpc CreateDevice (CreateDeviceRequest) returns (CreateDeviceResponse);
rpc DeleteDevice (JWTInfo) returns (Empty);
rpc ListDevices (JWTInfo) returns (ListDevicesResponse);
}
message Peer {
string public_key = 1;
optional string preshared_key = 2;
repeated string allowed_ips = 3;
string endpoint = 4;
optional uint32 persistent_keepalive = 5;
optional string name = 6;
}
message InterfaceConfig {
// Does not include private key; the client is responsible for generating & persisting that
repeated string address = 1;
optional uint32 listen_port = 2;
repeated string dns = 3;
optional uint32 mtu = 4;
}
message Device {
int32 id = 1;
optional string name = 2;
string public_key = 3;
optional string apns_token = 4;
int32 user_id = 5;
string created_at = 6;
string ipv4 = 7;
string ipv6 = 8;
string access_token = 9;
string refresh_token = 10;
string expires_at = 11;
}
message User {
int32 id = 1;
string created_at = 2;
}
message UserConnection {
int32 user_id = 1;
string openid_provider = 2;
string openid_user_id = 3;
string openid_user_name = 4;
string access_token = 5;
string refresh_token = 6;
}
message Config {
InterfaceConfig interface = 1;
repeated Peer peers = 2;
}
message Empty {}
message SlackAuthRequest {
string slack_token = 1;
}
message JWTInfo {
string jwt = 1;
}
message CreateDeviceRequest {
JWTInfo jwt = 1;
string public_key = 2; // User's specified WG Public Key
}
message CreateDeviceResponse {
Config wg_config = 1;
}
message ListDevicesResponse {
repeated Device devices = 1;
}