adding function for adding custom sing-box config from user (#156)

* feat: adding code for receiving user manual configuration

* feat: adding url parser

* feat: parsing config based on received vmess config

* fix: removing tag parameter since this information is coming from the URL or it already exists inside the sing-box config

* fix: using sing-box context for unmarshaling json

* feat: adding unit tests and improve error handling

* fix: checking if ss url username has the expected length

* fix: parsing vmess transport config

* fix: using function provided context

* feat: refactoring function for being specific for sing-box json format

* fix: removing parser since it's being moved to another repository

* fix: updating span name so it matches the function name

Author: WendelHime

servers/manager.go

@@ -4,6 +4,7 @@
 package servers
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"io"
@@ -19,11 +20,13 @@ import (
 	"sync"
 
 	sbx "github.com/getlantern/sing-box-extensions"
+	"go.opentelemetry.io/otel"
 
 	C "github.com/getlantern/common"
 
 	"github.com/getlantern/radiance/common"
 	"github.com/getlantern/radiance/internal"
+	"github.com/getlantern/radiance/traces"
 
 	"github.com/sagernet/sing-box/option"
 	"github.com/sagernet/sing/common/json"
@@ -36,6 +39,8 @@ const (
 	SGUser    ServerGroup = "user"
 
 	trustFingerprintFileName = "trusted_server_fingerprints.json"
+
+	tracerName = "github.com/getlantern/radiance/servers"
 )
 
 type Options struct {
@@ -447,3 +452,21 @@ func (m *Manager) getClientForTrustedFingerprint(ip string, port int, trustFinge
 	}
 	return client, nil
 }
+
+// AddServerWithSingboxJSON parse a value that can be a JSON sing-box config.
+// It parses the config into a sing-box config and add it to the user managed group.
+func (m *Manager) AddServerWithSingboxJSON(ctx context.Context, value []byte) error {
+	ctx, span := otel.Tracer(tracerName).Start(ctx, "Manager.AddServerWithSingboxJSON")
+	defer span.End()
+	var option Options
+	if err := json.UnmarshalContext(sbx.BoxContext(), value, &option); err != nil {
+		return traces.RecordError(ctx, fmt.Errorf("failed to parse config: %w", err))
+	}
+	if len(option.Endpoints) == 0 && len(option.Outbounds) == 0 {
+		return traces.RecordError(ctx, fmt.Errorf("no endpoints or outbounds found in the provided configuration"))
+	}
+	if err := m.AddServers(SGUser, option); err != nil {
+		return traces.RecordError(ctx, fmt.Errorf("failed to add servers: %w", err))
+	}
+	return nil
+}

servers/manager_test.go

@@ -1,6 +1,8 @@
 package servers
 
 import (
+	"context"
+	"encoding/json"
 	"fmt"
 	"net/http"
 	"net/http/httptest"
@@ -139,3 +141,53 @@ func (s *lanternServerManagerMock) ServeHTTP(w http.ResponseWriter, r *http.Requ
 
 	w.WriteHeader(http.StatusNotFound)
 }
+
+func TestAddServerWithSingBoxJSON(t *testing.T) {
+	dataPath := t.TempDir()
+	manager := &Manager{
+		servers: Servers{
+			SGLantern: Options{
+				Outbounds: make([]option.Outbound, 0),
+				Endpoints: make([]option.Endpoint, 0),
+				Locations: make(map[string]C.ServerLocation),
+			},
+			SGUser: Options{
+				Outbounds: make([]option.Outbound, 0),
+				Endpoints: make([]option.Endpoint, 0),
+				Locations: make(map[string]C.ServerLocation),
+			},
+		},
+		optsMaps: map[ServerGroup]map[string]any{
+			SGLantern: make(map[string]any),
+			SGUser:    make(map[string]any),
+		},
+		serversFile:      filepath.Join(dataPath, common.ServersFileName),
+		fingerprintsFile: filepath.Join(dataPath, trustFingerprintFileName),
+	}
+
+	ctx := context.Background()
+	jsonConfig := `
+	{
+		"outbounds": [
+			{
+               "type": "shadowsocks",
+               "tag": "ss-out",
+               "server": "127.0.0.1",
+               "server_port": 8388,
+               "method": "chacha20-ietf-poly1305",
+               "password": "randompasswordwith24char",
+               "network": "tcp"
+            }
+		]
+	}`
+
+	t.Run("adding server with a sing-box json config should work", func(t *testing.T) {
+		require.NoError(t, manager.AddServerWithSingboxJSON(ctx, []byte(jsonConfig)))
+	})
+	t.Run("using a empty config should return an error", func(t *testing.T) {
+		require.Error(t, manager.AddServerWithSingboxJSON(ctx, []byte{}))
+	})
+	t.Run("providing a json that doesn't have any endpoints or outbounds should return a error", func(t *testing.T) {
+		require.Error(t, manager.AddServerWithSingboxJSON(ctx, json.RawMessage("{}")))
+	})
+}