begriffs open source - ai-pg/blob - full-docs/src/sgml/html/oauth-validators.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 50. OAuth Validator Modules</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="archive-module-callbacks.html" title="49.2. Archive Module Callbacks" /><link rel="next" href="oauth-validator-design.html" title="50.1. Safely Designing a Validator Module" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">Chapter 50. OAuth Validator Modules</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="archive-module-callbacks.html" title="49.2. Archive Module Callbacks">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="server-programming.html" title="Part V. Server Programming">Up</a></td><th width="60%" align="center">Part V. Server Programming</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="oauth-validator-design.html" title="50.1. Safely Designing a Validator Module">Next</a></td></tr></table><hr /></div><div class="chapter" id="OAUTH-VALIDATORS"><div class="titlepage"><div><div><h2 class="title">Chapter 50. OAuth Validator Modules</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="oauth-validator-design.html">50.1. Safely Designing a Validator Module</a></span></dt><dd><dl><dt><span class="sect2"><a href="oauth-validator-design.html#OAUTH-VALIDATOR-DESIGN-RESPONSIBILITIES">50.1.1. Validator Responsibilities</a></span></dt><dt><span class="sect2"><a href="oauth-validator-design.html#OAUTH-VALIDATOR-DESIGN-GUIDELINES">50.1.2. General Coding Guidelines</a></span></dt><dt><span class="sect2"><a href="oauth-validator-design.html#OAUTH-VALIDATOR-DESIGN-USERMAP-DELEGATION">50.1.3. Authorizing Users (Usermap Delegation)</a></span></dt></dl></dd><dt><span class="sect1"><a href="oauth-validator-init.html">50.2. Initialization Functions</a></span></dt><dt><span class="sect1"><a href="oauth-validator-callbacks.html">50.3. OAuth Validator Callbacks</a></span></dt><dd><dl><dt><span class="sect2"><a href="oauth-validator-callbacks.html#OAUTH-VALIDATOR-CALLBACK-STARTUP">50.3.1. Startup Callback</a></span></dt><dt><span class="sect2"><a href="oauth-validator-callbacks.html#OAUTH-VALIDATOR-CALLBACK-VALIDATE">50.3.2. Validate Callback</a></span></dt><dt><span class="sect2"><a href="oauth-validator-callbacks.html#OAUTH-VALIDATOR-CALLBACK-SHUTDOWN">50.3.3. Shutdown Callback</a></span></dt></dl></dd></dl></div><a id="id-1.8.17.2" class="indexterm"></a><p>
   3   <span class="productname">PostgreSQL</span> provides infrastructure for creating
   4   custom modules to perform server-side validation of OAuth bearer tokens.
   5   Because OAuth implementations vary so wildly, and bearer token validation is
   6   heavily dependent on the issuing party, the server cannot check the token
   7   itself; validator modules provide the integration layer between the server
   8   and the OAuth provider in use.
   9  </p><p>
  10   OAuth validator modules must at least consist of an initialization function
  11   (see <a class="xref" href="oauth-validator-init.html" title="50.2. Initialization Functions">Section 50.2</a>) and the required callback for
  12   performing validation (see <a class="xref" href="oauth-validator-callbacks.html#OAUTH-VALIDATOR-CALLBACK-VALIDATE" title="50.3.2. Validate Callback">Section 50.3.2</a>).
  13  </p><div class="warning"><h3 class="title">Warning</h3><p>
  14    Since a misbehaving validator might let unauthorized users into the database,
  15    correct implementation is crucial for server safety. See
  16    <a class="xref" href="oauth-validator-design.html" title="50.1. Safely Designing a Validator Module">Section 50.1</a> for design considerations.
  17   </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="archive-module-callbacks.html" title="49.2. Archive Module Callbacks">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="server-programming.html" title="Part V. Server Programming">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="oauth-validator-design.html" title="50.1. Safely Designing a Validator Module">Next</a></td></tr><tr><td width="40%" align="left" valign="top">49.2. Archive Module Callbacks </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 50.1. Safely Designing a Validator Module</td></tr></table></div></body></html>