Chapter 51. OAuth Validator Modules

Table of Contents

51.1. Safely Designing a Validator Module
51.1.1. Validator Responsibilities
51.1.2. General Coding Guidelines
51.1.3. Authorizing Users (Usermap Delegation)
51.2. Initialization Functions
51.3. OAuth Validator Callbacks
51.3.1. Startup Callback
51.3.2. Validate Callback
51.3.3. Shutdown Callback

PostgreSQL provides infrastructure for creating custom modules to perform server-side validation of OAuth bearer tokens. Because OAuth implementations vary so wildly, and bearer token validation is heavily dependent on the issuing party, the server cannot check the token itself; validator modules provide the integration layer between the server and the OAuth provider in use.

OAuth validator modules must at least consist of an initialization function (see Section 51.2) and the required callback for performing validation (see Section 51.3.2).

Warning

Since a misbehaving validator might let unauthorized users into the database, correct implementation is crucial for server safety. See Section 51.1 for design considerations.