Ability to configure SAN/CN validation for client certificates is missing
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go
- Domain
- authentication, security
Research direction
Start in the linked config/http_config.go section around lines 819-823 and read the Prometheus HTTPS configuration documentation. Trace how client certificate validation is configured, then determine where a dns_name_regex option and its matching behavior would belong. Done means authorized client certificate identities can be restricted by the configured pattern rather than accepting every certificate signed by the CA.
Written by the indexing model from the issue text.
Description
Issue
Let's say I have a Prometheus server running, secured with TLS with a custom CA (that of my whole cluster).
Using the documentation at https://prometheus.io/docs/prometheus/latest/configuration/https/ I can specify that the server validates client certificates. However once that is configured, it will accept any certificate signed by the CA.
That is an issue because the safety levels of all the services that have certificates are not the same: some are more likely to be compromised than others.
And of course, it wouldn't be legitimate for some-random-maybe-compromised-service.example.com (even if we know it is that service thanks to the CA!) to access and export the Prometheus metrics.
Solving it
=> In order to avoid this, it should be possible not only to validate that the client certificate is signed by the CA, but that whoever it turns out to be thanks to that authentication is indeed authorized to connect to Prometheus.
Currently, the configuration does not seem to allow configuring that.
However, that also seems reasonably easy to enable:
It's just about adding the proper parameters here:
https://github.com/prometheus/common/blob/2f04d2ec94b96df44aa4f8a60ae9fb29d8512636/config/http_config.go#L819-L823
(Note however that in the article it tries to validate based on some connection data, whereas we just want to validate based on e.g. a regexp).
Implementation notes
I think it would be good to validate that by providing a dns_name_regex in the TLS configuration parameters, as that is both simple and very flexible (users can specify sets of services, wildcards, prefix/suffix factoring..., all while keeping the prometheus side of things very simple). Kafka has done the same for their mTLS configuration, where you can specify which role you get depending on regex.
- Dominant language
- Go
- Stars
- 297
- Forks
- 380
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 12
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from prometheus/common
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
prometheus/common#1051 ·
Maintainers usually reply within 2 days
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
prometheus/common#1023 ·
Maintainers usually reply within 2 days
-
expfmt: OpenMetrics 1.0 output with a unit that is not a name suffix fails the whole scrape in PrometheusPossibly taken @itsmeasadali claimed this 43 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 58/100
prometheus/common#1005 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
prometheus/common#876 · 1 comment ·
Maintainers usually reply within 2 days
-
Feature request: Add client_assertion field for oauth2 jwt-bearer grant typePossibly taken @alliasgher claimed this 220 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 68/100
prometheus/common#869 ·
Maintainers usually reply within 2 days
All issues in prometheus/common
Similar issues
-
Difficulty 2/5 Half a day Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
keyxmakerx/Chronicle#2616 ·
Maintainers usually reply within 1 day
-
tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
internal/mcp: an exported-but-empty env var is reported as configured but never injectedPossibly taken A pull request linked to this issue is open or already merged. Opengo good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day