2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2003 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>
46 #define UNSUPPORTED_EXTENDEDOP "unsupported extended operation"
49 #define SLAP_EXOP_HIDE 0x0000
51 #define SLAP_EXOP_HIDE 0x8000
54 static struct extop_list {
55 struct extop_list *next;
58 SLAP_EXTOP_MAIN_FN *ext_main;
59 } *supp_ext_list = NULL;
61 static SLAP_EXTOP_MAIN_FN whoami_extop;
63 /* this list of built-in extops is for extops that are not part
64 * of backends or in external modules. essentially, this is
65 * just a way to get built-in extops onto the extop list without
66 * having a separate init routine for each built-in extop.
68 #ifdef LDAP_EXOP_X_CANCEL
69 const struct berval slap_EXOP_CANCEL = BER_BVC(LDAP_EXOP_X_CANCEL);
71 const struct berval slap_EXOP_WHOAMI = BER_BVC(LDAP_EXOP_X_WHO_AM_I);
72 const struct berval slap_EXOP_MODIFY_PASSWD = BER_BVC(LDAP_EXOP_MODIFY_PASSWD);
73 const struct berval slap_EXOP_START_TLS = BER_BVC(LDAP_EXOP_START_TLS);
76 const struct berval *oid;
78 SLAP_EXTOP_MAIN_FN *ext_main;
79 } builtin_extops[] = {
80 #ifdef LDAP_EXOP_X_CANCEL
81 { &slap_EXOP_CANCEL, SLAP_EXOP_HIDE, cancel_extop },
83 { &slap_EXOP_WHOAMI, 0, whoami_extop },
84 { &slap_EXOP_MODIFY_PASSWD, 0, passwd_extop },
86 { &slap_EXOP_START_TLS, 0, starttls_extop },
92 static struct extop_list *find_extop(
93 struct extop_list *list, struct berval *oid );
96 get_supported_extop (int index)
98 struct extop_list *ext;
100 /* linear scan is slow, but this way doesn't force a
101 * big change on root_dse.c, where this routine is used.
103 for (ext = supp_ext_list; ext != NULL && --index >= 0; ext = ext->next) {
107 if (ext == NULL) return NULL;
113 int exop_root_dse_info( Entry *e )
115 AttributeDescription *ad_supportedExtension
116 = slap_schema.si_ad_supportedExtension;
117 struct berval vals[2];
118 struct extop_list *ext;
120 vals[1].bv_val = NULL;
123 for (ext = supp_ext_list; ext != NULL; ext = ext->next) {
124 if( ext->flags & SLAP_EXOP_HIDE ) continue;
128 if( attr_merge( e, ad_supportedExtension, vals, NULL ) ) {
142 struct berval reqdata = {0, NULL};
145 struct extop_list *ext = NULL;
147 #if defined(LDAP_SLAPI)
148 Slapi_PBlock *pb = op->o_pb;
149 SLAPI_FUNC funcAddr = NULL;
151 int msg_sent = FALSE;
152 #endif /* defined(LDAP_SLAPI) */
155 LDAP_LOG( OPERATION, ENTRY, "do_extended: conn %d\n", op->o_connid, 0, 0 );
157 Debug( LDAP_DEBUG_TRACE, "do_extended\n", 0, 0, 0 );
160 if( op->o_protocol < LDAP_VERSION3 ) {
162 LDAP_LOG( OPERATION, ERR,
163 "do_extended: protocol version (%d) too low.\n", op->o_protocol, 0, 0 );
165 Debug( LDAP_DEBUG_ANY,
166 "do_extended: protocol version (%d) too low\n",
167 op->o_protocol, 0 ,0 );
169 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "requires LDAPv3" );
174 if ( ber_scanf( op->o_ber, "{m" /*}*/, &op->ore_reqoid ) == LBER_ERROR ) {
176 LDAP_LOG( OPERATION, ERR, "do_extended: conn %d ber_scanf failed\n",
177 op->o_connid, 0, 0 );
179 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
181 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
187 getPluginFunc( &op->ore_reqoid, &funcAddr ); /* NS-SLAPI extended operation */
188 if( !funcAddr && !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
190 if( !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
194 LDAP_LOG( OPERATION, ERR,
195 "do_extended: conn %d unsupported operation \"%s\"\n",
196 op->o_connid, op->ore_reqoid.bv_val, 0 );
198 Debug( LDAP_DEBUG_ANY, "do_extended: unsupported operation \"%s\"\n",
199 op->ore_reqoid.bv_val, 0 ,0 );
201 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR,
202 "unsupported extended operation" );
206 tag = ber_peek_tag( op->o_ber, &len );
208 if( ber_peek_tag( op->o_ber, &len ) == LDAP_TAG_EXOP_REQ_VALUE ) {
209 if( ber_scanf( op->o_ber, "m", &reqdata ) == LBER_ERROR ) {
211 LDAP_LOG( OPERATION, ERR,
212 "do_extended: conn %d ber_scanf failed\n",
213 op->o_connid, 0, 0 );
215 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
217 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
223 if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
225 LDAP_LOG( OPERATION, ERR,
226 "do_extended: conn %d get_ctrls failed\n", op->o_connid, 0, 0 );
228 Debug( LDAP_DEBUG_ANY, "do_extended: get_ctrls failed\n", 0, 0 ,0 );
233 /* check for controls inappropriate for all extended operations */
234 if( get_manageDSAit( op ) == SLAP_CRITICAL_CONTROL ) {
235 send_ldap_error( op, rs,
236 LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
237 "manageDSAit control inappropriate" );
242 LDAP_LOG( OPERATION, DETAIL1,
243 "do_extended: conn %d oid=%s\n.", op->o_connid, op->ore_reqoid.bv_val, 0 );
245 Debug( LDAP_DEBUG_ARGS, "do_extended: oid=%s\n", op->ore_reqoid.bv_val, 0 ,0 );
248 #if defined(LDAP_SLAPI)
249 if ( funcAddr != NULL ) {
250 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_OID,
251 (void *)op->ore_reqoid.bv_val);
252 if ( rs->sr_err != LDAP_SUCCESS ) {
253 rs->sr_err = LDAP_OTHER;
257 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_VALUE,
259 if ( rs->sr_err != LDAP_SUCCESS ) {
260 rs->sr_err = LDAP_OTHER;
264 rs->sr_err = slapi_x_pblock_set_operation( pb, op );
265 if ( rs->sr_err != LDAP_SUCCESS ) {
266 rs->sr_err = LDAP_OTHER;
270 extop_rc = (*funcAddr)( pb );
271 if ( extop_rc == SLAPI_PLUGIN_EXTENDED_SENT_RESULT ) {
274 } else if ( extop_rc == SLAPI_PLUGIN_EXTENDED_NOT_HANDLED ) {
275 rs->sr_err = LDAP_PROTOCOL_ERROR;
276 rs->sr_text = UNSUPPORTED_EXTENDEDOP;
279 rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_OID,
281 if ( rs->sr_err != LDAP_SUCCESS ) {
285 rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_VALUE,
287 if ( rs->sr_err != LDAP_SUCCESS ) {
291 rs->sr_err = extop_rc;
292 send_ldap_extended( op, rs );
297 if ( rs->sr_err != LDAP_SUCCESS && msg_sent == FALSE ) {
298 send_ldap_result( op, rs );
301 if ( rs->sr_rspoid != NULL ) {
302 ch_free( (char *)rs->sr_rspoid );
305 if ( rs->sr_rspdata != NULL ) {
306 ber_bvfree( rs->sr_rspdata );
308 } else { /* start of OpenLDAP extended operation */
309 #endif /* defined( LDAP_SLAPI ) */
310 if (reqdata.bv_val) op->ore_reqdata = &reqdata;
311 rs->sr_err = (ext->ext_main)( op, rs );
313 if( rs->sr_err != SLAPD_ABANDON ) {
314 if ( rs->sr_err == LDAP_REFERRAL && rs->sr_ref == NULL ) {
315 rs->sr_ref = referral_rewrite( default_referral,
316 NULL, NULL, LDAP_SCOPE_DEFAULT );
317 if ( !rs->sr_ref ) rs->sr_ref = default_referral;
319 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
320 rs->sr_text = "referral missing";
324 send_ldap_extended( op, rs );
326 ber_bvarray_free( rs->sr_ref );
329 if ( rs->sr_rspoid != NULL ) {
330 free( (char *)rs->sr_rspoid );
333 if ( rs->sr_rspdata != NULL ) {
334 ber_bvfree( rs->sr_rspdata );
337 } /* end of OpenLDAP extended operation */
338 #endif /* LDAP_SLAPI */
346 struct berval *ext_oid,
347 slap_mask_t ext_flags,
348 SLAP_EXTOP_MAIN_FN *ext_main )
350 struct extop_list *ext;
352 if( ext_oid == NULL || ext_oid->bv_val == NULL ||
353 ext_oid->bv_val[0] == '\0' || ext_oid->bv_len == 0 ) return -1;
354 if(!ext_main) return -1;
356 ext = ch_calloc(1, sizeof(struct extop_list) + ext_oid->bv_len + 1);
360 ext->flags = ext_flags;
362 ext->oid.bv_val = (char *)(ext + 1);
363 AC_MEMCPY( ext->oid.bv_val, ext_oid->bv_val, ext_oid->bv_len );
364 ext->oid.bv_len = ext_oid->bv_len;
365 ext->oid.bv_val[ext->oid.bv_len] = '\0';
367 ext->ext_main = ext_main;
368 ext->next = supp_ext_list;
380 for (i = 0; builtin_extops[i].oid != NULL; i++) {
381 load_extop((struct berval *)builtin_extops[i].oid,
382 builtin_extops[i].flags,
383 builtin_extops[i].ext_main);
391 struct extop_list *ext;
393 /* we allocated the memory, so we have to free it, too. */
394 while ((ext = supp_ext_list) != NULL) {
395 supp_ext_list = ext->next;
401 static struct extop_list *
402 find_extop( struct extop_list *list, struct berval *oid )
404 struct extop_list *ext;
406 for (ext = list; ext; ext = ext->next) {
407 if (bvmatch(&ext->oid, oid))
421 if ( op->ore_reqdata != NULL ) {
422 /* no request data should be provided */
423 rs->sr_text = "no request data expected";
424 return LDAP_PROTOCOL_ERROR;
427 op->o_bd = op->o_conn->c_authz_backend;
428 if( backend_check_restrictions( op, rs,
429 (struct berval *)&slap_EXOP_WHOAMI ) != LDAP_SUCCESS ) {
433 bv = (struct berval *) ch_malloc( sizeof(struct berval) );
434 if( op->o_dn.bv_len ) {
435 bv->bv_len = op->o_dn.bv_len + sizeof("dn:")-1;
436 bv->bv_val = ch_malloc( bv->bv_len + 1 );
437 AC_MEMCPY( bv->bv_val, "dn:", sizeof("dn:")-1 );
438 AC_MEMCPY( &bv->bv_val[sizeof("dn:")-1], op->o_dn.bv_val,
440 bv->bv_val[bv->bv_len] = '\0';