kubernetes/test/images/agnhost/netexec/netexec.go
Dan Williams 31c563a46f agnhost/netexec: logging cleanup and print more verbose errors
There's currently no way to know whether an error is for SCTP or
UDP, for example:

Jul 24 09:55:54.469: INFO: netserver-0[e2e-nettest-3476].container[webserver].log
2020/07/24 09:53:52 Started UDP server
2020/07/24 09:53:52 Error occurred. error:protocol not supported

In this case the "Error occurred. error:protocol not supported" is
actually for the SCTP socket. Make that more apparent.
2020-07-24 14:40:58 -05:00

592 lines
19 KiB
Go

/*
Copyright 2014 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package netexec
import (
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"log"
"net"
"net/http"
"net/url"
"os"
"os/exec"
"strconv"
"strings"
"sync/atomic"
"time"
"github.com/ishidawataru/sctp"
"github.com/spf13/cobra"
utilnet "k8s.io/apimachinery/pkg/util/net"
)
var (
httpPort = 8080
udpPort = 8081
sctpPort = -1
shellPath = "/bin/sh"
serverReady = &atomicBool{0}
certFile = ""
privKeyFile = ""
)
// CmdNetexec is used by agnhost Cobra.
var CmdNetexec = &cobra.Command{
Use: "netexec",
Short: "Creates HTTP(S), UDP, and (optionally) SCTP servers with various endpoints",
Long: `Starts a HTTP(S) server on given port with the following endpoints:
- /: Returns the request's timestamp.
- /clientip: Returns the request's IP address.
- /dial: Creates a given number of requests to the given host and port using the given protocol,
and returns a JSON with the fields "responses" (successful request responses) and "errors" (
failed request responses). Returns "200 OK" status code if the last request succeeded,
"417 Expectation Failed" if it did not, or "400 Bad Request" if any of the endpoint's parameters
is invalid. The endpoint's parameters are:
- "host": The host that will be dialed.
- "port": The port that will be dialed.
- "request": The HTTP endpoint or data to be sent through UDP. If not specified, it will result
in a "400 Bad Request" status code being returned.
- "protocol": The protocol which will be used when making the request. Default value: "http".
Acceptable values: "http", "udp", "sctp".
- "tries": The number of times the request will be performed. Default value: "1".
- "/echo": Returns the given "msg" ("/echo?msg=echoed_msg")
- "/exit": Closes the server with the given code and graceful shutdown. The endpoint's parameters
are:
- "code": The exit code for the process. Default value: 0. Allows an integer [0-127].
- "timeout": The amount of time to wait for connections to close before shutting down.
Acceptable values are golang durations. If 0 the process will exit immediately without
shutdown.
- "wait": The amount of time to wait before starting shutdown. Acceptable values are
golang durations. If 0 the process will start shutdown immediately.
- "/healthz": Returns "200 OK" if the server is ready, "412 Status Precondition Failed"
otherwise. The server is considered not ready if the UDP server did not start yet or
it exited.
- "/hostname": Returns the server's hostname.
- "/hostName": Returns the server's hostname.
- "/shell": Executes the given "shellCommand" or "cmd" ("/shell?cmd=some-command") and
returns a JSON containing the fields "output" (command's output) and "error" (command's
error message). Returns "200 OK" if the command succeeded, "417 Expectation Failed" if not.
- "/shutdown": Closes the server with the exit code 0.
- "/upload": Accepts a file to be uploaded, writing it in the "/uploads" folder on the host.
Returns a JSON with the fields "output" (containing the file's name on the server) and
"error" containing any potential server side errors.
It will also start a UDP server on the indicated UDP port that responds to the following commands:
- "hostname": Returns the server's hostname
- "echo <msg>": Returns the given <msg>
- "clientip": Returns the request's IP address
Additionally, if (and only if) --sctp-port is passed, it will start an SCTP server on that port,
responding to the same commands as the UDP server.
`,
Args: cobra.MaximumNArgs(0),
Run: main,
}
func init() {
CmdNetexec.Flags().IntVar(&httpPort, "http-port", 8080, "HTTP Listen Port")
CmdNetexec.Flags().StringVar(&certFile, "tls-cert-file", "",
"File containing an x509 certificate for HTTPS. (CA cert, if any, concatenated after server cert)")
CmdNetexec.Flags().StringVar(&privKeyFile, "tls-private-key-file", "",
"File containing an x509 private key matching --tls-cert-file")
CmdNetexec.Flags().IntVar(&udpPort, "udp-port", 8081, "UDP Listen Port")
CmdNetexec.Flags().IntVar(&sctpPort, "sctp-port", -1, "SCTP Listen Port")
}
// atomicBool uses load/store operations on an int32 to simulate an atomic boolean.
type atomicBool struct {
v int32
}
// set sets the int32 to the given boolean.
func (a *atomicBool) set(value bool) {
if value {
atomic.StoreInt32(&a.v, 1)
return
}
atomic.StoreInt32(&a.v, 0)
}
// get returns true if the int32 == 1
func (a *atomicBool) get() bool {
return atomic.LoadInt32(&a.v) == 1
}
func main(cmd *cobra.Command, args []string) {
exitCh := make(chan shutdownRequest)
addRoutes(exitCh)
go startUDPServer(udpPort)
if sctpPort != -1 {
go startSCTPServer(sctpPort)
}
server := &http.Server{Addr: fmt.Sprintf(":%d", httpPort)}
if len(certFile) > 0 {
startServer(server, exitCh, func() error { return server.ListenAndServeTLS(certFile, privKeyFile) })
} else {
startServer(server, exitCh, server.ListenAndServe)
}
}
func addRoutes(exitCh chan shutdownRequest) {
http.HandleFunc("/", rootHandler)
http.HandleFunc("/clientip", clientIPHandler)
http.HandleFunc("/echo", echoHandler)
http.HandleFunc("/exit", func(w http.ResponseWriter, req *http.Request) { exitHandler(w, req, exitCh) })
http.HandleFunc("/hostname", hostnameHandler)
http.HandleFunc("/shell", shellHandler)
http.HandleFunc("/upload", uploadHandler)
http.HandleFunc("/dial", dialHandler)
http.HandleFunc("/healthz", healthzHandler)
// older handlers
http.HandleFunc("/hostName", hostNameHandler)
http.HandleFunc("/shutdown", shutdownHandler)
}
func startServer(server *http.Server, exitCh chan shutdownRequest, fn func() error) {
go func() {
re := <-exitCh
ctx, cancelFn := context.WithTimeout(context.Background(), re.timeout)
defer cancelFn()
err := server.Shutdown(ctx)
log.Printf("Graceful shutdown completed with: %v", err)
os.Exit(re.code)
}()
if err := fn(); err != nil {
if err == http.ErrServerClosed {
// wait until the goroutine calls os.Exit()
select {}
}
log.Fatal(err)
}
}
func rootHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /")
fmt.Fprintf(w, "NOW: %v", time.Now())
}
func echoHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /echo?msg=%s", r.FormValue("msg"))
fmt.Fprintf(w, "%s", r.FormValue("msg"))
}
func clientIPHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /clientip")
fmt.Fprintf(w, r.RemoteAddr)
}
type shutdownRequest struct {
code int
timeout time.Duration
}
func exitHandler(w http.ResponseWriter, r *http.Request, exitCh chan<- shutdownRequest) {
waitString := r.FormValue("wait")
timeoutString := r.FormValue("timeout")
codeString := r.FormValue("code")
log.Printf("GET /exit?code=%s&timeout=%s&wait=%s", codeString, timeoutString, waitString)
timeout, err := time.ParseDuration(timeoutString)
if err != nil && timeoutString != "" {
fmt.Fprintf(w, "argument 'timeout' must be a valid golang duration or empty, got %q\n", timeoutString)
return
}
wait, err := time.ParseDuration(waitString)
if err != nil && waitString != "" {
fmt.Fprintf(w, "argument 'wait' must be a valid golang duration or empty, got %q\n", waitString)
return
}
code, err := strconv.Atoi(codeString)
if err != nil && codeString != "" {
fmt.Fprintf(w, "argument 'code' must be an integer [0-127] or empty, got %q\n", codeString)
return
}
log.Printf("Will begin shutdown in %s, allowing %s for connections to close, then will exit with %d", wait, timeout, code)
time.Sleep(wait)
if timeout == 0 {
os.Exit(code)
}
exitCh <- shutdownRequest{code: code, timeout: timeout}
}
func hostnameHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /hostname")
fmt.Fprint(w, getHostName())
}
// healthHandler response with a 200 if the UDP server is ready. It also serves
// as a health check of the HTTP server by virtue of being a HTTP handler.
func healthzHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /healthz")
if serverReady.get() {
w.WriteHeader(200)
return
}
w.WriteHeader(http.StatusPreconditionFailed)
}
func shutdownHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /shutdown")
os.Exit(0)
}
func dialHandler(w http.ResponseWriter, r *http.Request) {
values, err := url.Parse(r.URL.RequestURI())
if err != nil {
http.Error(w, fmt.Sprintf("%v", err), http.StatusBadRequest)
return
}
host := values.Query().Get("host")
port := values.Query().Get("port")
request := values.Query().Get("request") // hostName
protocol := values.Query().Get("protocol")
tryParam := values.Query().Get("tries")
log.Printf("GET /dial?host=%s&protocol=%s&port=%s&request=%s&tries=%s", host, protocol, port, request, tryParam)
tries := 1
if len(tryParam) > 0 {
tries, err = strconv.Atoi(tryParam)
}
if err != nil {
http.Error(w, fmt.Sprintf("tries parameter is invalid. %v", err), http.StatusBadRequest)
return
}
if len(request) == 0 {
http.Error(w, fmt.Sprintf("request parameter not specified. %v", err), http.StatusBadRequest)
return
}
hostPort := net.JoinHostPort(host, port)
var addr net.Addr
var dialer func(string, net.Addr) (string, error)
switch strings.ToLower(protocol) {
case "", "http":
protocol = "http"
dialer = dialHTTP
addr, err = net.ResolveTCPAddr("tcp", hostPort)
case "udp":
protocol = "udp"
dialer = dialUDP
addr, err = net.ResolveUDPAddr("udp", hostPort)
case "sctp":
protocol = "sctp"
dialer = dialSCTP
addr, err = sctp.ResolveSCTPAddr("sctp", hostPort)
default:
http.Error(w, fmt.Sprintf("unsupported protocol. %s", protocol), http.StatusBadRequest)
return
}
if err != nil {
http.Error(w, fmt.Sprintf("host and/or port param are invalid. %v", err), http.StatusBadRequest)
return
}
errors := make([]string, 0)
responses := make([]string, 0)
var response string
for i := 0; i < tries; i++ {
response, err = dialer(request, addr)
if err != nil {
errors = append(errors, fmt.Sprintf("%v", err))
} else {
responses = append(responses, response)
}
}
output := map[string][]string{}
if len(response) > 0 {
output["responses"] = responses
}
if len(errors) > 0 {
output["errors"] = errors
}
bytes, err := json.Marshal(output)
if err == nil {
fmt.Fprint(w, string(bytes))
} else {
http.Error(w, fmt.Sprintf("response could not be serialized. %v", err), http.StatusExpectationFailed)
}
}
func dialHTTP(request string, addr net.Addr) (string, error) {
transport := utilnet.SetTransportDefaults(&http.Transport{})
httpClient := createHTTPClient(transport)
resp, err := httpClient.Get(fmt.Sprintf("http://%s/%s", addr.String(), request))
defer transport.CloseIdleConnections()
if err == nil {
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err == nil {
return string(body), nil
}
}
return "", err
}
func createHTTPClient(transport *http.Transport) *http.Client {
client := &http.Client{
Transport: transport,
Timeout: 5 * time.Second,
}
return client
}
func dialUDP(request string, addr net.Addr) (string, error) {
Conn, err := net.DialUDP("udp", nil, addr.(*net.UDPAddr))
if err != nil {
return "", fmt.Errorf("udp dial failed. err:%v", err)
}
defer Conn.Close()
buf := []byte(request)
_, err = Conn.Write(buf)
if err != nil {
return "", fmt.Errorf("udp connection write failed. err:%v", err)
}
udpResponse := make([]byte, 2048)
Conn.SetReadDeadline(time.Now().Add(5 * time.Second))
count, err := Conn.Read(udpResponse)
if err != nil || count == 0 {
return "", fmt.Errorf("reading from udp connection failed. err:'%v'", err)
}
return string(udpResponse[0:count]), nil
}
func dialSCTP(request string, addr net.Addr) (string, error) {
Conn, err := sctp.DialSCTP("sctp", nil, addr.(*sctp.SCTPAddr))
if err != nil {
return "", fmt.Errorf("sctp dial failed. err:%v", err)
}
defer Conn.Close()
buf := []byte(request)
_, err = Conn.Write(buf)
if err != nil {
return "", fmt.Errorf("sctp connection write failed. err:%v", err)
}
sctpResponse := make([]byte, 1024)
Conn.SetReadDeadline(time.Now().Add(5 * time.Second))
count, err := Conn.Read(sctpResponse)
if err != nil || count == 0 {
return "", fmt.Errorf("reading from sctp connection failed. err:'%v'", err)
}
return string(sctpResponse[0:count]), nil
}
func shellHandler(w http.ResponseWriter, r *http.Request) {
cmd := r.FormValue("shellCommand")
if cmd == "" {
cmd = r.FormValue("cmd")
}
log.Printf("GET /shell?cmd=%s", cmd)
cmdOut, err := exec.Command(shellPath, "-c", cmd).CombinedOutput()
output := map[string]string{}
if len(cmdOut) > 0 {
output["output"] = string(cmdOut)
}
if err != nil {
output["error"] = fmt.Sprintf("%v", err)
}
log.Printf("Output: %s", output)
bytes, err := json.Marshal(output)
if err == nil {
fmt.Fprint(w, string(bytes))
} else {
http.Error(w, fmt.Sprintf("response could not be serialized. %v", err), http.StatusExpectationFailed)
}
}
func uploadHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /upload")
result := map[string]string{}
file, _, err := r.FormFile("file")
if err != nil {
result["error"] = "Unable to upload file."
bytes, err := json.Marshal(result)
if err == nil {
fmt.Fprint(w, string(bytes))
} else {
http.Error(w, fmt.Sprintf("%s. Also unable to serialize output. %v", result["error"], err), http.StatusInternalServerError)
}
log.Printf("Unable to upload file: %s", err)
return
}
defer file.Close()
f, err := ioutil.TempFile("/uploads", "upload")
if err != nil {
result["error"] = "Unable to open file for write"
bytes, err := json.Marshal(result)
if err == nil {
fmt.Fprint(w, string(bytes))
} else {
http.Error(w, fmt.Sprintf("%s. Also unable to serialize output. %v", result["error"], err), http.StatusInternalServerError)
}
log.Printf("Unable to open file for write: %s", err)
return
}
defer f.Close()
if _, err = io.Copy(f, file); err != nil {
result["error"] = "Unable to write file."
bytes, err := json.Marshal(result)
if err == nil {
fmt.Fprint(w, string(bytes))
} else {
http.Error(w, fmt.Sprintf("%s. Also unable to serialize output. %v", result["error"], err), http.StatusInternalServerError)
}
log.Printf("Unable to write file: %s", err)
return
}
UploadFile := f.Name()
if err := os.Chmod(UploadFile, 0700); err != nil {
result["error"] = "Unable to chmod file."
bytes, err := json.Marshal(result)
if err == nil {
fmt.Fprint(w, string(bytes))
} else {
http.Error(w, fmt.Sprintf("%s. Also unable to serialize output. %v", result["error"], err), http.StatusInternalServerError)
}
log.Printf("Unable to chmod file: %s", err)
return
}
log.Printf("Wrote upload to %s", UploadFile)
result["output"] = UploadFile
w.WriteHeader(http.StatusCreated)
bytes, err := json.Marshal(result)
if err != nil {
http.Error(w, fmt.Sprintf("%s. Also unable to serialize output. %v", result["error"], err), http.StatusInternalServerError)
return
}
fmt.Fprint(w, string(bytes))
}
func hostNameHandler(w http.ResponseWriter, r *http.Request) {
log.Printf("GET /hostName")
fmt.Fprint(w, getHostName())
}
// udp server supports the hostName, echo and clientIP commands.
func startUDPServer(udpPort int) {
serverAddress, err := net.ResolveUDPAddr("udp", fmt.Sprintf(":%d", udpPort))
assertNoError(err, fmt.Sprintf("failed to resolve UDP address for port %d", sctpPort))
serverConn, err := net.ListenUDP("udp", serverAddress)
assertNoError(err, fmt.Sprintf("failed to create listener for UDP address %v", serverAddress))
defer serverConn.Close()
buf := make([]byte, 2048)
log.Printf("Started UDP server")
// Start responding to readiness probes.
serverReady.set(true)
defer func() {
log.Printf("UDP server exited")
serverReady.set(false)
}()
for {
n, clientAddress, err := serverConn.ReadFromUDP(buf)
assertNoError(err, fmt.Sprintf("failed accepting UDP connections"))
receivedText := strings.ToLower(strings.TrimSpace(string(buf[0:n])))
if receivedText == "hostname" {
log.Println("Sending udp hostName response")
_, err = serverConn.WriteToUDP([]byte(getHostName()), clientAddress)
assertNoError(err, fmt.Sprintf("failed to write hostname to UDP client %s", clientAddress))
} else if strings.HasPrefix(receivedText, "echo ") {
parts := strings.SplitN(receivedText, " ", 2)
resp := ""
if len(parts) == 2 {
resp = parts[1]
}
log.Printf("Echoing %v to UDP client %s\n", resp, clientAddress)
_, err = serverConn.WriteToUDP([]byte(resp), clientAddress)
assertNoError(err, fmt.Sprintf("failed to echo to UDP client %s", clientAddress))
} else if receivedText == "clientip" {
log.Printf("Sending clientip back to UDP client %s\n", clientAddress)
_, err = serverConn.WriteToUDP([]byte(clientAddress.String()), clientAddress)
assertNoError(err, fmt.Sprintf("failed to write clientip to UDP client %s", clientAddress))
} else if len(receivedText) > 0 {
log.Printf("Unknown UDP command received from %s: %v\n", clientAddress, receivedText)
}
}
}
// sctp server supports the hostName, echo and clientIP commands.
func startSCTPServer(sctpPort int) {
serverAddress, err := sctp.ResolveSCTPAddr("sctp", fmt.Sprintf(":%d", sctpPort))
assertNoError(err, fmt.Sprintf("failed to resolve SCTP address for port %d", sctpPort))
listener, err := sctp.ListenSCTP("sctp", serverAddress)
assertNoError(err, fmt.Sprintf("failed to create listener for SCTP address %v", serverAddress))
defer listener.Close()
buf := make([]byte, 1024)
log.Printf("Started SCTP server")
// Start responding to readiness probes.
serverReady.set(true)
defer func() {
log.Printf("SCTP server exited")
serverReady.set(false)
}()
for {
conn, err := listener.AcceptSCTP()
assertNoError(err, fmt.Sprintf("failed accepting SCTP connections"))
clientAddress := conn.RemoteAddr().String()
n, err := conn.Read(buf)
assertNoError(err, fmt.Sprintf("failed to read from SCTP client %s", clientAddress))
receivedText := strings.ToLower(strings.TrimSpace(string(buf[0:n])))
if receivedText == "hostname" {
log.Println("Sending SCTP hostName response")
_, err = conn.Write([]byte(getHostName()))
assertNoError(err, fmt.Sprintf("failed to write hostname to SCTP client %s", clientAddress))
} else if strings.HasPrefix(receivedText, "echo ") {
parts := strings.SplitN(receivedText, " ", 2)
resp := ""
if len(parts) == 2 {
resp = parts[1]
}
log.Printf("Echoing %v to SCTP client %s\n", resp, clientAddress)
_, err = conn.Write([]byte(resp))
assertNoError(err, fmt.Sprintf("failed to echo to SCTP client %s", clientAddress))
} else if receivedText == "clientip" {
log.Printf("Sending clientip back to SCTP client %s\n", clientAddress)
_, err = conn.Write([]byte(clientAddress))
assertNoError(err, fmt.Sprintf("failed to write clientip to SCTP client %s", clientAddress))
} else if len(receivedText) > 0 {
log.Printf("Unknown SCTP command received from %s: %v\n", clientAddress, receivedText)
}
conn.Close()
}
}
func getHostName() string {
hostName, err := os.Hostname()
assertNoError(err, "failed to get hostname")
return hostName
}
func assertNoError(err error, detail string) {
if err != nil {
log.Fatalf("Error occurred: %s:%v", detail, err)
}
}