slapd-perl.5 revision 1.5
1 .lf 1 stdin 2 .TH SLAPD-PERL 5 "2014/01/26" "OpenLDAP 2.4.39" 3 .\" $OpenLDAP$ 4 .SH NAME 5 slapd\-perl \- Perl backend to slapd 6 .SH SYNOPSIS 7 /etc/openldap/slapd.conf 8 .SH DESCRIPTION 9 The Perl backend to 10 .BR slapd (8) 11 works by embedding a 12 .BR perl (1) 13 interpreter into 14 .BR slapd (8). 15 Any perl database section of the configuration file 16 .BR slapd.conf (5) 17 must then specify what Perl module to use. 18 .B Slapd 19 then creates a new Perl object that handles all the requests for that 20 particular instance of the backend. 21 .LP 22 You will need to create a method for each one of the 23 following actions: 24 .LP 25 .nf 26 * new # creates a new object, 27 * search # performs the ldap search, 28 * compare # does a compare, 29 * modify # modifies an entry, 30 * add # adds an entry to backend, 31 * modrdn # modifies an entry's rdn, 32 * delete # deletes an ldap entry, 33 * config # module-specific config directives, 34 * init # called after backend is initialized. 35 .fi 36 .LP 37 Unless otherwise specified, the methods return the result code 38 which will be returned to the client. Unimplemented actions 39 can just return unwillingToPerform (53). 40 .TP 41 .B new 42 This method is called when the configuration file encounters a 43 .B perlmod 44 line. 45 The module in that line is then effectively `use'd into the perl 46 interpreter, then the \fBnew\fR method is called to create a new 47 object. 48 Note that multiple instances of that object may be instantiated, as 49 with any perl object. 50 .\" .LP 51 The 52 .B new 53 method receives the class name as argument. 54 .TP 55 .B search 56 This method is called when a search request comes from a client. 57 It arguments are as follows: 58 .nf 59 * object reference 60 * base DN 61 * scope 62 * alias dereferencing policy 63 * size limit 64 * time limit 65 * filter string 66 * attributes only flag (1 for yes) 67 * list of attributes to return (may be empty) 68 .fi 69 .LP 70 Return value: (resultcode, ldif-entry, ldif-entry, ...) 71 .TP 72 .B compare 73 This method is called when a compare request comes from a client. 74 Its arguments are as follows. 75 .nf 76 * object reference 77 * dn 78 * attribute assertion string 79 .fi 80 .LP 81 .TP 82 .B modify 83 This method is called when a modify request comes from a client. 84 Its arguments are as follows. 85 .nf 86 * object reference 87 * dn 88 * a list formatted as follows 89 ({ "ADD" | "DELETE" | "REPLACE" }, 90 attributetype, value...)... 91 .fi 92 .LP 93 .TP 94 .B add 95 This method is called when a add request comes from a client. 96 Its arguments are as follows. 97 .nf 98 * object reference 99 * entry in string format 100 .fi 101 .LP 102 .TP 103 .B modrdn 104 This method is called when a modrdn request comes from a client. 105 Its arguments are as follows. 106 .nf 107 * object reference 108 * dn 109 * new rdn 110 * delete old dn flag (1 means yes) 111 .fi 112 .LP 113 .TP 114 .B delete 115 This method is called when a delete request comes from a client. 116 Its arguments are as follows. 117 .nf 118 * object reference 119 * dn 120 .fi 121 .LP 122 .TP 123 .B config 124 This method is called once for each perlModuleConfig line in the 125 .BR slapd.conf (5) 126 configuration file. 127 Its arguments are as follows. 128 .nf 129 * object reference 130 * array of arguments on line 131 .fi 132 .LP 133 Return value: nonzero if this is not a valid option. 134 .TP 135 .B init 136 This method is called after backend is initialized. 137 Its argument is as follows. 138 .nf 139 * object reference 140 .fi 141 .LP 142 Return value: nonzero if initialization failed. 143 .SH CONFIGURATION 144 These 145 .B slapd.conf 146 options apply to the PERL backend database. 147 That is, they must follow a "database perl" line and come before any 148 subsequent "backend" or "database" lines. 149 Other database options are described in the 150 .BR slapd.conf (5) 151 manual page. 152 .TP 153 .B perlModulePath /path/to/libs 154 Add the path to the @INC variable. 155 .TP 156 .B perlModule ModName 157 `Use' the module name ModName from ModName.pm 158 .TP 159 .B filterSearchResults 160 Search results are candidates that need to be filtered (with the 161 filter in the search request), rather than search results to be 162 returned directly to the client. 163 .TP 164 .B perlModuleConfig <arguments> 165 Invoke the module's config method with the given arguments. 166 .SH EXAMPLE 167 There is an example Perl module `SampleLDAP' in the slapd/back\-perl/ 168 directory in the OpenLDAP source tree. 169 .SH ACCESS CONTROL 170 The 171 .B perl 172 backend does not honor any of the access control semantics described in 173 .BR slapd.access (5); 174 all access control is delegated to the underlying PERL scripting. 175 Only 176 .B read (=r) 177 access to the 178 .B entry 179 pseudo-attribute and to the other attribute values of the entries 180 returned by the 181 .B search 182 operation is honored, which is performed by the frontend. 183 .SH WARNING 184 The interface of this backend to the perl module MAY change. 185 Any suggestions would greatly be appreciated. 186 187 Note: in previous versions, any unrecognized lines in the slapd.conf 188 file were passed to the perl module's config method. This behavior is 189 deprecated (but still allowed for backward compatibility), and the 190 perlModuleConfig directive should instead be used to invoke the 191 module's config method. This compatibility feature will be removed at 192 some future date. 193 .SH FILES 194 .TP 195 /etc/openldap/slapd.conf 196 default slapd configuration file 197 .SH SEE ALSO 198 .BR slapd.conf (5), 199 .BR slapd (8), 200 .BR perl (1). 201
Indexes created Wed May 13 00:24:45 UTC 2026