nginx/njs-acme

Allow for a custom hostname validator

Open

#25 opened on Jul 18, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (16 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (93 stars)
PR merge metrics
 (PR metrics pending)

Description

From @ivanitskiy:

here is an idea for you. let's have a callback on the client so users/developers can build their own validators (say they want to have allow list). from: https://github.com/auto-ssl/lua-resty-auto-ssl

auto_ssl:set("allow_domain", function(domain, auto_ssl, ssl_options, renewal)
  return ngx.re.match(domain, "^(example.com|example.net)$", "ijo")
end)

we can provide a default callback but allow people to make their own validations.

Contributor guide

Research direction
Examine the existing SSL certificate request flow and identify where a domain validation callback can be inserted. Look for existing configuration examples in the auto ssl library and adapt them to the njs acme module's architecture.
Tech stack
typescript
Domain
backendsecurity
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNJS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70