Skip to content

Provide a default template when none exists #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joecorall merged 2 commits into from
Feb 21, 2025
Merged

Provide a default template when none exists #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b186f2d
Provide a default template when none exists
joecorall Feb 21, 2025
5369045
Do not provide a default template in the integration test
joecorall Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ services:
traefik.http.routers.nginx.rule: Host(`localhost`)
traefik.http.services.nginx.loadbalancer.server.port: 80
traefik.http.routers.nginx.middlewares: captcha-protect@docker
traefik.http.middlewares.captcha-protect.plugin.captcha-protect.challengeTmpl: /plugins-local/src/github.com/libops/captcha-protect/challenge.tmpl.html
traefik.http.middlewares.captcha-protect.plugin.captcha-protect.captchaProvider: turnstile
traefik.http.middlewares.captcha-protect.plugin.captcha-protect.window: 120
traefik.http.middlewares.captcha-protect.plugin.captcha-protect.rateLimit: ${RATE_LIMIT}
Expand Down
60 changes: 50 additions & 10 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ type CaptchaProtect struct {
botCache *lru.Cache
captchaConfig CaptchaConfig
exemptIps []*net.IPNet
tmpl *template.Template
}

type CaptchaConfig struct {
Expand Down Expand Up @@ -113,10 +114,21 @@ func New(ctx context.Context, next http.Handler, config *Config, name string) (h
return nil, fmt.Errorf("you must protect at least one route with the protectRoutes config value. / will cover your entire site")
}

var tmpl *template.Template
if _, err := os.Stat(config.ChallengeTmpl); os.IsNotExist(err) {
return nil, fmt.Errorf("template file does not exist: %s", config.ChallengeTmpl)
log.Warn("Unable to find template file. Using default template.", "challengeTmpl", config.ChallengeTmpl)
ts := getDefaultTmpl()
tmpl, err = template.New("challenge").Parse(ts)
if err != nil {
return nil, fmt.Errorf("unable to parse challenge template: %v", err)
}
} else if err != nil {
return nil, fmt.Errorf("error check for template file %s: %v", config.ChallengeTmpl, err)
return nil, fmt.Errorf("error checking for template file %s: %v", config.ChallengeTmpl, err)
} else {
tmpl, err = template.ParseFiles(config.ChallengeTmpl)
if err != nil {
return nil, fmt.Errorf("unable to parse challenge template file %s: %v", config.ChallengeTmpl, err)
}
}

// transform exempt IP strings into what go can easily parse (net.IPNet)
Expand All @@ -137,6 +149,7 @@ func New(ctx context.Context, next http.Handler, config *Config, name string) (h
botCache: lru.New(expiration, 1*time.Hour),
verifiedCache: lru.New(expiration, 1*time.Hour),
exemptIps: ips,
tmpl: tmpl,
}

// set the captcha config based on the provider
Expand Down Expand Up @@ -213,21 +226,14 @@ func (bc *CaptchaProtect) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
}

func (bc *CaptchaProtect) serveChallengePage(rw http.ResponseWriter, req *http.Request) {
tmpl, err := template.ParseFiles(bc.config.ChallengeTmpl)
if err != nil {
log.Error("Unable to parse go template", "tmpl", bc.config.ChallengeTmpl, "err", err)
http.Error(rw, "Internal error", http.StatusInternalServerError)
return
}

d := map[string]string{
"SiteKey": bc.config.SiteKey,
"FrontendJS": bc.captchaConfig.js,
"FrontendKey": bc.captchaConfig.key,
"ChallengeURL": bc.config.ChallengeURL,
"Destination": req.URL.Query().Get("destination"),
}
err = tmpl.Execute(rw, d)
err := bc.tmpl.Execute(rw, d)
if err != nil {
log.Error("Unable to execute go template", "tmpl", bc.config.ChallengeTmpl, "err", err)
http.Error(rw, "Internal error", http.StatusInternalServerError)
Expand Down Expand Up @@ -579,3 +585,37 @@ func (bc *CaptchaProtect) loadState() {

log.Info("Loaded previous state")
}

func getDefaultTmpl() string {
return `<html>
<head>
<title>Verifying connection</title>
<script src="{{ .FrontendJS }}" async defer referrerpolicy="no-referrer"></script>
</head>
<body>
<h1>Verifying connection</h1>
<p>One moment while we verify your network connection.</p>
<form action="{{ .ChallengeURL }}" method="post" id="captcha-form" accept-charset="UTF-8">
<div
data-callback="captchaCallback"
class="{{ .FrontendKey }}"
data-sitekey="{{ .SiteKey }}"
data-theme="auto"
data-size="normal"
data-language="auto"
data-retry="auto"
interval="8000"
data-appearance="always">
</div>
<input type="hidden" name="destination" value="{{ .Destination }}">
</form>
<script type="text/javascript">
function captchaCallback(token) {
setTimeout(function() {
document.getElementById("captcha-form").submit();
}, 1000);
}
</script>
</body>
</html>`
}