Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add troubleshooting option for openid-connect #11892

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add troubleshooting option for openid-connect #11892

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/en/latest/plugins/openid-connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,21 @@ upstream sent too big header while reading response header from upstream

If so, try adjusting `proxy_buffers`, `proxy_buffer_size`, and `proxy_busy_buffers_size` to larger values.

Another option is to set the `session_content` attribute:

```yaml
openid-connect:
...
bearer_only: false
# this comes from https://github.com/zmartzone/lua-resty-openidc, if this is missing, all information will be stored in the session. This
# causes the cookies to be too large and the request to fail. We have control over id_token, user, enc_id_token, and access_token.
# We currently include only access_token in the session. If this gets too big we can remove it as well.
Copy link
Member

Choose a reason for hiding this comment

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

Could you simplify the comment to

# use session_contents option to configure which information among id_token, user, enc_id_token, and access_token, get stored.

and add the same doc update to the Chinese doc?

session_contents:
access_token: true
Copy link
Member

Choose a reason for hiding this comment

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

Technically this is an attribute that was previously not explicitly exposed, so should be also be added to attribute section of the doc; as well as to the plugin schema in the source code (relevant tests need to be updated as well) 💭 cc: @juzhiyuan

session:
secret: "NTgzZWY1MzAtOTcyNi00MzA5LWI1MjItNjFhMzI2NzRkZWQxCg==" # used `uuidgen|base64` to generate this secret
```

#### 5. Invalid Client Secret

Verify if `client_secret` is valid and correct. An invalid `client_secret` would lead to an authentication failure and no token shall be returned and stored in session.
Loading