Make stream keys objects with comment instead of string slice

config/defaults.go

@@ -21,7 +21,7 @@ type Defaults struct {
 	WebServerIP      string
 	RTMPServerPort   int
 	AdminPassword    string
-	StreamKeys       []string
+	StreamKeys       []models.StreamKey
 
 	YPEnabled bool
 	YPServer  string
@@ -44,7 +44,9 @@ func GetDefaults() Defaults {
 		ServerWelcomeMessage: "",
 		Logo:                 "logo.svg",
 		AdminPassword:        "abc123",
-		StreamKeys:           []string{"abc123"},
+		StreamKeys: []models.StreamKey{
+			{Key: "abc123", Comment: "Default stream key"},
+		},
 		Tags: []string{
 			"owncast",
 			"streaming",

controllers/admin/config.go

@@ -796,17 +796,18 @@ func SetStreamKeys(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	configValues, success := getValuesFromRequest(w, r)
-	if !success {
+	type streamKeysRequest struct {
+		Value []models.StreamKey `json:"value"`
+	}
+
+	decoder := json.NewDecoder(r.Body)
+	var streamKeys streamKeysRequest
+	if err := decoder.Decode(&streamKeys); err != nil {
+		controllers.WriteSimpleResponse(w, false, "unable to update stream keys with provided values")
 		return
 	}
 
-	streamKeyStrings := make([]string, 0)
-	for _, key := range configValues {
-		streamKeyStrings = append(streamKeyStrings, key.Value.(string))
-	}
-
-	if err := data.SetStreamKeys(streamKeyStrings); err != nil {
+	if err := data.SetStreamKeys(streamKeys.Value); err != nil {
 		controllers.WriteSimpleResponse(w, false, err.Error())
 		return
 	}

controllers/admin/serverConfig.go

@@ -100,7 +100,7 @@ type serverConfigAdminResponse struct {
 	InstanceDetails         webConfigResponse           `json:"instanceDetails"`
 	FFmpegPath              string                      `json:"ffmpegPath"`
 	AdminPassword           string                      `json:"adminPassword"`
-	StreamKeys              []string                    `json:"streamKeys"`
+	StreamKeys              []models.StreamKey          `json:"streamKeys"`
 	WebServerPort           int                         `json:"webServerPort"`
 	WebServerIP             string                      `json:"webServerIP"`
 	RTMPServerPort          int                         `json:"rtmpServerPort"`

core/data/config.go

@@ -946,12 +946,22 @@ func GetCustomColorVariableValues() map[string]string {
 }
 
 // GetStreamKeys will return valid stream keys.
-func GetStreamKeys() []string {
-	keys, _ := _datastore.GetStringSlice(streamKeysKey)
-	return keys
+func GetStreamKeys() []models.StreamKey {
+	configEntry, err := _datastore.Get(streamKeysKey)
+	if err != nil {
+		return []models.StreamKey{}
+	}
+
+	var streamKeys []models.StreamKey
+	if err := configEntry.getObject(&streamKeys); err != nil {
+		return []models.StreamKey{}
+	}
+
+	return streamKeys
 }
 
 // SetStreamKeys will set valid stream keys.
-func SetStreamKeys(keys []string) error {
-	return _datastore.SetStringSlice(streamKeysKey, keys)
+func SetStreamKeys(actions []models.StreamKey) error {
+	configEntry := ConfigEntry{Key: streamKeysKey, Value: actions}
+	return _datastore.Save(configEntry)
 }

core/data/datastoreMigrations.go

@@ -3,6 +3,7 @@ package data
 import (
 	"strings"
 
+	"github.com/owncast/owncast/models"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -56,5 +57,7 @@ func migrateToDatastoreValues1(datastore *Datastore) {
 func migrateToDatastoreValues2(datastore *Datastore) {
 	oldAdminPassword, _ := datastore.GetString("stream_key")
 	_ = SetAdminPassword(oldAdminPassword)
-	_ = SetStreamKeys([]string{oldAdminPassword})
+	_ = SetStreamKeys([]models.StreamKey{
+		{Key: oldAdminPassword, Comment: "Default stream key"},
+	})
 }

core/rtmp/rtmp.go

@@ -81,7 +81,7 @@ func HandleConn(c *rtmp.Conn, nc net.Conn) {
 	validStreamingKeys := data.GetStreamKeys()
 
 	for _, key := range validStreamingKeys {
-		if secretMatch(key, c.URL.Path) {
+		if secretMatch(key.Key, c.URL.Path) {
 			accessGranted = true
 			break
 		}

models/streamKey.go

@@ -0,0 +1,7 @@
+package models
+
+// StreamKey represents a single stream key
+type StreamKey struct {
+	Key     string `json:"key"`
+	Comment string `json:"comment"`
+}

test/automated/api/configmanagement.test.js

@@ -7,7 +7,11 @@ const serverSummary = randomString();
 const offlineMessage = randomString();
 const pageContent = `<p>${randomString()}</p>`;
 const tags = [randomString(), randomString(), randomString()];
-const streamKeys = [randomString(), randomString(), randomString()];
+const streamKeys = [
+	{ key: randomString(), comment: 'test key 1' },
+	{ key: randomString(), comment: 'test key 1' },
+	{ key: randomString(), comment: 'test key 1' },
+];
 
 const latencyLevel = Math.floor(Math.random() * 4);
 const appearanceValues = {