Skip to content

Modern Docker Management, Designed for Everyone

fix: allow mtls when tls is not managed by arcane (#2503)

Kyle Mendella80bc62c74e8
diff --git a/backend/internal/bootstrap/bootstrap.go b/backend/internal/bootstrap/bootstrap.go
index de5ad968d..fbdb26856 100644
--- a/backend/internal/bootstrap/bootstrap.go
+++ b/backend/internal/bootstrap/bootstrap.go
@@ -400,7 +400,7 @@ func prepareServerTLSInternal(ctx context.Context, cfg *config.Config) (bool, st
}
if edge.NormalizeEdgeMTLSMode(cfg.EdgeMTLSMode) != edge.EdgeMTLSModeDisabled {
- if err := edge.ValidateManagerMTLSConfig(edgeCfg, useTLS); err != nil {
+ if err := edge.ValidateManagerMTLSConfig(edgeCfg); err != nil {
return false, "", "", nil, err
}
}
diff --git a/backend/internal/bootstrap/bootstrap_test.go b/backend/internal/bootstrap/bootstrap_test.go
index 4f02b8ff8..d82d7ceb2 100644
--- a/backend/internal/bootstrap/bootstrap_test.go
+++ b/backend/internal/bootstrap/bootstrap_test.go
@@ -4,9 +4,11 @@ import (
"context"
"net/http"
"net/http/httptest"
+ "os"
"testing"
"github.com/getarcaneapp/arcane/backend/internal/config"
+ libcrypto "github.com/getarcaneapp/arcane/backend/pkg/libarcane/crypto"
tunnelpb "github.com/getarcaneapp/arcane/backend/pkg/libarcane/edge/proto/tunnel/v1"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
@@ -133,3 +135,30 @@ func TestPrepareServerTLSInternal_AgentModeSkipsManagerMTLSValidation(t *testing
require.NotNil(t, edgeCfg)
assert.Equal(t, "required", edgeCfg.EdgeMTLSMode)
}
+
+func TestPrepareServerTLSInternal_AllowsExternalMTLSTermination(t *testing.T) {
+ libcrypto.InitEncryption(&libcrypto.Config{
+ EncryptionKey: "test-encryption-key-for-edge-mtls-32bytes-min",
+ Environment: "test",
+ })
+
+ assetsDir := t.TempDir()
+ cfg := &config.Config{
+ TLSEnabled: false,
+ EdgeMTLSMode: "required",
+ EdgeMTLSAssetsDir: assetsDir,
+ EncryptionKey: "test-encryption-key-for-edge-mtls-32bytes-min",
+ }
+
+ useTLS, tlsCertFile, tlsKeyFile, edgeCfg, err := prepareServerTLSInternal(context.Background(), cfg)
+ require.NoError(t, err)
+ assert.False(t, useTLS)
+ assert.Empty(t, tlsCertFile)
+ assert.Empty(t, tlsKeyFile)
+ require.NotNil(t, edgeCfg)
+ assert.Equal(t, "required", edgeCfg.EdgeMTLSMode)
+ require.FileExists(t, edgeCfg.EdgeMTLSCAFile)
+ require.FileExists(t, assetsDir+"/ca.crt")
+ _, statErr := os.Stat(assetsDir + "/ca.key")
+ require.NoError(t, statErr)
+}
diff --git a/backend/pkg/libarcane/edge/server.go b/backend/pkg/libarcane/edge/server.go
index 203847cdd..5895686db 100644
--- a/backend/pkg/libarcane/edge/server.go
+++ b/backend/pkg/libarcane/edge/server.go
@@ -672,7 +672,7 @@ func (s *TunnelServer) requireClientCertificateInternal(req *http.Request) error
if NormalizeEdgeMTLSMode(s.edgeMTLSModeInternal()) != EdgeMTLSModeRequired {
return nil
}
- if hasVerifiedPeerCertificateInternal(req.TLS) {
+ if req != nil && req.TLS != nil && hasVerifiedPeerCertificateInternal(req.TLS) {
return nil
}
return errors.New("verified client certificate required")
@@ -684,11 +684,10 @@ func (s *TunnelServer) requireClientCertificateFromContextInternal(ctx context.C
}
p, ok := peer.FromContext(ctx)
- if !ok {
- return errors.New("verified client certificate required")
- }
- if tlsInfo, ok := p.AuthInfo.(credentials.TLSInfo); ok && hasVerifiedPeerCertificateInternal(&tlsInfo.State) {
- return nil
+ if ok {
+ if tlsInfo, ok := p.AuthInfo.(credentials.TLSInfo); ok && hasVerifiedPeerCertificateInternal(&tlsInfo.State) {
+ return nil
+ }
}
return errors.New("verified client certificate required")
}
diff --git a/backend/pkg/libarcane/edge/tls.go b/backend/pkg/libarcane/edge/tls.go
index 3509b5693..2984e77ae 100644
--- a/backend/pkg/libarcane/edge/tls.go
+++ b/backend/pkg/libarcane/edge/tls.go
@@ -454,7 +454,7 @@ func ValidateAgentMTLSConfig(cfg *Config) error {
// ValidateManagerMTLSConfig validates the manager-side mTLS configuration used
// by edge tunnel endpoints.
-func ValidateManagerMTLSConfig(cfg *Config, managerTLSEnabled bool) error {
+func ValidateManagerMTLSConfig(cfg *Config) error {
if cfg == nil {
return nil
}
@@ -463,9 +463,6 @@ func ValidateManagerMTLSConfig(cfg *Config, managerTLSEnabled bool) error {
if mode == EdgeMTLSModeDisabled {
return nil
}
- if !managerTLSEnabled {
- return fmt.Errorf("EDGE_MTLS_MODE requires TLS_ENABLED=true on the manager")
- }
if strings.TrimSpace(cfg.EdgeMTLSCAFile) == "" {
return fmt.Errorf("EDGE_MTLS_MODE=%s requires EDGE_MTLS_CA_FILE on the manager", mode)
diff --git a/backend/pkg/libarcane/edge/tls_test.go b/backend/pkg/libarcane/edge/tls_test.go
index 869bb4ef6..08728fbd7 100644
--- a/backend/pkg/libarcane/edge/tls_test.go
+++ b/backend/pkg/libarcane/edge/tls_test.go
@@ -22,8 +22,14 @@ import (
"github.com/getarcaneapp/arcane/backend/internal/common"
libcrypto "github.com/getarcaneapp/arcane/backend/pkg/libarcane/crypto"
"github.com/stretchr/testify/require"
+ "google.golang.org/grpc/credentials"
+ "google.golang.org/grpc/peer"
)
+type testAuthInfo struct{}
+
+func (testAuthInfo) AuthType() string { return "test" }
+
func TestMain(m *testing.M) {
libcrypto.InitEncryption(&libcrypto.Config{
EncryptionKey: "test-encryption-key-for-edge-mtls-32bytes-min",
@@ -274,6 +280,76 @@ func TestTunnelServerRequireCertificateIdentityInternal_RejectsWrongEnvironmentU
require.Error(t, server.requireCertificateIdentityInternal(state, "env-b"))
}
+func TestValidateManagerMTLSConfig_DoesNotRequireArcaneTLSTermination(t *testing.T) {
+ assetsDir := t.TempDir()
+ caPath, _, _, err := ensureManagerCAInternal(context.Background(), assetsDir)
+ require.NoError(t, err)
+
+ err = ValidateManagerMTLSConfig(&Config{
+ EdgeMTLSMode: EdgeMTLSModeRequired,
+ EdgeMTLSCAFile: caPath,
+ })
+ require.NoError(t, err)
+}
+
+func TestValidateManagerMTLSConfig_RejectsMissingOrMalformedCAFile(t *testing.T) {
+ t.Run("missing file", func(t *testing.T) {
+ err := ValidateManagerMTLSConfig(&Config{
+ EdgeMTLSMode: EdgeMTLSModeRequired,
+ EdgeMTLSCAFile: filepath.Join(t.TempDir(), "missing-ca.crt"),
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "failed to load edge mTLS CA file")
+ })
+
+ t.Run("malformed file", func(t *testing.T) {
+ caPath := filepath.Join(t.TempDir(), "ca.crt")
+ require.NoError(t, os.WriteFile(caPath, []byte("not a pem"), 0o600))
+
+ err := ValidateManagerMTLSConfig(&Config{
+ EdgeMTLSMode: EdgeMTLSModeRequired,
+ EdgeMTLSCAFile: caPath,
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "failed to load edge mTLS CA file")
+ })
+}
+
+func TestTunnelServerRequiredMTLS_RejectsRequestWithoutTLSState(t *testing.T) {
+ server := NewTunnelServer(nil, nil)
+ server.SetConfig(&Config{
+ EdgeMTLSMode: EdgeMTLSModeRequired,
+ AppURL: "https://manager.example.com",
+ })
+
+ req := httptest.NewRequest(http.MethodGet, "/api/tunnel/connect", nil)
+ require.ErrorContains(t, server.requireClientCertificateInternal(req), "verified client certificate required")
+ require.NoError(t, server.requireCertificateIdentityInternal(nil, "env-a"))
+}
+
+func TestTunnelServerRequiredMTLS_RejectsGRPCContextsWithoutVerifiedPeerCertificate(t *testing.T) {
+ server := NewTunnelServer(nil, nil)
+ server.SetConfig(&Config{EdgeMTLSMode: EdgeMTLSModeRequired})
+
+ t.Run("missing peer", func(t *testing.T) {
+ require.ErrorContains(t, server.requireClientCertificateFromContextInternal(context.Background()), "verified client certificate required")
+ })
+
+ t.Run("non tls peer", func(t *testing.T) {
+ ctx := peer.NewContext(context.Background(), &peer.Peer{AuthInfo: testAuthInfo{}})
+ require.ErrorContains(t, server.requireClientCertificateFromContextInternal(ctx), "verified client certificate required")
+ })
+
+ t.Run("verified tls peer", func(t *testing.T) {
+ cert := &x509.Certificate{}
+ ctx := peer.NewContext(context.Background(), &peer.Peer{AuthInfo: credentials.TLSInfo{State: tls.ConnectionState{
+ PeerCertificates: []*x509.Certificate{cert},
+ VerifiedChains: [][]*x509.Certificate{{cert}},
+ }}})
+ require.NoError(t, server.requireClientCertificateFromContextInternal(ctx))
+ })
+}
+
func TestAgentMTLSAssetsNeedEnrollmentInternal_RenewsExpiredCertificate(t *testing.T) {
assetsDir := t.TempDir()
assets, err := GenerateManagerClientMTLSAssetsWithContext(context.Background(), &Config{
diff --git a/backend/pkg/libarcane/edge/transport.go b/backend/pkg/libarcane/edge/transport.go
index b4103ff52..e5fac62c6 100644
--- a/backend/pkg/libarcane/edge/transport.go
+++ b/backend/pkg/libarcane/edge/transport.go
@@ -92,7 +92,8 @@ const (
EdgeMTLSModeDisabled = "disabled"
// EdgeMTLSModeOptional enables edge tunnel mTLS when certificates are configured.
EdgeMTLSModeOptional = "optional"
- // EdgeMTLSModeRequired requires a verified client certificate on edge tunnel endpoints.
+ // EdgeMTLSModeRequired requires a verified client certificate on edge tunnel endpoints
+ // when Arcane terminates TLS; external TLS terminators must enforce mTLS before proxying.
EdgeMTLSModeRequired = "required"
)