]> git.sur5r.net Git - openldap/blob - servers/slapd/extended.c
- setup framework for monitoring of back-bdb/back-hdb stuff in their
[openldap] / servers / slapd / extended.c
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  *
4  * Copyright 1999-2006 The OpenLDAP Foundation.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted only as authorized by the OpenLDAP
9  * Public License.
10  *
11  * A copy of this license is available in the file LICENSE in the
12  * top-level directory of the distribution or, alternatively, at
13  * <http://www.OpenLDAP.org/license.html>.
14  */
15
16 /*
17  * LDAPv3 Extended Operation Request
18  *      ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
19  *              requestName      [0] LDAPOID,
20  *              requestValue     [1] OCTET STRING OPTIONAL
21  *      }
22  *
23  * LDAPv3 Extended Operation Response
24  *      ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
25  *              COMPONENTS OF LDAPResult,
26  *              responseName     [10] LDAPOID OPTIONAL,
27  *              response         [11] OCTET STRING OPTIONAL
28  *      }
29  *
30  */
31
32 #include "portable.h"
33
34 #include <stdio.h>
35
36 #include <ac/socket.h>
37 #include <ac/string.h>
38
39 #include "slap.h"
40 #include "lber_pvt.h"
41
42 static struct extop_list {
43         struct extop_list *next;
44         struct berval oid;
45         slap_mask_t flags;
46         SLAP_EXTOP_MAIN_FN *ext_main;
47 } *supp_ext_list = NULL;
48
49 static SLAP_EXTOP_MAIN_FN whoami_extop;
50
51 /* This list of built-in extops is for extops that are not part
52  * of backends or in external modules.  Essentially, this is
53  * just a way to get built-in extops onto the extop list without
54  * having a separate init routine for each built-in extop.
55  */
56 static struct {
57         const struct berval *oid;
58         slap_mask_t flags;
59         SLAP_EXTOP_MAIN_FN *ext_main;
60 } builtin_extops[] = {
61 #ifdef LDAP_X_TXN
62         { &slap_EXOP_TXN_START, 0, txn_start_extop },
63         { &slap_EXOP_TXN_END, 0, txn_end_extop },
64 #endif
65         { &slap_EXOP_CANCEL, 0, cancel_extop },
66         { &slap_EXOP_WHOAMI, 0, whoami_extop },
67         { &slap_EXOP_MODIFY_PASSWD, SLAP_EXOP_WRITES, passwd_extop },
68         { NULL, 0, NULL }
69 };
70
71
72 static struct extop_list *find_extop(
73         struct extop_list *list, struct berval *oid );
74
75 struct berval *
76 get_supported_extop (int index)
77 {
78         struct extop_list *ext;
79
80         /* linear scan is slow, but this way doesn't force a
81          * big change on root_dse.c, where this routine is used.
82          */
83         for (ext = supp_ext_list; ext != NULL && --index >= 0; ext = ext->next) {
84                 ; /* empty */
85         }
86
87         if (ext == NULL) return NULL;
88
89         return &ext->oid;
90 }
91
92
93 int exop_root_dse_info( Entry *e )
94 {
95         AttributeDescription *ad_supportedExtension
96                 = slap_schema.si_ad_supportedExtension;
97         struct berval vals[2];
98         struct extop_list *ext;
99
100         vals[1].bv_val = NULL;
101         vals[1].bv_len = 0;
102
103         for (ext = supp_ext_list; ext != NULL; ext = ext->next) {
104                 if( ext->flags & SLAP_EXOP_HIDE ) continue;
105
106                 vals[0] = ext->oid;
107
108                 if( attr_merge( e, ad_supportedExtension, vals, NULL ) ) {
109                         return LDAP_OTHER;
110                 }
111         }
112
113         return LDAP_SUCCESS;
114 }
115
116 int
117 do_extended(
118     Operation   *op,
119     SlapReply   *rs
120 )
121 {
122         struct berval reqdata = {0, NULL};
123         ber_tag_t tag;
124         ber_len_t len;
125
126         Debug( LDAP_DEBUG_TRACE, "do_extended\n", 0, 0, 0 );
127
128         if( op->o_protocol < LDAP_VERSION3 ) {
129                 Debug( LDAP_DEBUG_ANY,
130                         "do_extended: protocol version (%d) too low\n",
131                         op->o_protocol, 0 ,0 );
132                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "requires LDAPv3" );
133                 rs->sr_err = SLAPD_DISCONNECT;
134                 goto done;
135         }
136
137         if ( ber_scanf( op->o_ber, "{m" /*}*/, &op->ore_reqoid ) == LBER_ERROR ) {
138                 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
139                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
140                 rs->sr_err = SLAPD_DISCONNECT;
141                 goto done;
142         }
143
144         tag = ber_peek_tag( op->o_ber, &len );
145         
146         if( ber_peek_tag( op->o_ber, &len ) == LDAP_TAG_EXOP_REQ_VALUE ) {
147                 if( ber_scanf( op->o_ber, "m", &reqdata ) == LBER_ERROR ) {
148                         Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
149                         send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
150                         rs->sr_err = SLAPD_DISCONNECT;
151                         goto done;
152                 }
153         }
154
155         if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
156                 Debug( LDAP_DEBUG_ANY, "do_extended: get_ctrls failed\n", 0, 0 ,0 );
157                 return rs->sr_err;
158         } 
159
160         /* check for controls inappropriate for all extended operations */
161         if( get_manageDSAit( op ) == SLAP_CONTROL_CRITICAL ) {
162                 Statslog( LDAP_DEBUG_STATS, "%s EXT oid=%s\n",
163                     op->o_log_prefix, op->ore_reqoid.bv_val, 0, 0, 0 );
164                 send_ldap_error( op, rs,
165                         LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
166                         "manageDSAit control inappropriate" );
167                 goto done;
168         }
169
170         /* FIXME: temporary? */
171         if ( reqdata.bv_val ) {
172                 op->ore_reqdata = &reqdata;
173         }
174
175         op->o_bd = frontendDB;
176         rs->sr_err = frontendDB->be_extended( op, rs );
177
178 done:
179         return rs->sr_err;
180 }
181
182 int
183 fe_extended( Operation *op, SlapReply *rs )
184 {
185         struct extop_list       *ext = NULL;
186         struct berval           reqdata = BER_BVNULL;
187
188         if (op->ore_reqdata) {
189                 reqdata = *op->ore_reqdata;
190         }
191
192         ext = find_extop(supp_ext_list, &op->ore_reqoid );
193         if ( ext == NULL ) {
194                 Statslog( LDAP_DEBUG_STATS, "%s EXT oid=%s\n",
195                     op->o_log_prefix, op->ore_reqoid.bv_val, 0, 0, 0 );
196                 Debug( LDAP_DEBUG_ANY, "do_extended: unsupported operation \"%s\"\n",
197                         op->ore_reqoid.bv_val, 0 ,0 );
198                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR,
199                         "unsupported extended operation" );
200                 goto done;
201         }
202
203         op->ore_flags = ext->flags;
204
205         Debug( LDAP_DEBUG_ARGS, "do_extended: oid=%s\n",
206                 op->ore_reqoid.bv_val, 0 ,0 );
207
208         { /* start of OpenLDAP extended operation */
209                 BackendDB       *bd = op->o_bd;
210
211                 rs->sr_err = (ext->ext_main)( op, rs );
212
213                 if( rs->sr_err != SLAPD_ABANDON ) {
214                         if ( rs->sr_err == LDAP_REFERRAL && rs->sr_ref == NULL ) {
215                                 rs->sr_ref = referral_rewrite( default_referral,
216                                         NULL, NULL, LDAP_SCOPE_DEFAULT );
217                                 if ( !rs->sr_ref ) rs->sr_ref = default_referral;
218                                 if ( !rs->sr_ref ) {
219                                         rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
220                                         rs->sr_text = "referral missing";
221                                 }
222                         }
223
224                         if ( op->o_bd == NULL )
225                                 op->o_bd = bd;
226                         send_ldap_extended( op, rs );
227
228                         if ( rs->sr_ref != default_referral ) {
229                                 ber_bvarray_free( rs->sr_ref );
230                                 rs->sr_ref = NULL;
231                         }
232                 }
233
234                 if ( rs->sr_rspoid != NULL ) {
235                         free( (char *)rs->sr_rspoid );
236                 }
237
238                 if ( rs->sr_rspdata != NULL ) {
239                         ber_bvfree( rs->sr_rspdata );
240                 }
241         } /* end of OpenLDAP extended operation */
242
243 done:;
244         return rs->sr_err;
245 }
246
247 int
248 load_extop2(
249         const struct berval *ext_oid,
250         slap_mask_t ext_flags,
251         SLAP_EXTOP_MAIN_FN *ext_main,
252         unsigned flags )
253 {
254         struct berval           oidm = BER_BVNULL;
255         struct extop_list       *ext;
256         int                     insertme = 0;
257
258         if ( !ext_main ) {
259                 return -1; 
260         }
261
262         if ( ext_oid == NULL || BER_BVISNULL( ext_oid ) ||
263                 BER_BVISEMPTY( ext_oid ) )
264         {
265                 return -1; 
266         }
267
268         if ( numericoidValidate( NULL, (struct berval *)ext_oid ) !=
269                 LDAP_SUCCESS )
270         {
271                 oidm.bv_val = oidm_find( ext_oid->bv_val );
272                 if ( ext_oid == NULL ) {
273                         return -1;
274                 }
275                 oidm.bv_len = strlen( oidm.bv_val );
276                 ext_oid = &oidm;
277         }
278
279         for ( ext = supp_ext_list; ext; ext = ext->next ) {
280                 if ( bvmatch( ext_oid, &ext->oid ) ) {
281                         if ( flags == 1 ) {
282                                 break;
283                         }
284                         return -1;
285                 }
286         }
287
288         if ( flags == 0 || ext == NULL ) {
289                 ext = ch_calloc( 1, sizeof(struct extop_list) + ext_oid->bv_len + 1 );
290                 if ( ext == NULL ) {
291                         return(-1);
292                 }
293
294                 ext->oid.bv_val = (char *)(ext + 1);
295                 AC_MEMCPY( ext->oid.bv_val, ext_oid->bv_val, ext_oid->bv_len );
296                 ext->oid.bv_len = ext_oid->bv_len;
297                 ext->oid.bv_val[ext->oid.bv_len] = '\0';
298
299                 insertme = 1;
300         }
301
302         ext->flags = ext_flags;
303         ext->ext_main = ext_main;
304
305         if ( insertme ) {
306                 ext->next = supp_ext_list;
307                 supp_ext_list = ext;
308         }
309
310         return(0);
311 }
312
313 int
314 extops_init (void)
315 {
316         int i;
317
318         for ( i = 0; builtin_extops[i].oid != NULL; i++ ) {
319                 load_extop( (struct berval *)builtin_extops[i].oid,
320                         builtin_extops[i].flags,
321                         builtin_extops[i].ext_main );
322         }
323         return(0);
324 }
325
326 int
327 extops_kill (void)
328 {
329         struct extop_list *ext;
330
331         /* we allocated the memory, so we have to free it, too. */
332         while ((ext = supp_ext_list) != NULL) {
333                 supp_ext_list = ext->next;
334                 ch_free(ext);
335         }
336         return(0);
337 }
338
339 static struct extop_list *
340 find_extop( struct extop_list *list, struct berval *oid )
341 {
342         struct extop_list *ext;
343
344         for (ext = list; ext; ext = ext->next) {
345                 if (bvmatch(&ext->oid, oid))
346                         return(ext);
347         }
348         return(NULL);
349 }
350
351
352 const struct berval slap_EXOP_WHOAMI = BER_BVC(LDAP_EXOP_WHO_AM_I);
353
354 static int
355 whoami_extop (
356         Operation *op,
357         SlapReply *rs )
358 {
359         struct berval *bv;
360
361         if ( op->ore_reqdata != NULL ) {
362                 /* no request data should be provided */
363                 rs->sr_text = "no request data expected";
364                 return LDAP_PROTOCOL_ERROR;
365         }
366
367         Statslog( LDAP_DEBUG_STATS, "%s WHOAMI\n",
368             op->o_log_prefix, 0, 0, 0, 0 );
369
370         op->o_bd = op->o_conn->c_authz_backend;
371         if( backend_check_restrictions( op, rs,
372                 (struct berval *)&slap_EXOP_WHOAMI ) != LDAP_SUCCESS )
373         {
374                 return rs->sr_err;
375         }
376
377         bv = (struct berval *) ch_malloc( sizeof(struct berval) );
378         if( op->o_dn.bv_len ) {
379                 bv->bv_len = op->o_dn.bv_len + STRLENOF( "dn:" );
380                 bv->bv_val = ch_malloc( bv->bv_len + 1 );
381                 AC_MEMCPY( bv->bv_val, "dn:", STRLENOF( "dn:" ) );
382                 AC_MEMCPY( &bv->bv_val[STRLENOF( "dn:" )], op->o_dn.bv_val,
383                         op->o_dn.bv_len );
384                 bv->bv_val[bv->bv_len] = '\0';
385
386         } else {
387                 bv->bv_len = 0;
388                 bv->bv_val = NULL;
389         }
390
391         rs->sr_rspdata = bv;
392         return LDAP_SUCCESS;
393 }