github.com/google/go-safeweb@v0.0.0-20231219055052-64d8cfc90fbb/examples/sample-application/server/server.go

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//	https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build go1.16
// +build go1.16

// Package server implements the application server.
//
// This is the piece that a product team owns and implements. They use APIs from
// go-safeweb/examples/sample-application/secure and Go Safe
// Web to configure the HTTP handlers.
//
// If strictly necessary, the product team might use restricted APIs using
// security-reviewed exemptions (e.g. with go-safeweb/cmd/banchek).
package server

import (
	"github.com/google/go-safeweb/safehttp"

	"embed"

	"github.com/google/go-safeweb/safehttp/plugins/htmlinject"
	"github.com/google/safehtml/template"

	"github.com/google/go-safeweb/examples/sample-application/secure/auth"
	"github.com/google/go-safeweb/examples/sample-application/secure/responses"
	"github.com/google/go-safeweb/examples/sample-application/storage"
)

//go:embed static
var staticFiles embed.FS

//go:embed templates
var templatesFS embed.FS

var templates *template.Template

func init() {
	tplSrc := template.TrustedSourceFromConstant("templates/*.tpl.html")
	var err error
	// htmlinject automatically injects CSP nonces and XSRF tokens placeholders.
	templates, err = htmlinject.LoadGlobEmbed(nil, htmlinject.LoadConfig{}, tplSrc, templatesFS)
	if err != nil {
		panic(err)
	}
}

type serverDeps struct {
	db *storage.DB
}

func Load(db *storage.DB, mux *safehttp.ServeMux) {
	deps := &serverDeps{
		db: db,
	}

	// Private endpoints, only accessible to authenticated users (default).
	mux.Handle("/notes/", "GET", getNotesHandler(deps))
	mux.Handle("/notes", "POST", postNotesHandler(deps))
	mux.Handle("/logout", "POST", logoutHandler(deps))

	// Public enpoints, no auth checks performed.
	mux.Handle("/login", "POST", postLoginHandler(deps), auth.Skip{})
	mux.Handle("/static/", "GET", safehttp.FileServerEmbed(staticFiles), auth.Skip{})
	mux.Handle("/", "GET", indexHandler(deps), auth.Skip{})
}

func getNotesHandler(deps *serverDeps) safehttp.Handler {
	return safehttp.HandlerFunc(func(rw safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
		user := auth.User(r)
		notes := deps.db.GetNotes(user)
		return safehttp.ExecuteNamedTemplate(rw, templates, "notes.tpl.html", map[string]interface{}{
			"notes": notes,
			"user":  user,
		})
	})
}

func postNotesHandler(deps *serverDeps) safehttp.Handler {
	noFormErr := responses.NewError(
		safehttp.StatusBadRequest,
		template.MustParseAndExecuteToHTML(`Please submit a valid form with "title" and "text" parameters.`),
	)
	noFieldsErr := responses.NewError(
		safehttp.StatusBadRequest,
		template.MustParseAndExecuteToHTML("Both title and text must be specified."),
	)

	return safehttp.HandlerFunc(func(rw safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
		form, err := r.PostForm()
		if err != nil {
			return rw.WriteError(noFormErr)
		}
		title := form.String("title", "")
		body := form.String("text", "")
		if title == "" || body == "" {
			return rw.WriteError(noFieldsErr)
		}
		user := auth.User(r)
		deps.db.AddOrEditNote(user, storage.Note{Title: title, Text: body})

		notes := deps.db.GetNotes(user)
		return safehttp.ExecuteNamedTemplate(rw, templates, "notes.tpl.html", map[string]interface{}{
			"notes": notes,
			"user":  user,
		})
	})
}

func indexHandler(deps *serverDeps) safehttp.Handler {
	return safehttp.HandlerFunc(func(rw safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
		user := auth.User(r)
		if user != "" {
			return safehttp.Redirect(rw, r, "/notes/", safehttp.StatusTemporaryRedirect)
		}
		return safehttp.ExecuteNamedTemplate(rw, templates, "index.tpl.html", nil)
	})
}

// Logout and Login handlers would normally be centralized and provided by a separate package owned by the security team.
// Since this is a simple example application they are here together with the rest.
func logoutHandler(deps *serverDeps) safehttp.Handler {
	return safehttp.HandlerFunc(func(rw safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
		auth.ClearSession(r)
		return safehttp.Redirect(rw, r, "/", safehttp.StatusSeeOther)
	})
}

func postLoginHandler(deps *serverDeps) safehttp.Handler {
	invalidAuthErr := responses.NewError(
		safehttp.StatusBadRequest,
		template.MustParseAndExecuteToHTML("Please specify a username and a password, both must be non-empty and your password must match the one you use to register."),
	)

	// Always return the same error to not leak the existence of a user.
	return safehttp.HandlerFunc(func(rw safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
		form, err := r.PostForm()
		if err != nil {
			return rw.WriteError(invalidAuthErr)
		}
		username := form.String("username", "")
		password := form.String("password", "")
		if username == "" || password == "" {
			return rw.WriteError(invalidAuthErr)
		}
		if err := deps.db.AddOrAuthUser(username, password); err != nil {
			return rw.WriteError(invalidAuthErr)
		}
		auth.CreateSession(r, username)
		return safehttp.Redirect(rw, r, "/notes/", safehttp.StatusSeeOther)
	})
}