This is an automated message from %s. If you did not request this message please ignore or block. Your requested one-time code is:
%s
", data.GetServerName(), reg.Code) + msg := fmt.Sprintf("One-time code from %s: %s. If you did not request this message please ignore or block.
", data.GetServerName(), reg.Code) if err := activitypub.SendDirectFederatedMessage(msg, reg.Account); err != nil { controllers.WriteSimpleResponse(w, false, "Could not send code to fediverse: "+err.Error()) return diff --git a/controllers/auth/indieauth/server.go b/controllers/auth/indieauth/server.go index 92cb4562f..68078e8de 100644 --- a/controllers/auth/indieauth/server.go +++ b/controllers/auth/indieauth/server.go @@ -13,18 +13,18 @@ import ( func HandleAuthEndpoint(w http.ResponseWriter, r *http.Request) { if r.Method == http.MethodGet { // Require the GET request for IndieAuth to be behind admin login. - f := middleware.RequireAdminAuth(handleAuthEndpointGet) + f := middleware.RequireAdminAuth(HandleAuthEndpointGet) f(w, r) return } else if r.Method == http.MethodPost { - handleAuthEndpointPost(w, r) + HandleAuthEndpointPost(w, r) } else { w.WriteHeader(http.StatusMethodNotAllowed) return } } -func handleAuthEndpointGet(w http.ResponseWriter, r *http.Request) { +func HandleAuthEndpointGet(w http.ResponseWriter, r *http.Request) { clientID := r.URL.Query().Get("client_id") redirectURI := r.URL.Query().Get("redirect_uri") codeChallenge := r.URL.Query().Get("code_challenge") @@ -57,7 +57,7 @@ func handleAuthEndpointGet(w http.ResponseWriter, r *http.Request) { http.Redirect(w, r, u.String(), http.StatusTemporaryRedirect) } -func handleAuthEndpointPost(w http.ResponseWriter, r *http.Request) { +func HandleAuthEndpointPost(w http.ResponseWriter, r *http.Request) { if err := r.ParseForm(); err != nil { controllers.WriteSimpleResponse(w, false, err.Error()) return diff --git a/controllers/config.go b/controllers/config.go index ceec87692..a8ea9f599 100644 --- a/controllers/config.go +++ b/controllers/config.go @@ -16,26 +16,27 @@ import ( ) type webConfigResponse struct { - AppearanceVariables map[string]string `json:"appearanceVariables"` - Name string `json:"name"` - CustomStyles string `json:"customStyles"` - StreamTitle string `json:"streamTitle,omitempty"` // What's going on with the current stream - OfflineMessage string `json:"offlineMessage"` - Logo string `json:"logo"` - Version string `json:"version"` - SocketHostOverride string `json:"socketHostOverride,omitempty"` - ExtraPageContent string `json:"extraPageContent"` - Summary string `json:"summary"` - Tags []string `json:"tags"` - SocialHandles []models.SocialHandle `json:"socialHandles"` - ExternalActions []models.ExternalAction `json:"externalActions"` - Notifications notificationsConfigResponse `json:"notifications"` - Federation federationConfigResponse `json:"federation"` - MaxSocketPayloadSize int `json:"maxSocketPayloadSize"` - HideViewerCount bool `json:"hideViewerCount"` - ChatDisabled bool `json:"chatDisabled"` - NSFW bool `json:"nsfw"` - Authentication authenticationConfigResponse `json:"authentication"` + AppearanceVariables map[string]string `json:"appearanceVariables"` + Name string `json:"name"` + CustomStyles string `json:"customStyles"` + StreamTitle string `json:"streamTitle,omitempty"` // What's going on with the current stream + OfflineMessage string `json:"offlineMessage"` + Logo string `json:"logo"` + Version string `json:"version"` + SocketHostOverride string `json:"socketHostOverride,omitempty"` + ExtraPageContent string `json:"extraPageContent"` + Summary string `json:"summary"` + Tags []string `json:"tags"` + SocialHandles []models.SocialHandle `json:"socialHandles"` + ExternalActions []models.ExternalAction `json:"externalActions"` + Notifications notificationsConfigResponse `json:"notifications"` + Federation federationConfigResponse `json:"federation"` + MaxSocketPayloadSize int `json:"maxSocketPayloadSize"` + HideViewerCount bool `json:"hideViewerCount"` + ChatDisabled bool `json:"chatDisabled"` + ChatSpamProtectionDisabled bool `json:"chatSpamProtectionDisabled"` + NSFW bool `json:"nsfw"` + Authentication authenticationConfigResponse `json:"authentication"` } type federationConfigResponse struct { @@ -118,26 +119,27 @@ func getConfigResponse() webConfigResponse { } return webConfigResponse{ - Name: data.GetServerName(), - Summary: serverSummary, - OfflineMessage: offlineMessage, - Logo: "/logo", - Tags: data.GetServerMetadataTags(), - Version: config.GetReleaseString(), - NSFW: data.GetNSFW(), - SocketHostOverride: data.GetWebsocketOverrideHost(), - ExtraPageContent: pageContent, - StreamTitle: data.GetStreamTitle(), - SocialHandles: socialHandles, - ChatDisabled: data.GetChatDisabled(), - ExternalActions: data.GetExternalActions(), - CustomStyles: data.GetCustomStyles(), - MaxSocketPayloadSize: config.MaxSocketPayloadSize, - Federation: federationResponse, - Notifications: notificationsResponse, - Authentication: authenticationResponse, - AppearanceVariables: data.GetCustomColorVariableValues(), - HideViewerCount: data.GetHideViewerCount(), + Name: data.GetServerName(), + Summary: serverSummary, + OfflineMessage: offlineMessage, + Logo: "/logo", + Tags: data.GetServerMetadataTags(), + Version: config.GetReleaseString(), + NSFW: data.GetNSFW(), + SocketHostOverride: data.GetWebsocketOverrideHost(), + ExtraPageContent: pageContent, + StreamTitle: data.GetStreamTitle(), + SocialHandles: socialHandles, + ChatDisabled: data.GetChatDisabled(), + ChatSpamProtectionDisabled: data.GetChatSpamProtectionEnabled(), + ExternalActions: data.GetExternalActions(), + CustomStyles: data.GetCustomStyles(), + MaxSocketPayloadSize: config.MaxSocketPayloadSize, + Federation: federationResponse, + Notifications: notificationsResponse, + Authentication: authenticationResponse, + AppearanceVariables: data.GetCustomColorVariableValues(), + HideViewerCount: data.GetHideViewerCount(), } } diff --git a/core/chat/chatclient.go b/core/chat/chatclient.go index fac4ed491..df344f17b 100644 --- a/core/chat/chatclient.go +++ b/core/chat/chatclient.go @@ -13,19 +13,21 @@ import ( "github.com/gorilla/websocket" "github.com/owncast/owncast/config" "github.com/owncast/owncast/core/chat/events" + "github.com/owncast/owncast/core/data" "github.com/owncast/owncast/core/user" "github.com/owncast/owncast/geoip" ) // Client represents a single chat client. type Client struct { - ConnectedAt time.Time `json:"connectedAt"` - timeoutTimer *time.Timer - rateLimiter *rate.Limiter - conn *websocket.Conn - User *user.User `json:"user"` - server *Server - Geo *geoip.GeoDetails `json:"geo"` + ConnectedAt time.Time `json:"connectedAt"` + timeoutTimer *time.Timer + rateLimiter *rate.Limiter + messageFilter *ChatMessageFilter + conn *websocket.Conn + User *user.User `json:"user"` + server *Server + Geo *geoip.GeoDetails `json:"geo"` // Buffered channel of outbound messages. send chan []byte accessToken string @@ -90,6 +92,7 @@ func (c *Client) readPump() { // Allow 3 messages every two seconds. limit := rate.Every(2 * time.Second / 3) c.rateLimiter = rate.NewLimiter(limit, 1) + c.messageFilter = NewMessageFilter() defer func() { c.close() @@ -129,6 +132,12 @@ func (c *Client) readPump() { continue } + // Check if this message passes the optional language filter + if data.GetChatSlurFilterEnabled() && !c.messageFilter.Allow(string(message)) { + c.sendAction("Sorry, that message contained language that is not allowed in this chat.") + continue + } + message = bytes.TrimSpace(bytes.ReplaceAll(message, newline, space)) c.handleEvent(message) } @@ -200,7 +209,13 @@ func (c *Client) close() { } func (c *Client) passesRateLimit() bool { - return c.User.IsModerator() || (c.rateLimiter.Allow() && !c.inTimeout) + // If spam rate limiting is disabled, or the user is a moderator, always + // allow the message. + if !data.GetChatSpamProtectionEnabled() || c.User.IsModerator() { + return true + } + + return (c.rateLimiter.Allow() && !c.inTimeout) } func (c *Client) startChatRejectionTimeout() { diff --git a/core/chat/messageFilter.go b/core/chat/messageFilter.go new file mode 100644 index 000000000..86d11ec02 --- /dev/null +++ b/core/chat/messageFilter.go @@ -0,0 +1,18 @@ +package chat + +import ( + goaway "github.com/TwiN/go-away" +) + +// ChatMessageFilter is a allow/deny chat message filter. +type ChatMessageFilter struct{} + +// NewMessageFilter will return an instance of the chat message filter. +func NewMessageFilter() *ChatMessageFilter { + return &ChatMessageFilter{} +} + +// Allow will test if this message should be allowed to be sent. +func (*ChatMessageFilter) Allow(message string) bool { + return !goaway.IsProfane(message) +} diff --git a/core/chat/messageFilter_test.go b/core/chat/messageFilter_test.go new file mode 100644 index 000000000..37ca31823 --- /dev/null +++ b/core/chat/messageFilter_test.go @@ -0,0 +1,39 @@ +package chat + +import ( + "testing" +) + +func TestFiltering(t *testing.T) { + filter := NewMessageFilter() + + filteredTestMessages := []string{ + "Hello, fucking world!", + "Suck my dick", + "Eat my ass", + "fuck this shit", + "@$$h073", + "F u C k th1$ $h!t", + "u r fag", + "fucking sucks", + } + + unfilteredTestMessages := []string{ + "bass fish", + "assumptions", + } + + for _, m := range filteredTestMessages { + result := filter.Allow(m) + if result { + t.Errorf("%s should be seen as a filtered profane message", m) + } + } + + for _, m := range unfilteredTestMessages { + result := filter.Allow(m) + if !result { + t.Errorf("%s should not be filtered", m) + } + } +} diff --git a/core/core.go b/core/core.go index 5b6e28262..ef7165d5b 100644 --- a/core/core.go +++ b/core/core.go @@ -104,7 +104,7 @@ func transitionToOfflineVideoStreamContent() { _transcoder.SetLatencyLevel(models.GetLatencyLevel(4)) _transcoder.SetIsEvent(true) - offlineFilePath, err := saveOfflineClipToDisk("offline.ts") + offlineFilePath, err := saveOfflineClipToDisk("offline-v2.ts") if err != nil { log.Fatalln("unable to save offline clip:", err) } diff --git a/core/data/config.go b/core/data/config.go index 47cc860af..ca440dc56 100644 --- a/core/data/config.go +++ b/core/data/config.go @@ -59,6 +59,8 @@ const ( suggestedUsernamesKey = "suggested_usernames" chatJoinMessagesEnabledKey = "chat_join_messages_enabled" chatEstablishedUsersOnlyModeKey = "chat_established_users_only_mode" + chatSpamProtectionEnabledKey = "chat_spam_protection_enabled" + chatSlurFilterEnabledKey = "chat_slur_filter_enabled" notificationsEnabledKey = "notifications_enabled" discordConfigurationKey = "discord_configuration" browserPushConfigurationKey = "browser_push_configuration" @@ -528,6 +530,36 @@ func GetChatEstbalishedUsersOnlyMode() bool { return false } +// SetChatSpamProtectionEnabled will enable chat spam protection if set to true. +func SetChatSpamProtectionEnabled(enabled bool) error { + return _datastore.SetBool(chatSpamProtectionEnabledKey, enabled) +} + +// GetChatSpamProtectionEnabled will return if chat spam protection is enabled. +func GetChatSpamProtectionEnabled() bool { + enabled, err := _datastore.GetBool(chatSpamProtectionEnabledKey) + if err == nil { + return enabled + } + + return true +} + +// SetChatSlurFilterEnabled will enable the chat slur filter. +func SetChatSlurFilterEnabled(enabled bool) error { + return _datastore.SetBool(chatSlurFilterEnabledKey, enabled) +} + +// GetChatSlurFilterEnabled will return if the chat slur filter is enabled. +func GetChatSlurFilterEnabled() bool { + enabled, err := _datastore.GetBool(chatSlurFilterEnabledKey) + if err == nil { + return enabled + } + + return false +} + // GetExternalActions will return the registered external actions. func GetExternalActions() []models.ExternalAction { configEntry, err := _datastore.Get(externalActionsKey) diff --git a/core/offlineState.go b/core/offlineState.go index e1257c37f..4fb1c7e04 100644 --- a/core/offlineState.go +++ b/core/offlineState.go @@ -36,7 +36,7 @@ func appendOfflineToVariantPlaylist(index int, playlistFilePath string) { _, _ = atomicWriteTmpPlaylistFile.WriteString("#EXT-X-DISCONTINUITY\n") // If "offline" content gets changed then change the duration below _, _ = atomicWriteTmpPlaylistFile.WriteString("#EXTINF:8.000000,\n") - _, _ = atomicWriteTmpPlaylistFile.WriteString("offline.ts\n") + _, _ = atomicWriteTmpPlaylistFile.WriteString("offline-v2.ts\n") _, _ = atomicWriteTmpPlaylistFile.WriteString("#EXT-X-ENDLIST\n") if err := atomicWriteTmpPlaylistFile.Close(); err != nil { diff --git a/core/streamState.go b/core/streamState.go index 52b8b844e..cb6f10f5a 100644 --- a/core/streamState.go +++ b/core/streamState.go @@ -93,7 +93,7 @@ func SetStreamAsDisconnected() { _stats.LastConnectTime = nil _broadcaster = nil - offlineFilename := "offline.ts" + offlineFilename := "offline-v2.ts" offlineFilePath, err := saveOfflineClipToDisk(offlineFilename) if err != nil { diff --git a/docs/api/index.html b/docs/api/index.html index 3d9ac4567..32c7188be 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2261,7 +2261,7 @@ data-styled.g138[id="sc-iIgjPs"]{content:"jIUTls,"}/*!sc*/ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">Download OpenAPI specification:Download
Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software.
Take note that only APIs listed specifically for external use, 3rd parties or for integration purposes are encouraged for external use. Internal APIs may change at any time and are used by the server and frontend itself.
Download OpenAPI specification:Download
Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software.
Take note that only APIs listed specifically for external use, 3rd parties or for integration purposes are encouraged for external use. Internal APIs may change at any time and are used by the server and frontend itself.
{- "broadcaster": {
- "remoteAddr": "172.217.164.110",
- "time": "2020-10-06T23:20:44.588649-07:00",
- "streamDetails": {
- "width": 640,
- "height": 480,
- "frameRate": 24,
- "videoBitrate": 1500,
- "videoCodec": "mp4a",
- "audioBitrate": 256,
- "audioCodec": "aac",
- "encoder": "obs-output module (libobs version 25.0.8)"
}
}, - "online": true,
- "viewerCount": 3,
- "overallPeakViewerCount": 4,
- "sessionPeakViewerCount": 4,
- "versionNumber": "0.0.3"
}Disconnect the active inbound stream, if one exists, and terminate the broadcast.
@@ -2442,11 +2442,11 @@ data-styled.g138[id="sc-iIgjPs"]{content:"jIUTls,"}/*!sc*/{- "lastConnectTime": "2020-10-03T21:36:22-05:00",
- "lastDisconnectTime": null,
- "online": true,
- "overallMaxViewerCount": 420,
- "sessionMaxViewerCount": 12,
- "viewerCount": 7
}Information to be used in the Yellow Pages service, a global directory of Owncast servers.
{- "name": "string",
- "description": "string",
- "logo": "string",
- "nsfw": true,
- "tags": [
- "string"
], - "online": true,
- "viewerCount": 0,
- "overallMaxViewerCount": 0,
- "sessionMaxViewerCount": 0,
- "lastConnectTime": "2019-08-24T14:15:22Z"
}[- {
- "name": "John Smith",
- "timestamp": "2019-08-24T14:15:22Z",
- "disabledAt": "2019-08-24T14:15:22Z"
}
]| account | string The fediverse username@server.tld account that wants to perform the remote follow action. +Response samples
Content type application/json [Return the information needed to redirect a user to a fediverse server to perform a remote follow action.Request Body schema: application/json
ResponsesRequest samples
Content type application/json {Response samples
Content type application/json 404This page could not be found. |
