mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2025-06-05 21:59:39 +02:00
ec4d4d0115
- adds config flags `instance-expose-allowlist` and `instance-expose-allowlist-web` to allow instance admins to expose their allowlist via the web + api. - renames `instance-expose-suspended` and `instance-expose-suspended-web` to `instance-expose-blocklist` and `instance-expose-blocklist-web`. - deprecates the `suspended` filter on `/api/v1/instance/peers` endpoint and adds `blocked` and `allowed` filters - adds the `flat` query param to `/api/v1/instance/peers` to allow forcing return of a flat list of domains - implements `/api/v1/instance/domain_blocks` and `/api/v1/instance/domain_allows` endpoints with or without auth depending on config - rejigs the instance about page to include a general section on domain permissions, with block and allow subsections (and appropriate links) Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/3847 Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/4150 Prerequisite to https://codeberg.org/superseriousbusiness/gotosocial/issues/3711 Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4169 Co-authored-by: tobi <tobi.smethurst@protonmail.com> Co-committed-by: tobi <tobi.smethurst@protonmail.com>
361 lines
11 KiB
Go
361 lines
11 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package instance_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"code.superseriousbusiness.org/gotosocial/internal/api/client/instance"
|
|
"code.superseriousbusiness.org/gotosocial/internal/config"
|
|
"code.superseriousbusiness.org/gotosocial/internal/gtsmodel"
|
|
"code.superseriousbusiness.org/gotosocial/internal/util"
|
|
"code.superseriousbusiness.org/gotosocial/testrig"
|
|
"github.com/gin-gonic/gin/render"
|
|
"github.com/stretchr/testify/suite"
|
|
)
|
|
|
|
type InstancePeersGetTestSuite struct {
|
|
InstanceStandardTestSuite
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetNoParams() {
|
|
recorder := httptest.NewRecorder()
|
|
ctx, r := testrig.CreateGinTestContext(recorder, nil)
|
|
r.HTMLRender = render.HTMLDebug{}
|
|
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s", baseURI, instance.InstancePeersPath)
|
|
ctx.Request = httptest.NewRequest(http.MethodGet, requestURI, nil)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[
|
|
"example.org",
|
|
"fossbros-anonymous.io"
|
|
]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetNoParamsUnauthorized() {
|
|
config.SetInstanceExposePeers(false)
|
|
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", false)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusUnauthorized, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
|
|
suite.Equal(`{"error":"Unauthorized: peers open query requires an authenticated account/user"}`, string(b))
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetNoParamsAuthorized() {
|
|
config.SetInstanceExposePeers(false)
|
|
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", true)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[
|
|
"example.org",
|
|
"fossbros-anonymous.io"
|
|
]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetOnlySuspended() {
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=suspended", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", false)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[
|
|
{
|
|
"domain": "replyguys.com",
|
|
"suspended_at": "2020-05-13T13:29:12.000Z",
|
|
"comment": "reply-guying to tech posts",
|
|
"severity": "suspend"
|
|
}
|
|
]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetOnlySuspendedUnauthorized() {
|
|
config.SetInstanceExposeBlocklist(false)
|
|
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=suspended", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", false)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusUnauthorized, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
|
|
suite.Equal(`{"error":"Unauthorized: peers blocked query requires an authenticated account/user"}`, string(b))
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetOnlySuspendedAuthorized() {
|
|
config.SetInstanceExposeBlocklist(false)
|
|
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=suspended", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", true)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[
|
|
{
|
|
"domain": "replyguys.com",
|
|
"suspended_at": "2020-05-13T13:29:12.000Z",
|
|
"comment": "reply-guying to tech posts",
|
|
"severity": "suspend"
|
|
}
|
|
]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetAll() {
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=suspended,open", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", false)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[
|
|
{
|
|
"domain": "example.org"
|
|
},
|
|
{
|
|
"domain": "fossbros-anonymous.io"
|
|
},
|
|
{
|
|
"domain": "replyguys.com",
|
|
"suspended_at": "2020-05-13T13:29:12.000Z",
|
|
"comment": "reply-guying to tech posts",
|
|
"severity": "suspend"
|
|
}
|
|
]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetAllowed() {
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=allowed", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", false)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetAllWithObfuscated() {
|
|
err := suite.db.Put(context.Background(), >smodel.DomainBlock{
|
|
ID: "01G633XTNK51GBADQZFZQDP6WR",
|
|
CreatedAt: testrig.TimeMustParse("2021-06-09T12:34:55+02:00"),
|
|
UpdatedAt: testrig.TimeMustParse("2021-06-09T12:34:55+02:00"),
|
|
Domain: "omg.just.the.worst.org.ever",
|
|
CreatedByAccountID: "01F8MH17FWEB39HZJ76B6VXSKF",
|
|
PublicComment: "just absolutely the worst, wowza",
|
|
Obfuscate: util.Ptr(true),
|
|
})
|
|
suite.NoError(err)
|
|
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=suspended,open", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", false)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[
|
|
{
|
|
"domain": "example.org"
|
|
},
|
|
{
|
|
"domain": "fossbros-anonymous.io"
|
|
},
|
|
{
|
|
"domain": "o*g.*u**.t**.*or*t.*r**ev**",
|
|
"suspended_at": "2021-06-09T10:34:55.000Z",
|
|
"comment": "just absolutely the worst, wowza",
|
|
"severity": "suspend"
|
|
},
|
|
{
|
|
"domain": "replyguys.com",
|
|
"suspended_at": "2020-05-13T13:29:12.000Z",
|
|
"comment": "reply-guying to tech posts",
|
|
"severity": "suspend"
|
|
}
|
|
]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetAllWithObfuscatedFlat() {
|
|
err := suite.db.Put(context.Background(), >smodel.DomainBlock{
|
|
ID: "01G633XTNK51GBADQZFZQDP6WR",
|
|
CreatedAt: testrig.TimeMustParse("2021-06-09T12:34:55+02:00"),
|
|
UpdatedAt: testrig.TimeMustParse("2021-06-09T12:34:55+02:00"),
|
|
Domain: "omg.just.the.worst.org.ever",
|
|
CreatedByAccountID: "01F8MH17FWEB39HZJ76B6VXSKF",
|
|
PublicComment: "just absolutely the worst, wowza",
|
|
Obfuscate: util.Ptr(true),
|
|
})
|
|
suite.NoError(err)
|
|
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=suspended,open&flat=true", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", false)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
dst := new(bytes.Buffer)
|
|
err = json.Indent(dst, b, "", " ")
|
|
suite.NoError(err)
|
|
suite.Equal(`[
|
|
"example.org",
|
|
"fossbros-anonymous.io",
|
|
"o*g.*u**.t**.*or*t.*r**ev**",
|
|
"replyguys.com"
|
|
]`, dst.String())
|
|
}
|
|
|
|
func (suite *InstancePeersGetTestSuite) TestInstancePeersGetFunkyParams() {
|
|
recorder := httptest.NewRecorder()
|
|
baseURI := fmt.Sprintf("%s://%s", config.GetProtocol(), config.GetHost())
|
|
requestURI := fmt.Sprintf("%s/%s?filter=aaaaaaaaaaaaaaaaa,open", baseURI, instance.InstancePeersPath)
|
|
ctx := suite.newContext(recorder, http.MethodGet, requestURI, nil, "", true)
|
|
|
|
suite.instanceModule.InstancePeersGETHandler(ctx)
|
|
|
|
suite.Equal(http.StatusBadRequest, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
|
|
b, err := io.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
|
|
suite.Equal(`{"error":"Bad Request: filter aaaaaaaaaaaaaaaaa not recognized; accepted values are 'open', 'blocked', 'allowed', and 'suspended' (deprecated)"}`, string(b))
|
|
}
|
|
|
|
func TestInstancePeersGetTestSuite(t *testing.T) {
|
|
suite.Run(t, &InstancePeersGetTestSuite{})
|
|
}
|