mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 13:07:00 +01:00
30 lines
6.2 KiB
HTML
30 lines
6.2 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="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../static.files/ayu-65289d5d067c7c66.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-3367e395607fafc1.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="logo-container" href="../pam_kanidm/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../pam_kanidm/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><div class="sidebar-elems"><h2><a href="index.html">In pam_kanidm</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="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"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/pam_kanidm/pam/macros.rs.html#34-117">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><div class="item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules! </span>pam_hooks {
|
||
(<span class="macro-nonterminal">$ident</span>:ident) => { ... };
|
||
}</code></pre></div>
|
||
</div><details class="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="attr">#[macro_use]
|
||
</span><span class="kw">extern crate </span>pam;
|
||
|
||
<span class="kw">use </span>pam::constants::{PamFlag, PamResultCode};
|
||
<span class="kw">use </span>pam::module::{PamHandle, PamHooks};
|
||
<span class="kw">use </span>std::ffi::CStr;
|
||
|
||
<span class="kw">struct </span>MyPamModule;
|
||
<span class="macro">pam_hooks!</span>(MyPamModule);
|
||
|
||
<span class="kw">impl </span>PamHooks <span class="kw">for </span>MyPamModule {
|
||
<span class="kw">fn </span>sm_authenticate(pamh: <span class="kw-2">&</span>PamHandle, args: Vec<<span class="kw-2">&</span>CStr>, flags: PamFlag) -> PamResultCode {
|
||
<span class="macro">println!</span>(<span class="string">"Everybody is authenticated!"</span>);
|
||
PamResultCode::PAM_SUCCESS
|
||
}
|
||
|
||
<span class="kw">fn </span>acct_mgmt(pamh: <span class="kw-2">&</span>PamHandle, args: Vec<<span class="kw-2">&</span>CStr>, flags: PamFlag) -> PamResultCode {
|
||
<span class="macro">println!</span>(<span class="string">"Everybody is authorized!"</span>);
|
||
PamResultCode::PAM_SUCCESS
|
||
}
|
||
}</code></pre></div>
|
||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="pam_kanidm" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.0 (2c8cc3432 2023-03-06)" data-search-js="search-98d53477a794af0b.js" data-settings-js="settings-c3c521c753752a1a.js" data-settings-css="settings-08ddfdda51b8ee2e.css" ></div></body></html> |