/usr/share/doc/automx/html/automx

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.10: http://docutils.sourceforge.net/" />
<title>automx_ldap</title>
<meta name="date" content="02/08/2013" />
<meta name="copyright" content="This document has been placed in the public domain." />
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7514 2012-09-14 14:27:12Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="automx-ldap">
<h1 class="title">automx_ldap</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Date:</th>
<td>02/08/2013</td></tr>
<tr class="field"><th class="docinfo-name">Subtitle:</th><td class="field-body">automx LDAP backend configuration parameters</td>
</tr>
<tr class="field"><th class="docinfo-name">Manual Section:</th><td class="field-body">5</td>
</tr>
<tr class="field"><th class="docinfo-name">Manual Group:</th><td class="field-body">automx</td>
</tr>
<tr><th class="docinfo-name">Copyright:</th>
<td>This document has been placed in the public domain.</td></tr>
</tbody>
</table>
<div class="section" id="description">
<h1>Description</h1>
<p>The automx_ldap(5) man page specifies all parameters that control access from
within automx to a LDAP backend.</p>
</div>
<div class="section" id="parameters">
<h1>Parameters</h1>
<dl class="docutils">
<dt>authzid (no default)</dt>
<dd>Specifies the SASL proxy authorization identity.</dd>
<dt>base (default: none)</dt>
<dd>Specifies the default base DN to use when performing ldap operations. The base must be specified as a Distinguished Name in LDAP format.</dd>
<dt>binddn (default: none)</dt>
<dd>Specifies the default bind DN to use when performing ldap operations. The bind DN must be specified as a Distinguished Name in LDAP format.</dd>
<dt>bindmethod (default: simple)</dt>
<dd>Specifies how authentication should take place. Valid options are either simple for a simple bind or sasl for a bind that requires SASL authentication.</dd>
<dt>bindpw (default: none)</dt>
<dd>Specifies the password used when binddn identifies itself with the LDAP server.</dd>
<dt>cacert (default: none)</dt>
<dd>Specifies the path to a file that contains all certificates of Certification Authorities automx should trust.</dd>
<dt>cert (default: none)</dt>
<dd>Specifies the path to a file that contains automx's certificate.</dd>
<dt>cipher (default: TLSv1)</dt>
<dd>See ciphers(1) for a list of valid options.</dd>
<dt>filter (default: (objectClass=*))</dt>
<dd><p class="first">Specifies the search filter to select appropriate LDAP objects. The filter should conform to the string representation for search filters as defined in RFC 4515.</p>
<div class="note last">
<p class="first admonition-title">Note</p>
<p class="last">See the section “Macros and Variables” in automx.conf(5) for a list of available query macros.</p>
</div>
</dd>
<dt>host (default: <a class="reference external" href="ldap://127.0.0.1/">ldap://127.0.0.1/</a>)</dt>
<dd><p class="first">Specifies one or more LDAP servers separated by commas as shown in the following example:</p>
<pre class="literal-block">
host = ldap://127.0.0.1, ldap://192.168.2.1
</pre>
<div class="important last">
<p class="first admonition-title">Important</p>
<p class="last">Subsequent servers to the first serve only for fallback purposes, i.e. a server to the right will only be queried if the server left to it cannot be reached. If a server can be reached no further attempts will be made regardless if the query returned a result or not.</p>
</div>
</dd>
<dt>key (default: none)</dt>
<dd>Specifies the path to a file that contains automx's private key, which matches automx certificate given with cert.</dd>
<dt>reqcert (default: never)</dt>
<dd><p class="first">Specifies what checks to perform on server certificates in a TLS session, if any. The &lt;level&gt; can be specified as one of the following keywords:</p>
<dl class="last docutils">
<dt>never</dt>
<dd>The client will not request or check any server certificate. This is the default setting.</dd>
<dt>allow</dt>
<dd>The server certificate is requested. If no certificate is provided, the session proceeds normally. If a bad certificate is provided, it will be ignored and the session proceeds normally.</dd>
<dt>try</dt>
<dd>The server certificate is requested. If no certificate is provided, the session proceeds normally. If a bad certificate is provided, the session is immediately terminated.</dd>
<dt>demand</dt>
<dd>These keywords are equivalent. The server certificate is requested. If no certificate is provided, or a bad certificate is provided, the session is immediately terminated.</dd>
</dl>
</dd>
<dt>result_attrs (default: none)</dt>
<dd>If automx finds one or more entries, the attributes specified by result_attrs are returned. If * is listed, all user attributes are returned.</dd>
<dt>saslmech (default: none)</dt>
<dd><p class="first">Specifies the SASL mechanism to be used for authentication.</p>
<dl class="last docutils">
<dt>cram-md5</dt>
<dd>The SASL cram-md5 mechanism (see: RFC 2195) will be used to authenticate LDAP bind requests.</dd>
<dt>digest-md5</dt>
<dd>The SASL digest-md5 mechanism (see: RFC 2831) will be used to authenticate LDAP bind requests.</dd>
<dt>external</dt>
<dd>The SASL external mechanism (see: RFC 4422) will be used to authenticate LDAP bind requests.</dd>
<dt>gssapi</dt>
<dd>The SASL gssapi mechanism (see: RFC 4752) will be used to authenticate LDAP bind requests.</dd>
<dt>none</dt>
<dd>No SASL mechanism will be use to authenticate LDAP bind requests.</dd>
</dl>
</dd>
<dt>scope (default: sub)</dt>
<dd>Specify the scope of the search to be one of base (or exact), one (or onelevel), sub (or substree), to specify a base object, one-level, or subtree search.</dd>
<dt>usetls (default: false)</dt>
<dd>Specifies if automx should use TLS when it connects to the LDAP host.</dd>
</dl>
</div>
<div class="section" id="authors">
<h1>Authors</h1>
<dl class="docutils">
<dt>Christian Roessner &lt;<a class="reference external" href="mailto:cr&#64;sys4.de">cr&#64;sys4.de</a>&gt;</dt>
<dd>Wrote the program.</dd>
<dt>Patrick Ben Koetter &lt;<a class="reference external" href="mailto:p&#64;sys4.de">p&#64;sys4.de</a>&gt;</dt>
<dd>Wrote the documentation.</dd>
</dl>
</div>
<div class="section" id="see-also">
<h1>See also</h1>
<p><a class="reference external" href="automx.8.html">automx(8)</a>, <a class="reference external" href="automx.conf.5.html">automx.conf(5)</a>, <a class="reference external" href="automx_ldap.5.html">automx_ldap(5)</a>, <a class="reference external" href="automx_script.5.html">automx_script(5)</a>, <a class="reference external" href="automx_sql.5.html">automx_sql(5)</a>, <a class="reference external" href="automx-test.1.html">automx-test(1)</a></p>
</div>
</div>
</body>
</html>
automx 0.10.0-2.1 / usr / share / doc / automx / html / automx_ldap.5.html
