mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 21:17:01 +01:00
30 lines
6.9 KiB
HTML
30 lines
6.9 KiB
HTML
|
<!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="Macro to generate the `extern "C"` entrypoint bindings needed by PAM"><meta name="keywords" content="rust, rustlang, rust-lang, pam_hooks"><title>pam_hooks in pam_kanidm - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../pam_kanidm/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../pam_kanidm/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In pam_kanidm</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../pam_kanidm/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">pam_kanidm</a>::<wbr><a class="macro" href="#">pam_hooks</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/pam_kanidm/pam/macros.rs.html#34-117">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">pam_hooks</span> {
|
|||
|
|
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ident</span>:<span class="ident">ident</span>) => { ... };
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Macro to generate the <code>extern "C"</code> entrypoint bindings needed by PAM</p>
|
|||
|
|
<p>You can call <code>pam_hooks!(SomeType);</code> for any type that implements <code>PamHooks</code></p>
|
|||
|
|
<h3 id="examples"><a href="#examples">Examples:</a></h3>
|
|||
|
|
<p>Here is full example of a PAM module that would authenticate and authorize everybody:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">pam</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">use</span> <span class="ident">pam::constants</span>::{<span class="ident">PamFlag</span>, <span class="ident">PamResultCode</span>};
|
|||
|
|
<span class="kw">use</span> <span class="ident">pam::module</span>::{<span class="ident">PamHandle</span>, <span class="ident">PamHooks</span>};
|
|||
|
|
<span class="kw">use</span> <span class="ident">std::ffi::CStr</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">MyPamModule</span>;
|
|||
|
|
<span class="macro">pam_hooks!</span>(<span class="ident">MyPamModule</span>);
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span> <span class="ident">PamHooks</span> <span class="kw">for</span> <span class="ident">MyPamModule</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">sm_authenticate</span>(<span class="ident">pamh</span>: <span class="kw-2">&</span><span class="ident">PamHandle</span>, <span class="ident">args</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">CStr</span><span class="op">></span>, <span class="ident">flags</span>: <span class="ident">PamFlag</span>) -> <span class="ident">PamResultCode</span> {
|
|||
|
|
<span class="macro">println!</span>(<span class="string">"Everybody is authenticated!"</span>);
|
|||
|
|
<span class="ident">PamResultCode::PAM_SUCCESS</span>
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">acct_mgmt</span>(<span class="ident">pamh</span>: <span class="kw-2">&</span><span class="ident">PamHandle</span>, <span class="ident">args</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">CStr</span><span class="op">></span>, <span class="ident">flags</span>: <span class="ident">PamFlag</span>) -> <span class="ident">PamResultCode</span> {
|
|||
|
|
<span class="macro">println!</span>(<span class="string">"Everybody is authorized!"</span>);
|
|||
|
|
<span class="ident">PamResultCode::PAM_SUCCESS</span>
|
|||
|
|
}
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="pam_kanidm" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|