2021-01-16 10:25:02 +00:00
package suites
import (
2021-11-25 01:56:58 +00:00
"context"
"fmt"
2021-01-16 10:25:02 +00:00
"os"
2021-06-18 04:35:43 +00:00
"regexp"
2021-12-01 12:11:29 +00:00
"strconv"
2021-01-16 10:25:02 +00:00
"testing"
"github.com/stretchr/testify/suite"
2021-11-25 01:56:58 +00:00
2022-03-06 05:47:40 +00:00
"github.com/authelia/authelia/v4/internal/model"
2021-11-25 01:56:58 +00:00
"github.com/authelia/authelia/v4/internal/storage"
2021-01-16 10:25:02 +00:00
)
type CLISuite struct {
* CommandSuite
}
func NewCLISuite ( ) * CLISuite {
return & CLISuite { CommandSuite : new ( CommandSuite ) }
}
func ( s * CLISuite ) SetupSuite ( ) {
dockerEnvironment := NewDockerEnvironment ( [ ] string {
"internal/suites/docker-compose.yml" ,
"internal/suites/CLI/docker-compose.yml" ,
"internal/suites/example/compose/authelia/docker-compose.backend.{}.yml" ,
} )
s . DockerEnvironment = dockerEnvironment
}
func ( s * CLISuite ) SetupTest ( ) {
testArg := ""
coverageArg := ""
2021-12-01 03:32:58 +00:00
if os . Getenv ( "CI" ) == t {
2021-01-16 10:25:02 +00:00
testArg = "-test.coverprofile=/authelia/coverage-$(date +%s).txt"
coverageArg = "COVERAGE"
}
s . testArg = testArg
s . coverageArg = coverageArg
}
2021-06-18 04:35:43 +00:00
func ( s * CLISuite ) TestShouldPrintBuildInformation ( ) {
2022-04-04 23:57:47 +00:00
if os . Getenv ( "CI" ) == "false" {
s . T ( ) . Skip ( "Skipping testing in dev environment" )
}
2021-08-03 09:55:21 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "build-info" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2021-06-18 04:35:43 +00:00
s . Assert ( ) . Contains ( output , "Last Tag: " )
s . Assert ( ) . Contains ( output , "State: " )
s . Assert ( ) . Contains ( output , "Branch: " )
s . Assert ( ) . Contains ( output , "Build Number: " )
s . Assert ( ) . Contains ( output , "Build OS: " )
s . Assert ( ) . Contains ( output , "Build Arch: " )
s . Assert ( ) . Contains ( output , "Build Date: " )
r := regexp . MustCompile ( ` ^Last Tag: v\d+\.\d+\.\d+\nState: (tagged|untagged) (clean|dirty)\nBranch: [^\s\n]+\nCommit: [0-9a-f] { 40}\nBuild Number: \d+\nBuild OS: (linux|darwin|windows|freebsd)\nBuild Arch: (amd64|arm|arm64)\nBuild Date: (Sun|Mon|Tue|Wed|Thu|Fri|Sat), \d { 2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d { 4} \d { 2}:\d { 2}:\d { 2} [+-]\d { 4}\nExtra: \n ` )
s . Assert ( ) . Regexp ( r , output )
}
2021-01-16 23:23:35 +00:00
func ( s * CLISuite ) TestShouldPrintVersion ( ) {
2021-06-18 04:35:43 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "--version" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2021-06-18 04:35:43 +00:00
s . Assert ( ) . Contains ( output , "authelia version" )
2021-01-16 23:23:35 +00:00
}
2021-01-16 10:25:02 +00:00
func ( s * CLISuite ) TestShouldValidateConfig ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "validate-config" , "--config=/config/configuration.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . Contains ( output , "Configuration parsed and loaded successfully without errors." )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldFailValidateConfig ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "validate-config" , "--config=/config/invalid.yml" } )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "failed to load configuration from yaml file(/config/invalid.yml) source: open /config/invalid.yml: no such file or directory" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldHashPasswordArgon2id ( ) {
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "hash-password" , "test" , "-m" , "32" , "-s" , "test1234" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2021-01-16 10:25:02 +00:00
s . Assert ( ) . Contains ( output , "Password hash: $argon2id$v=19$m=32768,t=1,p=8" )
}
func ( s * CLISuite ) TestShouldHashPasswordSHA512 ( ) {
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "hash-password" , "test" , "-z" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2021-01-16 10:25:02 +00:00
s . Assert ( ) . Contains ( output , "Password hash: $6$rounds=50000" )
}
func ( s * CLISuite ) TestShouldGenerateCertificateRSA ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateRSAWithIPAddress ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=127.0.0.1" , "--dir=/tmp/" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateRSAWithStartDate ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--start-date='Jan 1 15:04:05 2011'" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldFailGenerateCertificateRSAWithStartDate ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--start-date=Jan" } )
2021-01-16 10:25:02 +00:00
s . Assert ( ) . NotNil ( err )
2021-08-03 09:55:21 +00:00
s . Assert ( ) . Contains ( output , "Failed to parse start date: parsing time \"Jan\" as \"Jan 2 15:04:05 2006\": cannot parse \"\" as \"2\"" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateCA ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--ca" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateEd25519 ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--ed25519" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldFailGenerateCertificateECDSA ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--ecdsa-curve=invalid" } )
2021-01-16 10:25:02 +00:00
s . Assert ( ) . NotNil ( err )
2021-08-03 09:55:21 +00:00
s . Assert ( ) . Contains ( output , "Failed to generate private key: unrecognized elliptic curve: \"invalid\"" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateECDSAP224 ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--ecdsa-curve=P224" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateECDSAP256 ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--ecdsa-curve=P256" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateECDSAP384 ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--ecdsa-curve=P384" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
func ( s * CLISuite ) TestShouldGenerateCertificateECDSAP521 ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "certificates" , "generate" , "--host=*.example.com" , "--dir=/tmp/" , "--ecdsa-curve=P521" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-04-04 23:57:47 +00:00
s . Assert ( ) . Contains ( output , "Certificate written to /tmp/cert.pem" )
s . Assert ( ) . Contains ( output , "Private Key written to /tmp/key.pem" )
2021-01-16 10:25:02 +00:00
}
2021-11-25 01:56:58 +00:00
func ( s * CLISuite ) TestStorageShouldShowErrWithoutConfig ( ) {
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "schema-info" } )
s . Assert ( ) . EqualError ( err , "exit status 1" )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . Contains ( output , "Error: storage: configuration for a 'local', 'mysql' or 'postgres' database must be provided, storage: option 'encryption_key' must is required\n" )
2021-11-25 01:56:58 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "history" } )
s . Assert ( ) . EqualError ( err , "exit status 1" )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . Contains ( output , "Error: storage: configuration for a 'local', 'mysql' or 'postgres' database must be provided, storage: option 'encryption_key' must is required\n" )
2021-11-25 01:56:58 +00:00
}
func ( s * CLISuite ) TestStorage00ShouldShowCorrectPreInitInformation ( ) {
2021-12-01 12:11:29 +00:00
_ = os . Remove ( "/tmp/db.sqlite3" )
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "schema-info" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
pattern := regexp . MustCompile ( ` ^Schema Version: N/A\nSchema Upgrade Available: yes - version \d+\nSchema Tables: N/A\nSchema Encryption Key: unsupported \(schema version\) ` )
s . Assert ( ) . Regexp ( pattern , output )
patternOutdated := regexp . MustCompile ( ` Error: schema is version \d+ which is outdated please migrate to version \d+ in order to use this command or use an older binary ` )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "export" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Regexp ( patternOutdated , output )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "change-key" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Regexp ( patternOutdated , output )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "check" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Could not check encryption key for validity. The schema version doesn't support encryption." )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "down" , "--target=0" , "--destroy-data" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Contains ( output , "Error: schema migration target version 0 is the same current version 0" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "up" , "--target=2147483640" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Contains ( output , "Error: schema up migration target version 2147483640 is greater then the latest version " )
s . Assert ( ) . Contains ( output , " which indicates it doesn't exist" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "history" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "No migration history is available for schemas that not version 1 or above.\n" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "list-up" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Storage Schema Migration List (Up)\n\nVersion\t\tDescription\n1\t\tInitial Schema\n" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "list-down" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Storage Schema Migration List (Down)\n\nNo Migrations Available\n" )
}
func ( s * CLISuite ) TestStorage01ShouldMigrateUp ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "up" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Require ( ) . NoError ( err )
pattern0 := regexp . MustCompile ( ` "Storage schema migration from \d+ to \d+ is being attempted" ` )
pattern1 := regexp . MustCompile ( ` "Storage schema migration from \d+ to \d+ is complete" ` )
s . Regexp ( pattern0 , output )
s . Regexp ( pattern1 , output )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "up" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Contains ( output , "Error: schema already up to date\n" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "history" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Migration History:\n\nID\tDate\t\t\t\tBefore\tAfter\tAuthelia Version\n" )
s . Assert ( ) . Contains ( output , "0\t1" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "list-up" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Storage Schema Migration List (Up)\n\nNo Migrations Available" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "list-down" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Storage Schema Migration List (Down)\n\nVersion\t\tDescription\n" )
s . Assert ( ) . Contains ( output , "1\t\tInitial Schema" )
}
func ( s * CLISuite ) TestStorage02ShouldShowSchemaInfo ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "schema-info" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-03-03 11:20:43 +00:00
s . Assert ( ) . Contains ( output , "Schema Version: " )
s . Assert ( ) . Contains ( output , "authentication_logs" )
s . Assert ( ) . Contains ( output , "identity_verification" )
s . Assert ( ) . Contains ( output , "duo_devices" )
s . Assert ( ) . Contains ( output , "user_preferences" )
s . Assert ( ) . Contains ( output , "migrations" )
s . Assert ( ) . Contains ( output , "encryption" )
s . Assert ( ) . Contains ( output , "encryption" )
s . Assert ( ) . Contains ( output , "webauthn_devices" )
s . Assert ( ) . Contains ( output , "totp_configurations" )
s . Assert ( ) . Contains ( output , "Schema Encryption Key: valid" )
2021-11-25 01:56:58 +00:00
}
func ( s * CLISuite ) TestStorage03ShouldExportTOTP ( ) {
2021-12-01 12:11:29 +00:00
storageProvider := storage . NewSQLiteProvider ( & storageLocalTmpConfig )
2021-11-25 01:56:58 +00:00
ctx := context . Background ( )
var (
2021-12-01 12:11:29 +00:00
err error
2021-11-25 01:56:58 +00:00
)
var (
expectedLines = make ( [ ] string , 0 , 3 )
expectedLinesCSV = make ( [ ] string , 0 , 4 )
output string
)
expectedLinesCSV = append ( expectedLinesCSV , "issuer,username,algorithm,digits,period,secret" )
2022-03-02 07:50:36 +00:00
testCases := [ ] struct {
2022-03-06 05:47:40 +00:00
config model . TOTPConfiguration
2022-03-02 07:50:36 +00:00
png bool
} {
2021-12-01 12:11:29 +00:00
{
2022-03-06 05:47:40 +00:00
config : model . TOTPConfiguration {
2022-03-02 07:50:36 +00:00
Username : "john" ,
Period : 30 ,
Digits : 6 ,
Algorithm : "SHA1" ,
} ,
2021-12-01 12:11:29 +00:00
} ,
{
2022-03-06 05:47:40 +00:00
config : model . TOTPConfiguration {
2022-03-02 07:50:36 +00:00
Username : "mary" ,
Period : 45 ,
Digits : 6 ,
Algorithm : "SHA1" ,
} ,
2021-12-01 12:11:29 +00:00
} ,
{
2022-03-06 05:47:40 +00:00
config : model . TOTPConfiguration {
2022-03-02 07:50:36 +00:00
Username : "fred" ,
Period : 30 ,
Digits : 8 ,
Algorithm : "SHA1" ,
} ,
2021-12-01 12:11:29 +00:00
} ,
{
2022-03-06 05:47:40 +00:00
config : model . TOTPConfiguration {
2022-03-02 07:50:36 +00:00
Username : "jone" ,
Period : 30 ,
Digits : 6 ,
Algorithm : "SHA512" ,
} ,
png : true ,
2021-12-01 12:11:29 +00:00
} ,
}
2021-11-25 01:56:58 +00:00
2022-03-02 07:50:36 +00:00
var (
2022-03-06 05:47:40 +00:00
config * model . TOTPConfiguration
2022-03-02 07:50:36 +00:00
fileInfo os . FileInfo
)
2021-11-25 01:56:58 +00:00
2022-03-02 07:50:36 +00:00
for _ , testCase := range testCases {
if testCase . png {
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "generate" , testCase . config . Username , "--period" , strconv . Itoa ( int ( testCase . config . Period ) ) , "--algorithm" , testCase . config . Algorithm , "--digits" , strconv . Itoa ( int ( testCase . config . Digits ) ) , "--path=/tmp/qr.png" , "--config=/config/configuration.storage.yml" } )
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , " and saved it as a PNG image at the path '/tmp/qr.png'" )
fileInfo , err = os . Stat ( "/tmp/qr.png" )
s . Assert ( ) . NoError ( err )
s . Require ( ) . NotNil ( fileInfo )
s . Assert ( ) . False ( fileInfo . IsDir ( ) )
s . Assert ( ) . Greater ( fileInfo . Size ( ) , int64 ( 1000 ) )
} else {
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "generate" , testCase . config . Username , "--period" , strconv . Itoa ( int ( testCase . config . Period ) ) , "--algorithm" , testCase . config . Algorithm , "--digits" , strconv . Itoa ( int ( testCase . config . Digits ) ) , "--config=/config/configuration.storage.yml" } )
s . Assert ( ) . NoError ( err )
}
config , err = storageProvider . LoadTOTPConfiguration ( ctx , testCase . config . Username )
2021-12-01 12:11:29 +00:00
s . Assert ( ) . NoError ( err )
2022-03-02 07:50:36 +00:00
2021-12-01 12:11:29 +00:00
s . Assert ( ) . Contains ( output , config . URI ( ) )
expectedLinesCSV = append ( expectedLinesCSV , fmt . Sprintf ( "%s,%s,%s,%d,%d,%s" , "Authelia" , config . Username , config . Algorithm , config . Digits , config . Period , string ( config . Secret ) ) )
expectedLines = append ( expectedLines , config . URI ( ) )
2021-11-25 01:56:58 +00:00
}
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "export" , "--format=uri" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
for _ , expectedLine := range expectedLines {
s . Assert ( ) . Contains ( output , expectedLine )
}
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "export" , "--format=csv" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
for _ , expectedLine := range expectedLinesCSV {
s . Assert ( ) . Contains ( output , expectedLine )
}
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "export" , "--format=wrong" , "--config=/config/configuration.storage.yml" } )
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Contains ( output , "Error: format must be csv, uri, or png" )
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "export" , "--format=png" , "--dir=/tmp/qr" , "--config=/config/configuration.storage.yml" } )
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Exported TOTP QR codes in PNG format in the '/tmp/qr' directory" )
for _ , testCase := range testCases {
fileInfo , err = os . Stat ( fmt . Sprintf ( "/tmp/qr/%s.png" , testCase . config . Username ) )
s . Assert ( ) . NoError ( err )
s . Require ( ) . NotNil ( fileInfo )
s . Assert ( ) . False ( fileInfo . IsDir ( ) )
s . Assert ( ) . Greater ( fileInfo . Size ( ) , int64 ( 1000 ) )
}
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "totp" , "generate" , "test" , "--period=30" , "--algorithm=SHA1" , "--digits=6" , "--path=/tmp/qr.png" , "--config=/config/configuration.storage.yml" } )
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Contains ( output , "Error: image output filepath already exists" )
2021-11-25 01:56:58 +00:00
}
func ( s * CLISuite ) TestStorage04ShouldChangeEncryptionKey ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "change-key" , "--new-encryption-key=apple-apple-apple-apple" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Completed the encryption key change. Please adjust your configuration to use the new key.\n" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "schema-info" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2022-03-03 11:20:43 +00:00
s . Assert ( ) . Contains ( output , "Schema Version: " )
s . Assert ( ) . Contains ( output , "authentication_logs" )
s . Assert ( ) . Contains ( output , "identity_verification" )
s . Assert ( ) . Contains ( output , "duo_devices" )
s . Assert ( ) . Contains ( output , "user_preferences" )
s . Assert ( ) . Contains ( output , "migrations" )
s . Assert ( ) . Contains ( output , "encryption" )
s . Assert ( ) . Contains ( output , "encryption" )
s . Assert ( ) . Contains ( output , "webauthn_devices" )
s . Assert ( ) . Contains ( output , "totp_configurations" )
s . Assert ( ) . Contains ( output , "Schema Encryption Key: invalid" )
2021-11-25 01:56:58 +00:00
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "check" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Encryption key validation: failed.\n\nError: the encryption key is not valid against the schema check value.\n" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "check" , "--verbose" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
2021-12-01 12:11:29 +00:00
s . Assert ( ) . Contains ( output , "Encryption key validation: failed.\n\nError: the encryption key is not valid against the schema check value, 4 of 4 total TOTP secrets were invalid.\n" )
2021-11-25 01:56:58 +00:00
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "check" , "--encryption-key=apple-apple-apple-apple" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Encryption key validation: success.\n" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "check" , "--verbose" , "--encryption-key=apple-apple-apple-apple" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
s . Assert ( ) . Contains ( output , "Encryption key validation: success.\n" )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "change-key" , "--encryption-key=apple-apple-apple-apple" , "--config=/config/configuration.storage.yml" } )
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Contains ( output , "Error: you must set the --new-encryption-key flag\n" )
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "encryption" , "change-key" , "--encryption-key=apple-apple-apple-apple" , "--new-encryption-key=abc" , "--config=/config/configuration.storage.yml" } )
s . Assert ( ) . EqualError ( err , "exit status 1" )
s . Assert ( ) . Contains ( output , "Error: the new encryption key must be at least 20 characters\n" )
2021-11-25 01:56:58 +00:00
}
func ( s * CLISuite ) TestStorage05ShouldMigrateDown ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "storage" , "migrate" , "down" , "--target=0" , "--destroy-data" , "--config=/config/configuration.storage.yml" } )
2021-11-25 01:56:58 +00:00
s . Assert ( ) . NoError ( err )
pattern0 := regexp . MustCompile ( ` "Storage schema migration from \d+ to \d+ is being attempted" ` )
pattern1 := regexp . MustCompile ( ` "Storage schema migration from \d+ to \d+ is complete" ` )
s . Regexp ( pattern0 , output )
s . Regexp ( pattern1 , output )
}
2022-02-28 03:15:01 +00:00
func ( s * CLISuite ) TestACLPolicyCheckVerbose ( ) {
2022-03-02 07:50:36 +00:00
output , err := s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "access-control" , "check-policy" , "--url=https://public.example.com" , "--verbose" , "--config=/config/configuration.yml" } )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . NoError ( err )
// This is an example of `authelia access-control check-policy --config .\internal\suites\CLI\configuration.yml --url=https://public.example.com --verbose`.
s . Contains ( output , "Performing policy check for request to 'https://public.example.com' method 'GET'.\n\n" )
s . Contains ( output , " #\tDomain\tResource\tMethod\tNetwork\tSubject\n" )
s . Contains ( output , "* 1\thit\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 2\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 3\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 4\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 5\tmiss\tmiss\t\thit\thit\thit\n" )
s . Contains ( output , " 6\tmiss\thit\t\tmiss\thit\thit\n" )
s . Contains ( output , " 7\tmiss\thit\t\thit\tmiss\thit\n" )
s . Contains ( output , " 8\tmiss\thit\t\thit\thit\tmay\n" )
s . Contains ( output , " 9\tmiss\thit\t\thit\thit\tmay\n" )
s . Contains ( output , "The policy 'bypass' from rule #1 will be applied to this request." )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "access-control" , "check-policy" , "--url=https://admin.example.com" , "--method=HEAD" , "--username=tom" , "--groups=basic,test" , "--ip=192.168.2.3" , "--verbose" , "--config=/config/configuration.yml" } )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . NoError ( err )
// This is an example of `authelia access-control check-policy --config .\internal\suites\CLI\configuration.yml --url=https://admin.example.com --method=HEAD --username=tom --groups=basic,test --ip=192.168.2.3 --verbose`.
s . Contains ( output , "Performing policy check for request to 'https://admin.example.com' method 'HEAD' username 'tom' groups 'basic,test' from IP '192.168.2.3'.\n\n" )
s . Contains ( output , " #\tDomain\tResource\tMethod\tNetwork\tSubject\n" )
s . Contains ( output , " #\tDomain\tResource\tMethod\tNetwork\tSubject\n" )
s . Contains ( output , " 1\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , "* 2\thit\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 3\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 4\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 5\tmiss\tmiss\t\thit\thit\thit\n" )
s . Contains ( output , " 6\tmiss\thit\t\tmiss\thit\thit\n" )
s . Contains ( output , " 7\tmiss\thit\t\thit\tmiss\thit\n" )
s . Contains ( output , " 8\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 9\tmiss\thit\t\thit\thit\tmiss\n" )
s . Contains ( output , "The policy 'two_factor' from rule #2 will be applied to this request." )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "access-control" , "check-policy" , "--url=https://resources.example.com/resources/test" , "--method=POST" , "--username=john" , "--groups=admin,test" , "--ip=192.168.1.3" , "--verbose" , "--config=/config/configuration.yml" } )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . NoError ( err )
// This is an example of `authelia access-control check-policy --config .\internal\suites\CLI\configuration.yml --url=https://resources.example.com/resources/test --method=POST --username=john --groups=admin,test --ip=192.168.1.3 --verbose`.
s . Contains ( output , "Performing policy check for request to 'https://resources.example.com/resources/test' method 'POST' username 'john' groups 'admin,test' from IP '192.168.1.3'.\n\n" )
s . Contains ( output , " #\tDomain\tResource\tMethod\tNetwork\tSubject\n" )
s . Contains ( output , " 1\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 2\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 3\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 4\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , "* 5\thit\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 6\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 7\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 8\tmiss\thit\t\thit\thit\tmiss\n" )
s . Contains ( output , " 9\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , "The policy 'one_factor' from rule #5 will be applied to this request." )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "access-control" , "check-policy" , "--url=https://user.example.com/resources/test" , "--method=HEAD" , "--username=john" , "--groups=admin,test" , "--ip=192.168.1.3" , "--verbose" , "--config=/config/configuration.yml" } )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . NoError ( err )
// This is an example of `access-control check-policy --config .\internal\suites\CLI\configuration.yml --url=https://user.example.com --method=HEAD --username=john --groups=admin,test --ip=192.168.1.3 --verbose`.
s . Contains ( output , "Performing policy check for request to 'https://user.example.com/resources/test' method 'HEAD' username 'john' groups 'admin,test' from IP '192.168.1.3'.\n\n" )
s . Contains ( output , " #\tDomain\tResource\tMethod\tNetwork\tSubject\n" )
s . Contains ( output , " 1\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 2\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 3\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 4\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 5\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 6\tmiss\thit\t\tmiss\thit\thit\n" )
s . Contains ( output , " 7\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 8\tmiss\thit\t\thit\thit\tmiss\n" )
s . Contains ( output , "* 9\thit\thit\t\thit\thit\thit\n" )
s . Contains ( output , "The policy 'one_factor' from rule #9 will be applied to this request." )
2022-03-02 07:50:36 +00:00
output , err = s . Exec ( "authelia-backend" , [ ] string { "authelia" , s . testArg , s . coverageArg , "access-control" , "check-policy" , "--url=https://user.example.com" , "--method=HEAD" , "--ip=192.168.1.3" , "--verbose" , "--config=/config/configuration.yml" } )
2022-02-28 03:15:01 +00:00
s . Assert ( ) . NoError ( err )
// This is an example of `authelia access-control check-policy --config .\internal\suites\CLI\configuration.yml --url=https://user.example.com --method=HEAD --ip=192.168.1.3 --verbose`.
s . Contains ( output , "Performing policy check for request to 'https://user.example.com' method 'HEAD' from IP '192.168.1.3'.\n\n" )
s . Contains ( output , " #\tDomain\tResource\tMethod\tNetwork\tSubject\n" )
s . Contains ( output , " 1\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 2\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 3\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 4\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 5\tmiss\tmiss\t\thit\thit\thit\n" )
s . Contains ( output , " 6\tmiss\thit\t\tmiss\thit\thit\n" )
s . Contains ( output , " 7\tmiss\thit\t\thit\thit\thit\n" )
s . Contains ( output , " 8\tmiss\thit\t\thit\thit\tmay\n" )
s . Contains ( output , "~ 9\thit\thit\t\thit\thit\tmay\n" )
s . Contains ( output , "The policy 'one_factor' from rule #9 will potentially be applied to this request. Otherwise the policy 'bypass' from the default policy will be." )
}
2021-01-16 10:25:02 +00:00
func TestCLISuite ( t * testing . T ) {
2021-03-14 07:08:26 +00:00
if testing . Short ( ) {
t . Skip ( "skipping suite test in short mode" )
}
2021-01-16 10:25:02 +00:00
suite . Run ( t , NewCLISuite ( ) )
}