Files
greptimedb/auth/common/index.html
T

3 lines
9.6 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 `common` mod in crate `auth`."><title>auth::common - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="auth" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 common</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../auth/index.html">auth</a><span class="version">1.3.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module common</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="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate auth</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">auth</a></div><h1>Module <span>common</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/auth/common.rs.html#15-551">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.PgScramSha256Verifier.html" title="struct auth::common::PgScramSha256Verifier">PgScram<wbr>Sha256<wbr>Verifier</a></dt></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.Identity.html" title="enum auth::common::Identity">Identity</a></dt><dt><a class="enum" href="enum.Password.html" title="enum auth::common::Password">Password</a></dt><dd>Authentication information sent by the client.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.DEFAULT_PBKDF2_SHA256_ITERATIONS.html" title="constant auth::common::DEFAULT_PBKDF2_SHA256_ITERATIONS">DEFAULT_<wbr>PBKD<wbr>F2_<wbr>SHA256_<wbr>ITERATIONS</a></dt><dt><a class="constant" href="constant.DEFAULT_PBKDF2_SHA256_SALT_LEN.html" title="constant auth::common::DEFAULT_PBKDF2_SHA256_SALT_LEN">DEFAULT_<wbr>PBKD<wbr>F2_<wbr>SHA256_<wbr>SALT_<wbr>LEN</a></dt><dt><a class="constant" href="constant.DEFAULT_USERNAME.html" title="constant auth::common::DEFAULT_USERNAME">DEFAULT_<wbr>USERNAME</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.MAX_PBKDF2_SHA256_ITERATIONS.html" title="constant auth::common::MAX_PBKDF2_SHA256_ITERATIONS">MAX_<wbr>PBKD<wbr>F2_<wbr>SHA256_<wbr>ITERATIONS</a></dt><dt><a class="constant" href="constant.MAX_PBKDF2_SHA256_SALT_LEN.html" title="constant auth::common::MAX_PBKDF2_SHA256_SALT_LEN">MAX_<wbr>PBKD<wbr>F2_<wbr>SHA256_<wbr>SALT_<wbr>LEN</a></dt><dt><a class="constant" href="constant.PBKDF2_SHA256_HASH_LEN.html" title="constant auth::common::PBKDF2_SHA256_HASH_LEN">PBKD<wbr>F2_<wbr>SHA256_<wbr>HASH_<wbr>LEN</a></dt><dt><a class="constant" href="constant.PG_SCRAM_SHA256_KEY_LEN.html" title="constant auth::common::PG_SCRAM_SHA256_KEY_LEN">PG_<wbr>SCRAM_<wbr>SHA256_<wbr>KEY_<wbr>LEN</a></dt></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.PG_SCRAM_MOCK_SECRET.html" title="static auth::common::PG_SCRAM_MOCK_SECRET">PG_<wbr>SCRAM_<wbr>MOCK_<wbr>SECRET</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Process-wide secret used to derive a stable mock salt for unknown users, so
the SCRAM <code>server-first-message</code> cant be used to enumerate usernames.</dd></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.auth_mysql.html" title="fn auth::common::auth_mysql">auth_<wbr>mysql</a></dt><dt><a class="fn" href="fn.auth_mysql_with_hash_stage_2.html" title="fn auth::common::auth_mysql_with_hash_stage_2">auth_<wbr>mysql_<wbr>with_<wbr>hash_<wbr>stage_<wbr>2</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.double_sha1.html" title="fn auth::common::double_sha1">double_<wbr>sha1</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.format_mysql_native_password_verifier.html" title="fn auth::common::format_mysql_native_password_verifier">format_<wbr>mysql_<wbr>native_<wbr>password_<wbr>verifier</a></dt><dt><a class="fn" href="fn.format_pbkdf2_sha256_password_verifier.html" title="fn auth::common::format_pbkdf2_sha256_password_verifier">format_<wbr>pbkdf2_<wbr>sha256_<wbr>password_<wbr>verifier</a></dt><dt><a class="fn" href="fn.format_pg_scram_sha256_password_verifier.html" title="fn auth::common::format_pg_scram_sha256_password_verifier">format_<wbr>pg_<wbr>scram_<wbr>sha256_<wbr>password_<wbr>verifier</a></dt><dt><a class="fn" href="fn.hmac_sha256.html" title="fn auth::common::hmac_sha256">hmac_<wbr>sha256</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.mysql_native_password_hash.html" title="fn auth::common::mysql_native_password_hash">mysql_<wbr>native_<wbr>password_<wbr>hash</a></dt><dt><a class="fn" href="fn.pg_scram_sha256_salted_password.html" title="fn auth::common::pg_scram_sha256_salted_password">pg_<wbr>scram_<wbr>sha256_<wbr>salted_<wbr>password</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.sha1_one.html" title="fn auth::common::sha1_one">sha1_<wbr>one</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.sha1_two.html" title="fn auth::common::sha1_two">sha1_<wbr>two</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.sha256.html" title="fn auth::common::sha256">sha256</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.static_user_provider_from_option.html" title="fn auth::common::static_user_provider_from_option">static_<wbr>user_<wbr>provider_<wbr>from_<wbr>option</a></dt><dt><a class="fn" href="fn.user_provider_from_option.html" title="fn auth::common::user_provider_from_option">user_<wbr>provider_<wbr>from_<wbr>option</a></dt><dt><a class="fn" href="fn.userinfo_by_name.html" title="fn auth::common::userinfo_by_name">userinfo_<wbr>by_<wbr>name</a></dt><dd>construct a <a href="../trait.UserInfo.html" title="trait auth::UserInfo"><code>UserInfo</code></a> impl with name
use default username <code>greptime</code> if None is provided</dd><dt><a class="fn" href="fn.xor.html" title="fn auth::common::xor">xor</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.HashedPassword.html" title="type auth::common::HashedPassword">Hashed<wbr>Password</a></dt><dt><a class="type" href="type.HmacSha256.html" title="type auth::common::HmacSha256">Hmac<wbr>Sha256</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="type" href="type.HostOrIp.html" title="type auth::common::HostOrIp">Host<wbr>OrIp</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="type" href="type.Salt.html" title="type auth::common::Salt">Salt</a></dt><dt><a class="type" href="type.Username.html" title="type auth::common::Username">Username</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>