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 .BR regex ,
  35 .BR size ,
  36 .BR count ,
  37 .BR uri ,
  38 and
  39 .BR set .
  40
  41 The parameter following the
  42 .B regex
  43 type is a Unix style regular expression (See
  44 .BR regex (7)
  45 ). The parameter following the
  46 .B uri
  47 type is an LDAP URI. The URI will be evaluated using an internal search.
  48 It must not include a hostname, and it must include a list of attributes
  49 to evaluate.
  50
  51 The parameter following the
  52 .B set
  53 type is a string that is interpreted according to the syntax in use
  54 for ACL sets.  This allows to construct constraints based on the contents
  55 of the entry.
  56
  57 The
  58 .B size
  59 type can be used to enforce a limit on an attribute length, and the
  60 .B count
  61 type limits the number of values of an attribute.
  62
  63 Any attempt to add or modify an attribute named as part of the
  64 constraint overlay specification which does not fit the
  65 constraint listed will fail with a
  66 LDAP_CONSTRAINT_VIOLATION error.
  67 .SH EXAMPLES
  68 .LP
  69 .RS
  70 .nf
  71 overlay constraint
  72 constraint_attribute jpegPhoto size 131072
  73 constraint_attribute userPassword count 3
  74 constraint_attribute mail regex ^[:alnum:]+@mydomain.com$
  75 constraint_attribute title uri
  76   ldap:///dc=catalog,dc=example,dc=com?title?sub?(objectClass=titleCatalog)
  77 constraint_attribute cn,sn,givenName set
  78   "(this/givenName + [ ] + this/sn) & this/cn"
  79 .fi
  80
  81 .RE
  82 A specification like the above would reject any
  83 .B mail
  84 attribute which did not look like
  85 .BR "<alpha-numeric string>@mydomain.com" .
  86 It would also reject any
  87 .B title
  88 attribute whose values were not listed in the
  89 .B title
  90 attribute of any
  91 .B titleCatalog
  92 entries in the given scope.
  93 Finally, it requires the values of the attribute
  94 .B cn
  95 to be constructed by pairing values of the attributes
  96 .B sn
  97 and
  98 .BR givenName ,
  99 separated by a space.
 100 .RE
 101 .SH FILES
 102 .TP
 103 ETCDIR/slapd.conf
 104 default slapd configuration file
 105 .SH SEE ALSO
 106 .BR slapd.conf (5).
 107 .SH ACKNOWLEDGEMENTS
 108 This module was written in 2005 by Neil Dunbar of Hewlett-Packard and subsequently
 109 extended by Howard Chu and Emmanuel Dreyfus.
 110 .so ../Project