mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 13:07:00 +01:00
35 lines
6.3 KiB
HTML
35 lines
6.3 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="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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../pam_kanidm/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">pam_kanidm</a></p><div id="sidebar-vars" data-name="pam_hooks" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><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)">⎘</button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/pam_kanidm/pam/macros.rs.html#33-115" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><div class="example-wrap"><pre class="rust macro">
|
||
<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>) <span class="op">=</span><span class="op">></span> { ... };
|
||
}</pre></div>
|
||
</div><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>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples:</a></h2>
|
||
<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">
|
||
<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::module</span>::{<span class="ident">PamHooks</span>, <span class="ident">PamHandle</span>};
|
||
<span class="kw">use</span> <span class="ident">pam::constants</span>::{<span class="ident">PamResultCode</span>, <span class="ident">PamFlag</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="op">-</span><span class="op">></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="op">-</span><span class="op">></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>
|
||
}
|
||
}</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="pam_kanidm" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script></body></html> |