Skip to content

Add OTLP client certificate auth details to dashboard config#703

Merged
JamesNK merged 2 commits intomainfrom
docs/otlp-client-cert-auth
Apr 11, 2026
Merged

Add OTLP client certificate auth details to dashboard config#703
JamesNK merged 2 commits intomainfrom
docs/otlp-client-cert-auth

Conversation

@JamesNK
Copy link
Copy Markdown
Member

@JamesNK JamesNK commented Apr 11, 2026

Ports changes from dotnet/docs-aspire#5196 to the dashboard configuration page.

Changes

  • Updated client certificate authentication description with detailed validation info
  • Added AllowedCertificates and CertificateAuthenticationOptions configuration options to the OTLP table
  • Added new "Allowed certificates" subsection with:
    • Properties table (Thumbprint)
    • JSON configuration example
    • Environment variable configuration example
    • Note about default behavior when no allowed certificates are configured

- Add client certificate authentication validation description
- Add AllowedCertificates and CertificateAuthenticationOptions config options
- Add Allowed certificates subsection with examples
- Port changes from dotnet/docs-aspire#5196
Copilot AI review requested due to automatic review settings April 11, 2026 09:24
@JamesNK JamesNK requested a review from IEvangelist as a code owner April 11, 2026 09:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Aspire dashboard OTLP configuration documentation to better describe client certificate authentication and add configuration details for certificate allowlisting and certificate authentication options.

Changes:

  • Expanded OTLP client certificate authentication text with details about ASP.NET Core validation and optional allowlisting.
  • Added Dashboard:Otlp:AllowedCertificates and Dashboard:Otlp:CertificateAuthOptions:* to the OTLP configuration options table.
  • Added a new “Allowed certificates” subsection with property details and JSON/env-var configuration examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Client certificate authentication validates the TLS connection's client certificate. When a request with a client certificate is received, two sets of validation are performed:

- **ASP.NET Core certificate authentication validation:** By default this verifies that the certificate chains to a trusted root on the machine, the certificate hasn't expired, and that its Extended Key Usage value is appropriate for Client Authentication. For more information on this validation and how to configure it, see [Configure ASP.NET Core certificate validation](https://learn.microsoft.com/aspnet/core/security/authentication/certauth#configure-certificate-validation).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we instead point people at a doc in aspire.dev using the aspire cert command.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this is different. This is about authenticating client cert.

@JamesNK JamesNK merged commit 2b3675a into main Apr 11, 2026
5 checks passed
@JamesNK JamesNK deleted the docs/otlp-client-cert-auth branch April 11, 2026 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants