3 * Copyright 1999-2003 The OpenLDAP Foundation.
6 * Redistribution and use in source and binary forms are permitted only
7 * as authorized by the OpenLDAP Public License. A copy of this
8 * license is available at http://www.OpenLDAP.org/license.html or
9 * in file LICENSE in the top-level directory of the distribution.
13 * LDAPv3 Extended Operation Request
14 * ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
15 * requestName [0] LDAPOID,
16 * requestValue [1] OCTET STRING OPTIONAL
19 * LDAPv3 Extended Operation Response
20 * ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
21 * COMPONENTS OF LDAPResult,
22 * responseName [10] LDAPOID OPTIONAL,
23 * response [11] OCTET STRING OPTIONAL
32 #include <ac/socket.h>
33 #include <ac/string.h>
42 #define UNSUPPORTED_EXTENDEDOP "unsupported extended operation"
44 static struct extop_list {
45 struct extop_list *next;
47 SLAP_EXTOP_MAIN_FN *ext_main;
48 } *supp_ext_list = NULL;
50 static SLAP_EXTOP_MAIN_FN whoami_extop;
52 /* this list of built-in extops is for extops that are not part
53 * of backends or in external modules. essentially, this is
54 * just a way to get built-in extops onto the extop list without
55 * having a separate init routine for each built-in extop.
57 #ifdef LDAP_EXOP_X_CANCEL
58 const struct berval slap_EXOP_CANCEL = BER_BVC(LDAP_EXOP_X_CANCEL);
60 const struct berval slap_EXOP_WHOAMI = BER_BVC(LDAP_EXOP_X_WHO_AM_I);
61 const struct berval slap_EXOP_MODIFY_PASSWD = BER_BVC(LDAP_EXOP_MODIFY_PASSWD);
62 const struct berval slap_EXOP_START_TLS = BER_BVC(LDAP_EXOP_START_TLS);
65 const struct berval *oid;
66 SLAP_EXTOP_MAIN_FN *ext_main;
67 } builtin_extops[] = {
68 #ifdef LDAP_EXOP_X_CANCEL
69 { &slap_EXOP_CANCEL, cancel_extop },
71 { &slap_EXOP_WHOAMI, whoami_extop },
72 { &slap_EXOP_MODIFY_PASSWD, passwd_extop },
74 { &slap_EXOP_START_TLS, starttls_extop },
80 static struct extop_list *find_extop(
81 struct extop_list *list, struct berval *oid );
84 get_supported_extop (int index)
86 struct extop_list *ext;
88 /* linear scan is slow, but this way doesn't force a
89 * big change on root_dse.c, where this routine is used.
91 for (ext = supp_ext_list; ext != NULL && --index >= 0; ext = ext->next) {
95 if (ext == NULL) return NULL;
106 struct berval reqdata = {0, NULL};
109 struct extop_list *ext = NULL;
111 #if defined(LDAP_SLAPI)
112 Slapi_PBlock *pb = op->o_pb;
113 SLAPI_FUNC funcAddr = NULL;
115 int msg_sent = FALSE;
116 #endif /* defined(LDAP_SLAPI) */
119 LDAP_LOG( OPERATION, ENTRY, "do_extended: conn %d\n", op->o_connid, 0, 0 );
121 Debug( LDAP_DEBUG_TRACE, "do_extended\n", 0, 0, 0 );
124 if( op->o_protocol < LDAP_VERSION3 ) {
126 LDAP_LOG( OPERATION, ERR,
127 "do_extended: protocol version (%d) too low.\n", op->o_protocol, 0, 0 );
129 Debug( LDAP_DEBUG_ANY,
130 "do_extended: protocol version (%d) too low\n",
131 op->o_protocol, 0 ,0 );
133 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "requires LDAPv3" );
138 if ( ber_scanf( op->o_ber, "{m" /*}*/, &op->ore_reqoid ) == LBER_ERROR ) {
140 LDAP_LOG( OPERATION, ERR, "do_extended: conn %d ber_scanf failed\n",
141 op->o_connid, 0, 0 );
143 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
145 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
151 getPluginFunc( &op->ore_reqoid, &funcAddr ); /* NS-SLAPI extended operation */
152 if( !funcAddr && !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
154 if( !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
158 LDAP_LOG( OPERATION, ERR,
159 "do_extended: conn %d unsupported operation \"%s\"\n",
160 op->o_connid, op->ore_reqoid.bv_val, 0 );
162 Debug( LDAP_DEBUG_ANY, "do_extended: unsupported operation \"%s\"\n",
163 op->ore_reqoid.bv_val, 0 ,0 );
165 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR,
166 "unsupported extended operation" );
170 tag = ber_peek_tag( op->o_ber, &len );
172 if( ber_peek_tag( op->o_ber, &len ) == LDAP_TAG_EXOP_REQ_VALUE ) {
173 if( ber_scanf( op->o_ber, "m", &reqdata ) == LBER_ERROR ) {
175 LDAP_LOG( OPERATION, ERR,
176 "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 if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
189 LDAP_LOG( OPERATION, ERR,
190 "do_extended: conn %d get_ctrls failed\n", op->o_connid, 0, 0 );
192 Debug( LDAP_DEBUG_ANY, "do_extended: get_ctrls failed\n", 0, 0 ,0 );
197 /* check for controls inappropriate for all extended operations */
198 if( get_manageDSAit( op ) == SLAP_CRITICAL_CONTROL ) {
199 send_ldap_error( op, rs,
200 LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
201 "manageDSAit control inappropriate" );
206 LDAP_LOG( OPERATION, DETAIL1,
207 "do_extended: conn %d oid=%s\n.", op->o_connid, op->ore_reqoid.bv_val, 0 );
209 Debug( LDAP_DEBUG_ARGS, "do_extended: oid=%s\n", op->ore_reqoid.bv_val, 0 ,0 );
212 #if defined(LDAP_SLAPI)
213 if (ext != NULL) { /* OpenLDAP extended operation */
214 #endif /* defined(LDAP_SLAPI) */
216 if (reqdata.bv_val) op->ore_reqdata = &reqdata;
217 rs->sr_err = (ext->ext_main)( op, rs );
219 if( rs->sr_err != SLAPD_ABANDON ) {
220 if ( rs->sr_err == LDAP_REFERRAL && rs->sr_ref == NULL ) {
221 rs->sr_ref = referral_rewrite( default_referral,
222 NULL, NULL, LDAP_SCOPE_DEFAULT );
225 send_ldap_extended( op, rs );
227 ber_bvarray_free( rs->sr_ref );
230 if ( rs->sr_rspoid != NULL ) {
231 free( (char *)rs->sr_rspoid );
234 if ( rs->sr_rspdata != NULL ) {
235 ber_bvfree( rs->sr_rspdata );
238 #if defined( LDAP_SLAPI )
239 goto done; /* end of OpenLDAP extended operation */
241 } else { /* start of Netscape extended operation */
242 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_OID,
243 (void *)op->ore_reqoid.bv_val);
244 if ( rs->sr_err != LDAP_SUCCESS ) {
245 rs->sr_err = LDAP_OTHER;
249 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_VALUE,
251 if ( rs->sr_err != LDAP_SUCCESS ) {
252 rs->sr_err = LDAP_OTHER;
256 rs->sr_err = slapi_x_pblock_set_operation( pb, op );
257 if ( rs->sr_err != LDAP_SUCCESS ) {
258 rs->sr_err = LDAP_OTHER;
262 extop_rc = (*funcAddr)( pb );
263 if ( extop_rc == SLAPI_PLUGIN_EXTENDED_SENT_RESULT ) {
266 } else if ( extop_rc == SLAPI_PLUGIN_EXTENDED_NOT_HANDLED ) {
267 rs->sr_err = LDAP_PROTOCOL_ERROR;
268 rs->sr_text = UNSUPPORTED_EXTENDEDOP;
271 rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_OID,
273 if ( rs->sr_err != LDAP_SUCCESS ) {
277 rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_VALUE,
279 if ( rs->sr_err != LDAP_SUCCESS ) {
283 rs->sr_err = extop_rc;
284 send_ldap_extended( op, rs );
289 if ( rs->sr_err != LDAP_SUCCESS && msg_sent == FALSE ) {
290 send_ldap_result( op, rs );
293 if ( rs->sr_rspoid != NULL ) {
294 ch_free( (char *)rs->sr_rspoid );
297 if ( rs->sr_rspdata != NULL ) {
298 ber_bvfree( rs->sr_rspdata );
301 } /* end of Netscape extended operation */
302 #endif /* defined( LDAP_SLAPI ) */
310 struct berval *ext_oid,
311 SLAP_EXTOP_MAIN_FN *ext_main )
313 struct extop_list *ext;
315 if( ext_oid == NULL || ext_oid->bv_val == NULL ||
316 ext_oid->bv_val[0] == '\0' || ext_oid->bv_len == 0 ) return -1;
317 if(!ext_main) return -1;
319 ext = ch_calloc(1, sizeof(struct extop_list) + ext_oid->bv_len + 1);
323 ext->oid.bv_val = (char *)(ext + 1);
324 AC_MEMCPY( ext->oid.bv_val, ext_oid->bv_val, ext_oid->bv_len );
325 ext->oid.bv_len = ext_oid->bv_len;
326 ext->oid.bv_val[ext->oid.bv_len] = '\0';
328 ext->ext_main = ext_main;
329 ext->next = supp_ext_list;
341 for (i = 0; builtin_extops[i].oid != NULL; i++) {
342 load_extop((struct berval *)builtin_extops[i].oid, builtin_extops[i].ext_main);
350 struct extop_list *ext;
352 /* we allocated the memory, so we have to free it, too. */
353 while ((ext = supp_ext_list) != NULL) {
354 supp_ext_list = ext->next;
360 static struct extop_list *
361 find_extop( struct extop_list *list, struct berval *oid )
363 struct extop_list *ext;
365 for (ext = list; ext; ext = ext->next) {
366 if (bvmatch(&ext->oid, oid))
380 if ( op->ore_reqdata != NULL ) {
381 /* no request data should be provided */
382 rs->sr_text = "no request data expected";
383 return LDAP_PROTOCOL_ERROR;
386 op->o_bd = op->o_conn->c_authz_backend;
387 if( backend_check_restrictions( op, rs,
388 (struct berval *)&slap_EXOP_WHOAMI ) != LDAP_SUCCESS ) {
392 bv = (struct berval *) ch_malloc( sizeof(struct berval) );
393 if( op->o_dn.bv_len ) {
394 bv->bv_len = op->o_dn.bv_len + sizeof("dn:")-1;
395 bv->bv_val = ch_malloc( bv->bv_len + 1 );
396 AC_MEMCPY( bv->bv_val, "dn:", sizeof("dn:")-1 );
397 AC_MEMCPY( &bv->bv_val[sizeof("dn:")-1], op->o_dn.bv_val,
399 bv->bv_val[bv->bv_len] = '\0';