1 .TH SLAPO-RETCODE5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2004 The OpenLDAP Foundation, All Rights Reserved.
3 .\" Copying restrictions apply. See the COPYRIGHT file.
4 .\" Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
7 slapo-retcode \- return code overlay
15 is useful to test the behavior of clients when server-generated erroneous
16 and/or unusual responses occur, e.g. error codes, referrals,
17 excessive response times and so on.
19 The error responses are generated according to different strategies.
21 In the first case, all operations targeted at a specific configurable
22 subtree cause the object related to the request DN to be looked up
23 and checked for return code data: a response code, plus an optional
24 textual message, an optional configurable delay, and, when the response code
25 is referral, a (list of) referral(s).
27 Well-known response codes from standard track documents are provided
28 in \fBretcode.conf\fP, which can be included after instantiating
31 In the second case, objects of classes inherited from
32 the \fBerrAbsObject\fP, like \fBerrObject\fP or \fBerrAuxObject\fP,
33 when returned as intermediate responses of a search request, are changed
34 into the response dictated by their content.
36 A third mode causes objects to be looked up from the underlying database
37 to discover if their class inherits from \fBerrABsObject\fP;
38 in that case, their content is used to compute the corresponding response.
40 The behavior is disabled by using the \fBmanageDSAit\fP control (RFC 3296);
41 in that case, the resulting object, either present in the directory
42 or dynamically generated by the overlay, or contained in the request,
45 The config directives that are specific to the
47 overlay must be prefixed by
49 to avoid conflicts with directives specific to the underlying database
50 or to other stacked overlays. The following specific directives
51 can be used to configure the retcode overlay:
53 .B retcode\-parent <DN>
54 This directive defines the parent DN where dynamically generated
56 If not defined, the suffix of the database is used.
59 .B retcode\-item <RDN> <errCode> [op=<oplist>] [text=<message>]
60 .B [ref=<referral>] [sleeptime=<sec>]
62 A dynamically generated entry, located below \fBretcode\-parent\fP.
63 The \fB<errCode>\fP is the number of the response code;
64 it can be in any format supported by strtol.
65 The optional \fB<oplist>\fP is a list of operations that cause
66 response code generation; if absent, all operations are affected.
67 The \fBref\fP field is only allowed for the \fBreferral\fP
72 Enables exploitation of in-directory stored errAbsObject.
73 May result in a lot of unnecessary overhead.
76 The following schema items are created and used by the overlay:
80 ( 1.3.6.1.4.1.4203.666.11.4.1.1
82 DESC 'LDAP error code'
84 ORDERING integerOrderingMatch
85 SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
89 The operations that trigger the response code:
91 ( 1.3.6.1.4.1.4203.666.11.4.1.2
93 DESC 'Operations the errObject applies to'
94 EQUALITY caseIgnoreMatch
95 SUBSTR caseIgnoreSubstringsMatch
96 SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
101 ( 1.3.6.1.4.1.4203.666.11.4.1.3
103 DESC 'LDAP error textual description'
104 EQUALITY caseIgnoreMatch
105 SUBSTR caseIgnoreSubstringsMatch
106 SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
110 The sleep time before the response is actually returned to the client:
112 ( 1.3.6.1.4.1.4203.666.11.4.1.4
113 NAME ( 'errSleepTime' )
114 DESC 'Time to wait before returning the error'
115 EQUALITY integerMatch
116 SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
120 The abstract class that triggers the overlay:
122 ( 1.3.6.1.4.1.4203.666.11.4.3.0
123 NAME ( 'errAbsObject' )
126 MAY ( cn $ description $ errOp $ errText $ errSleepTime ) )
129 The standalone structural objectclass for specifically created data:
131 ( 1.3.6.1.4.1.4203.666.11.4.3.1
133 SUP errAbsObject STRUCTURAL )
136 The auxiliary objectclass to alter the behavior of existing objects:
138 ( 1.3.6.1.4.1.4203.666.11.4.3.2
139 NAME ( 'errAuxObject' )
140 SUP errAbsObject AUXILIARY )
148 retcode-parent "ou=RetCodes,dc=example,dc=com"
149 include ./retcode.conf
151 # Wait 10 seconds, then return success (0x00)
152 retcode-item "cn=Success after 10 seconds" 0x00 sleeptime=10
153 # Wait 10 seconds, then return timelimitExceeded (0x03)
154 retcode-item "cn=Timelimit after 10 seconds" 0x03 sleeptime=10
163 default slapd configuration file
169 This module was written in 2005 by Pierangelo Masarati for SysNet s.n.c.