<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Provides functions that are invoked by the entrypoints generated by the `pam_hooks!` macro."><title>PamHooks in pam_kanidm::module - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-c4dbdcde0fbd8430.css"id="mainThemeStyle"><linkrel="stylesheet"id="themeStyle"href="../../static.files/light-db279b6232be9c13.css"><linkrel="stylesheet"disabledhref="../../static.files/dark-cf923f49f397b216.css"><linkrel="stylesheet"disabledhref="../../static.files/ayu-be46fdc453a55015.css"><scriptsrc="../../static.files/storage-3891ce972e3a2bf8.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-98a684e84ae5b08b.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-13285aec31fa243e.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="logo-container"href="../../pam_kanidm/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2></h2></nav><navclass="sidebar"><aclass="logo-container"href="../../pam_kanidm/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2class="location"><ahref="#">PamHooks</a></h2><divclass="sidebar-elems"><section><h3><ahref="#provided-methods">Provided Methods</a></h3><ulclass="block"><li><ahref="#method.acct_mgmt">acct_mgmt</a></li><li><ahref="#method.sm_authenticate">sm_authenticate</a></li><li><ahref="#method.sm_chauthtok">sm_chauthtok</a></li><li><ahref="#method.sm_close_session">sm_close_session</a></li><li><ahref="#method.sm_open_session">sm_open_session</a></li><li><ahref="#method.sm_setcred">sm_setcred</a></li></ul><h3><ahref="#implementors">Implementors</a></h3></section><h2><ahref="index.html">In pam_kanidm::module</a></h2></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><ahref="../../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Trait <ahref="../index.htm
}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Provides functions that are invoked by the entrypoints generated by the
</div></details><h2id="provided-methods"class="small-section-header">Provided Methods<ahref="#provided-methods"class="anchor">§</a></h2><divclass="methods"><detailsclass="toggle method-toggle"open><summary><sectionid="method.acct_mgmt"class="method"><aclass="srclink rightside"href="../../src/pam_kanidm/pam/module.rs.html#262-264">source</a><h4class="code-header">fn <ahref="#method.acct_mgmt"class="fn">acct_mgmt</a>(pamh: &<aclass="enum"href="enum.PamHandle.html"title="enum pam_kanidm::module::PamHandle">PamHandle</a>, args: <aclass="struct"href="https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><&<aclass="struct"href="https://doc.rust-lang.org/1.69.0/core/ffi/c_str/struct.CStr.html"title="struct core::ffi::c_str::CStr">CStr</a>>, flags: <aclass="type"href="../constants/type.PamFlag.html"title="type pam_kanidm::constants::PamFlag">PamFlag</a>) -><aclass="enum"href="../constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass="docblock"><p>This function performs the task of establishing whether the user is permitted to gain access at
) -><aclass="enum"href="../constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass="docblock"><p>This function performs the task of authenticating the user.</p>
) -><aclass="enum"href="../constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass="docblock"><p>This function is used to (re-)set the authentication token of the user.</p>
) -><aclass="enum"href="../constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass="docblock"><p>This function is called to terminate a session.</p>
) -><aclass="enum"href="../constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass="docblock"><p>This function is called to commence a session.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.sm_setcred"class="method"><aclass="srclink rightside"href="../../src/pam_kanidm/pam/module.rs.html#296-298">source</a><h4class="code-header">fn <ahref="#method.sm_setcred"class="fn">sm_setcred</a>(pamh: &<aclass="enum"href="enum.PamHandle.html"title="enum pam_kanidm::module::PamHandle">PamHandle</a>, args: <aclass="struct"href="https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><&<aclass="struct"href="https://doc.rust-lang.org/1.69.0/core/ffi/c_str/struct.CStr.html"title="struct core::ffi::c_str::CStr">CStr</a>>, flags: <aclass="type"href="../constants/type.PamFlag.html"title="type pam_kanidm::constants::PamFlag">PamFlag</a>) -><aclass="enum"href="../constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass="docblock"><p>This function performs the task of altering the credentials of the user with respect to the
