sspanel

Documentation

Index

• type APIClient
  • func New(apiConfig *api.Config) *APIClient
  • func (c *APIClient) Debug()
  • func (c *APIClient) Describe() api.ClientInfo
  • func (c *APIClient) GetNodeInfo() (nodeInfo *api.NodeInfo, err error)
  • func (c *APIClient) GetNodeRule() (*[]api.DetectRule, error)
  • func (c *APIClient) GetUserList() (UserList *[]api.UserInfo, err error)
  • func (c *APIClient) ParseSSNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)
  • func (c *APIClient) ParseSSPanelNodeInfo(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)
  • func (c *APIClient) ParseSSPluginNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)
  • func (c *APIClient) ParseTrojanNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)
  • func (c *APIClient) ParseUserListResponse(userInfoResponse *[]UserResponse) (*[]api.UserInfo, error)
  • func (c *APIClient) ParseV2rayNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)
  • func (c *APIClient) ReportIllegal(detectResultList *[]api.DetectResult) error
  • func (c *APIClient) ReportNodeOnlineUsers(onlineUserList *[]api.OnlineUser) error
  • func (c *APIClient) ReportNodeStatus(nodeStatus *api.NodeStatus) (err error)
  • func (c *APIClient) ReportUserTraffic(userTraffic *[]api.UserTraffic) error
• type CustomConfig
• type IllegalItem
• type NodeInfoResponse
• type OnlineUser
• type PostData
• type Response
• type RuleItem
• type SystemLoad
• type UserResponse
• type UserTraffic

Types

type APIClient

type APIClient struct {
	APIHost             string
	NodeID              int
	Key                 string
	NodeType            string
	EnableVless         bool
	EnableXTLS          bool
	SpeedLimit          float64
	DeviceLimit         int
	DisableCustomConfig bool
	LocalRuleList       []api.DetectRule
	LastReportOnline    map[int]int
	// contains filtered or unexported fields
}

APIClient create a api client to the panel.

func New

func New(apiConfig *api.Config) *APIClient

New creat a api instance

func (*APIClient) Debug

func (c *APIClient) Debug()

Debug set the client debug for client

func (*APIClient) Describe

func (c *APIClient) Describe() api.ClientInfo

Describe return a description of the client

func (*APIClient) GetNodeInfo

func (c *APIClient) GetNodeInfo() (nodeInfo *api.NodeInfo, err error)

GetNodeInfo will pull NodeInfo Config from sspanel

func (*APIClient) GetNodeRule

func (c *APIClient) GetNodeRule() (*[]api.DetectRule, error)

GetNodeRule will pull the audit rule form sspanel

func (*APIClient) GetUserList

func (c *APIClient) GetUserList() (UserList *[]api.UserInfo, err error)

GetUserList will pull user form sspanel

func (*APIClient) ParseSSNodeResponse

func (c *APIClient) ParseSSNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)

ParseSSNodeResponse parse the response for the given nodeinfor format

func (*APIClient) ParseSSPanelNodeInfo

func (c *APIClient) ParseSSPanelNodeInfo(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)

ParseSSPanelNodeInfo parse the response for the given nodeinfor format Only used for SSPanel version >= 2021.11

func (*APIClient) ParseSSPluginNodeResponse

func (c *APIClient) ParseSSPluginNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)

ParseSSPluginNodeResponse parse the response for the given nodeinfor format

func (*APIClient) ParseTrojanNodeResponse

func (c *APIClient) ParseTrojanNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)

ParseTrojanNodeResponse parse the response for the given nodeinfor format

func (*APIClient) ParseUserListResponse

func (c *APIClient) ParseUserListResponse(userInfoResponse *[]UserResponse) (*[]api.UserInfo, error)

ParseUserListResponse parse the response for the given nodeinfo format

func (*APIClient) ParseV2rayNodeResponse

func (c *APIClient) ParseV2rayNodeResponse(nodeInfoResponse *NodeInfoResponse) (*api.NodeInfo, error)

ParseV2rayNodeResponse parse the response for the given nodeinfor format

func (*APIClient) ReportIllegal

func (c *APIClient) ReportIllegal(detectResultList *[]api.DetectResult) error

ReportIllegal reports the user illegal behaviors

func (*APIClient) ReportNodeOnlineUsers

func (c *APIClient) ReportNodeOnlineUsers(onlineUserList *[]api.OnlineUser) error

ReportNodeOnlineUsers reports online user ip

func (*APIClient) ReportNodeStatus

func (c *APIClient) ReportNodeStatus(nodeStatus *api.NodeStatus) (err error)

ReportNodeStatus reports the node status to the sspanel

func (*APIClient) ReportUserTraffic

func (c *APIClient) ReportUserTraffic(userTraffic *[]api.UserTraffic) error

ReportUserTraffic reports the user traffic

type CustomConfig

type CustomConfig struct {
	OffsetPortUser string          `json:"offset_port_user"`
	OffsetPortNode string          `json:"offset_port_node"`
	ServerSub      string          `json:"server_sub"`
	Host           string          `json:"host"`
	MuPort         string          `json:"mu_port"`
	MuEncryption   string          `json:"mu_encryption"`
	MuProtocol     string          `json:"mu_protocol"`
	MuObfs         string          `json:"mu_obfs"`
	MuSuffix       string          `json:"mu_suffix"`
	V2Port         string          `json:"v2_port"`
	TLS            string          `json:"tls"`
	EnableVless    string          `json:"enable_vless"`
	AlterID        string          `json:"alter_id"`
	Network        string          `json:"network"`
	Security       string          `json:"security"`
	Path           string          `json:"path"`
	VerifyCert     bool            `json:"verify_cert"`
	Obfs           string          `json:"obfs"`
	Header         json.RawMessage `json:"header"`
	TrojanPort     string          `json:"trojan_port"`
	AllowInsecure  string          `json:"allow_insecure"`
	Grpc           string          `json:"grpc"`
	Servicename    string          `json:"servicename"`
	EnableXtls     string          `json:"enable_xtls"`
	Flow           string          `json:"flow"`
}

type IllegalItem

type IllegalItem struct {
	ID  int `json:"list_id"`
	UID int `json:"user_id"`
}

type NodeInfoResponse

type NodeInfoResponse struct {
	Group           int             `json:"node_group"`
	Class           int             `json:"node_class"`
	SpeedLimit      float64         `json:"node_speedlimit"`
	TrafficRate     float64         `json:"traffic_rate"`
	MuOnly          int             `json:"mu_only"`
	Sort            int             `json:"sort"`
	RawServerString string          `json:"server"`
	Type            string          `json:"type"`
	CustomConfig    json.RawMessage `json:"custom_config"`
	Version         string          `json:"version"`
}

NodeInfoResponse is the response of node

type OnlineUser

type OnlineUser struct {
	UID int    `json:"user_id"`
	IP  string `json:"ip"`
}

OnlineUser is the data structure of online user

type PostData

type PostData struct {
	Data interface{} `json:"data"`
}

PostData is the data structure of post data

type Response

type Response struct {
	Ret  uint            `json:"ret"`
	Data json.RawMessage `json:"data"`
}

Response is the common response

type RuleItem

type RuleItem struct {
	ID      int    `json:"id"`
	Content string `json:"regex"`
}

type SystemLoad

type SystemLoad struct {
	Uptime string `json:"uptime"`
	Load   string `json:"load"`
}

SystemLoad is the data structure of systemload

type UserResponse

type UserResponse struct {
	ID            int     `json:"id"`
	Email         string  `json:"email"`
	Passwd        string  `json:"passwd"`
	Port          int     `json:"port"`
	Method        string  `json:"method"`
	SpeedLimit    float64 `json:"node_speedlimit"`
	DeviceLimit   int     `json:"node_connector"`
	Protocol      string  `json:"protocol"`
	ProtocolParam string  `json:"protocol_param"`
	Obfs          string  `json:"obfs"`
	ObfsParam     string  `json:"obfs_param"`
	ForbiddenIP   string  `json:"forbidden_ip"`
	ForbiddenPort string  `json:"forbidden_port"`
	UUID          string  `json:"uuid"`
	MultiUser     int     `json:"is_multi_user"`
	AliveIP       int     `json:"alive_ip"`
}

UserResponse is the response of user

type UserTraffic

type UserTraffic struct {
	UID      int   `json:"user_id"`
	Upload   int64 `json:"u"`
	Download int64 `json:"d"`
}

UserTraffic is the data structure of traffic