1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
/** BEGIN COPYRIGHT BLOCK
* This Program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation; version 2 of the License.
*
* This Program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* this Program; if not, write to the Free Software Foundation, Inc., 59 Temple
* Place, Suite 330, Boston, MA 02111-1307 USA.
*
* In addition, as a special exception, Red Hat, Inc. gives You the additional
* right to link the code of this Program with code not covered under the GNU
* General Public License ("Non-GPL Code") and to distribute linked combinations
* including the two, subject to the limitations in this paragraph. Non-GPL Code
* permitted under this exception must only link to the code of this Program
* through those well defined interfaces identified in the file named EXCEPTION
* found in the source code files (the "Approved Interfaces"). The files of
* Non-GPL Code may instantiate templates or use macros or inline functions from
* the Approved Interfaces without causing the resulting work to be covered by
* the GNU General Public License. Only Red Hat, Inc. may make changes or
* additions to the list of Approved Interfaces. You must obey the GNU General
* Public License in all respects for all of the Program code and other code used
* in conjunction with the Program except the Non-GPL Code covered by this
* exception. If you modify this file, you may extend this exception to your
* version of the file, but you are not obligated to do so. If you do not wish to
* provide this exception without modification, you must delete this exception
* statement from your version and license this file solely under the GPL without
* exception.
*
*
* Copyright (C) 2001 Sun Microsystems, Inc. Used by permission.
* Copyright (C) 2005 Red Hat, Inc.
* All rights reserved.
* END COPYRIGHT BLOCK **/
/************************************************************
testpreop.c
This source file provides examples of pre-operation plug-in
functions. The server calls these plug-in functions before
executing certain LDAP operations:
* testpreop_bind (called before an LDAP bind operation)
* testpreop_add (called before an LDAP add operation)
* testpreop_search (called before an LDAP search operation)
* testpreop_abandon (called before an LDAP abandon operation)
testpreop_bind logs information about the LDAP bind operation
to the server error log. testpreop_add prepends the name "BOB"
to the value of the cn attribute before an entry is added.
Note that the Directory Server front-end handles bind
operations requested by the root DN. The server does not
invoke your plug-in function if the client is authenticating
as the root DN.
To test this plug-in function, stop the server, edit the dse.ldif file
(in the <server_root>/slapd-<server_id>/config directory)
and add the following lines before restarting the server :
dn: cn=Test Preop,cn=plugins,cn=config
objectClass: top
objectClass: nsSlapdPlugin
objectClass: extensibleObject
cn: Test Preop
nsslapd-pluginPath: <server_root>/plugins/slapd/slapi/examples/libtest-plugin.so
nsslapd-pluginInitfunc: testpreop_init
nsslapd-pluginType: preoperation
nsslapd-pluginEnabled: on
nsslapd-plugin-depends-on-type: database
nsslapd-pluginId: test-preop
************************************************************/
#include <stdio.h>
#include <string.h>
#include "slapi-plugin.h"
Slapi_PluginDesc preoppdesc = { "test-preop", "Fedora Project", "1.0.4",
"sample pre-operation plugin" };
/* Pre-operation plug-in function */
int
testpreop_bind( Slapi_PBlock *pb )
{
char *dn;
int method;
char *auth;
/* Get the DN that the client is binding as and the method
of authentication used. */
if ( slapi_pblock_get( pb, SLAPI_BIND_TARGET, &dn ) != 0 ||
slapi_pblock_get( pb, SLAPI_BIND_METHOD, &method ) != 0 ) {
slapi_log_error( SLAPI_LOG_PLUGIN,
"testpreop_bind", "Could not get parameters\n" );
return( -1 );
}
switch( method ) {
case LDAP_AUTH_NONE:
auth = "No authentication";
break;
case LDAP_AUTH_SIMPLE:
auth = "Simple authentication";
break;
case LDAP_AUTH_SASL:
auth = "SASL authentication";
break;
default:
auth = "Unknown method of authentication";
break;
}
/* Log information about the bind operation to the
server error log. */
slapi_log_error( SLAPI_LOG_PLUGIN, "testpreop_bind",
"Preoperation bind function called.\n"
"\tTarget DN: %s\n\tAuthentication method: %s\n",
dn, auth );
return( 0 ); /* allow the operation to continue */
}
/* Pre-operation plug-in function */
int
testpreop_add( Slapi_PBlock *pb )
{
Slapi_Entry *e;
Slapi_Attr *a;
Slapi_Value *v;
struct berval **bvals;
int i, hint;
char *tmp;
const char *s;
/* Get the entry that is about to be added. */
if ( slapi_pblock_get( pb, SLAPI_ADD_ENTRY, &e ) != 0 ) {
slapi_log_error( SLAPI_LOG_PLUGIN,
"testpreop_add", "Could not get entry\n" );
return( -1 );
}
/* Prepend the name "BOB" to the value of the cn attribute
in the entry. */
if ( slapi_entry_attr_find( e, "cn", &a ) == 0 ) {
for ( hint = slapi_attr_first_value( a, &v ); hint != -1;
hint = slapi_attr_next_value( a, hint, &v )) {
s = slapi_value_get_string( v );
tmp = (char *) malloc( 5 + strlen( s ));
strcpy( tmp, "BOB " );
strcat( tmp + 4, s );
slapi_value_set_string( v, tmp );
free( tmp );
}
}
return( 0 ); /* allow the operation to continue */
}
/* Pre-operation plug-in function */
int
testpreop_search( Slapi_PBlock *pb )
{
char *base;
/* Log a message to indicate when the plug-in function starts */
slapi_log_error( SLAPI_LOG_FATAL, "testpreop_search",
"*** PREOPERATION SEARCH PLUGIN ***\n");
/* Get and log the base DN of the search criteria */
if ( slapi_pblock_get( pb, SLAPI_SEARCH_TARGET, &base ) == 0 )
slapi_log_error( SLAPI_LOG_FATAL, "SLAPI_SEARCH_TARGET",
"%s\n", base );
/* Get and log the original base DN */
if ( slapi_pblock_get( pb, SLAPI_ORIGINAL_TARGET_DN, &base ) == 0 )
slapi_log_error( SLAPI_LOG_FATAL, "SLAPI_ORIGINAL_TARGET_DN",
"%s\n", base );
return( 0 ); /* allow the operation to continue */
}
/* Pre-operation plug-in function */
int
testpreop_abandon( Slapi_PBlock *pb )
{
int msgid;
/* Get the LDAP message ID of the abandon target */
if ( slapi_pblock_get( pb, SLAPI_ABANDON_MSGID, &msgid ) != 0 ) {
slapi_log_error( SLAPI_LOG_PLUGIN,
"testpreop_abandon", "Could not get parameters\n" );
return( -1 );
}
/* Log information about the abandon operation to the
server error log. */
slapi_log_error( SLAPI_LOG_PLUGIN, "testpreop_bind",
"Preoperation abandon function called.\n"
"\tTarget MsgID: %d\n",
msgid );
return( 0 ); /* allow the operation to continue */
}
static void
get_plugin_config_dn_and_entry( char *msg, Slapi_PBlock *pb )
{
char *dn = NULL;
Slapi_Entry *e = NULL;
int loglevel = SLAPI_LOG_PLUGIN;
if ( slapi_pblock_get( pb, SLAPI_TARGET_DN, &dn ) != 0 || dn == NULL ) {
slapi_log_error( loglevel, msg, "failed to get plugin config DN\n" );
} else {
slapi_log_error( loglevel, msg, "this plugin's config DN is \"%s\"\n",
dn );
}
if ( slapi_pblock_get( pb, SLAPI_ADD_ENTRY, &e ) != 0 || e == NULL ) {
slapi_log_error( loglevel, msg, "failed to get plugin config entry\n" );
} else {
char *ldif;
ldif = slapi_entry2str_with_options( e, NULL, 0 );
slapi_log_error( loglevel, msg,
"this plugin's config entry is \"\n%s\"\n", ldif );
slapi_ch_free_string( &ldif );
}
}
static int
testpreop_start( Slapi_PBlock *pb )
{
get_plugin_config_dn_and_entry( "testpreop_start", pb );
return( 0 );
}
/* Initialization function */
#ifdef _WIN32
__declspec(dllexport)
#endif
int
testpreop_init( Slapi_PBlock *pb )
{
/* Register the two pre-operation plug-in functions,
and specify the server plug-in version. */
if ( slapi_pblock_set( pb, SLAPI_PLUGIN_VERSION,
SLAPI_PLUGIN_VERSION_01 ) != 0 ||
slapi_pblock_set( pb, SLAPI_PLUGIN_DESCRIPTION,
(void *)&preoppdesc ) != 0 ||
slapi_pblock_set( pb, SLAPI_PLUGIN_START_FN,
(void *) testpreop_start ) != 0 ||
slapi_pblock_set( pb, SLAPI_PLUGIN_PRE_BIND_FN,
(void *) testpreop_bind ) != 0 ||
slapi_pblock_set( pb, SLAPI_PLUGIN_PRE_ADD_FN,
(void *) testpreop_add ) != 0 ||
slapi_pblock_set( pb, SLAPI_PLUGIN_PRE_SEARCH_FN,
(void *) testpreop_search ) != 0 ||
slapi_pblock_set( pb, SLAPI_PLUGIN_PRE_ABANDON_FN,
(void *) testpreop_abandon ) != 0 ) {
slapi_log_error( SLAPI_LOG_FATAL, "testpreop_init",
"Failed to set version and function\n" );
return( -1 );
}
return( 0 );
}
|
