docs(suites): add license headers (1/2) (#13056)

This commit is contained in:
James Elliott authored and GitHub committed 2026-09-09 08:58:57 +00:00
1 parent e18e62a707
commit 25bf94c912
158 files changed
+698 -19

No files matched your search

+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
version: "2"
linters:
+45 -19
View File
@@ -7,6 +7,7 @@ package main
import (
"bufio"
"fmt"
"os"
"path/filepath"
"strings"
@@ -82,6 +83,48 @@ func removeRunningSuiteFile() error {
return os.Remove(runningSuiteFile)
}
func loadSuiteEnvironment(path string) (err error) {
if _, err = os.Stat(path); err != nil {
if os.IsNotExist(err) {
return nil
}
return fmt.Errorf("error checking environment file '%s': %w", path, err)
}
file, err := os.Open(path)
if err != nil {
return fmt.Errorf("error opening environment file '%s': %w", path, err)
}
defer file.Close()
scanner := bufio.NewScanner(file)
for scanner.Scan() {
line := strings.TrimSpace(scanner.Text())
if line == "" || strings.HasPrefix(line, "#") {
continue
}
v := strings.SplitN(line, "=", 2)
if len(v) != 2 {
return fmt.Errorf("error parsing environment file '%s': line '%s' is not a comment and does not contain a '=' character", path, line)
}
if err = os.Setenv(v[0], v[1]); err != nil {
return fmt.Errorf("error setting environment variable '%s' from environment file '%s': %w", v[0], path, err)
}
}
if err = scanner.Err(); err != nil {
return fmt.Errorf("error reading environment file '%s': %w", path, err)
}
return nil
}
func setupSuite(cmd *cobra.Command, args []string) {
suiteName := args[0]
s := suites.GlobalRegistry.Get(suiteName)
@@ -98,25 +141,8 @@ func setupSuite(cmd *cobra.Command, args []string) {
log.Fatal(err)
}
suiteEnv := suiteResourcePath + "/.env"
_, err = os.Stat(suiteEnv)
if err == nil {
file, err := os.Open(suiteEnv)
if err != nil {
log.Fatal(err)
}
env := bufio.NewScanner(file)
for env.Scan() {
v := strings.Split(env.Text(), "=")
err := os.Setenv(v[0], v[1])
if err != nil {
log.Fatal(err)
}
}
if err = loadSuiteEnvironment(suiteResourcePath + "/.env"); err != nil {
log.Fatal(err)
}
suiteTmpDirectory := suites.SuiteTmpPath("authelia", "suites", suiteName)
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
theme: 'grey'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: ''
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
storage:
encryption_key: a_not_so_secure_encryption_key
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
users:
bob:
password: $6$rounds=500000$jgiCMRyGXzoqpxS3$w2pJeZnnH8bwW3zzvoMWtTRfQYsHbWbD/hquuQ5vUeIyl9gdwBIt6RWk2S6afBA0DPakbeWgD/4SZPiS0hYtU/
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
theme: 'dark'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
theme: 'auto'
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1 +1,5 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
PathPrefix=/auth
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: /certs/
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+6
View File
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2026 Authelia
SPDX-License-Identifier: Apache-2.0
-->
# Authelia Suites
A **suite** is a kind of virtual environment for Authelia. Please
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
theme: 'auto'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2026 Authelia
SPDX-License-Identifier: Apache-2.0
+3
View File
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2026 Authelia
SPDX-License-Identifier: Apache-2.0
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
services:
authelia-backend:
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
certificates_directory: '/certs/'
theme: 'auto'
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
users:
john:
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,5 +1,9 @@
#!/usr/bin/env bash
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
# go run ./cmd/authelia crypto certificate rsa generate --directory='./internal/suites/common/pki/ca' --file.ca-certificate='ca.private.pem' --file.ca-private-key='ca.public.crt' -n 'Authelia Development Standalone Root CA' --not-before='Jan 1 00:00:00 2000' --not-after='Jan 1 00:00:00 2100' -o 'Authelia' --organizational-unit='Development' --ca
# cp ./internal/suites/common/pki/ca/ca.public.crt ./internal/suites/common/pki/ca.public.crt
go run ./cmd/authelia crypto certificate rsa generate --directory='./internal/suites/common/pki' --path.ca='./internal/suites/common/pki/ca' --bundles='chain,priv-chain' -n '*.example.com' --sans='*.example.com,example.com,*.example1.com,example1.com,*.example2.com,example2.com,*.example3.com,example3.com' --not-before='Jan 1 00:00:00 2000' --not-after='Jan 1 00:00:00 2100' -o 'Authelia' --organizational-unit 'Development'
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
# yaml-language-server: $schema=https://www.authelia.com/schemas/latest/json-schema/export.webauthn.json
# {"4c9219a1-0183-4bd3-b5a4-f5c76393dc09":{"credentials":[{"credentialId":"zoBGAEy968vwQe4AA7sTMbj2grpWyzWCZ8GqunMwiZs=","isResidentCredential":true,"rpId":"login.example.com","privateKey":"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgNcU6wDECTnNy3DMqC5T+IxtYCv7wRxHxtNvZZLoW8bqhRANCAARdgy+FhYhi4hqIjN7Im4ul0z8+PUwS12PpSJ+mzvweN7QlQx3LecibxIfKz+DH3iJfdp73jBhpqICGSHdKI7kE","userHandle":"QmNTN3syN2ZHanJlOjliN2QyMyx7KEViKTEkbik1YTVKbyRmaDFCfjBpaysvajYiN0k3ejhmOVk5cTBYclMsYg==","signCount":1}]}}
+4
View File
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2026 Authelia
#
# SPDX-License-Identifier: Apache-2.0
---
networks:
authelianet:
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
//go:build !externalsuites
// +build !externalsuites
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,2 +1,6 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
// Package suites implements the integration test suites and the utilities they share.
package suites
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
+4
View File
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2026 Authelia
//
// SPDX-License-Identifier: Apache-2.0
package suites
import (
Loaded 100 of 158 files, more files were not shown because too many files have changed in this diff. Show more