Skip to content

Conversation

tanberry
Copy link
Contributor

@tanberry tanberry commented Oct 14, 2025

This PR adds more content to the Docs about EAP PR 15702, adds mention of needing to use a proper CA certificate with EAP-TLS and the mTLS stage. Also a few random cleanups.

  • The documentation has been updated
  • The documentation has been formatted (make docs)

Tana M Berry added 2 commits October 13, 2025 22:41
@tanberry tanberry requested a review from a team as a code owner October 14, 2025 02:51
Copy link

netlify bot commented Oct 14, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 8138023
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/68f1489761505f00085a340a

Copy link

netlify bot commented Oct 14, 2025

Deploy Preview for authentik-integrations ready!

Name Link
🔨 Latest commit 8138023
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/68f14897571d640008975b18
😎 Deploy Preview https://deploy-preview-17419--authentik-integrations.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 14, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 8138023
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/68f14897ca62f200081355eb
😎 Deploy Preview https://deploy-preview-17419--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

codecov bot commented Oct 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.93%. Comparing base (274b002) to head (8138023).
⚠️ Report is 75 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17419      +/-   ##
==========================================
- Coverage   92.98%   92.93%   -0.05%     
==========================================
  Files         868      868              
  Lines       47841    47906      +65     
==========================================
+ Hits        44483    44522      +39     
- Misses       3358     3384      +26     
Flag Coverage Δ
e2e 45.20% <ø> (-0.11%) ⬇️
integration 23.18% <ø> (+<0.01%) ⬆️
unit 90.50% <ø> (-0.56%) ⬇️
unit-migrate 91.13% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines 119 to 121
:::info Use PKI for certificates
For certificates, we recommend using Public Key Infrastructure (PKI) with the mTLS stage. The PKI issues digital certificates to authenticate both the user and the server.
:::
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
:::info Use PKI for certificates
For certificates, we recommend using Public Key Infrastructure (PKI) with the mTLS stage. The PKI issues digital certificates to authenticate both the user and the server.
:::

I would remove this because it's redundant. All certificates are inherently and fundamentally PKI related. There's no such thing as a non-PKI certificate.

Copy link
Contributor Author

@tanberry tanberry Oct 14, 2025

Choose a reason for hiding this comment

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

How about this: "For certificates, ensure that you use a certificate created by a certificate authority, not a self-generated certificate."

Copy link

@cheggerdev cheggerdev Oct 14, 2025

Choose a reason for hiding this comment

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

Real certificates are always trusted. For EAP-TLS this means, any client can authenticate with real certificates. This is a security incident.
Therefore, self-generated client and server certificates should be provided via PKI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @cheggerdev I might need you and @BeryJu to hash this out... I thought I understood after talking to him that the requirement is that the two certificates (server and client) are proper CA certificates (not self-generated)... What exactly do you mean by PKI.. isn't, as @dewi-tik says above, practically all CA certs made with PKI? Do you feel we really need to specify PKI?

Maybe you could provide the exact phrasing that you would like to see us add, please?

Copy link

@cheggerdev cheggerdev Oct 15, 2025

Choose a reason for hiding this comment

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

:::warning Use of trusted Certificate Authority
For EAP-TLS, note that you should NOT use a globally known CA!
e.g. using a Verisign cert as a "known CA" means that ANYONE who has a certificate signed by them can authenticate via EAP-TLS! This is likely not what you want.
:::

:::info Client Certificate distribution
Using PKI is best practise to distribute client certificates.
:::

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK @cheggerdev and @BeryJu I used the above suggestion, plus a few key words from marc, and pushed the same note into both the mTLS and the RADIUS docs. Let me know if that works, or if further tweaks are needed.

Copy link
Contributor

github-actions bot commented Oct 14, 2025

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-813802372e85d41c54c4596c91c0f30437b7de8f
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-813802372e85d41c54c4596c91c0f30437b7de8f

Afterwards, run the upgrade commands from the latest release notes.

@BeryJu BeryJu changed the title website/docs: add more to EAP docs and add mention of using PKI website/docs: add more Radius EAP-TLS docs Oct 14, 2025
@tanberry tanberry changed the title website/docs: add more Radius EAP-TLS docs website/docs: add more RADIUS EAP-TLS docs Oct 15, 2025
tanberry and others added 4 commits October 15, 2025 14:01
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
Copy link

@cheggerdev cheggerdev left a comment

Choose a reason for hiding this comment

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

Very nice

@tanberry
Copy link
Contributor Author

Very nice

Thanks for your patience with our word-wrangling. ;-)

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