caddyfile_authn_ui.go

// Copyright 2022 Paul Greenberg greenpau@outlook.com
//
// 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
//
//     http://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.

package security

import (
	"os"
	"strings"

	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
	"github.com/greenpau/go-authcrunch/pkg/authn"
	"github.com/greenpau/go-authcrunch/pkg/authn/ui"
)

// parseCaddyfileAuthPortalUI parses UI settings inside an authentication portal.
//
// Syntax:
//
//	ui {
//		template <template_name> <file_path>
//		theme basic
//		language <language>
//		meta <title|author|description> <value>
//		logo <url|description> <value>
//		auto_redirect_url <url>
//		custom css [path] <path>
//		custom js [path] <path>
//		custom html header path <path>
//		static_asset <assets/URI> <media_type> <path>
//		links {
//			<title> <url> [target_blank] [icon <class>] [disabled]
//		}
//	}
//
// Quote multiword values. Use image/png or image/jpeg for image media types.
// basic is the only registered theme in v1.3.3. Embedded pages handle browser
// color preferences without additional Caddy directives. Profile image assets
// use SVG; custom static PNG assets remain supported.
// Template names, themes, and languages depend on go-authcrunch/pkg/authn/ui
// and pkg/translate. custom html header reads its file during adaptation.
// There are no logo_url, logo_description, or allow settings directives.
func parseCaddyfileAuthPortalUI(h *caddyfile.Dispenser, portal *authn.PortalConfig, rootDirective string) error {
	for nesting := h.Nesting(); h.NextBlock(nesting); {
		subDirective := h.Val()
		switch subDirective {
		case "template":
			hargs := h.RemainingArgs()
			switch {
			case len(hargs) == 2:
				portal.UI.Templates[hargs[0]] = hargs[1]
			default:
				args := strings.Join(h.RemainingArgs(), " ")
				return h.Errf("%s directive %q is invalid", rootDirective, args)
			}
		case "theme":
			if !h.NextArg() {
				return h.Errf("%s %s subdirective has no value", rootDirective, subDirective)
			}
			portal.UI.Theme = h.Val()
		case "language":
			if !h.NextArg() {
				return h.Errf("%s %s subdirective has no value", rootDirective, subDirective)
			}
			portal.UI.Language = h.Val()
		case "logo":
			hargs := h.RemainingArgs()
			args := strings.Join(hargs, " ")
			args = strings.TrimSpace(args)
			switch {
			case strings.HasPrefix(args, "url"):
				portal.UI.LogoURL = strings.ReplaceAll(args, "url ", "")
			case strings.HasPrefix(args, "description"):
				portal.UI.LogoDescription = strings.ReplaceAll(args, "description ", "")
			case args == "":
				return h.Errf("%s %s directive has no value", rootDirective, subDirective)
			default:
				return h.Errf("%s directive %q is unsupported", rootDirective, args)
			}
		case "meta":
			hargs := h.RemainingArgs()
			args := strings.Join(hargs, " ")
			args = strings.TrimSpace(args)
			switch {
			case strings.HasPrefix(args, "title"):
				portal.UI.MetaTitle = strings.ReplaceAll(args, "title ", "")
			case strings.HasPrefix(args, "author"):
				portal.UI.MetaAuthor = strings.ReplaceAll(args, "author ", "")
			case strings.HasPrefix(args, "description"):
				portal.UI.MetaDescription = strings.ReplaceAll(args, "description ", "")
			case args == "":
				return h.Errf("%s %s directive has no value", rootDirective, subDirective)
			default:
				return h.Errf("%s directive %q is unsupported", rootDirective, args)
			}
		case "auto_redirect_url":
			if !h.NextArg() {
				return h.Errf("%s %s subdirective has no value", rootDirective, subDirective)
			}
			portal.UI.AutoRedirectURL = h.Val()
		case "links":
			for subNesting := h.Nesting(); h.NextBlock(subNesting); {
				title := h.Val()
				args := h.RemainingArgs()
				if len(args) == 0 {
					return h.Errf("auth backend %s subdirective %s has no value", subDirective, title)
				}
				privateLink := &ui.Link{
					Title: title,
					Link:  args[0],
				}
				if len(args) == 1 {
					portal.UI.PrivateLinks = append(portal.UI.PrivateLinks, privateLink)
					continue
				}
				argp := 1
				disabledLink := false
				for argp < len(args) {
					switch args[argp] {
					case "target_blank":
						privateLink.Target = "_blank"
						privateLink.TargetEnabled = true
					case "icon":
						argp++
						if argp < len(args) {
							privateLink.IconName = args[argp]
							privateLink.IconEnabled = true
						}
					case "disabled":
						disabledLink = true
					default:
						return h.Errf("auth backend %s subdirective %s has unsupported key %s", subDirective, title, args[argp])
					}
					argp++
				}
				if disabledLink {
					continue
				}
				portal.UI.PrivateLinks = append(portal.UI.PrivateLinks, privateLink)
			}
		case "custom":
			args := strings.Join(h.RemainingArgs(), " ")
			args = strings.TrimSpace(args)
			switch {
			case strings.HasPrefix(args, "css path"):
				portal.UI.CustomCSSPath = strings.ReplaceAll(args, "css path ", "")
			case strings.HasPrefix(args, "css"):
				portal.UI.CustomCSSPath = strings.ReplaceAll(args, "css ", "")
			case strings.HasPrefix(args, "js path"):
				portal.UI.CustomJsPath = strings.ReplaceAll(args, "js path ", "")
			case strings.HasPrefix(args, "js"):
				portal.UI.CustomJsPath = strings.ReplaceAll(args, "js ", "")
			case strings.HasPrefix(args, "html header path"):
				args = strings.ReplaceAll(args, "html header path ", "")
				b, err := os.ReadFile(args)
				if err != nil {
					return h.Errf("%s %s subdirective: %s %v", rootDirective, subDirective, args, err)
				}
				for _, k := range ui.PageTemplates.GetAssetPaths() {
					asset, err := ui.PageTemplates.GetAsset(k)
					if err != nil {
						return h.Errf("%s %s subdirective: %s %v", rootDirective, subDirective, args, err)
					}

					headIndex := strings.Index(asset.Content, "<meta name=\"description\"")
					if headIndex < 1 {
						continue
					}
					asset.Content = asset.Content[:headIndex] + string(b) + asset.Content[headIndex:]
				}
			case args == "":
				return h.Errf("%s %s directive has no value", rootDirective, subDirective)
			default:
				return h.Errf("%s directive %q is unsupported", rootDirective, args)
			}
		case "static_asset":
			args := h.RemainingArgs()
			if len(args) != 3 {
				return h.Errf("auth backend %s subdirective %s is malformed", rootDirective, subDirective)
			}
			prefix := "assets/"
			assetURI := args[0]
			assetContentType := args[1]
			assetPath := args[2]
			if !strings.HasPrefix(assetURI, prefix) {
				return h.Errf("auth backend %s subdirective %s URI must be prefixed with %s, got %s",
					rootDirective, subDirective, prefix, assetURI)
			}

			portal.UI.StaticAssets = append(portal.UI.StaticAssets, &ui.StaticAsset{
				Path:        assetURI,
				ContentType: assetContentType,
				FsPath:      assetPath,
			})
		default:
			return h.Errf("unsupported subdirective for %s: %s", rootDirective, subDirective)
		}
	}

	return nil
}