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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1999-2003 The OpenLDAP Foundation.
   4  * All rights reserved.
   5  *
   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.
  10  */
  11
  12 /*
  13  * LDAPv3 Extended Operation Request
  14  *      ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
  15  *              requestName      [0] LDAPOID,
  16  *              requestValue     [1] OCTET STRING OPTIONAL
  17  *      }
  18  *
  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
  24  *      }
  25  *
  26  */
  27
  28 #include "portable.h"
  29
  30 #include <stdio.h>
  31
  32 #include <ac/socket.h>
  33 #include <ac/string.h>
  34
  35 #include "slap.h"
  36 #include "lber_pvt.h"
  37
  38 #ifdef LDAP_SLAPI
  39 #include "slapi.h"
  40 #endif
  41
  42 #define UNSUPPORTED_EXTENDEDOP "unsupported extended operation"
  43
  44 #ifdef LDAP_DEVEL
  45 #define SLAP_EXOP_HIDE 0x0000
  46 #else
  47 #define SLAP_EXOP_HIDE 0x8000
  48 #endif
  49
  50 static struct extop_list {
  51         struct extop_list *next;
  52         struct berval oid;
  53         slap_mask_t flags;
  54         SLAP_EXTOP_MAIN_FN *ext_main;
  55 } *supp_ext_list = NULL;
  56
  57 static SLAP_EXTOP_MAIN_FN whoami_extop;
  58
  59 /* this list of built-in extops is for extops that are not part
  60  * of backends or in external modules.  essentially, this is
  61  * just a way to get built-in extops onto the extop list without
  62  * having a separate init routine for each built-in extop.
  63  */
  64 #ifdef LDAP_EXOP_X_CANCEL
  65 const struct berval slap_EXOP_CANCEL = BER_BVC(LDAP_EXOP_X_CANCEL);
  66 #endif
  67 const struct berval slap_EXOP_WHOAMI = BER_BVC(LDAP_EXOP_X_WHO_AM_I);
  68 const struct berval slap_EXOP_MODIFY_PASSWD = BER_BVC(LDAP_EXOP_MODIFY_PASSWD);
  69 const struct berval slap_EXOP_START_TLS = BER_BVC(LDAP_EXOP_START_TLS);
  70
  71 static struct {
  72         const struct berval *oid;
  73         slap_mask_t flags;
  74         SLAP_EXTOP_MAIN_FN *ext_main;
  75 } builtin_extops[] = {
  76 #ifdef LDAP_EXOP_X_CANCEL
  77         { &slap_EXOP_CANCEL, SLAP_EXOP_HIDE, cancel_extop },
  78 #endif
  79         { &slap_EXOP_WHOAMI, 0, whoami_extop },
  80         { &slap_EXOP_MODIFY_PASSWD, 0, passwd_extop },
  81 #ifdef HAVE_TLS
  82         { &slap_EXOP_START_TLS, 0, starttls_extop },
  83 #endif
  84         { NULL, 0, NULL }
  85 };
  86
  87
  88 static struct extop_list *find_extop(
  89         struct extop_list *list, struct berval *oid );
  90
  91 struct berval *
  92 get_supported_extop (int index)
  93 {
  94         struct extop_list *ext;
  95
  96         /* linear scan is slow, but this way doesn't force a
  97          * big change on root_dse.c, where this routine is used.
  98          */
  99         for (ext = supp_ext_list; ext != NULL && --index >= 0; ext = ext->next) {
 100                 ; /* empty */
 101         }
 102
 103         if (ext == NULL) return NULL;
 104
 105         return &ext->oid;
 106 }
 107
 108
 109 int exop_root_dse_info( Entry *e )
 110 {
 111         AttributeDescription *ad_supportedExtension
 112                 = slap_schema.si_ad_supportedExtension;
 113         struct berval vals[2];
 114         struct extop_list *ext;
 115
 116         vals[1].bv_val = NULL;
 117         vals[1].bv_len = 0;
 118
 119         for (ext = supp_ext_list; ext != NULL; ext = ext->next) {
 120                 if( ext->flags & SLAP_EXOP_HIDE ) continue;
 121
 122                 vals[0] = ext->oid;
 123
 124                 if( attr_merge( e, ad_supportedExtension, vals, NULL ) ) {
 125                         return LDAP_OTHER;
 126                 }
 127         }
 128
 129         return LDAP_SUCCESS;
 130 }
 131
 132 int
 133 do_extended(
 134     Operation   *op,
 135     SlapReply   *rs
 136 )
 137 {
 138         struct berval reqdata = {0, NULL};
 139         ber_tag_t tag;
 140         ber_len_t len;
 141         struct extop_list *ext = NULL;
 142
 143 #if defined(LDAP_SLAPI)
 144         Slapi_PBlock    *pb = op->o_pb;
 145         SLAPI_FUNC      funcAddr = NULL;
 146         int             extop_rc;
 147         int             msg_sent = FALSE;
 148 #endif /* defined(LDAP_SLAPI) */
 149
 150 #ifdef NEW_LOGGING
 151         LDAP_LOG( OPERATION, ENTRY, "do_extended: conn %d\n", op->o_connid, 0, 0 );
 152 #else
 153         Debug( LDAP_DEBUG_TRACE, "do_extended\n", 0, 0, 0 );
 154 #endif
 155
 156         if( op->o_protocol < LDAP_VERSION3 ) {
 157 #ifdef NEW_LOGGING
 158                 LDAP_LOG( OPERATION, ERR,
 159                         "do_extended: protocol version (%d) too low.\n", op->o_protocol, 0, 0 );
 160 #else
 161                 Debug( LDAP_DEBUG_ANY,
 162                         "do_extended: protocol version (%d) too low\n",
 163                         op->o_protocol, 0 ,0 );
 164 #endif
 165                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "requires LDAPv3" );
 166                 rs->sr_err = -1;
 167                 goto done;
 168         }
 169
 170         if ( ber_scanf( op->o_ber, "{m" /*}*/, &op->ore_reqoid ) == LBER_ERROR ) {
 171 #ifdef NEW_LOGGING
 172                 LDAP_LOG( OPERATION, ERR, "do_extended: conn %d  ber_scanf failed\n",
 173                         op->o_connid, 0, 0 );
 174 #else
 175                 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
 176 #endif
 177                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
 178                 rs->sr_err = -1;
 179                 goto done;
 180         }
 181
 182 #ifdef LDAP_SLAPI
 183         getPluginFunc( &op->ore_reqoid, &funcAddr ); /* NS-SLAPI extended operation */
 184         if( !funcAddr && !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
 185 #else
 186         if( !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
 187 #endif
 188         {
 189 #ifdef NEW_LOGGING
 190                 LDAP_LOG( OPERATION, ERR,
 191                         "do_extended: conn %d  unsupported operation \"%s\"\n",
 192                         op->o_connid, op->ore_reqoid.bv_val, 0 );
 193 #else
 194                 Debug( LDAP_DEBUG_ANY, "do_extended: unsupported operation \"%s\"\n",
 195                         op->ore_reqoid.bv_val, 0 ,0 );
 196 #endif
 197                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR,
 198                         "unsupported extended operation" );
 199                 goto done;
 200         }
 201
 202         tag = ber_peek_tag( op->o_ber, &len );
 203
 204         if( ber_peek_tag( op->o_ber, &len ) == LDAP_TAG_EXOP_REQ_VALUE ) {
 205                 if( ber_scanf( op->o_ber, "m", &reqdata ) == LBER_ERROR ) {
 206 #ifdef NEW_LOGGING
 207                         LDAP_LOG( OPERATION, ERR,
 208                                 "do_extended: conn %d  ber_scanf failed\n",
 209                                 op->o_connid, 0, 0 );
 210 #else
 211                         Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
 212 #endif
 213                         send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
 214                         rs->sr_err = -1;
 215                         goto done;
 216                 }
 217         }
 218
 219         if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
 220 #ifdef NEW_LOGGING
 221                 LDAP_LOG( OPERATION, ERR,
 222                         "do_extended: conn %d  get_ctrls failed\n", op->o_connid, 0, 0 );
 223 #else
 224                 Debug( LDAP_DEBUG_ANY, "do_extended: get_ctrls failed\n", 0, 0 ,0 );
 225 #endif
 226                 return rs->sr_err;
 227         }
 228
 229         /* check for controls inappropriate for all extended operations */
 230         if( get_manageDSAit( op ) == SLAP_CRITICAL_CONTROL ) {
 231                 send_ldap_error( op, rs,
 232                         LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
 233                         "manageDSAit control inappropriate" );
 234                 goto done;
 235         }
 236
 237 #ifdef NEW_LOGGING
 238         LDAP_LOG( OPERATION, DETAIL1,
 239                 "do_extended: conn %d  oid=%s\n.", op->o_connid, op->ore_reqoid.bv_val, 0 );
 240 #else
 241         Debug( LDAP_DEBUG_ARGS, "do_extended: oid=%s\n", op->ore_reqoid.bv_val, 0 ,0 );
 242 #endif
 243
 244 #if defined(LDAP_SLAPI)
 245         if ( funcAddr != NULL ) {
 246                 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_OID,
 247                                 (void *)op->ore_reqoid.bv_val);
 248                 if ( rs->sr_err != LDAP_SUCCESS ) {
 249                         rs->sr_err = LDAP_OTHER;
 250                         goto done;
 251                 }
 252
 253                 rs->sr_err = slapi_pblock_set( pb, SLAPI_EXT_OP_REQ_VALUE,
 254                                 (void *)&reqdata);
 255                 if ( rs->sr_err != LDAP_SUCCESS ) {
 256                         rs->sr_err = LDAP_OTHER;
 257                         goto done;
 258                 }
 259
 260                 rs->sr_err = slapi_x_pblock_set_operation( pb, op );
 261                 if ( rs->sr_err != LDAP_SUCCESS ) {
 262                         rs->sr_err = LDAP_OTHER;
 263                         goto done;
 264                 }
 265
 266                 extop_rc = (*funcAddr)( pb );
 267                 if ( extop_rc == SLAPI_PLUGIN_EXTENDED_SENT_RESULT ) {
 268                         msg_sent = TRUE;
 269
 270                 } else if ( extop_rc == SLAPI_PLUGIN_EXTENDED_NOT_HANDLED ) {
 271                         rs->sr_err = LDAP_PROTOCOL_ERROR;
 272                         rs->sr_text = UNSUPPORTED_EXTENDEDOP;
 273
 274                 } else {
 275                         rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_OID,
 276                                         &rs->sr_rspoid);
 277                         if ( rs->sr_err != LDAP_SUCCESS ) {
 278                                 goto done2;
 279                         }
 280
 281                         rs->sr_err = slapi_pblock_get( pb, SLAPI_EXT_OP_RET_VALUE,
 282                                         &rs->sr_rspdata);
 283                         if ( rs->sr_err != LDAP_SUCCESS ) {
 284                                 goto done2;
 285                         }
 286
 287                         rs->sr_err = extop_rc;
 288                         send_ldap_extended( op, rs );
 289                         msg_sent = TRUE;
 290                 }
 291
 292 done2:;
 293                 if ( rs->sr_err != LDAP_SUCCESS && msg_sent == FALSE ) {
 294                         send_ldap_result( op, rs );
 295                 }
 296
 297                 if ( rs->sr_rspoid != NULL ) {
 298                         ch_free( (char *)rs->sr_rspoid );
 299                 }
 300
 301                 if ( rs->sr_rspdata != NULL ) {
 302                         ber_bvfree( rs->sr_rspdata );
 303                 }
 304         } else { /* start of OpenLDAP extended operation */
 305 #endif /* defined( LDAP_SLAPI ) */
 306                 if (reqdata.bv_val) op->ore_reqdata = &reqdata;
 307                 rs->sr_err = (ext->ext_main)( op, rs );
 308
 309                 if( rs->sr_err != SLAPD_ABANDON ) {
 310                         if ( rs->sr_err == LDAP_REFERRAL && rs->sr_ref == NULL ) {
 311                                 rs->sr_ref = referral_rewrite( default_referral,
 312                                         NULL, NULL, LDAP_SCOPE_DEFAULT );
 313                         }
 314
 315                         send_ldap_extended( op, rs );
 316
 317                         ber_bvarray_free( rs->sr_ref );
 318                 }
 319
 320                 if ( rs->sr_rspoid != NULL ) {
 321                         free( (char *)rs->sr_rspoid );
 322                 }
 323
 324                 if ( rs->sr_rspdata != NULL ) {
 325                         ber_bvfree( rs->sr_rspdata );
 326                 }
 327 #ifdef LDAP_SLAPI
 328         } /* end of OpenLDAP extended operation */
 329 #endif /* LDAP_SLAPI */
 330
 331 done:
 332         return rs->sr_err;
 333 }
 334
 335 int
 336 load_extop(
 337         struct berval *ext_oid,
 338         slap_mask_t ext_flags,
 339         SLAP_EXTOP_MAIN_FN *ext_main )
 340 {
 341         struct extop_list *ext;
 342
 343         if( ext_oid == NULL || ext_oid->bv_val == NULL ||
 344                 ext_oid->bv_val[0] == '\0' || ext_oid->bv_len == 0 ) return -1;
 345         if(!ext_main) return -1;
 346
 347         ext = ch_calloc(1, sizeof(struct extop_list) + ext_oid->bv_len + 1);
 348         if (ext == NULL)
 349                 return(-1);
 350
 351         ext->flags = ext_flags;
 352
 353         ext->oid.bv_val = (char *)(ext + 1);
 354         AC_MEMCPY( ext->oid.bv_val, ext_oid->bv_val, ext_oid->bv_len );
 355         ext->oid.bv_len = ext_oid->bv_len;
 356         ext->oid.bv_val[ext->oid.bv_len] = '\0';
 357
 358         ext->ext_main = ext_main;
 359         ext->next = supp_ext_list;
 360
 361         supp_ext_list = ext;
 362
 363         return(0);
 364 }
 365
 366 int
 367 extops_init (void)
 368 {
 369         int i;
 370
 371         for (i = 0; builtin_extops[i].oid != NULL; i++) {
 372                 load_extop((struct berval *)builtin_extops[i].oid,
 373                         builtin_extops[i].flags,
 374                         builtin_extops[i].ext_main);
 375         }
 376         return(0);
 377 }
 378
 379 int
 380 extops_kill (void)
 381 {
 382         struct extop_list *ext;
 383
 384         /* we allocated the memory, so we have to free it, too. */
 385         while ((ext = supp_ext_list) != NULL) {
 386                 supp_ext_list = ext->next;
 387                 ch_free(ext);
 388         }
 389         return(0);
 390 }
 391
 392 static struct extop_list *
 393 find_extop( struct extop_list *list, struct berval *oid )
 394 {
 395         struct extop_list *ext;
 396
 397         for (ext = list; ext; ext = ext->next) {
 398                 if (bvmatch(&ext->oid, oid))
 399                         return(ext);
 400         }
 401         return(NULL);
 402 }
 403
 404
 405 static int
 406 whoami_extop (
 407         Operation *op,
 408         SlapReply *rs )
 409 {
 410         struct berval *bv;
 411
 412         if ( op->ore_reqdata != NULL ) {
 413                 /* no request data should be provided */
 414                 rs->sr_text = "no request data expected";
 415                 return LDAP_PROTOCOL_ERROR;
 416         }
 417
 418         op->o_bd = op->o_conn->c_authz_backend;
 419         if( backend_check_restrictions( op, rs,
 420                 (struct berval *)&slap_EXOP_WHOAMI ) != LDAP_SUCCESS ) {
 421                 return rs->sr_err;
 422         }
 423
 424         bv = (struct berval *) ch_malloc( sizeof(struct berval) );
 425         if( op->o_dn.bv_len ) {
 426                 bv->bv_len = op->o_dn.bv_len + sizeof("dn:")-1;
 427                 bv->bv_val = ch_malloc( bv->bv_len + 1 );
 428                 AC_MEMCPY( bv->bv_val, "dn:", sizeof("dn:")-1 );
 429                 AC_MEMCPY( &bv->bv_val[sizeof("dn:")-1], op->o_dn.bv_val,
 430                         op->o_dn.bv_len );
 431                 bv->bv_val[bv->bv_len] = '\0';
 432
 433         } else {
 434                 bv->bv_len = 0;
 435                 bv->bv_val = NULL;
 436         }
 437
 438         rs->sr_rspdata = bv;
 439         return LDAP_SUCCESS;
 440 }