git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-constraint.5

   1 .TH SLAPO-CONSTRAINT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2005-2006 Hewlett-Packard Company
   3 .\" Copyright 2006-2008 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .\" $OpenLDAP$
   6 .SH NAME
   7 slapo-constraint \- Attribute Constraint Overlay to slapd
   8 .SH SYNOPSIS
   9 ETCDIR/slapd.conf
  10 .SH DESCRIPTION
  11 The constraint overlay is used to ensure that attribute values match
  12 some constraints beyond basic LDAP syntax.  Attributes can
  13 have multiple constraints placed upon them, and all must be satisfied
  14 when modifying an attribute value under constraint.
  15 .LP
  16 This overlay is intended to be used to force syntactic regularity upon
  17 certain string represented data which have well known canonical forms,
  18 like telephone numbers, post codes, FQDNs, etc.
  19 .LP
  20 It constrains only LDAP adds and modify commands and only seeks to
  21 control the add and modify value of a modify request.
  22 .SH CONFIGURATION
  23 This
  24 .B slapd.conf
  25 option applies to the constraint overlay.
  26 It should appear after the
  27 .B overlay
  28 directive.
  29 .TP
  30 .B constraint_attribute <attribute_name> <type> <value>
  31 Specifies the constraint which should apply to the attribute named as
  32 the first parameter.
  33 Two types of constraint are currently supported -
  34 .B regex
  35 and
  36 .BR uri .
  37
  38 The parameter following the
  39 .B regex
  40 type is a Unix style regular expression (See
  41 .BR regex (7)
  42 ). The parameter following the
  43 .B uri
  44 type is an LDAP URI. The URI will be evaluated using an internal search.
  45 It must not include a hostname, and it must include a list of attributes
  46 to evaluate.
  47
  48 Any attempt to add or modify an attribute named as part of the
  49 constraint overlay specification which does not fit the
  50 constraint listed will fail with a
  51 LDAP_CONSTRAINT_VIOLATION error.
  52 .SH EXAMPLES
  53 .LP
  54 .RS
  55 .nf
  56 overlay constraint
  57 constraint_attribute mail regex ^[:alnum:]+@mydomain.com$
  58 constraint_attribute title uri
  59   ldap:///dc=catalog,dc=example,dc=com?title?sub?(objectClass=titleCatalog)
  60 .fi
  61
  62 A specification like the above would reject any
  63 .B mail
  64 attribute which did not look like
  65 .B
  66 <alpha-numeric string>@mydomain.com
  67 It would also reject any
  68 .B title
  69 attribute whose values were not listed in the
  70 .B title
  71 attribute of any
  72 .B titleCatalog
  73 entries in the given scope.
  74 .RE
  75 .SH FILES
  76 .TP
  77 ETCDIR/slapd.conf
  78 default slapd configuration file
  79 .SH SEE ALSO
  80 .BR slapd.conf (5).
  81 .SH ACKNOWLEDGEMENTS
  82 This module was written in 2005 by Neil Dunbar of Hewlett-Packard and subsequently
  83 extended by Howard Chu and Emmanuel Dreyfus.
  84 .so ../Project