oauth: Move the builtin flow into a separate module
authorJacob Champion <[email protected]>
Thu, 1 May 2025 16:14:30 +0000 (09:14 -0700)
committerJacob Champion <[email protected]>
Thu, 1 May 2025 16:14:30 +0000 (09:14 -0700)
commitb0635bfda0535a7fc36cd11d10eecec4e2a96330
tree13a39de30ba014942dc006a023102a6d9bf2fa51
parenta3ef0b570c56f7bb15e4aa5caf0125fff92a557a
oauth: Move the builtin flow into a separate module

The additional packaging footprint of the OAuth Curl dependency, as well
as the existence of libcurl in the address space even if OAuth isn't
ever used by a client, has raised some concerns. Split off this
dependency into a separate loadable module called libpq-oauth.

When configured using --with-libcurl, libpq.so searches for this new
module via dlopen(). End users may choose not to install the libpq-oauth
module, in which case the default flow is disabled.

For static applications using libpq.a, the libpq-oauth staticlib is a
mandatory link-time dependency for --with-libcurl builds. libpq.pc has
been updated accordingly.

The default flow relies on some libpq internals. Some of these can be
safely duplicated (such as the SIGPIPE handlers), but others need to be
shared between libpq and libpq-oauth for thread-safety. To avoid
exporting these internals to all libpq clients forever, these
dependencies are instead injected from the libpq side via an
initialization function. This also lets libpq communicate the offsets of
PGconn struct members to libpq-oauth, so that we can function without
crashing if the module on the search path came from a different build of
Postgres. (A minor-version upgrade could swap the libpq-oauth module out
from under a long-running libpq client before it does its first load of
the OAuth flow.)

This ABI is considered "private". The module has no SONAME or version
symlinks, and it's named libpq-oauth-<major>.so to avoid mixing and
matching across Postgres versions. (Future improvements may promote this
"OAuth flow plugin" to a first-class concept, at which point we would
need a public API to replace this anyway.)

Additionally, NLS support for error messages in b3f0be788a was
incomplete, because the new error macros weren't being scanned by
xgettext. Fix that now.

Per request from Tom Lane and Bruce Momjian. Based on an initial patch
by Daniel Gustafsson, who also contributed docs changes. The "bare"
dlopen() concept came from Thomas Munro. Many people reviewed the design
and implementation; thank you!

Co-authored-by: Daniel Gustafsson <[email protected]>
Reviewed-by: Andres Freund <[email protected]>
Reviewed-by: Christoph Berg <[email protected]>
Reviewed-by: Daniel Gustafsson <[email protected]>
Reviewed-by: Jelte Fennema-Nio <[email protected]>
Reviewed-by: Peter Eisentraut <[email protected]>
Reviewed-by: Wolfgang Walther <[email protected]>
Discussion: https://postgr.es/m/641687.1742360249%40sss.pgh.pa.us
25 files changed:
config/programs.m4
configure
configure.ac
doc/src/sgml/installation.sgml
doc/src/sgml/libpq.sgml
meson.build
src/Makefile.global.in
src/interfaces/Makefile
src/interfaces/libpq-oauth/Makefile [new file with mode: 0644]
src/interfaces/libpq-oauth/README [new file with mode: 0644]
src/interfaces/libpq-oauth/exports.txt [new file with mode: 0644]
src/interfaces/libpq-oauth/meson.build [new file with mode: 0644]
src/interfaces/libpq-oauth/oauth-curl.c [moved from src/interfaces/libpq/fe-auth-oauth-curl.c with 94% similarity]
src/interfaces/libpq-oauth/oauth-curl.h [new file with mode: 0644]
src/interfaces/libpq-oauth/oauth-utils.c [new file with mode: 0644]
src/interfaces/libpq-oauth/oauth-utils.h [new file with mode: 0644]
src/interfaces/libpq/Makefile
src/interfaces/libpq/exports.txt
src/interfaces/libpq/fe-auth-oauth.c
src/interfaces/libpq/fe-auth-oauth.h
src/interfaces/libpq/meson.build
src/interfaces/libpq/nls.mk
src/makefiles/meson.build
src/test/modules/oauth_validator/meson.build
src/test/modules/oauth_validator/t/002_client.pl