Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

Add permission checks to all SSR view handlers.

Kailash Nadh49f1f28b476d
diff --git a/cmd/campaigns.go b/cmd/campaigns.go
index 13c41ef0..b1968021 100644
--- a/cmd/campaigns.go
+++ b/cmd/campaigns.go
@@ -84,9 +84,13 @@ type campaignView struct {
// ViewNewCampaign renders the new campaign page (only the "campaign" tab).
func (a *App) ViewNewCampaign(c echo.Context) error {
- tpls, err := a.core.GetTemplates("", "", true, "", "")
- if err != nil {
- return err
+ var tpls []models.Template
+ if can(auth.GetUser(c), "templates:get") {
+ var err error
+ tpls, err = a.core.GetTemplates("", "", true, "", "")
+ if err != nil {
+ return err
+ }
}
// Pre-selected lists from ?list_id query params (filtered by permission).
@@ -157,9 +161,13 @@ func (a *App) ViewCampaign(c echo.Context) error {
}
}
- tpls, err := a.core.GetTemplates("", "", true, "", "")
- if err != nil {
- return err
+ var tpls []models.Template
+ if can(auth.GetUser(c), "templates:get") {
+ var err error
+ tpls, err = a.core.GetTemplates("", "", true, "", "")
+ if err != nil {
+ return err
+ }
}
allLists, err := a.getViewableLists(c)
diff --git a/cmd/handlers.go b/cmd/handlers.go
index 3c6435b0..f82d105b 100644
--- a/cmd/handlers.go
+++ b/cmd/handlers.go
@@ -1,6 +1,7 @@
package main
import (
+ "errors"
"net/http"
"net/url"
"path"
@@ -50,6 +51,8 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
// =================================================================
// Authenticated non /api handlers.
{
+ pm := a.auth.Perm
+
// Attach a middleware to the group that checks for auth.
g := e.Group("", a.auth.Middleware, func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
@@ -64,7 +67,13 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
return c.Redirect(http.StatusTemporaryRedirect, u.String())
}
- return next(c)
+ err := next(c)
+ var httpErr *echo.HTTPError
+ if errors.As(err, &httpErr) && httpErr.Code == http.StatusForbidden && !c.Response().Committed {
+ return a.renderAdminMessage(c, "Error", a.i18n.Ts("globals.messages.permissionDenied", "name", c.Path()))
+ }
+
+ return err
}
})
@@ -74,47 +83,48 @@ func initHTTPHandlers(e *echo.Echo, a *App) {
g.GET(path.Join(uriAdmin, "/custom.js"), serveCustomAppearance("admin.custom_js"))
g.GET(uriAdmin, a.ViewDashboard)
g.GET(path.Join(uriAdmin, "/lists"), a.ViewLists)
- g.GET(path.Join(uriAdmin, "/lists/new"), a.ViewNewList)
+ g.GET(path.Join(uriAdmin, "/lists/new"), pm(a.ViewNewList, "lists:manage_all"))
g.GET(path.Join(uriAdmin, "/lists/:id"), hasID(a.ViewList))
g.GET(path.Join(uriAdmin, "/lists/forms"), a.ViewForms)
- g.GET(path.Join(uriAdmin, "/campaigns"), a.ViewCampaigns)
- g.GET(path.Join(uriAdmin, "/campaigns/media"), a.ViewMedia)
- g.GET(path.Join(uriAdmin, "/campaigns/media/fragment"), a.ViewMediaFragment)
- g.GET(path.Join(uriAdmin, "/campaigns/analytics"), a.ViewCampaignAnalytics)
- g.GET(path.Join(uriAdmin, "/campaigns/new"), a.ViewNewCampaign)
- g.GET(path.Join(uriAdmin, "/campaigns/:id"), hasID(a.ViewCampaign))
- g.GET(path.Join(uriAdmin, "/campaigns/:id/:tab"), hasID(a.ViewCampaign))
- g.GET(path.Join(uriAdmin, "/templates"), a.ViewTemplates)
- g.GET(path.Join(uriAdmin, "/templates/new"), a.ViewNewTemplate)
- g.GET(path.Join(uriAdmin, "/templates/:id"), hasID(a.ViewTemplate))
- g.GET(path.Join(uriAdmin, "/subscribers/import"), a.ViewImport)
- g.GET(path.Join(uriAdmin, "/subscribers/bounces"), a.ViewBounces)
- g.GET(path.Join(uriAdmin, "/subscribers"), a.ViewSubscribers)
- g.POST(path.Join(uriAdmin, "/subscribers"), a.ViewSubscribers)
- g.GET(path.Join(uriAdmin, "/subscribers/lists/:id"), hasID(a.ViewSubscribers))
- g.POST(path.Join(uriAdmin, "/subscribers/lists/:id"), hasID(a.ViewSubscribers))
- g.GET(path.Join(uriAdmin, "/subscribers/new"), a.ViewNewSubscriber)
- g.GET(path.Join(uriAdmin, "/subscribers/:id"), hasID(a.ViewSubscriber))
- g.GET(path.Join(uriAdmin, "/subscribers/:id/lists"), hasID(a.ViewSubscriber))
- g.GET(path.Join(uriAdmin, "/subscribers/:id/bounces"), hasID(a.ViewSubscriberBounces))
- g.GET(path.Join(uriAdmin, "/subscribers/:id/activity"), hasID(a.ViewSubscriberActivity))
+ g.GET(path.Join(uriAdmin, "/campaigns"), pm(a.ViewCampaigns, "campaigns:get_all", "campaigns:get"))
+ g.GET(path.Join(uriAdmin, "/campaigns/media"), pm(a.ViewMedia, "media:get"))
+ g.GET(path.Join(uriAdmin, "/campaigns/media/fragment"), pm(a.ViewMediaFragment, "media:get"))
+ g.GET(path.Join(uriAdmin, "/campaigns/analytics"), pm(a.ViewCampaignAnalytics, "campaigns:get_analytics"))
+ g.GET(path.Join(uriAdmin, "/campaigns/new"), pm(a.ViewNewCampaign, "campaigns:manage_all", "campaigns:manage"))
+ g.GET(path.Join(uriAdmin, "/campaigns/:id"), pm(hasID(a.ViewCampaign), "campaigns:get_all", "campaigns:get"))
+ g.GET(path.Join(uriAdmin, "/campaigns/:id/:tab"), pm(hasID(a.ViewCampaign), "campaigns:get_all", "campaigns:get"))
+ g.GET(path.Join(uriAdmin, "/templates"), pm(a.ViewTemplates, "templates:get"))
+ g.GET(path.Join(uriAdmin, "/templates/new"), pm(a.ViewNewTemplate, "templates:manage"))
+ g.GET(path.Join(uriAdmin, "/templates/:id"), pm(hasID(a.ViewTemplate), "templates:get"))
+ g.GET(path.Join(uriAdmin, "/subscribers/import"), pm(a.ViewImport, "subscribers:import"))
+ g.GET(path.Join(uriAdmin, "/subscribers/bounces"), pm(a.ViewBounces, "bounces:get"))
+ g.GET(path.Join(uriAdmin, "/subscribers"), pm(a.ViewSubscribers, "subscribers:get_all", "subscribers:get"))
+ g.POST(path.Join(uriAdmin, "/subscribers"), pm(a.ViewSubscribers, "subscribers:get_all", "subscribers:get"))
+ g.GET(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), "subscribers:get_all", "subscribers:get"))
+ g.POST(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), "subscribers:get_all", "subscribers:get"))
+ g.GET(path.Join(uriAdmin, "/subscribers/new"), pm(a.ViewNewSubscriber, "subscribers:manage"))
+ g.GET(path.Join(uriAdmin, "/subscribers/:id"), pm(hasID(a.ViewSubscriber), "subscribers:get_all", "subscribers:get"))
+ g.GET(path.Join(uriAdmin, "/subscribers/:id/lists"), pm(hasID(a.ViewSubscriber), "subscribers:get_all", "subscribers:get"))
+ // This view renders both the subscriber profile and bounce records.
+ g.GET(path.Join(uriAdmin, "/subscribers/:id/bounces"), pm(pm(hasID(a.ViewSubscriberBounces), "bounces:get"), "subscribers:get_all", "subscribers:get"))
+ g.GET(path.Join(uriAdmin, "/subscribers/:id/activity"), pm(hasID(a.ViewSubscriberActivity), "subscribers:get_all", "subscribers:get"))
// Users and roles. Static segments are registered before the :id param routes.
- g.GET(path.Join(uriAdmin, "/users"), a.ViewUsers)
- g.GET(path.Join(uriAdmin, "/users/new"), a.ViewUser)
- g.GET(path.Join(uriAdmin, "/users/roles"), a.ViewUserRoles)
- g.GET(path.Join(uriAdmin, "/users/roles/new"), a.ViewUserRole)
- g.GET(path.Join(uriAdmin, "/users/roles/lists"), a.ViewListRoles)
- g.GET(path.Join(uriAdmin, "/users/roles/lists/new"), a.ViewListRole)
- g.GET(path.Join(uriAdmin, "/users/roles/lists/:id"), hasID(a.ViewListRole))
- g.GET(path.Join(uriAdmin, "/users/roles/:id"), hasID(a.ViewUserRole))
- g.GET(path.Join(uriAdmin, "/users/:id"), hasID(a.ViewUser))
+ g.GET(path.Join(uriAdmin, "/users"), pm(a.ViewUsers, "users:get"))
+ g.GET(path.Join(uriAdmin, "/users/new"), pm(a.ViewUser, "users:manage"))
+ g.GET(path.Join(uriAdmin, "/users/roles"), pm(a.ViewUserRoles, "roles:get"))
+ g.GET(path.Join(uriAdmin, "/users/roles/new"), pm(a.ViewUserRole, "roles:manage"))
+ g.GET(path.Join(uriAdmin, "/users/roles/lists"), pm(a.ViewListRoles, "roles:get"))
+ g.GET(path.Join(uriAdmin, "/users/roles/lists/new"), pm(a.ViewListRole, "roles:manage"))
+ g.GET(path.Join(uriAdmin, "/users/roles/lists/:id"), pm(hasID(a.ViewListRole), "roles:get"))
+ g.GET(path.Join(uriAdmin, "/users/roles/:id"), pm(hasID(a.ViewUserRole), "roles:get"))
+ g.GET(path.Join(uriAdmin, "/users/:id"), pm(hasID(a.ViewUser), "users:get"))
g.GET(path.Join(uriAdmin, "/user/profile"), a.ViewProfile)
// Settings.
- g.GET(path.Join(uriAdmin, "/settings"), a.ViewSettings)
- g.GET(path.Join(uriAdmin, "/settings/logs"), a.ViewLogs)
- g.GET(path.Join(uriAdmin, "/settings/maintenance"), a.ViewMaintenance)
+ g.GET(path.Join(uriAdmin, "/settings"), pm(a.ViewSettings, "settings:get"))
+ g.GET(path.Join(uriAdmin, "/settings/logs"), pm(a.ViewLogs, "settings:get"))
+ g.GET(path.Join(uriAdmin, "/settings/maintenance"), pm(a.ViewMaintenance, "settings:maintain"))
}
// =================================================================
diff --git a/cmd/lists.go b/cmd/lists.go
index ada3407b..6f37380e 100644
--- a/cmd/lists.go
+++ b/cmd/lists.go
@@ -102,7 +102,7 @@ func (a *App) ViewList(c echo.Context) error {
// Check if the user has access to the list.
id := getID(c)
if err := user.HasListPerm(auth.PermTypeGet, id); err != nil {
- return err
+ return a.renderAdminMessage(c, "Error", a.i18n.Ts("globals.messages.permissionDenied", "name", "lists"))
}
list, err := a.core.GetList(id, "")
@@ -120,7 +120,9 @@ func (a *App) ViewList(c echo.Context) error {
// ViewForms renders the HTML view for the public subscription form generator.
func (a *App) ViewForms(c echo.Context) error {
- lists, err := a.core.GetLists(models.ListTypePublic, models.ListStatusActive, true, nil)
+ user := auth.GetUser(c)
+ hasAllPerm, permittedIDs := user.GetPermittedLists(auth.PermTypeGet)
+ lists, err := a.core.GetLists(models.ListTypePublic, models.ListStatusActive, hasAllPerm, permittedIDs)
if err != nil {
return err
}
diff --git a/cmd/maintenance.go b/cmd/maintenance.go
index e3b0a7c3..c1fb3362 100644
--- a/cmd/maintenance.go
+++ b/cmd/maintenance.go
@@ -8,7 +8,6 @@ import (
"time"
"github.com/jmoiron/sqlx"
- "github.com/knadh/listmonk/internal/auth"
"github.com/labstack/echo/v4"
)
@@ -24,10 +23,6 @@ type maintenanceView struct {
// ViewMaintenance renders the HTML view for the maintenance page.
func (a *App) ViewMaintenance(c echo.Context) error {
- if !can(auth.GetUser(c), "settings:maintain") {
- return auth.ErrPermDenied
- }
-
s, err := a.core.GetSettings()
if err != nil {
return err
diff --git a/cmd/roles.go b/cmd/roles.go
index 99cebd21..e299fa3f 100644
--- a/cmd/roles.go
+++ b/cmd/roles.go
@@ -54,10 +54,6 @@ type roleFormView struct {
// ViewUserRoles renders the HTML view listing user roles.
func (a *App) ViewUserRoles(c echo.Context) error {
- if !can(auth.GetUser(c), auth.PermRolesGet) {
- return auth.ErrPermDenied
- }
-
q := makeQuery(c.Request().URL.Query(), rolesQueryDefaults)
roles, err := a.core.GetRoles(q.Get("query"), q.Get("order_by"), q.Get("order"))
if err != nil {
@@ -81,10 +77,6 @@ func (a *App) ViewUserRoles(c echo.Context) error {
// ViewListRoles renders the HTML view listing list roles.
func (a *App) ViewListRoles(c echo.Context) error {
- if !can(auth.GetUser(c), auth.PermRolesGet) {
- return auth.ErrPermDenied
- }
-
q := makeQuery(c.Request().URL.Query(), rolesQueryDefaults)
roles, err := a.core.GetListRoles(q.Get("query"), q.Get("order_by"), q.Get("order"))
if err != nil {
@@ -108,10 +100,6 @@ func (a *App) ViewListRoles(c echo.Context) error {
// ViewUserRole renders the HTML add/edit form for a user role.
func (a *App) ViewUserRole(c echo.Context) error {
- if !can(auth.GetUser(c), auth.PermRolesGet) {
- return auth.ErrPermDenied
- }
-
var (
role auth.Role
isNew = true
@@ -148,10 +136,6 @@ func (a *App) ViewUserRole(c echo.Context) error {
// ViewListRole renders the HTML add/edit form for a list role.
func (a *App) ViewListRole(c echo.Context) error {
- if !can(auth.GetUser(c), auth.PermRolesGet) {
- return auth.ErrPermDenied
- }
-
var (
role auth.ListRole
isNew = true
@@ -178,7 +162,7 @@ func (a *App) ViewListRole(c echo.Context) error {
}
// All lists for the list-permission selector.
- lists, err := a.core.GetLists("", models.ListStatusActive, true, nil)
+ lists, err := a.getViewableLists(c)
if err != nil {
return err
}
diff --git a/cmd/settings.go b/cmd/settings.go
index 811a494d..268a42d0 100644
--- a/cmd/settings.go
+++ b/cmd/settings.go
@@ -106,10 +106,6 @@ type settingsView struct {
// ViewSettings renders the HTML view for the settings form.
func (a *App) ViewSettings(c echo.Context) error {
- if !can(auth.GetUser(c), "settings:get") {
- return auth.ErrPermDenied
- }
-
s, err := a.core.GetSettings()
if err != nil {
return err
@@ -465,10 +461,6 @@ type logsView struct {
// ViewLogs renders the HTML view for the application log viewer.
func (a *App) ViewLogs(c echo.Context) error {
- if !can(auth.GetUser(c), "settings:get") {
- return auth.ErrPermDenied
- }
-
data := logsView{
adminView: newAdminView(c, a.i18n.T("logs.title"), "", "settings.logs"),
Lines: a.bufLog.Lines(),
diff --git a/cmd/subscribers.go b/cmd/subscribers.go
index d229aa42..bfa16cac 100644
--- a/cmd/subscribers.go
+++ b/cmd/subscribers.go
@@ -116,6 +116,12 @@ type subLinkClick struct {
// ViewSubscribers renders the HTML view for subscribers, optionally filtered by a list.
func (a *App) ViewSubscribers(c echo.Context) error {
listID, _ := strconv.Atoi(c.Param("id"))
+ if listID > 0 {
+ user := auth.GetUser(c)
+ if err := user.HasListPerm(auth.PermTypeGet, listID); err != nil {
+ return a.renderAdminMessage(c, "Error", a.i18n.Ts("globals.messages.permissionDenied", "name", "lists"))
+ }
+ }
subs, props, err := a.getSubscribers(c, listID)
if err != nil {
diff --git a/cmd/users.go b/cmd/users.go
index cf8c5a3a..4faec63f 100644
--- a/cmd/users.go
+++ b/cmd/users.go
@@ -58,10 +58,6 @@ type userView struct {
// ViewUsers renders the HTML view listing all users.
func (a *App) ViewUsers(c echo.Context) error {
- if !can(auth.GetUser(c), auth.PermUsersGet) {
- return auth.ErrPermDenied
- }
-
// Whitelisted filter params.
q := makeQuery(c.Request().URL.Query(), usersQueryDefaults)
var (
@@ -107,10 +103,6 @@ func (a *App) ViewUsers(c echo.Context) error {
// ViewUser renders the HTML add/edit form for a user. It handles both the "new user"
// (no ID) and the "edit user" (ID in the URI) cases.
func (a *App) ViewUser(c echo.Context) error {
- if !can(auth.GetUser(c), auth.PermUsersGet) {
- return auth.ErrPermDenied
- }
-
var (
user auth.User
isNew = true
@@ -127,9 +119,16 @@ func (a *App) ViewUser(c echo.Context) error {
}
// Roles for the role selectors.
- userRoles, listRoles, err := a.getRoles()
- if err != nil {
- return err
+ var (
+ userRoles []auth.Role
+ listRoles []auth.ListRole
+ )
+ if can(auth.GetUser(c), auth.PermRolesGet) {
+ var err error
+ userRoles, listRoles, err = a.getRoles()
+ if err != nil {
+ return err
+ }
}
title := a.i18n.T("users.newUser")
diff --git a/cmd/views.go b/cmd/views.go
index 77a8759b..aeea394d 100644
--- a/cmd/views.go
+++ b/cmd/views.go
@@ -1,6 +1,7 @@
package main
import (
+ "net/http"
"strings"
"github.com/knadh/listmonk/internal/auth"
@@ -52,3 +53,8 @@ func can(user auth.User, perms ...string) bool {
func canManageList(user auth.User, id int) bool {
return user.HasListPerm(auth.PermTypeManage, id) == nil
}
+
+// renderAdminMessage renders a message page.
+func (a *App) renderAdminMessage(c echo.Context, title, description string) error {
+ return c.Render(http.StatusForbidden, "admin-message", newAdminView(c, title, description, ""))
+}