control_dto

Documentation

Index

• Constants
• type AgentCmdReq
• type AgentCmdResp
• type ClientCacheInfo
  • func (c *ClientCacheInfo) GetClientAddCmd() (fullCmd, b64 string)
  • func (c *ClientCacheInfo) GetClientB64() (raw, b64 string)
  • func (c *ClientCacheInfo) GetClientWgPeer(toRemove bool) (peerConfig *wg_core.WgPeer, err error)
• type ConnectorRegisterReq
• type ConnectorRegisterResp
• type ConnectorRegisterRespPop
• type PopRegisterIfaceResp
• type PopRegisterReq
• type PopRegisterResp
• type WgClientConnReq
• type WgClientConnResp
• type WgClientConnRespPop

Constants

const (
	AGENT_CMD_REGISTER uint8 = 1
)

Types

type AgentCmdReq

type AgentCmdReq struct {
	MsgId     string `json:"msg_id"`
	Cmd       uint8  `json:"cmd"`
	AgentType uint8  `json:"agent_type"`
	AgentId   string `json:"agent_id"`
	Ts        int64  `json:"ts"`
	Msg       string `json:"msg"`
}

type AgentCmdResp

type AgentCmdResp struct {
	MsgId string `json:"msg_id"` // echo
	Cmd   uint8  `json:"cmd"`
	Ts    int64  `json:"ts"`
	Msg   string `json:"msg"`
	Error string `json:"error,omitempty"`
}

type ClientCacheInfo

type ClientCacheInfo struct {
	IP        string `json:"ip"`         // CIDR format?
	PublicKey string `json:"public_key"` //
	PSK       string `json:"psk"`        //
	ClientId  string `json:"client_id"`  // 可以是client-id/pop-id/connector-id
	Type      uint8  `json:"type"`       // pop/connector/client, pop service订阅消息，需要知道对端是什么类型，他没有访问数据库的权限

}

Client can be pop/connector/client 对pop而言，连接到当前pop的所有设备（包括client/pop/connector）都可以看做是pop的client 对client而言，一个client id同时只能有一个client在线，多个uid也不行， 需要UID的话，可以从db里面获取，而不是从cache里,handlerClientLogin 发生在登录的时候，可以拿到client对应的user的info

func (*ClientCacheInfo) GetClientAddCmd

func (c *ClientCacheInfo) GetClientAddCmd() (fullCmd, b64 string)

func (*ClientCacheInfo) GetClientB64

func (c *ClientCacheInfo) GetClientB64() (raw, b64 string)

func (*ClientCacheInfo) GetClientWgPeer

func (c *ClientCacheInfo) GetClientWgPeer(toRemove bool) (peerConfig *wg_core.WgPeer, err error)

peer is client/connector/pop toRemove means peer is offline/session timeout/kickoff

type ConnectorRegisterReq

type ConnectorRegisterReq struct {
	ConnectorId string `json:"connector_id"`        // required, TODO: use uuid, pop_id/connector_id
	PubKey      string `json:"pub_key,omitempty"`   // [optional][pop&connector]agent's, 可以由controller 分配
	RenewKey    bool   `json:"renew_key,omitempty"` //
}

type ConnectorRegisterResp

type ConnectorRegisterResp struct {
	// pop's info
	Pop ConnectorRegisterRespPop `json:"pop"`

	// connector's info
	WgPublicKey  string `json:"wg_public_key,omitempty"`  // [optional][connector]agent's, controller 分配
	WgPrivateKey string `json:"wg_private_key,omitempty"` // [optional][connector]agent's, controller 分配
	WgPSK        string `json:"wg_psk"`                   // [optional]connector's,
	WgIP         string `json:"wg_ip"`                    // [required]connector's, controller 分配给 connector 的 wg IP

	// connector's non-wg info
	ConnectorId string `json:"connector_id"`     // [required]connector's
	Access      bool   `json:"access,omitempty"` //
	Error       string `json:"error,omitempty"`  //
}

type ConnectorRegisterRespPop

type ConnectorRegisterRespPop struct {
	PopId      string `json:"pop_id"`                // pop id
	PublicKey  string `json:"public_key"`            // pop's public_key
	WgIP       string `json:"wg_ip"`                 // pop's wg IP
	Network    string `json:"network"`               // pop's network, cidr format: 10.0.0.1/24
	Endpoint   string `json:"endpoint"`              // pop's Endpoint
	Port       int    `json:"port"`                  // pop's listen port
	AllowedIPs string `json:"allowed_ips,omitempty"` //
	DNS        string `json:"dns,omitempty"`         //
}

type PopRegisterIfaceResp

type PopRegisterIfaceResp struct {
	WgEndpoint   string `json:"endpoint"`    // required, public-ip:listen-port
	WgPort       int    `json:"port"`        // required, pop's listen-port
	WgNetwork    string `json:"network"`     // required, wg ip pool, generate by pop-controller
	WgAllowedIps string `json:"allowed_ips"` // required, generate by pop-controller
	WgDns        string `json:"dns"`         // ?
	WgIP         string `json:"wg_ip"`       // required, internal wg ip for wg client to connect, should be consist with Network

}

type PopRegisterReq

type PopRegisterReq struct {
	PopId    string `json:"pop_id"`              // required, TODO: use uuid
	PubKey   string `json:"pub_key,omitempty"`   // optional, pop's pub key, may be generate by pop-controller
	RenewKey bool   `json:"renew_key,omitempty"` //
}

type PopRegisterResp

type PopRegisterResp struct {
	PopId        string                          `json:"pop_id,omitempty"`
	WgPublicKey  string                          `json:"public_key,omitempty"`  // pop's, all the interfaces share the same key
	WgPrivateKey string                          `json:"private_key,omitempty"` // pop's
	WgInterfaces map[string]PopRegisterIfaceResp `json:"interfaces,omitempty"`  // pop's
	Clients      []ClientCacheInfo               `json:"clients,omitempty"`     // include client/pop/connector
}

type WgClientConnReq

type WgClientConnReq struct {
	ClientId string `json:"client_id"`
	PubKey   string `json:"pub_key,omitempty"`
	RenewKey bool   `json:"renew_key,omitempty"` //
}

type WgClientConnResp

type WgClientConnResp struct {
	// pop's info
	Pop WgClientConnRespPop `json:"pop"`

	// client's wg info
	WgPublicKey  string `json:"wg_public_key,omitempty"`  // [optional][client]client's, controller 分配
	WgPrivateKey string `json:"wg_private_key,omitempty"` // [optional][client]client's, controller 分配
	WgPSK        string `json:"wg_psk,omitempty"`         // [optional]client's,
	WgIP         string `json:"wg_ip"`                    // [required]client's, controller 分配给client的 wg IP

	// client's non-wg info
	ClientId string   `json:"client_id"`        // [required]client's
	Groups   []string `json:"groups,omitempty"` //
	Access   bool     `json:"access,omitempty"` //
	Error    string   `json:"error,omitempty"`  //
}

type WgClientConnRespPop

type WgClientConnRespPop struct {
	PopId      string `json:"pop_id"`                // pop id
	PublicKey  string `json:"public_key"`            // pop's public_key
	WgIP       string `json:"wg_ip"`                 // pop's wg IP
	Network    string `json:"network"`               // pop's network, cidr format: 10.0.0.1/24
	Endpoint   string `json:"endpoint"`              // pop's Endpoint
	Port       int    `json:"port"`                  // pop's listen port
	AllowedIPs string `json:"allowed_ips,omitempty"` //
	DNS        string `json:"dns,omitempty"`         //
}