Skip to content

PG-2238 - Add the OIDC topic#930

Open
Andriciuc wants to merge 6 commits into18from
add-oidc-validator-topic
Open

PG-2238 - Add the OIDC topic#930
Andriciuc wants to merge 6 commits into18from
add-oidc-validator-topic

Conversation

@Andriciuc
Copy link
Copy Markdown
Contributor

This PR reorganizes the authentication methods in Solutions, adding a folder to future proof the authentication methods, and adds the OIDC topic.

This PR reorganizes the authentication methods in Solutions, adding a folder to future proof the authentication methods, and adds the OIDC topic.
- add content to oidc, which includes beginner explanations for authentication flow, why use OIDC and standard setup from the PG side.
- Add buttons to overview, and add a lot of links to the oidc chapter for all of our sources.
Comment thread docs/solutions/authentication/oidc.md Outdated
Comment thread docs/solutions/authentication/oidc.md Outdated
Comment thread docs/solutions/authentication/oidc.md Outdated
Comment thread docs/solutions/authentication/oidc.md Outdated
Comment thread docs/solutions/authentication/oidc.md Outdated
Comment thread docs/solutions/authentication/overview.md Outdated
- Proper installation steps, updated step 1 with readme info and remove step 2
- Reordered TOC to put OIDC first
- create a snippet folder with proper oidc authentication flow which can be modified any time to render immediately as opposed to having an svg, using mermaid.
- standardize the external identity providers, making a list of them is too bloaty.
Copy link
Copy Markdown

@dutow dutow left a comment

Choose a reason for hiding this comment

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

Is the oidc-auth-flow.svg still needed?


1. Install the `pg_oidc_validator` package.

Pre-built packages are not available in the default system repositories.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I thought we include it in our distribution? My previous comment was just about PGDG packages, as I don't think we build it for PGDG in our repositories.


Pre-built packages are not available in the default system repositories.

You can download pre-built packages from the `pg_oidc_validator` project (see the project releases page):
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Those are nightly builds, we shouldn't mention/recommend them in our documentation. (also, those DO build againts PGDG, not our distribution)

3. Add an OAuth authentication rule to `pg_hba.conf`:

```ini
host all all 192.168.1.0/24 oauth scope="openid",issuer=https://your-oidc-provider
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

please use a custom scope in the example, not a generic one like openid

* `issuer` is the URL of the OIDC identity provider

!!! important
PostgreSQL does not issue OIDC tokens. Clients must obtain an access token from an external identity provider before connecting.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

i don't understand this sentence, of course it doesn't because it's not an oidc provider, but the "before connecting" part also isn't strictly true, because clients like psql handle this automatically during the connection process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants