mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-24 21:17:01 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity
kanidm/docs/v1.0.0rc10/rustdoc/kanidmd_lib/index.html

26 lines
14 KiB
HTML
Raw Normal View History

deploy: 95cdaec75f535fb812ade4ce6a03cad3e76b7a6c
2023-03-10 00:19:42 +01:00
<!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="The Kanidmd server library. This implements all of the internal components of the server which is used to process authentication, store identities and enforce access controls."><meta name="keywords" content="rust, rustlang, rust-lang, kanidmd_lib"><title>kanidmd_lib - 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="../crates.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 mod crate"><!--[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">&#9776;</button><a class="logo-container" href="../kanidmd_lib/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="../kanidmd_lib/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate kanidmd_lib</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 1.1.0-alpha.12-dev</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></section></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>Crate <a class="mod" href="#">kanidmd_lib</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" al
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
which is used to process authentication, store identities and enforce access controls.</p>
deploy: 55ee2410d789f4f9469d622938e6cbef04c5058d
2022-11-04 01:07:22 +01:00
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="be/index.html" title="kanidmd_lib::be mod">be</a></div><div class="item-right docblock-short">The backend. This contains the “low level” storage and query code, which is
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
implemented as a json-like kv document database. This has no rules about content
of the server, which are all enforced at higher levels. The role of the backend
is to persist content safely to disk, load that content, and execute queries
deploy: 55ee2410d789f4f9469d622938e6cbef04c5058d
2022-11-04 01:07:22 +01:00
utilising indexes in the most effective way possible.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="constants/index.html" title="kanidmd_lib::constants mod">constants</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="credential/index.html" title="kanidmd_lib::credential mod">credential</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="entry/index.html" title="kanidmd_lib::entry mod">entry</a></div><div class="item-right docblock-short">Entries are the base unit of object storage in the server. This is one of the three foundational
concepts along with <a href="../filter/index.html"><code>filter</code></a>s and <a href="../schema/index.html"><code>schema</code></a> that everything else builds upon.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="event/index.html" title="kanidmd_lib::event mod">event</a></div><div class="item-right docblock-short">An <code>event</code> is a self contained module of data, that contains all of the
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
required information for any operation to proceed. While there are many
deploy: 55ee2410d789f4f9469d622938e6cbef04c5058d
2022-11-04 01:07:22 +01:00
types of potential events, they all eventually lower to one of:</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="filter/index.html" title="kanidmd_lib::filter mod">filter</a></div><div class="item-right docblock-short"><a href="struct.Filter.html"><code>Filter</code></a>s are one of the three foundational concepts of the design in kanidm.
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
They are used in nearly every aspect of the server to provide searching of
deploy: b8dcb47f93530753ac1fa05a3a1ba7cd9cc9cfc1
2023-01-10 05:08:56 +01:00
datasets and assertion of entry properties.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="idm/index.html" title="kanidmd_lib::idm mod">idm</a></div><div class="item-right docblock-short">The Identity Management components that are layered on top of the <a href="server/struct.QueryServer.html">QueryServer</a>. These allow
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
rich and expressive events and transformations that are lowered into the correct/relevant
actions in the <a href="server/struct.QueryServer.html">QueryServer</a>. Generally this is where “Identity Management” policy and code
deploy: 27cb3d8510c0392a0b97b789373d83de95022b7a
2022-12-28 09:07:51 +01:00
is implemented.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="macros/index.html" title="kanidmd_lib::macros mod">macros</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="modify/index.html" title="kanidmd_lib::modify mod">modify</a></div><div class="item-right docblock-short">Modification expressions and validation. This is how <code>ModifyEvents</code> store and
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
express the series of Modifications that should be applied. These are expressed
deploy: 55ee2410d789f4f9469d622938e6cbef04c5058d
2022-11-04 01:07:22 +01:00
as “states” on what attribute-values should appear as within the <code>Entry</code></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="prelude/index.html" title="kanidmd_lib::prelude mod">prelude</a></div><div class="item-right docblock-short">A prelude of imports that should be imported by all other Kanidm modules to
help make imports cleaner.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="schema/index.html" title="kanidmd_lib::schema mod">schema</a></div><div class="item-right docblock-short"><a href="struct.Schema.html"><code>Schema</code></a> is one of the foundational concepts of the server. It provides a
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
set of rules to enforce that <a href="../entry/index.html"><code>Entries</code></a> ava’s must be compliant to, to be
considered valid for commit to the database. This allows us to provide
requirements and structure as to what an <a href="../entry/index.html"><code>Entry</code></a> must have and may contain
deploy: 55ee2410d789f4f9469d622938e6cbef04c5058d
2022-11-04 01:07:22 +01:00
which enables many other parts to function.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="server/index.html" title="kanidmd_lib::server mod">server</a></div><div class="item-right docblock-short"><code>server</code> contains the query server, which is the main high level construction
to coordinate queries and operations in the server.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="status/index.html" title="kanidmd_lib::status mod">status</a></div><div class="item-right docblock-short">An actor that shows the servers current status and statistics. (TODO).</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="testkit/index.html" title="kanidmd_lib::testkit mod">testkit</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="utils/index.html" title="kanidmd_lib::utils mod">utils</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="value/index.html" title="kanidmd_lib::value mod">value</a></div><div class="item-right docblock-short">Inside an entry, the key-value pairs are stored in these <a href="value/enum.Value.html" title="Value"><code>Value</code></a> types. The components of
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
the <a href="value/enum.Value.html" title="Value"><code>Value</code></a> module allow storage and transformation of various types of input into strongly
typed values, allows their comparison, filtering and more. It also has the code for serialising
deploy: 2c2c3a6ddba6787fa8fdf109dad6355502ed3746
2023-03-25 06:42:48 +01:00
these into a form for the backend that can be persistent into the <a href="be/struct.Backend.html"><code>Backend</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="valueset/index.html" title="kanidmd_lib::valueset mod">valueset</a></div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.btreemap.html" title="kanidmd_lib::btreemap macro">btreemap</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.btreeset.html" title="kanidmd_lib::btreeset macro">btreeset</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.entry_init.html" title="kanidmd_lib::entry_init macro">entry_init</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.f_and.html" title="kanidmd_lib::f_and macro">f_and</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.f_inc.html" title="kanidmd_lib::f_inc macro">f_inc</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.f_or.html" title="kanidmd_lib::f_or macro">f_or</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.filter.html" title="kanidmd_lib::filter macro">filter</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.filter_all.html" title="kanidmd_lib::filter_all macro">filter_all</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.filter_rec.html" title="kanidmd_lib::filter_rec macro">filter_rec</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.mergemaps.html" title="kanidmd_lib::mergemaps macro">mergemaps</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.mergesets.html" title="kanidmd_lib::mergesets macro">mergesets</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.modlist.html" title="kanidmd_lib::modlist macro">modlist</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.smolset.html" title="kanidmd_lib::smolset macro">smolset</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_bool.html" title="kanidmd_lib::vs_bool macro">vs_bool</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_cid.html" title="kanidmd_lib::vs_cid macro">vs_cid</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_iname.html" title="kanidmd_lib::vs_iname macro">vs_iname</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_index.html" title="kanidmd_lib::vs_index macro">vs_index</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_iutf8.html" title="kanidmd_lib::vs_iutf8 macro">vs_iutf8</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_refer.html" title="kanidmd_lib::vs_refer macro">vs_refer</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_syntax.html" title="kanidmd_lib::vs_syntax macro">vs_syntax</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_utf8.html" title="kanidmd_lib::vs_utf8 macro">vs_utf8</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.vs_uuid.html" title="kanidmd_lib::vs_uuid macro">vs_uuid</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="kanidmd_lib" data-themes="" data-resource-suffix
Reference in a new issue Copy permalink