<!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="API documentation for the Rust `PamKanidm` struct in crate `pam_kanidm`."><metaname="keywords"content="rust, rustlang, rust-lang, PamKanidm"><title>PamKanidm in pam_kanidm - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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-124a1ca42af929b6.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-93196c7a1c3542a8.css"id="mainThemeStyle"><linkrel="stylesheet"id="themeStyle"href="../static.files/light-4743e13df3dfe8c4.css"><linkrel="stylesheet"disabledhref="../static.files/dark-0e1b889528bd466b.css"><linkrel="stylesheet"disabledhref="../static.files/ayu-65289d5d067c7c66.css"><scriptid="default-settings"></script><scriptsrc="../static.files/storage-d43fa987303ecbbb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-3367e395607fafc1.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 struct"><!--[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="#">PamKanidm</a></h2><divclass="sidebar-elems"><section><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-PamHooks-for-PamKanidm">PamHooks</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-RefUnwindSafe-for-PamKanidm">RefUnwindSafe</a></li><li><ahref="#impl-Send-for-PamKanidm">Send</a></li><li><ahref="#impl-Sync-for-PamKanidm">Sync</a></li><li><ahref="#impl-Unpin-for-PamKanidm">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-PamKanidm">UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block"><li><ahref="#impl-Any-for-PamKanidm">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-PamKanidm">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-PamKanidm">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E-for-PamKanidm">From<T></a></li><li><ahref="#impl-Instrument-for-PamKanidm">Instrument</a></li><li><ahref="#impl-Into%3CU%3E-for-PamKanidm">Into<U></a></li><li><ahref="#impl-TryFrom%3CU%3E-for-PamKanidm">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E-for-PamKanidm">TryInto<U></a></li><li><ahref="#impl-VZip%3CV%3E-for-PamKanidm">VZip&l
things like the expiration on passwords, and respond that the user change it before continuing.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.sm_authenticate"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../src/pam_kanidm/pam/mod.rs.html#162-270">source</a><ahref="#method.sm_authenticate"class="anchor">§</a><h4class="code-header">fn <ahref="module/trait.PamHooks.html#method.sm_authenticate"class="fn">sm_authenticate</a>(<br> pamh: &<aclass="enum"href="module/enum.PamHandle.html"title="enum pam_kanidm::module::PamHandle">PamHandle</a>,<br> args: <aclass="struct"href="https://doc.rust-lang.org/1.68.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><&<aclass="struct"href="https://doc.rust-lang.org/1.68.0/core/ffi/c_str/struct.CStr.html"title="struct core::ffi::c_str::CStr">CStr</a>>,<br> _flags: <aclass="type"href="constants/type.PamFlag.html"title="type pam_kanidm::constants::PamFlag">PamFlag</a><br>) -><aclass="enum"href="constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass='docblock'>This function performs the task of authenticating the user.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.sm_chauthtok"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../src/pam_kanidm/pam/mod.rs.html#272-284">source</a><ahref="#method.sm_chauthtok"class="anchor">§</a><h4class="code-header">fn <ahref="module/trait.PamHooks.html#method.sm_chauthtok"class="fn">sm_chauthtok</a>(<br> _pamh: &<aclass="enum"href="module/enum.PamHandle.html"title="enum pam_kanidm::module::PamHandle">PamHandle</a>,<br> args: <aclass="struct"href="https://doc.rust-lang.org/1.68.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><&<aclass="struct"href="https://doc.rust-lang.org/1.68.0/core/ffi/c_str/struct.CStr.html"title="struct core::ffi::c_str::CStr">CStr</a>>,<br> _flags: <aclass="type"href="constants/type.PamFlag.html"title="type pam_kanidm::constants::PamFlag">PamFlag</a><br>) -><aclass="enum"href="constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass='docblock'>This function is used to (re-)set the authentication token of the user. <ahref="module/trait.PamHooks.html#method.sm_chauthtok">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.sm_close_session"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../src/pam_kanidm/pam/mod.rs.html#286-298">source</a><ahref="#method.sm_close_session"class="anchor">§</a><h4class="code-header">fn <ahref="module/trait.PamHooks.html#method.sm_close_session"class="fn">sm_close_session</a>(<br> _pamh: &<aclass="enum"href="module/enum.PamHandle.html"title="enum pam_kanidm::module::PamHandle">PamHandle</a>,<br> args: <aclass="struct"href="https://doc.rust-lang.org/1.68.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><&<aclass="struct"href="https://doc.rust-lang.org/1.68.0/core/ffi/c_str/struct.CStr.html"title="struct core::ffi::c_str::CStr">CStr</a>>,<br> _flags: <aclass="type"href="constants/type.PamFlag.html"title="type pam_kanidm::constants::PamFlag">PamFlag</a><br>) -><aclass="enum"href="constants/enum.PamResultCode.html"title="enum pam_kanidm::constants::PamResultCode">PamResultCode</a></h4></section></summary><divclass='docblock'>This function is called to terminate a session.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.sm_open_session"class="method trait-impl has-srclink"><aclass="srclink rightside"href="../src/pam_kanidm/pam/mod.rs.html#300
authenticated but before a session has been established.</div></details></div></details></div><h2id="synthetic-implementations"class="small-section-header">Auto Trait Implementations<ahref="#synthetic-implementations"class="anchor">§</a></h2><divid="synthetic-implementations-list"><sectionid="impl-RefUnwindSafe-for-PamKanidm"class="impl has-srclink"><ahref="#impl-RefUnwindSafe-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/panic/unwind_safe/trait.RefUnwindSafe.html"title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <aclass="struct"href="struct.PamKanidm.html"title="struct pam_kanidm::PamKanidm">PamKanidm</a></h3></section><sectionid="impl-Send-for-PamKanidm"class="impl has-srclink"><ahref="#impl-Send-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="struct.PamKanidm.html"title="struct pam_kanidm::PamKanidm">PamKanidm</a></h3></section><sectionid="impl-Sync-for-PamKanidm"class="impl has-srclink"><ahref="#impl-Sync-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="struct.PamKanidm.html"title="struct pam_kanidm::PamKanidm">PamKanidm</a></h3></section><sectionid="impl-Unpin-for-PamKanidm"class="impl has-srclink"><ahref="#impl-Unpin-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/marker/trait.Unpin.html"title="trait core::marker::Unpin">Unpin</a> for <aclass="struct"href="struct.PamKanidm.html"title="struct pam_kanidm::PamKanidm">PamKanidm</a></h3></section><sectionid="impl-UnwindSafe-for-PamKanidm"class="impl has-srclink"><ahref="#impl-UnwindSafe-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/panic/unwind_safe/trait.UnwindSafe.html"title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <aclass="struct"href="struct.PamKanidm.html"title="struct pam_kanidm::PamKanidm">PamKanidm</a></h3></section></div><h2id="blanket-implementations"class="small-section-header">Blanket Implementations<ahref="#blanket-implementations"class="anchor">§</a></h2><divid="blanket-implementations-list"><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Any-for-PamKanidm"class="impl has-srclink"><aclass="srclink rightside"href="https://doc.rust-lang.org/1.68.0/src/core/any.rs.html#200">source</a><ahref="#impl-Any-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T<spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.type_id"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://doc.rust-lang.org/1.68.0/src/core/any.rs.html#201">source</a><ahref="#method.type_id"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.68.0/core/any/trait.Any.html#tymethod.type_id"class="fn">type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/1.68.0/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></h4></section></summary><divclass='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/1.68.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sect
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-PamKanidm"class="impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><ahref="#impl-Instrument-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><ahref="#method.instrument"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument"class="fn">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><ahref="#method.in_current_span"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fn">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<code><ahref="https://doc.rust-lang.org/1.68.0/core/convert/trait.From.html"title="From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-PamKanidm"class="impl has-srclink"><aclass="srclink rightside"href="https://doc.rust-lang.org/1.68.0/src/core/convert/mod.rs.html#775">source</a><ahref="#impl-TryFrom%3CU%3E-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.68.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.68.0/src/core/convert/mod.rs.html#781">source</a></span><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.68.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-PamKanidm"class="impl has-srclink"><aclass="srclink rightside"href="https://doc.rust-lang.org/1.68.0/src/core/convert/mod.rs.html#760">source</a><ahref="#impl-TryInto%3CU%3E-for-PamKanidm"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.68.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in th
<ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="WithDispatch"><code>WithDispatch</code></a> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><ahref="#method.with_current_subscriber"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fn">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="https://docs.rs/tracing/0.1.37/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
