|
| 1 | +package flags |
| 2 | + |
| 3 | +import ( |
| 4 | + "net" |
| 5 | + "os" |
| 6 | + "strconv" |
| 7 | + "strings" |
| 8 | + |
| 9 | + "github.com/aquasecurity/tracee/common/errfmt" |
| 10 | + "github.com/aquasecurity/tracee/pkg/server/grpc" |
| 11 | + "github.com/aquasecurity/tracee/pkg/server/http" |
| 12 | +) |
| 13 | + |
| 14 | +const ( |
| 15 | + ServerFlag = "server" |
| 16 | + HTTPAddressFlag = "http-address" |
| 17 | + GRPCAddressFlag = "grpc-address" |
| 18 | + GRPCEndpointFlag = "grpc" |
| 19 | + MetricsEndpointFlag = "metrics" |
| 20 | + HealthzEndpointFlag = "healthz" |
| 21 | + PProfEndpointFlag = "pprof" |
| 22 | + PyroscopeAgentEndpointFlag = "pyroscope" |
| 23 | + DefaultServerFlagValue = "" |
| 24 | + |
| 25 | + defaultHTTPAddress = ":3366" |
| 26 | + defaultGRPCPort = "4466" |
| 27 | + defaultGRPCPath = "/var/run/tracee.sock" |
| 28 | +) |
| 29 | + |
| 30 | +type Server struct { |
| 31 | + HTTP *http.Server |
| 32 | + GRPC *grpc.Server |
| 33 | +} |
| 34 | + |
| 35 | +// PrepareServer prepares the server based on the server flags |
| 36 | +func PrepareServer(serverSlice []string) (*Server, error) { |
| 37 | + var err error |
| 38 | + var server Server |
| 39 | + var ( |
| 40 | + enableMetrics = false |
| 41 | + enableHealthz = false |
| 42 | + enablePProf = false |
| 43 | + enablePyroscope = false |
| 44 | + ) |
| 45 | + for _, endpoint := range serverSlice { |
| 46 | + values := strings.SplitN(endpoint, "=", 2) |
| 47 | + if len(values) != 2 { |
| 48 | + return nil, errfmt.Errorf("invalid server flag: '%s', use 'trace man server' for more info", endpoint) |
| 49 | + } |
| 50 | + |
| 51 | + flagName := values[0] |
| 52 | + flagValue := values[1] |
| 53 | + |
| 54 | + switch flagName { |
| 55 | + case HTTPAddressFlag: // http-address=<host:port> |
| 56 | + err = validateHTTPAddr(flagValue) |
| 57 | + if err != nil { |
| 58 | + return nil, err |
| 59 | + } |
| 60 | + server.HTTP = http.New(flagValue) |
| 61 | + case GRPCAddressFlag: // grpc-address=protocol:address |
| 62 | + protocol, address, err := parseAndValidateGRPCAddr(flagValue) |
| 63 | + if err != nil { |
| 64 | + return nil, err |
| 65 | + } |
| 66 | + server.GRPC = grpc.New(protocol, address) |
| 67 | + case MetricsEndpointFlag: // metrics |
| 68 | + enableMetrics, err = validateAndGetBool(flagName, flagValue) |
| 69 | + if err != nil { |
| 70 | + return nil, err |
| 71 | + } |
| 72 | + case HealthzEndpointFlag: // healthz |
| 73 | + enableHealthz, err = validateAndGetBool(flagName, flagValue) |
| 74 | + if err != nil { |
| 75 | + return nil, err |
| 76 | + } |
| 77 | + case PProfEndpointFlag: // pprof |
| 78 | + enablePProf, err = validateAndGetBool(flagName, flagValue) |
| 79 | + if err != nil { |
| 80 | + return nil, err |
| 81 | + } |
| 82 | + case PyroscopeAgentEndpointFlag: // pyroscope |
| 83 | + enablePyroscope, err = validateAndGetBool(flagName, flagValue) |
| 84 | + if err != nil { |
| 85 | + return nil, err |
| 86 | + } |
| 87 | + default: |
| 88 | + return nil, errfmt.Errorf("invalid server flag: '%s', use 'trace man server' for more info", flagName) |
| 89 | + } |
| 90 | + } |
| 91 | + |
| 92 | + if enableMetrics || enableHealthz || enablePProf || enablePyroscope { |
| 93 | + // if a flag is set, but the server is not configured, set a default HTTP server |
| 94 | + if server.HTTP == nil { |
| 95 | + server.HTTP = http.New(defaultHTTPAddress) |
| 96 | + } |
| 97 | + if enableMetrics { |
| 98 | + server.HTTP.EnableMetricsEndpoint() |
| 99 | + } |
| 100 | + if enableHealthz { |
| 101 | + server.HTTP.EnableHealthzEndpoint() |
| 102 | + } |
| 103 | + if enablePProf { |
| 104 | + server.HTTP.EnablePProfEndpoint() |
| 105 | + } |
| 106 | + if enablePyroscope { |
| 107 | + err = server.HTTP.EnablePyroAgent() |
| 108 | + if err != nil { |
| 109 | + return nil, err |
| 110 | + } |
| 111 | + } |
| 112 | + } |
| 113 | + |
| 114 | + return &server, nil |
| 115 | +} |
| 116 | + |
| 117 | +func validateHTTPAddr(addr string) error { |
| 118 | + // Split the address into host and port. |
| 119 | + host, portStr, err := net.SplitHostPort(addr) |
| 120 | + if err != nil { |
| 121 | + return errfmt.Errorf("invalid http address: '%s', use 'trace man server' for more info", addr) |
| 122 | + } |
| 123 | + |
| 124 | + // If a host is specified, do basic validation |
| 125 | + if host != "" { |
| 126 | + // Accept IP addresses and basic hostname formats |
| 127 | + // For CLI tools, we can be permissive and let network operations |
| 128 | + // handle detailed validation when the server actually starts |
| 129 | + if net.ParseIP(host) == nil { |
| 130 | + // Basic hostname validation: no spaces, reasonable length |
| 131 | + if len(host) > 253 || strings.Contains(host, " ") { |
| 132 | + return errfmt.Errorf("invalid http host: '%s', use 'trace man server' for more info", host) |
| 133 | + } |
| 134 | + } |
| 135 | + } |
| 136 | + |
| 137 | + return validatePort(portStr) |
| 138 | +} |
| 139 | + |
| 140 | +func parseAndValidateGRPCAddr(addr string) (string, string, error) { |
| 141 | + // Split the address into protocol and address. |
| 142 | + values := strings.SplitN(addr, ":", 2) |
| 143 | + protocol := values[0] |
| 144 | + |
| 145 | + switch protocol { |
| 146 | + case "tcp": |
| 147 | + if len(values) == 2 { |
| 148 | + port := values[1] |
| 149 | + err := validatePort(port) |
| 150 | + if err != nil { |
| 151 | + return "", "", err |
| 152 | + } |
| 153 | + return protocol, port, nil |
| 154 | + } |
| 155 | + return protocol, defaultGRPCPort, nil |
| 156 | + case "unix": |
| 157 | + if len(values) == 2 { |
| 158 | + path := values[1] |
| 159 | + if _, err := os.Stat(path); err == nil { |
| 160 | + err = os.Remove(path) |
| 161 | + if err != nil { |
| 162 | + return "", "", errfmt.Errorf("failed to cleanup gRPC listening address (%s): %v", path, err) |
| 163 | + } |
| 164 | + } |
| 165 | + return protocol, path, nil |
| 166 | + } |
| 167 | + return protocol, defaultGRPCPath, nil |
| 168 | + } |
| 169 | + |
| 170 | + return "", "", errfmt.Errorf("invalid grpc protocol: '%s', use 'trace man server' for more info", protocol) |
| 171 | +} |
| 172 | + |
| 173 | +func validateAndGetBool(flagName, value string) (bool, error) { |
| 174 | + switch value { |
| 175 | + case "true": |
| 176 | + return true, nil |
| 177 | + case "false": |
| 178 | + return false, nil |
| 179 | + } |
| 180 | + |
| 181 | + return false, errfmt.Errorf("invalid flag value '%s' for flag '%s', use 'trace man server' for more info", value, flagName) |
| 182 | +} |
| 183 | + |
| 184 | +func validatePort(port string) error { |
| 185 | + portInt, err := strconv.Atoi(port) |
| 186 | + if err != nil { |
| 187 | + return errfmt.Errorf("invalid port number '%s', use 'trace man server' for more info", port) |
| 188 | + } |
| 189 | + if portInt < 0 || portInt > 65535 { |
| 190 | + return errfmt.Errorf("invalid port number '%s', value must be between 0 and 65535, use 'trace man server' for more info", port) |
| 191 | + } |
| 192 | + return nil |
| 193 | +} |
0 commit comments