fix(swarm): fixed issue parsing url with no scheme [EE-4017] (#7502)

api/agent/version.go

@@ -5,18 +5,17 @@ import (
 	"errors"
 	"fmt"
 	"net/http"
-	netUrl "net/url"
 	"strconv"
-	"strings"
 	"time"
 
 	portainer "github.com/portainer/portainer/api"
+	"github.com/portainer/portainer/api/internal/url"
 )
 
 // GetAgentVersionAndPlatform returns the agent version and platform
 //
 // it sends a ping to the agent and parses the version and platform from the headers
-func GetAgentVersionAndPlatform(url string, tlsConfig *tls.Config) (portainer.AgentPlatform, string, error) {
+func GetAgentVersionAndPlatform(endpointUrl string, tlsConfig *tls.Config) (portainer.AgentPlatform, string, error) {
 	httpCli := &http.Client{
 		Timeout: 3 * time.Second,
 	}
@@ -27,11 +26,7 @@ func GetAgentVersionAndPlatform(url string, tlsConfig *tls.Config) (portainer.Ag
 		}
 	}
 
-	if !strings.Contains(url, "://") {
+	parsedURL, err := url.ParseURL(endpointUrl + "/ping")
-		url = "https://" + url
-	}
-
-	parsedURL, err := netUrl.Parse(fmt.Sprintf("%s/ping", url))
 	if err != nil {
 		return 0, "", err
 	}

api/http/handler/endpoints/endpoint_create.go

@@ -259,9 +259,6 @@ func (handler *Handler) createEndpoint(payload *endpointCreatePayload) (*portain
 	endpointType := portainer.DockerEnvironment
 	var agentVersion string
 	if payload.EndpointCreationType == agentEnvironment {
-
-		payload.URL = "tcp://" + normalizeAgentAddress(payload.URL)
-
 		var tlsConfig *tls.Config
 		if payload.TLS {
 			tlsConfig, err = crypto.CreateTLSConfigurationFromBytes(payload.TLSCACertFile, payload.TLSCertFile, payload.TLSKeyFile, payload.TLSSkipVerify, payload.TLSSkipClientVerify)

api/http/handler/endpoints/endpoint_update.go

@@ -105,12 +105,7 @@ func (handler *Handler) endpointUpdate(w http.ResponseWriter, r *http.Request) *
 	}
 
 	if payload.URL != nil {
-		if endpoint.Type == portainer.AgentOnDockerEnvironment ||
+		endpoint.URL = *payload.URL
-			endpoint.Type == portainer.AgentOnKubernetesEnvironment {
-			endpoint.URL = normalizeAgentAddress(*payload.URL)
-		} else {
-			endpoint.URL = *payload.URL
-		}
 	}
 
 	if payload.PublicURL != nil {

api/http/handler/endpoints/utils.go

@@ -1,18 +1,6 @@
 package endpoints
 
-import "strings"
-
 func BoolAddr(b bool) *bool {
 	boolVar := b
 	return &boolVar
 }
-
-func normalizeAgentAddress(url string) string {
-	// Case insensitive strip http or https scheme if URL entered
-	index := strings.Index(url, "://")
-	if index >= 0 {
-		return url[index+3:]
-	}
-
-	return url
-}

api/http/proxy/factory/agent.go

@@ -5,14 +5,13 @@ import (
 	"log"
 	"net"
 	"net/http"
-	"net/url"
-	"strings"
 
 	"github.com/pkg/errors"
 	portainer "github.com/portainer/portainer/api"
 	"github.com/portainer/portainer/api/crypto"
 	"github.com/portainer/portainer/api/http/proxy/factory/agent"
 	"github.com/portainer/portainer/api/internal/endpointutils"
+	"github.com/portainer/portainer/api/internal/url"
 )
 
 // ProxyServer provide an extended proxy with a local server to forward requests
@@ -34,7 +33,7 @@ func (factory *ProxyFactory) NewAgentProxy(endpoint *portainer.Endpoint) (*Proxy
 		urlString = fmt.Sprintf("http://127.0.0.1:%d", tunnel.Port)
 	}
 
-	endpointURL, err := parseURL(urlString)
+	endpointURL, err := url.ParseURL(urlString)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed parsing url %s", endpoint.URL)
 	}
@@ -99,15 +98,3 @@ func (proxy *ProxyServer) Close() {
 		proxy.server.Close()
 	}
 }
-
-// parseURL parses the endpointURL using url.Parse.
-//
-// to prevent an error when url has port but no protocol prefix
-// we add `//` prefix if needed
-func parseURL(endpointURL string) (*url.URL, error) {
-	if !strings.HasPrefix(endpointURL, "http") && !strings.HasPrefix(endpointURL, "tcp") && !strings.HasPrefix(endpointURL, "//") {
-		endpointURL = fmt.Sprintf("//%s", endpointURL)
-	}
-
-	return url.Parse(endpointURL)
-}

api/http/proxy/factory/docker.go

@@ -5,13 +5,13 @@ import (
 	"io"
 	"log"
 	"net/http"
-	"net/url"
 	"strings"
 
 	httperror "github.com/portainer/libhttp/error"
 	portainer "github.com/portainer/portainer/api"
 	"github.com/portainer/portainer/api/crypto"
 	"github.com/portainer/portainer/api/http/proxy/factory/docker"
+	"github.com/portainer/portainer/api/internal/url"
 )
 
 func (factory *ProxyFactory) newDockerProxy(endpoint *portainer.Endpoint) (http.Handler, error) {
@@ -23,7 +23,7 @@ func (factory *ProxyFactory) newDockerProxy(endpoint *portainer.Endpoint) (http.
 }
 
 func (factory *ProxyFactory) newDockerLocalProxy(endpoint *portainer.Endpoint) (http.Handler, error) {
-	endpointURL, err := url.Parse(endpoint.URL)
+	endpointURL, err := url.ParseURL(endpoint.URL)
 	if err != nil {
 		return nil, err
 	}
@@ -38,7 +38,7 @@ func (factory *ProxyFactory) newDockerHTTPProxy(endpoint *portainer.Endpoint) (h
 		rawURL = fmt.Sprintf("http://127.0.0.1:%d", tunnel.Port)
 	}
 
-	endpointURL, err := url.Parse(rawURL)
+	endpointURL, err := url.ParseURL(rawURL)
 	if err != nil {
 		return nil, err
 	}

api/internal/url/url.go

@@ -0,0 +1,19 @@
+package url
+
+import (
+	"fmt"
+	"net/url"
+	"strings"
+)
+
+// ParseURL parses the endpointURL using url.Parse.
+//
+// to prevent an error when url has port but no protocol prefix
+// we add `//` prefix if needed
+func ParseURL(endpointURL string) (*url.URL, error) {
+	if !strings.HasPrefix(endpointURL, "http") && !strings.HasPrefix(endpointURL, "tcp") && !strings.HasPrefix(endpointURL, "//") {
+		endpointURL = fmt.Sprintf("//%s", endpointURL)
+	}
+
+	return url.Parse(endpointURL)
+}

app/portainer/environments/environment.service/create.ts

@@ -130,7 +130,7 @@ export async function createRemoteEnvironment({
 }: CreateRemoteEnvironment) {
   return createEnvironment(name, creationType, {
     ...options,
-    url: `${url}`,
+    url: `tcp://${url}`,
   });
 }
 

app/portainer/views/endpoints/edit/endpoint.html

@@ -110,9 +110,11 @@
               <span ng-if="!state.agentEndpoint">Environment URL</span>
               <span ng-if="state.agentEndpoint">Environment address</span>
               <portainer-tooltip
+                ng-if="!state.agentEndpoint"
                 message="'URL or IP address of a Docker host. The Docker API must be exposed over a TCP port. Please refer to the Docker documentation to configure it.'"
               >
               </portainer-tooltip>
+              <portainer-tooltip ng-if="state.agentEndpoint" message="'The address for the Portainer agent in the format <HOST>:<PORT> or <IP>:<PORT>'"> </portainer-tooltip>
             </label>
             <div class="col-sm-9 col-lg-10">
               <input

app/react/portainer/environments/wizard/EnvironmentsCreationView/shared/AgentForm/AgentForm.validation.tsx

@@ -9,8 +9,42 @@ import { nameValidation } from '../NameField';
 export function validation(): SchemaOf<CreateAgentEnvironmentValues> {
   return object({
     name: nameValidation(),
-    environmentUrl: string().required('This field is required.'),
+    environmentUrl: environmentValidation(),
     meta: metadataValidation(),
     gpus: gpusListValidation(),
   });
 }
+
+function environmentValidation() {
+  return string()
+    .required('This field is required')
+    .test(
+      'address',
+      'Environment address must be of the form <IP>:<PORT> or <HOST>:<PORT>.',
+      (environmentUrl) => validateAddress(environmentUrl)
+    );
+}
+
+export function validateAddress(address: string | undefined) {
+  if (typeof address === 'undefined') {
+    return false;
+  }
+
+  if (address.indexOf('://') > -1) {
+    return false;
+  }
+
+  const [host, port] = address.split(':');
+
+  if (
+    host.length === 0 ||
+    Number.isNaN(parseInt(port, 10)) ||
+    port.match(/^[0-9]+$/) == null ||
+    parseInt(port, 10) < 1 ||
+    parseInt(port, 10) > 65535
+  ) {
+    return false;
+  }
+
+  return true;
+}

app/react/portainer/environments/wizard/EnvironmentsCreationView/shared/AgentForm/EnvironmentUrlField.tsx

@@ -12,7 +12,7 @@ export function EnvironmentUrlField() {
       errors={meta.error}
       required
       inputId="environment-url-field"
-      tooltip="A host:port combination. The host can be either an IP address or a host name."
+      tooltip="<HOST>:<PORT> or <IP>:<PORT>"
     >
       <Field
         id="environment-url-field"