2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2005 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
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>.
17 * LDAPv3 Extended Operation Request
18 * ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
19 * requestName [0] LDAPOID,
20 * requestValue [1] OCTET STRING OPTIONAL
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
36 #include <ac/socket.h>
37 #include <ac/string.h>
43 #include "slapi/slapi.h"
46 #define UNSUPPORTED_EXOP "unsupported extended operation"
49 static struct extop_list {
50 struct extop_list *next;
53 SLAP_EXTOP_MAIN_FN *ext_main;
54 } *supp_ext_list = NULL;
56 static SLAP_EXTOP_MAIN_FN whoami_extop;
58 /* This list of built-in extops is for extops that are not part
59 * of backends or in external modules. Essentially, this is
60 * just a way to get built-in extops onto the extop list without
61 * having a separate init routine for each built-in extop.
63 const struct berval slap_EXOP_CANCEL = BER_BVC(LDAP_EXOP_X_CANCEL);
64 const struct berval slap_EXOP_WHOAMI = BER_BVC(LDAP_EXOP_X_WHO_AM_I);
65 const struct berval slap_EXOP_MODIFY_PASSWD = BER_BVC(LDAP_EXOP_MODIFY_PASSWD);
66 const struct berval slap_EXOP_START_TLS = BER_BVC(LDAP_EXOP_START_TLS);
69 const struct berval *oid;
71 SLAP_EXTOP_MAIN_FN *ext_main;
72 } builtin_extops[] = {
73 { &slap_EXOP_CANCEL, SLAP_EXOP_HIDE, cancel_extop },
74 { &slap_EXOP_WHOAMI, 0, whoami_extop },
75 { &slap_EXOP_MODIFY_PASSWD, SLAP_EXOP_WRITES, passwd_extop },
77 { &slap_EXOP_START_TLS, 0, starttls_extop },
83 static struct extop_list *find_extop(
84 struct extop_list *list, struct berval *oid );
87 get_supported_extop (int index)
89 struct extop_list *ext;
91 /* linear scan is slow, but this way doesn't force a
92 * big change on root_dse.c, where this routine is used.
94 for (ext = supp_ext_list; ext != NULL && --index >= 0; ext = ext->next) {
98 if (ext == NULL) return NULL;
104 int exop_root_dse_info( Entry *e )
106 AttributeDescription *ad_supportedExtension
107 = slap_schema.si_ad_supportedExtension;
108 struct berval vals[2];
109 struct extop_list *ext;
111 vals[1].bv_val = NULL;
114 for (ext = supp_ext_list; ext != NULL; ext = ext->next) {
115 if( ext->flags & SLAP_EXOP_HIDE ) continue;
119 if( attr_merge( e, ad_supportedExtension, vals, NULL ) ) {
133 struct berval reqdata = {0, NULL};
137 Debug( LDAP_DEBUG_TRACE, "do_extended\n", 0, 0, 0 );
139 if( op->o_protocol < LDAP_VERSION3 ) {
140 Debug( LDAP_DEBUG_ANY,
141 "do_extended: protocol version (%d) too low\n",
142 op->o_protocol, 0 ,0 );
143 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "requires LDAPv3" );
144 rs->sr_err = SLAPD_DISCONNECT;
148 if ( ber_scanf( op->o_ber, "{m" /*}*/, &op->ore_reqoid ) == LBER_ERROR ) {
149 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
150 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
151 rs->sr_err = SLAPD_DISCONNECT;
155 tag = ber_peek_tag( op->o_ber, &len );
157 if( ber_peek_tag( op->o_ber, &len ) == LDAP_TAG_EXOP_REQ_VALUE ) {
158 if( ber_scanf( op->o_ber, "m", &reqdata ) == LBER_ERROR ) {
159 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
160 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
161 rs->sr_err = SLAPD_DISCONNECT;
166 if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
167 Debug( LDAP_DEBUG_ANY, "do_extended: get_ctrls failed\n", 0, 0 ,0 );
171 /* check for controls inappropriate for all extended operations */
172 if( get_manageDSAit( op ) == SLAP_CONTROL_CRITICAL ) {
173 send_ldap_error( op, rs,
174 LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
175 "manageDSAit control inappropriate" );
179 /* FIXME: temporary? */
180 if ( reqdata.bv_val ) {
181 op->ore_reqdata = &reqdata;
184 op->o_bd = frontendDB;
185 rs->sr_err = frontendDB->be_extended( op, rs );
192 fe_extended( Operation *op, SlapReply *rs )
194 struct extop_list *ext = NULL;
195 struct berval reqdata = BER_BVNULL;
197 #if defined(LDAP_SLAPI)
198 Slapi_PBlock *pb = op->o_pb;
199 SLAPI_FUNC funcAddr = NULL;
201 int msg_sent = FALSE;
202 #endif /* defined(LDAP_SLAPI) */
204 if (op->ore_reqdata) {
205 reqdata = *op->ore_reqdata;
209 /* NS-SLAPI extended operation */
210 slapi_int_get_extop_plugin( &op->ore_reqoid, &funcAddr );
212 if( !funcAddr && !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
214 if( !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
217 Debug( LDAP_DEBUG_ANY, "do_extended: unsupported operation \"%s\"\n",
218 op->ore_reqoid.bv_val, 0 ,0 );
219 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR,
220 "unsupported extended operation" );
224 op->ore_flags = ext->flags;
226 Debug( LDAP_DEBUG_ARGS, "do_extended: oid=%s\n",
227 op->ore_reqoid.bv_val, 0 ,0 );
229 #if defined(LDAP_SLAPI)
230 if ( funcAddr != NULL ) {
231 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_OID,
232 (void *)op->ore_reqoid.bv_val);
233 if ( rs->sr_err != LDAP_SUCCESS ) {
234 rs->sr_err = LDAP_OTHER;
238 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_VALUE,
240 if ( rs->sr_err != LDAP_SUCCESS ) {
241 rs->sr_err = LDAP_OTHER;
245 rs->sr_err = slapi_int_pblock_set_operation( pb, op );
246 if ( rs->sr_err != LDAP_SUCCESS ) {
247 rs->sr_err = LDAP_OTHER;
251 extop_rc = (*funcAddr)( pb );
252 if ( extop_rc == SLAPI_PLUGIN_EXTENDED_SENT_RESULT ) {
255 } else if ( extop_rc == SLAPI_PLUGIN_EXTENDED_NOT_HANDLED ) {
256 rs->sr_err = LDAP_PROTOCOL_ERROR;
257 rs->sr_text = UNSUPPORTED_EXOP;
260 rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_OID,
262 if ( rs->sr_err != LDAP_SUCCESS ) {
266 rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_VALUE,
268 if ( rs->sr_err != LDAP_SUCCESS ) {
272 rs->sr_err = extop_rc;
273 send_ldap_extended( op, rs );
278 if ( rs->sr_err != LDAP_SUCCESS && msg_sent == FALSE ) {
279 send_ldap_result( op, rs );
282 if ( rs->sr_rspoid != NULL ) {
283 ch_free( (char *)rs->sr_rspoid );
286 if ( rs->sr_rspdata != NULL ) {
287 ber_bvfree( rs->sr_rspdata );
290 #endif /* defined( LDAP_SLAPI ) */
291 { /* start of OpenLDAP extended operation */
292 rs->sr_err = (ext->ext_main)( op, rs );
294 if( rs->sr_err != SLAPD_ABANDON ) {
295 if ( rs->sr_err == LDAP_REFERRAL && rs->sr_ref == NULL ) {
296 rs->sr_ref = referral_rewrite( default_referral,
297 NULL, NULL, LDAP_SCOPE_DEFAULT );
298 if ( !rs->sr_ref ) rs->sr_ref = default_referral;
300 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
301 rs->sr_text = "referral missing";
305 send_ldap_extended( op, rs );
307 if ( rs->sr_ref != default_referral ) {
308 ber_bvarray_free( rs->sr_ref );
313 if ( rs->sr_rspoid != NULL ) {
314 free( (char *)rs->sr_rspoid );
317 if ( rs->sr_rspdata != NULL ) {
318 ber_bvfree( rs->sr_rspdata );
320 } /* end of OpenLDAP extended operation */
328 struct berval *ext_oid,
329 slap_mask_t ext_flags,
330 SLAP_EXTOP_MAIN_FN *ext_main )
332 struct extop_list *ext;
334 if( ext_oid == NULL || ext_oid->bv_val == NULL ||
335 ext_oid->bv_val[0] == '\0' || ext_oid->bv_len == 0 ) return -1;
336 if(!ext_main) return -1;
338 ext = ch_calloc(1, sizeof(struct extop_list) + ext_oid->bv_len + 1);
342 ext->flags = ext_flags;
344 ext->oid.bv_val = (char *)(ext + 1);
345 AC_MEMCPY( ext->oid.bv_val, ext_oid->bv_val, ext_oid->bv_len );
346 ext->oid.bv_len = ext_oid->bv_len;
347 ext->oid.bv_val[ext->oid.bv_len] = '\0';
349 ext->ext_main = ext_main;
350 ext->next = supp_ext_list;
362 for (i = 0; builtin_extops[i].oid != NULL; i++) {
363 load_extop((struct berval *)builtin_extops[i].oid,
364 builtin_extops[i].flags,
365 builtin_extops[i].ext_main);
373 struct extop_list *ext;
375 /* we allocated the memory, so we have to free it, too. */
376 while ((ext = supp_ext_list) != NULL) {
377 supp_ext_list = ext->next;
383 static struct extop_list *
384 find_extop( struct extop_list *list, struct berval *oid )
386 struct extop_list *ext;
388 for (ext = list; ext; ext = ext->next) {
389 if (bvmatch(&ext->oid, oid))
403 if ( op->ore_reqdata != NULL ) {
404 /* no request data should be provided */
405 rs->sr_text = "no request data expected";
406 return LDAP_PROTOCOL_ERROR;
409 op->o_bd = op->o_conn->c_authz_backend;
410 if( backend_check_restrictions( op, rs,
411 (struct berval *)&slap_EXOP_WHOAMI ) != LDAP_SUCCESS ) {
415 bv = (struct berval *) ch_malloc( sizeof(struct berval) );
416 if( op->o_dn.bv_len ) {
417 bv->bv_len = op->o_dn.bv_len + STRLENOF( "dn:" );
418 bv->bv_val = ch_malloc( bv->bv_len + 1 );
419 AC_MEMCPY( bv->bv_val, "dn:", STRLENOF( "dn:" ) );
420 AC_MEMCPY( &bv->bv_val[STRLENOF( "dn:" )], op->o_dn.bv_val,
422 bv->bv_val[bv->bv_len] = '\0';