Repository files navigation

A fast Traefik forward-auth server for validating Cloudflare Access requests

• Kani
  • What is Kani?
  • Why use Kani?
  • Getting started
  • Contributing
    • Contact
    • License
  • Acknowledgements
    • Supporters

Kani (カニ) (Pronunciation) means Crab inJapanese.I'm not entirely sure what I decided to use this name, but here we are.Kani is designed to be aTraefik ForwardAuth server forvalidatingCloudflare Access requests.

When a request is proxied through Cloudflare Access, a signed JWT token will be sent to the backend (Traefik in thiscase) as an HTTP header.Since the JWT token is signed, we can get the public keys from Cloudflare Access to validate that it was indeed issuedby Cloudflare Access.

We recommend using Kani when using Cloudflare Access to protect websites.Kani allows Traefik to validate that requests actually went through Cloudflare Access, preventing users from accessingthe page without going through Cloudflare Access.

See examples inexamples/.

If you would like to contribute to this project, please seeCONTRIBUTING.md.

If you want to contact the Kani Project maintainers, please use one of the following methods:

• Discord server (Ask questions here please - best response time)
• Emailoss@hypera.dev
• Emailsupport@hypera.dev
• Emailsecurity@hypera.dev (security-related matters only)

Kani is distributed under the terms of the MIT License.
For further details, please refer to theLICENSE file.

We are extremely grateful to theamazing individuals who have contributed to this project,as well as those who have supported us by providing valuable feedback and donations.

We would also like to thank all the individuals and companies who have supported us in sustainingthis project. We are grateful for their valuable contributions that have enabled us to continue toimprove Kani.

Please note that the individuals and companies listed under the "Supporters" section areindependent of this project, and their inclusion should not be interpreted as an endorsement oraffiliation.

We don't currently have any supporters for this project :(
If you would like to sponsor this project, pleasecontact us!