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 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .SH NAME
   5 slapo-constraint \- Attribute Constraint Overlay to slapd
   6 .SH SYNOPSIS
   7 ETCDIR/slapd.conf
   8 .SH DESCRIPTION
   9 The constraint overlay is used to enforce a regular expression
  10 constraint on all values of specified attributes. Attributes can
  11 have multiple constraints placed upon them, and all must be satisfied
  12 when modifying an attribute value under constraint.
  13 .LP
  14 This overlay is intended to be used to force syntactic regularity upon
  15 certain string represented data which have well known canonical forms,
  16 like telephone numbers, post codes, FQDNs, etc.
  17 .SH CONFIGURATION
  18 This
  19 .B slapd.conf
  20 option applies to the constraint overlay.
  21 It should appear after the
  22 .B overlay
  23 directive.
  24 .TP
  25 .B constraint_attribute <attribute_name> <type> <value>
  26 Specifies the constraint which should apply to the attribute named as
  27 the first parameter.
  28 At the moment only one type of constraint is supported -
  29 .B
  30 regex.
  31 The parameter following the
  32 .B
  33 regex
  34 type is a Unix style regular expression (See
  35 .B
  36 regex(7))
  37
  38 Any attempt to add or modify an attribute named as part of the
  39 constraint overlay specification which does not fit the regular
  40 expression constraint listed will fail with a
  41 LDAP_CONSTRAINT_VIOLATION error.
  42 .SH EXAMPLES
  43 .B
  44 constraint_attribute mail regex ^[:alnum:]+@mydomain.com$
  45
  46 A specification like the above would reject any
  47 .B
  48 mail
  49 attribute which did not look like
  50 .B
  51 <alpha-numeric string>@mydomain.com
  52 .SH FILES
  53 .TP
  54 ETCDIR/slapd.conf
  55 default slapd configuration file
  56 .SH SEE ALSO
  57 .BR slapd.conf (5).