ClientAuthentication_hook

Description

Hook for plugins to get control in ClientAuthentication()

Interface type

ClientAuthentication_hook_type

Header

src/include/libpq/auth.h

Subsystem

Authentication and connections

Initial value

NULL (no hook installed)

C interface

typedef void (*ClientAuthentication_hook_type) (Port *, int);
extern PGDLLIMPORT ClientAuthentication_hook_type ClientAuthentication_hook;

Core source comments

This hook allows plugins to get control following client authentication, but before the user has been informed about the results. It could be used to record login events, insert a delay after failed authentication, etc.

Call sites

src/backend/libpq/auth.c:664

Core call context: src/backend/libpq/auth.c:658–672

					   "(%s:%d)",
					   port->user_name, hba_authname(port->hba->auth_method),
					   port->hba->sourcefile, port->hba->linenumber));
	}

	if (ClientAuthentication_hook)
		(*ClientAuthentication_hook) (port, status);

	if (status == STATUS_OK)
		sendAuthRequest(port, AUTH_REQ_OK, NULL, 0);
	else
		auth_failed(port, status, logdetail);
}

Documentation and source

• Interface declaration
• Core definition
• Call sites

Compare versions

PostgreSQL 17 → 18: unchanged.

Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.

Related entries

• check_password_hookcheck_password_hook
• ldap_password_hookldap_password_hook
• openssl_tls_init_hookopenssl_tls_init_hook