1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2024-11-30 09:16:52 +02:00
oauth2-proxy/docs
Jakub Holy 1961424561
Feature/configurable userid claim minimal (#499)
* Add -user-id-claim to support other claims than email

Fix #431 - This is a minimal change to allow the user to configure which claim is
the source of the "user ID".

- Add the option `user-id-claim` (defaults to email)
- OIDC extracts this claim into session.Email (to be renamed later)
- providers: add `CreateSessionStateFromBearerToken` with a default impl taken from
  `GetJwtSession` and overridden by oidc to respect `user-id-claim`

Once #466 is merged, I can continue to rename SessionState.Email to .UserID
and add HTTP headers with a corresponding name.

* Apply suggestions from code review

Co-Authored-By: Joel Speed <Joel.speed@hotmail.co.uk>

* Review feedback: Don't extract claims manually

Instead, parse them twice - it might be sligtly slower but less bug-prone as the code evolves.

* Fix indentation

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>
2020-04-28 07:46:46 +01:00
..
assets/js Initialise Jekyll site 2019-05-09 10:48:35 +01:00
configuration Feature/configurable userid claim minimal (#499) 2020-04-28 07:46:46 +01:00
logos Add logos to docs folder 2019-10-30 09:57:24 +00:00
_config.yml Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
.gitignore Initialise Jekyll site 2019-05-09 10:48:35 +01:00
0_index.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
1_installation.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
2_auth.md Update okta doc (#481) 2020-04-08 21:28:00 +01:00
4_tls.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
5_endpoints.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
6_request_signatures.md Fix links in docs 2019-08-11 16:07:03 +01:00
404.html Initialise Jekyll site 2019-05-09 10:48:35 +01:00
Gemfile Initialise Jekyll site 2019-05-09 10:48:35 +01:00
Gemfile.lock Update docs deps 2020-03-29 17:34:17 +01:00
Makefile Add make targets for serving docs locally 2019-05-10 12:07:16 +01:00
README.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00

Docs

This folder contains our Jekyll based docs site which is hosted at https://oauth2-proxy.github.io/oauth2-proxy.

When making changes to this docs site, please test your changes locally:

docs$ make serve

To run the docs site locally you will need Ruby at version 2.1.0 or higher and bundle (gem install bundler if you already have Ruby).