truecharts/charts/stable/traefik-forward-auth/docs/how-to.md at f90b46ec531c5b97d5acaad3f45179cf30d5a737

Files

T

Stavros KoisandGitHub 698622495c chore(docs): standardize ./img references (#16704 )

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

2023-12-31 22:39:31 +02:00

3.1 KiB

Raw Blame History

title

title
traefik-forward-auth

This app makes it possible to have a layer of security in front of your publicly exposed apps. It supports Google, OIDC, and generic OAuth2. Please read the GitHub README of the original project for your authentication options.

Note: generally, phone apps do not support redirection during their authentication flow, so this middleware is more suitable for protecting portals that you would access through a browser.

A standard setup (auth host mode)

This method will add a middleware to the traefik instance with Google authentication which then you can apply on any apps with either subdomain or path prefix Ingress rules. The example domain will be https://example.com which should be substituted to your externally accessible domain name.

Setting up traefik-forward-auth

Assuming you have set up the Client ID for Web application in the developer console and set the Authorized redirect URIs to https://auth.example.com/_oauth, start installing traefik-forward-auth:

Set a Secret (it's mandatory, but can be any string of your choosing).
Set Auth host to auth.example.com.
Add your email to Whitelist.

Add your root domain to Cookie options.

Set the Client ID and Client Secret to the ones presented on the developer console. Prompt can be left empty.

Set up Ingress for the app as auth.example.com as usual.
That's it, since this is a stateless program, it doesn't need any special permissions or storage.

Creating the middleware on traefik

The traefik instance has to be made aware of the forward authentication. Edit your traefik installation:

Go to websecure entrypoint and enable Accept forwarded headers.
Add your default gateway (internal router IP) to Trusted IPs if using hairpin NAT. If you are using DNS override for your domain name, you can probably skip this step.

Go to Middlewares and add a forward-auth one.
Name it (use a short one if planning to add to many apps).
Add https://auth.example.com/_oauth as address. This will redirect initial requests to the traefik-forward-auth container.
Check trustForwardHeader.
Add X-Forwarded-User to authResponseHeaders.

Applying the middleware on apps

To actually use the forward authentication, you have to add it to either a chain or by itself to existing app Ingresses.

Per-app whitelist

In case you need per-app whitelists, you have two options: set up multiple instances of traefik-forward-auth (cumbersome) or use custom rules. Consult the readme of the original project how to set them.

Testing

Opening your URL should result in being redirected to Google authentication. Subsequent checks if the auth is working can be made by opening an incognito window.

3.1 KiB Raw Blame History