← Back to branch summary

~ttx/openldap/lucid-gssapi-495418

« back to all changes in this revision

Viewing changes to doc/man/man5/slapo-retcode.5

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek, Updated debconf translations
  • Date: 2009-07-28 10:17:15 UTC
  • mfrom: (1.1.4 upstream) (0.2.2 sid)
  • mto: (0.2.4 sid)
  • mto: This revision was merged to the branch mainline in revision 16.
  • Revision ID: james.westby@ubuntu.com-20090728101715-epwmqmsk0d3h22k3
http://bugs.debian.org/524770
http://bugs.debian.org/505191
http://bugs.debian.org/496749
http://bugs.debian.org/498116
http://bugs.debian.org/522965
http://bugs.debian.org/521804
* New upstream version.
  - Fixes FTBFS on ia64 with -fPIE. Closes: #524770.
  - Fixes some TLS issues with GnuTLS.  Closes: #505191.
* Update priority of libldap-2.4-2 to match the archive override.
* Add the missing ldapexop and ldapurl tools to ldap-utils, as well as the
  ldapurl(1) manpage.  Thanks to Peter Marschall for the patch.
  Closes: #496749.
* Bump build-dependency on debhelper to 6 instead of 5, since that's
  what we're using.  Closes: #498116.
* Set the default SLAPD_SERVICES to ldap:/// ldapi:///, instead of using
  the built-in default of ldap:/// only.
* Build-depend on libltdl-dev | libltdl3-dev (>= 1.4.3), for the package
  name change.  Closes: #522965.

[ Updated debconf translations ]
* Spanish, thanks to Francisco Javier Cuadrado <fcocuadrado@gmail.com>.
  Closes: #521804.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man5/slapo-retcode.5
1
1
.TH SLAPO-RETCODE 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2
 
.\" Copyright 1998-2008 The OpenLDAP Foundation, All Rights Reserved.
 
2
.\" Copyright 1998-2009 The OpenLDAP Foundation, All Rights Reserved.
3
3
.\" Copying restrictions apply.  See the COPYRIGHT file.
4
4
.\" Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
5
 
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapo-retcode.5,v 1.9.2.4 2008/07/12 05:49:03 quanah Exp $
 
5
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapo-retcode.5,v 1.9.2.9 2009/06/03 01:42:00 quanah Exp $
6
6
.SH NAME
7
 
slapo-retcode \- return code overlay to slapd
 
7
slapo\-retcode \- return code overlay to slapd
8
8
.SH SYNOPSIS
9
9
ETCDIR/slapd.conf
10
10
.SH DESCRIPTION
58
58
.hy 0
59
59
.B retcode\-item <RDN> <errCode> [op=<oplist>] [text=<message>]
60
60
.B [ref=<referral>] [sleeptime=<sec>] [matched=<DN>]
61
 
.B [unsolicited=<OID>[:<data>]] [flags=[{pre|post}-]disconnect[,...]]
 
61
.B [unsolicited=<OID>[:<data>]] [flags=[{pre|post}\-]disconnect[,...]]
62
62
.RS
63
63
A dynamically generated entry, located below \fBretcode\-parent\fP.
64
64
The \fBerrCode\fP is the number of the response code;
79
79
of an RFC 4511 unsolicited response message; if \fBOID\fP
80
80
is not "0", an extended response is generated, with the optional
81
81
\fBdata\fP appended.
82
 
If \fBflags\fP contains \fBdisconnect\fP, or \fBpre-disconnect\fP,
 
82
If \fBflags\fP contains \fBdisconnect\fP, or \fBpre\-disconnect\fP,
83
83
.BR slapd (8)
84
 
disconnects abruptly, without notice; \fBpost-disconnect\fP
 
84
disconnects abruptly, without notice; \fBpost\-disconnect\fP
85
85
causes disconnection right after sending response as appropriate.
86
86
.RE
87
87
.TP
89
89
Enables exploitation of in-directory stored errAbsObject.
90
90
May result in a lot of unnecessary overhead.
91
91
.TP
92
 
.B retcode\-sleep [-]<n>
 
92
.B retcode\-sleep [\-]<n>
93
93
Defines a sleep time in seconds that is spent before actually handling
94
94
any operation.
95
95
If negative, a random time between 0 and the absolute value of the argument
119
119
    EQUALITY integerMatch
120
120
    ORDERING integerOrderingMatch
121
121
    SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
122
 
    SINGLE-VALUE )
 
122
    SINGLE\-VALUE )
123
123
.RE
124
124
.LP
125
125
The operations that trigger the response code:
140
140
    EQUALITY caseIgnoreMatch
141
141
    SUBSTR caseIgnoreSubstringsMatch
142
142
    SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
143
 
    SINGLE-VALUE )
 
143
    SINGLE\-VALUE )
144
144
.RE
145
145
.LP
146
146
The sleep time before the response is actually returned to the client:
150
150
    DESC 'Time to wait before returning the error'
151
151
    EQUALITY integerMatch
152
152
    SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
153
 
    SINGLE-VALUE )
 
153
    SINGLE\-VALUE )
154
154
.RE
155
155
.LP
156
156
The matched DN returned to the client:
160
160
    DESC 'Value to be returned as matched DN'
161
161
    EQUALITY distinguishedNameMatch
162
162
    SYNTAX 1.3.6.1.4.1.1466.115.121.1.12
163
 
    SINGLE-VALUE )
 
163
    SINGLE\-VALUE )
164
164
.RE
165
165
.LP
166
166
The OID to be returned as extended response OID
172
172
    DESC 'OID to be returned within unsolicited response'
173
173
    EQUALITY objectIdentifierMatch
174
174
    SYNTAX 1.3.6.1.4.1.1466.115.121.1.38
175
 
    SINGLE-VALUE )
 
175
    SINGLE\-VALUE )
176
176
.RE
177
177
.LP
178
178
The octet string to be returned as extended response data
182
182
    NAME ( 'errUnsolicitedData' )
183
183
    DESC 'Data to be returned within unsolicited response'
184
184
    SYNTAX 1.3.6.1.4.1.1466.115.121.1.40
185
 
    SINGLE-VALUE )
 
185
    SINGLE\-VALUE )
186
186
.RE
187
187
.LP
188
188
If TRUE,
194
194
    NAME ( 'errDisconnect' )
195
195
    DESC 'Disconnect without notice'
196
196
    SYNTAX 1.3.6.1.4.1.1466.115.121.1.7
197
 
    SINGLE-VALUE )
 
197
    SINGLE\-VALUE )
198
198
.RE
199
199
.LP
200
200
The abstract class that triggers the overlay:
226
226
.RS
227
227
.nf
228
228
overlay         retcode
229
 
retcode-parent  "ou=RetCodes,dc=example,dc=com"
 
229
retcode\-parent  "ou=RetCodes,dc=example,dc=com"
 
230
 
 
231
# retcode.conf is found in tests/data/ of the source tree
230
232
include         ./retcode.conf
231
233
 
232
234
# Wait 10 seconds, then return success (0x00)
233
 
retcode-item    "cn=Success after 10 seconds" 0x00 sleeptime=10
 
235
retcode\-item    "cn=Success after 10 seconds" 0x00 sleeptime=10
234
236
# Wait 10 seconds, then return timelimitExceeded (0x03)
235
 
retcode-item    "cn=Timelimit after 10 seconds" 0x03 sleeptime=10
 
237
retcode\-item    "cn=Timelimit after 10 seconds" 0x03 sleeptime=10
236
238
.fi
237
239
.RE
238
240
.LP
244
246
default slapd configuration file
245
247
.SH SEE ALSO
246
248
.BR slapd.conf (5),
247
 
.BR slapd (8),
 
249
.BR slapd\-config (5),
 
250
.BR slapd (8).
 
251
The
 
252
.BR slapo\-retcode (5)
 
253
overlay supports dynamic configuration via
 
254
.BR back-config .
248
255
.SH ACKNOWLEDGEMENTS
249
256
.P
250
257
This module was written in 2005 by Pierangelo Masarati for SysNet s.n.c.