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-2005 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 #define UNSUPPORTED_EXOP "unsupported extended operation"
  43
  44
  45 static struct extop_list {
  46         struct extop_list *next;
  47         struct berval oid;
  48         slap_mask_t flags;
  49         SLAP_EXTOP_MAIN_FN *ext_main;
  50 } *supp_ext_list = NULL;
  51
  52 static SLAP_EXTOP_MAIN_FN whoami_extop;
  53
  54 /* This list of built-in extops is for extops that are not part
  55  * of backends or in external modules.  Essentially, this is
  56  * just a way to get built-in extops onto the extop list without
  57  * having a separate init routine for each built-in extop.
  58  */
  59 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);
  63
  64 static struct {
  65         const struct berval *oid;
  66         slap_mask_t flags;
  67         SLAP_EXTOP_MAIN_FN *ext_main;
  68 } builtin_extops[] = {
  69         { &slap_EXOP_CANCEL, SLAP_EXOP_HIDE, cancel_extop },
  70         { &slap_EXOP_WHOAMI, 0, whoami_extop },
  71         { &slap_EXOP_MODIFY_PASSWD, SLAP_EXOP_WRITES, passwd_extop },
  72 #ifdef HAVE_TLS
  73         { &slap_EXOP_START_TLS, 0, starttls_extop },
  74 #endif
  75         { NULL, 0, NULL }
  76 };
  77
  78
  79 static struct extop_list *find_extop(
  80         struct extop_list *list, struct berval *oid );
  81
  82 struct berval *
  83 get_supported_extop (int index)
  84 {
  85         struct extop_list *ext;
  86
  87         /* linear scan is slow, but this way doesn't force a
  88          * big change on root_dse.c, where this routine is used.
  89          */
  90         for (ext = supp_ext_list; ext != NULL && --index >= 0; ext = ext->next) {
  91                 ; /* empty */
  92         }
  93
  94         if (ext == NULL) return NULL;
  95
  96         return &ext->oid;
  97 }
  98
  99
 100 int exop_root_dse_info( Entry *e )
 101 {
 102         AttributeDescription *ad_supportedExtension
 103                 = slap_schema.si_ad_supportedExtension;
 104         struct berval vals[2];
 105         struct extop_list *ext;
 106
 107         vals[1].bv_val = NULL;
 108         vals[1].bv_len = 0;
 109
 110         for (ext = supp_ext_list; ext != NULL; ext = ext->next) {
 111                 if( ext->flags & SLAP_EXOP_HIDE ) continue;
 112
 113                 vals[0] = ext->oid;
 114
 115                 if( attr_merge( e, ad_supportedExtension, vals, NULL ) ) {
 116                         return LDAP_OTHER;
 117                 }
 118         }
 119
 120         return LDAP_SUCCESS;
 121 }
 122
 123 int
 124 do_extended(
 125     Operation   *op,
 126     SlapReply   *rs
 127 )
 128 {
 129         struct berval reqdata = {0, NULL};
 130         ber_tag_t tag;
 131         ber_len_t len;
 132
 133         Debug( LDAP_DEBUG_TRACE, "do_extended\n", 0, 0, 0 );
 134
 135         if( op->o_protocol < LDAP_VERSION3 ) {
 136                 Debug( LDAP_DEBUG_ANY,
 137                         "do_extended: protocol version (%d) too low\n",
 138                         op->o_protocol, 0 ,0 );
 139                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "requires LDAPv3" );
 140                 rs->sr_err = SLAPD_DISCONNECT;
 141                 goto done;
 142         }
 143
 144         if ( ber_scanf( op->o_ber, "{m" /*}*/, &op->ore_reqoid ) == LBER_ERROR ) {
 145                 Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
 146                 send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
 147                 rs->sr_err = SLAPD_DISCONNECT;
 148                 goto done;
 149         }
 150
 151         tag = ber_peek_tag( op->o_ber, &len );
 152
 153         if( ber_peek_tag( op->o_ber, &len ) == LDAP_TAG_EXOP_REQ_VALUE ) {
 154                 if( ber_scanf( op->o_ber, "m", &reqdata ) == LBER_ERROR ) {
 155                         Debug( LDAP_DEBUG_ANY, "do_extended: ber_scanf failed\n", 0, 0 ,0 );
 156                         send_ldap_discon( op, rs, LDAP_PROTOCOL_ERROR, "decoding error" );
 157                         rs->sr_err = SLAPD_DISCONNECT;
 158                         goto done;
 159                 }
 160         }
 161
 162         if( get_ctrls( op, rs, 1 ) != LDAP_SUCCESS ) {
 163                 Debug( LDAP_DEBUG_ANY, "do_extended: get_ctrls failed\n", 0, 0 ,0 );
 164                 return rs->sr_err;
 165         }
 166
 167         /* check for controls inappropriate for all extended operations */
 168         if( get_manageDSAit( op ) == SLAP_CONTROL_CRITICAL ) {
 169                 send_ldap_error( op, rs,
 170                         LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
 171                         "manageDSAit control inappropriate" );
 172                 goto done;
 173         }
 174
 175         /* FIXME: temporary? */
 176         if ( reqdata.bv_val ) {
 177                 op->ore_reqdata = &reqdata;
 178         }
 179
 180         op->o_bd = frontendDB;
 181         rs->sr_err = frontendDB->be_extended( op, rs );
 182
 183 done:
 184         return rs->sr_err;
 185 }
 186
 187 int
 188 fe_extended( Operation *op, SlapReply *rs )
 189 {
 190         struct extop_list       *ext = NULL;
 191         struct berval           reqdata = BER_BVNULL;
 192
 193         if (op->ore_reqdata) {
 194                 reqdata = *op->ore_reqdata;
 195         }
 196
 197         if( !(ext = find_extop(supp_ext_list, &op->ore_reqoid )))
 198         {
 199                 Debug( LDAP_DEBUG_ANY, "do_extended: unsupported operation \"%s\"\n",
 200                         op->ore_reqoid.bv_val, 0 ,0 );
 201                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR,
 202                         "unsupported extended operation" );
 203                 goto done;
 204         }
 205
 206         op->ore_flags = ext->flags;
 207
 208         Debug( LDAP_DEBUG_ARGS, "do_extended: oid=%s\n",
 209                 op->ore_reqoid.bv_val, 0 ,0 );
 210
 211         { /* start of OpenLDAP extended operation */
 212                 rs->sr_err = (ext->ext_main)( op, rs );
 213
 214                 if( rs->sr_err != SLAPD_ABANDON ) {
 215                         if ( rs->sr_err == LDAP_REFERRAL && rs->sr_ref == NULL ) {
 216                                 rs->sr_ref = referral_rewrite( default_referral,
 217                                         NULL, NULL, LDAP_SCOPE_DEFAULT );
 218                                 if ( !rs->sr_ref ) rs->sr_ref = default_referral;
 219                                 if ( !rs->sr_ref ) {
 220                                         rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 221                                         rs->sr_text = "referral missing";
 222                                 }
 223                         }
 224
 225                         if ( op->o_bd == NULL )
 226                                 op->o_bd = frontendDB;
 227                         send_ldap_extended( op, rs );
 228
 229                         if ( rs->sr_ref != default_referral ) {
 230                                 ber_bvarray_free( rs->sr_ref );
 231                                 rs->sr_ref = NULL;
 232                         }
 233                 }
 234
 235                 if ( rs->sr_rspoid != NULL ) {
 236                         free( (char *)rs->sr_rspoid );
 237                 }
 238
 239                 if ( rs->sr_rspdata != NULL ) {
 240                         ber_bvfree( rs->sr_rspdata );
 241                 }
 242         } /* end of OpenLDAP extended operation */
 243
 244 done:;
 245         return rs->sr_err;
 246 }
 247
 248 int
 249 load_extop(
 250         struct berval *ext_oid,
 251         slap_mask_t ext_flags,
 252         SLAP_EXTOP_MAIN_FN *ext_main )
 253 {
 254         struct extop_list *ext;
 255
 256         if( ext_oid == NULL || ext_oid->bv_val == NULL ||
 257                 ext_oid->bv_val[0] == '\0' || ext_oid->bv_len == 0 ) return -1;
 258         if(!ext_main) return -1;
 259
 260         ext = ch_calloc(1, sizeof(struct extop_list) + ext_oid->bv_len + 1);
 261         if (ext == NULL)
 262                 return(-1);
 263
 264         ext->flags = ext_flags;
 265
 266         ext->oid.bv_val = (char *)(ext + 1);
 267         AC_MEMCPY( ext->oid.bv_val, ext_oid->bv_val, ext_oid->bv_len );
 268         ext->oid.bv_len = ext_oid->bv_len;
 269         ext->oid.bv_val[ext->oid.bv_len] = '\0';
 270
 271         ext->ext_main = ext_main;
 272         ext->next = supp_ext_list;
 273
 274         supp_ext_list = ext;
 275
 276         return(0);
 277 }
 278
 279 int
 280 extops_init (void)
 281 {
 282         int i;
 283
 284         for (i = 0; builtin_extops[i].oid != NULL; i++) {
 285                 load_extop((struct berval *)builtin_extops[i].oid,
 286                         builtin_extops[i].flags,
 287                         builtin_extops[i].ext_main);
 288         }
 289         return(0);
 290 }
 291
 292 int
 293 extops_kill (void)
 294 {
 295         struct extop_list *ext;
 296
 297         /* we allocated the memory, so we have to free it, too. */
 298         while ((ext = supp_ext_list) != NULL) {
 299                 supp_ext_list = ext->next;
 300                 ch_free(ext);
 301         }
 302         return(0);
 303 }
 304
 305 static struct extop_list *
 306 find_extop( struct extop_list *list, struct berval *oid )
 307 {
 308         struct extop_list *ext;
 309
 310         for (ext = list; ext; ext = ext->next) {
 311                 if (bvmatch(&ext->oid, oid))
 312                         return(ext);
 313         }
 314         return(NULL);
 315 }
 316
 317
 318 static int
 319 whoami_extop (
 320         Operation *op,
 321         SlapReply *rs )
 322 {
 323         struct berval *bv;
 324
 325         if ( op->ore_reqdata != NULL ) {
 326                 /* no request data should be provided */
 327                 rs->sr_text = "no request data expected";
 328                 return LDAP_PROTOCOL_ERROR;
 329         }
 330
 331         op->o_bd = op->o_conn->c_authz_backend;
 332         if( backend_check_restrictions( op, rs,
 333                 (struct berval *)&slap_EXOP_WHOAMI ) != LDAP_SUCCESS ) {
 334                 return rs->sr_err;
 335         }
 336
 337         bv = (struct berval *) ch_malloc( sizeof(struct berval) );
 338         if( op->o_dn.bv_len ) {
 339                 bv->bv_len = op->o_dn.bv_len + STRLENOF( "dn:" );
 340                 bv->bv_val = ch_malloc( bv->bv_len + 1 );
 341                 AC_MEMCPY( bv->bv_val, "dn:", STRLENOF( "dn:" ) );
 342                 AC_MEMCPY( &bv->bv_val[STRLENOF( "dn:" )], op->o_dn.bv_val,
 343                         op->o_dn.bv_len );
 344                 bv->bv_val[bv->bv_len] = '\0';
 345
 346         } else {
 347                 bv->bv_len = 0;
 348                 bv->bv_val = NULL;
 349         }
 350
 351         rs->sr_rspdata = bv;
 352         return LDAP_SUCCESS;
 353 }