git.sur5r.net Git - openldap/blob - servers/slapd/extended.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1999-2004 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 #ifdef LDAP_SLAPI
  43 #include "slapi/slapi.h"
  44 #endif
  45
  46 #define UNSUPPORTED_EXOP "unsupported extended operation"
  47
  48
  49 static struct extop_list {
  50         struct extop_list *next;
  51         struct berval oid;
  52         slap_mask_t flags;
  53         SLAP_EXTOP_MAIN_FN *ext_main;
  54 } *supp_ext_list = NULL;
  55
  56 static SLAP_EXTOP_MAIN_FN whoami_extop;
  57
  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.
  62  */
  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);
  67
  68 static struct {
  69         const struct berval *oid;
  70         slap_mask_t flags;
  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 },
  76 #ifdef HAVE_TLS
  77         { &slap_EXOP_START_TLS, 0, starttls_extop },
  78 #endif
  79         { NULL, 0, NULL }
  80 };
  81
  82
  83 static struct extop_list *find_extop(
  84         struct extop_list *list, struct berval *oid );
  85
  86 struct berval *
  87 get_supported_extop (int index)
  88 {
  89         struct extop_list *ext;
  90
  91         /* linear scan is slow, but this way doesn't force a
  92          * big change on root_dse.c, where this routine is used.
  93          */
  94         for (ext = supp_ext_list; ext != NULL && --index >= 0; ext = ext->next) {
  95                 ; /* empty */
  96         }
  97
  98         if (ext == NULL) return NULL;
  99
 100         return &ext->oid;
 101 }
 102
 103
 104 int exop_root_dse_info( Entry *e )
 105 {
 106         AttributeDescription *ad_supportedExtension
 107                 = slap_schema.si_ad_supportedExtension;
 108         struct berval vals[2];
 109         struct extop_list *ext;
 110
 111         vals[1].bv_val = NULL;
 112         vals[1].bv_len = 0;
 113
 114         for (ext = supp_ext_list; ext != NULL; ext = ext->next) {
 115                 if( ext->flags & SLAP_EXOP_HIDE ) continue;
 116
 117                 vals[0] = ext->oid;
 118
 119                 if( attr_merge( e, ad_supportedExtension, vals, NULL ) ) {
 120                         return LDAP_OTHER;
 121                 }
 122         }
 123
 124         return LDAP_SUCCESS;
 125 }
 126
 127 int
 128 do_extended(
 129     Operation   *op,
 130     SlapReply   *rs
 131 )
 132 {
 133         struct berval reqdata = {0, NULL};
 134         ber_tag_t tag;
 135         ber_len_t len;
 136
 137         Debug( LDAP_DEBUG_TRACE, "do_extended\n", 0, 0, 0 );
 138
 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;
 145                 goto done;
 146         }
 147
 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;
 152                 goto done;
 153         }
 154
 155         tag = ber_peek_tag( op->o_ber, &len );
 156
 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;
 162                         goto done;
 163                 }
 164         }
 165
 166         if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
 167                 Debug( LDAP_DEBUG_ANY, "do_extended: get_ctrls failed\n", 0, 0 ,0 );
 168                 return rs->sr_err;
 169         }
 170
 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" );
 176                 goto done;
 177         }
 178
 179         /* FIXME: temporary? */
 180         if ( reqdata.bv_val ) {
 181                 op->ore_reqdata = &reqdata;
 182         }
 183
 184         op->o_bd = frontendDB;
 185         rs->sr_err = frontendDB->be_extended( op, rs );
 186 done:
 187         return rs->sr_err;
 188 }
 189
 190 int
 191 fe_extended( Operation *op, SlapReply *rs )
 192 {
 193         struct extop_list       *ext = NULL;
 194         struct berval           reqdata = BER_BVNULL;
 195
 196 #if defined(LDAP_SLAPI)
 197         Slapi_PBlock            *pb = op->o_pb;
 198         SLAPI_FUNC              funcAddr = NULL;
 199         int                     extop_rc;
 200         int                     msg_sent = FALSE;
 201 #endif /* defined(LDAP_SLAPI) */
 202
 203         if (op->ore_reqdata) {
 204                 reqdata = *op->ore_reqdata;
 205         }
 206
 207 #ifdef LDAP_SLAPI
 208     /* NS-SLAPI extended operation */
 209         slapi_int_get_extop_plugin( &op->ore_reqoid, &funcAddr );
 210
 211         if( !funcAddr && !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
 212 #else
 213         if( !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
 214 #endif
 215         {
 216                 Debug( LDAP_DEBUG_ANY, "do_extended: unsupported operation \"%s\"\n",
 217                         op->ore_reqoid.bv_val, 0 ,0 );
 218                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR,
 219                         "unsupported extended operation" );
 220                 goto done;
 221         }
 222
 223         op->ore_flags = ext->flags;
 224
 225         Debug( LDAP_DEBUG_ARGS, "do_extended: oid=%s\n",
 226                 op->ore_reqoid.bv_val, 0 ,0 );
 227
 228 #if defined(LDAP_SLAPI)
 229         if ( funcAddr != NULL ) {
 230                 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_OID,
 231                                 (void *)op->ore_reqoid.bv_val);
 232                 if ( rs->sr_err != LDAP_SUCCESS ) {
 233                         rs->sr_err = LDAP_OTHER;
 234                         goto done;
 235                 }
 236
 237                 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_VALUE,
 238                                 (void *)&reqdata);
 239                 if ( rs->sr_err != LDAP_SUCCESS ) {
 240                         rs->sr_err = LDAP_OTHER;
 241                         goto done;
 242                 }
 243
 244                 rs->sr_err = slapi_int_pblock_set_operation( pb, op );
 245                 if ( rs->sr_err != LDAP_SUCCESS ) {
 246                         rs->sr_err = LDAP_OTHER;
 247                         goto done;
 248                 }
 249
 250                 extop_rc = (*funcAddr)( pb );
 251                 if ( extop_rc == SLAPI_PLUGIN_EXTENDED_SENT_RESULT ) {
 252                         msg_sent = TRUE;
 253
 254                 } else if ( extop_rc == SLAPI_PLUGIN_EXTENDED_NOT_HANDLED ) {
 255                         rs->sr_err = LDAP_PROTOCOL_ERROR;
 256                         rs->sr_text = UNSUPPORTED_EXOP;
 257
 258                 } else {
 259                         rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_OID,
 260                                         &rs->sr_rspoid);
 261                         if ( rs->sr_err != LDAP_SUCCESS ) {
 262                                 goto done2;
 263                         }
 264
 265                         rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_VALUE,
 266                                         &rs->sr_rspdata);
 267                         if ( rs->sr_err != LDAP_SUCCESS ) {
 268                                 goto done2;
 269                         }
 270
 271                         rs->sr_err = extop_rc;
 272                         send_ldap_extended( op, rs );
 273                         msg_sent = TRUE;
 274                 }
 275
 276 done2:;
 277                 if ( rs->sr_err != LDAP_SUCCESS && msg_sent == FALSE ) {
 278                         send_ldap_result( op, rs );
 279                 }
 280
 281                 if ( rs->sr_rspoid != NULL ) {
 282                         ch_free( (char *)rs->sr_rspoid );
 283                 }
 284
 285                 if ( rs->sr_rspdata != NULL ) {
 286                         ber_bvfree( rs->sr_rspdata );
 287                 }
 288         } else
 289 #endif /* defined( LDAP_SLAPI ) */
 290         { /* start of OpenLDAP extended operation */
 291                 rs->sr_err = (ext->ext_main)( op, rs );
 292
 293                 if( rs->sr_err != SLAPD_ABANDON ) {
 294                         if ( rs->sr_err == LDAP_REFERRAL && rs->sr_ref == NULL ) {
 295                                 rs->sr_ref = referral_rewrite( default_referral,
 296                                         NULL, NULL, LDAP_SCOPE_DEFAULT );
 297                                 if ( !rs->sr_ref ) rs->sr_ref = default_referral;
 298                                 if ( !rs->sr_ref ) {
 299                                         rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 300                                         rs->sr_text = "referral missing";
 301                                 }
 302                         }
 303
 304                         send_ldap_extended( op, rs );
 305
 306                         if ( rs->sr_ref != default_referral ) {
 307                                 ber_bvarray_free( rs->sr_ref );
 308                                 rs->sr_ref = NULL;
 309                         }
 310                 }
 311
 312                 if ( rs->sr_rspoid != NULL ) {
 313                         free( (char *)rs->sr_rspoid );
 314                 }
 315
 316                 if ( rs->sr_rspdata != NULL ) {
 317                         ber_bvfree( rs->sr_rspdata );
 318                 }
 319         } /* end of OpenLDAP extended operation */
 320
 321 done:;
 322         return rs->sr_err;
 323 }
 324
 325 int
 326 load_extop(
 327         struct berval *ext_oid,
 328         slap_mask_t ext_flags,
 329         SLAP_EXTOP_MAIN_FN *ext_main )
 330 {
 331         struct extop_list *ext;
 332
 333         if( ext_oid == NULL || ext_oid->bv_val == NULL ||
 334                 ext_oid->bv_val[0] == '\0' || ext_oid->bv_len == 0 ) return -1;
 335         if(!ext_main) return -1;
 336
 337         ext = ch_calloc(1, sizeof(struct extop_list) + ext_oid->bv_len + 1);
 338         if (ext == NULL)
 339                 return(-1);
 340
 341         ext->flags = ext_flags;
 342
 343         ext->oid.bv_val = (char *)(ext + 1);
 344         AC_MEMCPY( ext->oid.bv_val, ext_oid->bv_val, ext_oid->bv_len );
 345         ext->oid.bv_len = ext_oid->bv_len;
 346         ext->oid.bv_val[ext->oid.bv_len] = '\0';
 347
 348         ext->ext_main = ext_main;
 349         ext->next = supp_ext_list;
 350
 351         supp_ext_list = ext;
 352
 353         return(0);
 354 }
 355
 356 int
 357 extops_init (void)
 358 {
 359         int i;
 360
 361         for (i = 0; builtin_extops[i].oid != NULL; i++) {
 362                 load_extop((struct berval *)builtin_extops[i].oid,
 363                         builtin_extops[i].flags,
 364                         builtin_extops[i].ext_main);
 365         }
 366         return(0);
 367 }
 368
 369 int
 370 extops_kill (void)
 371 {
 372         struct extop_list *ext;
 373
 374         /* we allocated the memory, so we have to free it, too. */
 375         while ((ext = supp_ext_list) != NULL) {
 376                 supp_ext_list = ext->next;
 377                 ch_free(ext);
 378         }
 379         return(0);
 380 }
 381
 382 static struct extop_list *
 383 find_extop( struct extop_list *list, struct berval *oid )
 384 {
 385         struct extop_list *ext;
 386
 387         for (ext = list; ext; ext = ext->next) {
 388                 if (bvmatch(&ext->oid, oid))
 389                         return(ext);
 390         }
 391         return(NULL);
 392 }
 393
 394
 395 static int
 396 whoami_extop (
 397         Operation *op,
 398         SlapReply *rs )
 399 {
 400         struct berval *bv;
 401
 402         if ( op->ore_reqdata != NULL ) {
 403                 /* no request data should be provided */
 404                 rs->sr_text = "no request data expected";
 405                 return LDAP_PROTOCOL_ERROR;
 406         }
 407
 408         op->o_bd = op->o_conn->c_authz_backend;
 409         if( backend_check_restrictions( op, rs,
 410                 (struct berval *)&slap_EXOP_WHOAMI ) != LDAP_SUCCESS ) {
 411                 return rs->sr_err;
 412         }
 413
 414         bv = (struct berval *) ch_malloc( sizeof(struct berval) );
 415         if( op->o_dn.bv_len ) {
 416                 bv->bv_len = op->o_dn.bv_len + STRLENOF( "dn:" );
 417                 bv->bv_val = ch_malloc( bv->bv_len + 1 );
 418                 AC_MEMCPY( bv->bv_val, "dn:", STRLENOF( "dn:" ) );
 419                 AC_MEMCPY( &bv->bv_val[STRLENOF( "dn:" )], op->o_dn.bv_val,
 420                         op->o_dn.bv_len );
 421                 bv->bv_val[bv->bv_len] = '\0';
 422
 423         } else {
 424                 bv->bv_len = 0;
 425                 bv->bv_val = NULL;
 426         }
 427
 428         rs->sr_rspdata = bv;
 429         return LDAP_SUCCESS;
 430 }