Files
greptimedb/servers/postgres/auth_handler/index.html
T

6 lines
6.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `auth_handler` mod in crate `servers`."><title>servers::postgres::auth_handler - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="servers" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module auth_handler</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../servers/index.html">servers</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module auth_<wbr>handler</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In servers::<wbr>postgres</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">servers</a>::<wbr><a href="../index.html">postgres</a></div><h1>Module <span>auth_<wbr>handler</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/servers/postgres/auth_handler.rs.html#15-468">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.PgUserProviderSource.html" title="struct servers::postgres::auth_handler::PgUserProviderSource">PgUser<wbr>Provider<wbr>Source</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The [<code>AuthSource</code>] shared by pgwire’s cleartext and SCRAM mechanisms.
Stateless by design: it only holds the user provider, everything about
the current login arrives with each call, and the verified
[<code>UserInfoRef</code>] travels back to the startup handler as the source
identity, reported by [<code>AuthOutcome::Authenticated</code>].</dd><dt><a class="struct" href="struct.ZeroPidSecretKeyGenerator.html" title="struct servers::postgres::auth_handler::ZeroPidSecretKeyGenerator">Zero<wbr>PidSecret<wbr>KeyGenerator</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Query cancellation is not supported yet, so announce pid/secret key 0 as
before the <code>AuthDriver</code> adoption.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.DbResolution.html" title="enum servers::postgres::auth_handler::DbResolution">DbResolution</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="enum" href="enum.MechanismSelection.html" title="enum servers::postgres::auth_handler::MechanismSelection">Mechanism<wbr>Selection</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.record_auth_failure.html" title="fn servers::postgres::auth_handler::record_auth_failure">record_<wbr>auth_<wbr>failure</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.resolve_db_info.html" title="fn servers::postgres::auth_handler::resolve_db_info">resolve_<wbr>db_<wbr>info</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A function extracted to resolve lifetime and readability issues:</dd><dt><a class="fn" href="fn.send_error.html" title="fn servers::postgres::auth_handler::send_error">send_<wbr>error</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.send_password_authentication_failed.html" title="fn servers::postgres::auth_handler::send_password_authentication_failed">send_<wbr>password_<wbr>authentication_<wbr>failed</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.set_client_info.html" title="fn servers::postgres::auth_handler::set_client_info">set_<wbr>client_<wbr>info</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.to_scram_secret.html" title="fn servers::postgres::auth_handler::to_scram_secret">to_<wbr>scram_<wbr>secret</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>