1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
|
package api
import (
"net"
"strings"
)
// NetworkForwardPort represents a port specification in a network address forward
//
// swagger:model
//
// API extension: network_forward.
type NetworkForwardPort struct {
// Description of the forward port
// Example: My web server forward
Description string `json:"description" yaml:"description"`
// Protocol for port forward (either tcp or udp)
// Example: tcp
Protocol string `json:"protocol" yaml:"protocol"`
// ListenPort(s) to forward (comma delimited ranges)
// Example: 80,81,8080-8090
ListenPort string `json:"listen_port" yaml:"listen_port"`
// TargetPort(s) to forward ListenPorts to (allows for many-to-one)
// Example: 80,81,8080-8090
TargetPort string `json:"target_port" yaml:"target_port"`
// TargetAddress to forward ListenPorts to
// Example: 198.51.100.2
TargetAddress string `json:"target_address" yaml:"target_address"`
}
// Normalise normalises the fields in the rule so that they are comparable with ones stored.
func (p *NetworkForwardPort) Normalise() {
p.Description = strings.TrimSpace(p.Description)
p.Protocol = strings.TrimSpace(p.Protocol)
p.TargetAddress = strings.TrimSpace(p.TargetAddress)
ip := net.ParseIP(p.TargetAddress)
if ip != nil {
p.TargetAddress = ip.String() // Replace with canonical form if specified.
}
// Remove space from ListenPort list.
subjects := strings.Split(p.ListenPort, ",")
for i, s := range subjects {
subjects[i] = strings.TrimSpace(s)
}
p.ListenPort = strings.Join(subjects, ",")
// Remove space from TargetPort list.
subjects = strings.Split(p.TargetPort, ",")
for i, s := range subjects {
subjects[i] = strings.TrimSpace(s)
}
p.TargetPort = strings.Join(subjects, ",")
}
// NetworkForwardsPost represents the fields of a new network address forward
//
// swagger:model
//
// API extension: network_forward.
type NetworkForwardsPost struct {
NetworkForwardPut `yaml:",inline"`
// The listen address of the forward
// Example: 192.0.2.1
ListenAddress string `json:"listen_address" yaml:"listen_address"`
}
// Normalise normalises the fields in the rule so that they are comparable with ones stored.
func (f *NetworkForwardsPost) Normalise() {
ip := net.ParseIP(f.ListenAddress)
if ip != nil {
f.ListenAddress = ip.String() // Replace with canonical form if specified.
}
f.NetworkForwardPut.Normalise()
}
// NetworkForwardPut represents the modifiable fields of a network address forward
//
// swagger:model
//
// API extension: network_forward.
type NetworkForwardPut struct {
// Description of the forward listen IP
// Example: My public IP forward
Description string `json:"description" yaml:"description"`
// Forward configuration map (refer to doc/network-forwards.md)
// Example: {"user.mykey": "foo"}
Config map[string]string `json:"config" yaml:"config"`
// Port forwards (optional)
Ports []NetworkForwardPort `json:"ports" yaml:"ports"`
}
// Normalise normalises the fields in the rule so that they are comparable with ones stored.
func (f *NetworkForwardPut) Normalise() {
f.Description = strings.TrimSpace(f.Description)
ip := net.ParseIP(f.Config["target_address"])
if ip != nil {
f.Config["target_address"] = ip.String() // Replace with canonical form if specified.
}
for i := range f.Ports {
f.Ports[i].Normalise()
}
}
// NetworkForward used for displaying an network address forward.
//
// swagger:model
//
// API extension: network_forward.
type NetworkForward struct {
NetworkForwardPut `yaml:",inline"`
// The listen address of the forward
// Example: 192.0.2.1
ListenAddress string `json:"listen_address" yaml:"listen_address"`
// What cluster member this record was found on
// Example: server01
Location string `json:"location" yaml:"location"`
}
// Etag returns the values used for etag generation.
func (f *NetworkForward) Etag() []any {
return []any{f.ListenAddress, f.Description, f.Config, f.Ports}
}
// Writable converts a full NetworkForward struct into a NetworkForwardPut struct (filters read-only fields).
func (f *NetworkForward) Writable() NetworkForwardPut {
return f.NetworkForwardPut
}
|