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

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1999-2002 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 #include "portable.h"
  12
  13 #include <stdio.h>
  14
  15 #include <ac/string.h>
  16 #include <ac/socket.h>
  17
  18 #include "slap.h"
  19
  20 #include "../../libraries/liblber/lber-int.h"
  21
  22 #define SLAP_CTRL_FRONTEND                      0x80000000U
  23 #define SLAP_CTRL_FRONTEND_SEARCH       0x01000000U     /* for NOOP */
  24
  25 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
  26 #define SLAP_CTRL_ABANDON                       0x00000001U
  27 #define SLAP_CTRL_ADD                           0x00002002U
  28 #define SLAP_CTRL_BIND                          0x00000004U
  29 #define SLAP_CTRL_COMPARE                       0x00001008U
  30 #define SLAP_CTRL_DELETE                        0x00002010U
  31 #define SLAP_CTRL_MODIFY                        0x00002020U
  32 #define SLAP_CTRL_RENAME                        0x00002040U
  33 #define SLAP_CTRL_SEARCH                        0x00001080U
  34 #define SLAP_CTRL_UNBIND                        0x00000100U
  35
  36 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
  37 #define SLAP_CTRL_UPDATE \
  38         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
  39 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
  40
  41 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
  42         Connection *conn,
  43         Operation *op,
  44         LDAPControl *ctrl,
  45         const char **text ));
  46
  47 static SLAP_CTRL_PARSE_FN parseManageDSAit;
  48 static SLAP_CTRL_PARSE_FN parseSubentries;
  49 static SLAP_CTRL_PARSE_FN parseNoOp;
  50 static SLAP_CTRL_PARSE_FN parsePagedResults;
  51 static SLAP_CTRL_PARSE_FN parseValuesReturnFilter;
  52
  53 #ifdef LDAP_CLIENT_UPDATE
  54 static SLAP_CTRL_PARSE_FN parseClientUpdate;
  55 #endif /* LDAP_CLIENT_UPDATE */
  56
  57 #undef sc_mask /* avoid conflict with Irix 6.5 <sys/signal.h> */
  58
  59 static struct slap_control {
  60         char *sc_oid;
  61         slap_mask_t sc_mask;
  62         char **sc_extendedops;
  63         SLAP_CTRL_PARSE_FN *sc_parse;
  64
  65 } supportedControls[] = {
  66         { LDAP_CONTROL_MANAGEDSAIT,
  67                 SLAP_CTRL_ACCESS, NULL,
  68                 parseManageDSAit },
  69 #ifdef LDAP_CONTROL_SUBENTRIES
  70         { LDAP_CONTROL_SUBENTRIES,
  71                 SLAP_CTRL_SEARCH, NULL,
  72                 parseSubentries },
  73 #endif
  74 #ifdef LDAP_CONTROL_NOOP
  75         { LDAP_CONTROL_NOOP,
  76                 SLAP_CTRL_ACCESS, NULL,
  77                 parseNoOp },
  78 #endif
  79 #ifdef LDAP_CONTROL_PAGEDRESULTS_REQUEST
  80         { LDAP_CONTROL_PAGEDRESULTS_REQUEST,
  81                 SLAP_CTRL_SEARCH, NULL,
  82                 parsePagedResults },
  83 #endif
  84 #ifdef LDAP_CONTROL_VALUESRETURNFILTER
  85         { LDAP_CONTROL_VALUESRETURNFILTER,
  86                 SLAP_CTRL_SEARCH, NULL,
  87                 parseValuesReturnFilter },
  88 #endif
  89 #ifdef LDAP_CLIENT_UPDATE
  90         { LDAP_CONTROL_CLIENT_UPDATE,
  91                 SLAP_CTRL_SEARCH, NULL,
  92                 parseClientUpdate },
  93 #endif /* LDAP_CLIENT_UPDATE */
  94         { NULL }
  95 };
  96
  97 char *
  98 get_supported_ctrl(int index)
  99 {
 100         return supportedControls[index].sc_oid;
 101 }
 102
 103 static struct slap_control *
 104 find_ctrl( const char *oid )
 105 {
 106         int i;
 107         for( i=0; supportedControls[i].sc_oid; i++ ) {
 108                 if( strcmp( oid, supportedControls[i].sc_oid ) == 0 ) {
 109                         return &supportedControls[i];
 110                 }
 111         }
 112         return NULL;
 113 }
 114
 115 int get_ctrls(
 116         Connection *conn,
 117         Operation *op,
 118         int sendres )
 119 {
 120         int nctrls = 0;
 121         ber_tag_t tag;
 122         ber_len_t len;
 123         char *opaque;
 124         BerElement *ber = op->o_ber;
 125         struct slap_control *sc;
 126         int rc = LDAP_SUCCESS;
 127         const char *errmsg = NULL;
 128
 129         len = ber_pvt_ber_remaining(ber);
 130
 131         if( len == 0) {
 132                 /* no controls */
 133                 rc = LDAP_SUCCESS;
 134                 return rc;
 135         }
 136
 137         if(( tag = ber_peek_tag( ber, &len )) != LDAP_TAG_CONTROLS ) {
 138                 if( tag == LBER_ERROR ) {
 139                         rc = SLAPD_DISCONNECT;
 140                         errmsg = "unexpected data in PDU";
 141                 }
 142
 143                 goto return_results;
 144         }
 145
 146 #ifdef NEW_LOGGING
 147         LDAP_LOG( OPERATION, ENTRY, "get_ctrls: conn %lu\n", conn->c_connid, 0, 0 );
 148 #else
 149         Debug( LDAP_DEBUG_TRACE, "=> get_ctrls\n", 0, 0, 0 );
 150 #endif
 151         if( op->o_protocol < LDAP_VERSION3 ) {
 152                 rc = SLAPD_DISCONNECT;
 153                 errmsg = "controls require LDAPv3";
 154                 goto return_results;
 155         }
 156
 157         /* one for first control, one for termination */
 158         op->o_ctrls = ch_malloc( 2 * sizeof(LDAPControl *) );
 159
 160 #if 0
 161         if( op->ctrls == NULL ) {
 162                 rc = LDAP_NO_MEMORY;
 163                 errmsg = "no memory";
 164                 goto return_results;
 165         }
 166 #endif
 167
 168         op->o_ctrls[nctrls] = NULL;
 169
 170         /* step through each element */
 171         for( tag = ber_first_element( ber, &len, &opaque );
 172                 tag != LBER_ERROR;
 173                 tag = ber_next_element( ber, &len, opaque ) )
 174         {
 175                 LDAPControl *c;
 176                 LDAPControl **tctrls;
 177
 178                 c = ch_calloc( 1, sizeof(LDAPControl) );
 179
 180 #if 0
 181                 if( c == NULL ) {
 182                         ldap_controls_free(op->o_ctrls);
 183                         op->o_ctrls = NULL;
 184
 185                         rc = LDAP_NO_MEMORY;
 186                         errmsg = "no memory";
 187                         goto return_results;
 188                 }
 189 #endif
 190
 191                 /* allocate pointer space for current controls (nctrls)
 192                  * + this control + extra NULL
 193                  */
 194                 tctrls = ch_realloc( op->o_ctrls,
 195                         (nctrls+2) * sizeof(LDAPControl *));
 196
 197 #if 0
 198                 if( tctrls == NULL ) {
 199                         ch_free( c );
 200                         ldap_controls_free(op->o_ctrls);
 201                         op->o_ctrls = NULL;
 202
 203                         rc = LDAP_NO_MEMORY;
 204                         errmsg = "no memory";
 205                         goto return_results;
 206                 }
 207 #endif
 208                 op->o_ctrls = tctrls;
 209
 210                 op->o_ctrls[nctrls++] = c;
 211                 op->o_ctrls[nctrls] = NULL;
 212
 213                 tag = ber_scanf( ber, "{a" /*}*/, &c->ldctl_oid );
 214
 215                 if( tag == LBER_ERROR ) {
 216 #ifdef NEW_LOGGING
 217                         LDAP_LOG( OPERATION, INFO, "get_ctrls: conn %lu get OID failed.\n",
 218                                 conn->c_connid, 0, 0 );
 219 #else
 220                         Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: get oid failed.\n",
 221                                 0, 0, 0 );
 222 #endif
 223                         ldap_controls_free( op->o_ctrls );
 224                         op->o_ctrls = NULL;
 225                         rc = SLAPD_DISCONNECT;
 226                         errmsg = "decoding controls error";
 227                         goto return_results;
 228                 }
 229
 230                 tag = ber_peek_tag( ber, &len );
 231
 232                 if( tag == LBER_BOOLEAN ) {
 233                         ber_int_t crit;
 234                         tag = ber_scanf( ber, "b", &crit );
 235
 236                         if( tag == LBER_ERROR ) {
 237 #ifdef NEW_LOGGING
 238                                 LDAP_LOG( OPERATION, INFO,
 239                                         "get_ctrls: conn %lu get crit failed.\n",
 240                                         conn->c_connid, 0, 0 );
 241 #else
 242                                 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: get crit failed.\n",
 243                                         0, 0, 0 );
 244 #endif
 245                                 ldap_controls_free( op->o_ctrls );
 246                                 op->o_ctrls = NULL;
 247                                 rc = SLAPD_DISCONNECT;
 248                                 errmsg = "decoding controls error";
 249                                 goto return_results;
 250                         }
 251
 252                         c->ldctl_iscritical = (crit != 0);
 253                         tag = ber_peek_tag( ber, &len );
 254                 }
 255
 256                 if( tag == LBER_OCTETSTRING ) {
 257                         tag = ber_scanf( ber, "o", &c->ldctl_value );
 258
 259                         if( tag == LBER_ERROR ) {
 260 #ifdef NEW_LOGGING
 261                                 LDAP_LOG( OPERATION, INFO, "get_ctrls: conn %lu: "
 262                                         "%s (%scritical): get value failed.\n",
 263                                         conn->c_connid, c->ldctl_oid ? c->ldctl_oid : "(NULL)",
 264                                         c->ldctl_iscritical ? "" : "non" );
 265 #else
 266                                 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: conn %lu: "
 267                                         "%s (%scritical): get value failed.\n",
 268                                         conn->c_connid,
 269                                         c->ldctl_oid ? c->ldctl_oid : "(NULL)",
 270                                         c->ldctl_iscritical ? "" : "non" );
 271 #endif
 272                                 ldap_controls_free( op->o_ctrls );
 273                                 op->o_ctrls = NULL;
 274                                 rc = SLAPD_DISCONNECT;
 275                                 errmsg = "decoding controls error";
 276                                 goto return_results;
 277                         }
 278                 }
 279
 280 #ifdef NEW_LOGGING
 281                 LDAP_LOG( OPERATION, INFO,
 282                         "get_ctrls: conn %lu oid=\"%s\" (%scritical)\n",
 283                         conn->c_connid, c->ldctl_oid ? c->ldctl_oid : "(NULL)",
 284                         c->ldctl_iscritical ? "" : "non" );
 285 #else
 286                 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: oid=\"%s\" (%scritical)\n",
 287                         c->ldctl_oid ? c->ldctl_oid : "(NULL)",
 288                         c->ldctl_iscritical ? "" : "non",
 289                         0 );
 290 #endif
 291
 292                 sc = find_ctrl( c->ldctl_oid );
 293                 if( sc != NULL ) {
 294                         /* recognized control */
 295                         slap_mask_t tagmask;
 296                         switch( op->o_tag ) {
 297                         case LDAP_REQ_ADD:
 298                                 tagmask = SLAP_CTRL_ADD;
 299                                 break;
 300                         case LDAP_REQ_BIND:
 301                                 tagmask = SLAP_CTRL_BIND;
 302                                 break;
 303                         case LDAP_REQ_COMPARE:
 304                                 tagmask = SLAP_CTRL_COMPARE;
 305                                 break;
 306                         case LDAP_REQ_DELETE:
 307                                 tagmask = SLAP_CTRL_DELETE;
 308                                 break;
 309                         case LDAP_REQ_MODIFY:
 310                                 tagmask = SLAP_CTRL_MODIFY;
 311                                 break;
 312                         case LDAP_REQ_RENAME:
 313                                 tagmask = SLAP_CTRL_RENAME;
 314                                 break;
 315                         case LDAP_REQ_SEARCH:
 316                                 tagmask = SLAP_CTRL_SEARCH;
 317                                 break;
 318                         case LDAP_REQ_UNBIND:
 319                                 tagmask = SLAP_CTRL_UNBIND;
 320                                 break;
 321                         case LDAP_REQ_EXTENDED:
 322                                 /* FIXME: check list of extended operations */
 323                                 tagmask = ~0U;
 324                                 break;
 325                         default:
 326                                 rc = LDAP_OTHER;
 327                                 errmsg = "controls internal error";
 328                                 goto return_results;
 329                         }
 330
 331                         if (( sc->sc_mask & tagmask ) == tagmask ) {
 332                                 /* available extension */
 333
 334                                 if( !sc->sc_parse ) {
 335                                         rc = LDAP_OTHER;
 336                                         errmsg = "not yet implemented";
 337                                         goto return_results;
 338                                 }
 339
 340                                 rc = sc->sc_parse( conn, op, c, &errmsg );
 341
 342                                 if( rc != LDAP_SUCCESS ) goto return_results;
 343
 344                                 if ( sc->sc_mask & SLAP_CTRL_FRONTEND ) {
 345                                         /* kludge to disable backend_control() check */
 346                                         c->ldctl_iscritical = 0;
 347
 348                                 } else if ( tagmask == SLAP_CTRL_SEARCH &&
 349                                         sc->sc_mask & SLAP_CTRL_FRONTEND_SEARCH )
 350                                 {
 351                                         /* kludge to disable backend_control() check */
 352                                         c->ldctl_iscritical = 0;
 353                                 }
 354
 355                         } else if( c->ldctl_iscritical ) {
 356                                 /* unavailable CRITICAL control */
 357                                 rc = LDAP_UNAVAILABLE_CRITICAL_EXTENSION;
 358                                 errmsg = "critical extension is unavailable";
 359                                 goto return_results;
 360                         }
 361
 362                 } else if( c->ldctl_iscritical ) {
 363                         /* unrecognized CRITICAL control */
 364                         rc = LDAP_UNAVAILABLE_CRITICAL_EXTENSION;
 365                         errmsg = "critical extension is not recognized";
 366                         goto return_results;
 367                 }
 368         }
 369
 370 return_results:
 371 #ifdef NEW_LOGGING
 372         LDAP_LOG( OPERATION, RESULTS,
 373                 "get_ctrls: n=%d rc=%d err=%s\n", nctrls, rc, errmsg ? errmsg : "" );
 374 #else
 375         Debug( LDAP_DEBUG_TRACE, "<= get_ctrls: n=%d rc=%d err=%s\n",
 376                 nctrls, rc, errmsg ? errmsg : "");
 377 #endif
 378
 379         if( sendres && rc != LDAP_SUCCESS ) {
 380                 if( rc == SLAPD_DISCONNECT ) {
 381                         send_ldap_disconnect( conn, op, LDAP_PROTOCOL_ERROR, errmsg );
 382                 } else {
 383                         send_ldap_result( conn, op, rc,
 384                                 NULL, errmsg, NULL, NULL );
 385                 }
 386         }
 387
 388         return rc;
 389 }
 390
 391 static int parseManageDSAit (
 392         Connection *conn,
 393         Operation *op,
 394         LDAPControl *ctrl,
 395         const char **text )
 396 {
 397         if ( op->o_managedsait != SLAP_NO_CONTROL ) {
 398                 *text = "manageDSAit control specified multiple times";
 399                 return LDAP_PROTOCOL_ERROR;
 400         }
 401
 402         if ( ctrl->ldctl_value.bv_len ) {
 403                 *text = "manageDSAit control value not empty";
 404                 return LDAP_PROTOCOL_ERROR;
 405         }
 406
 407         op->o_managedsait = ctrl->ldctl_iscritical
 408                 ? SLAP_CRITICAL_CONTROL
 409                 : SLAP_NONCRITICAL_CONTROL;
 410
 411         return LDAP_SUCCESS;
 412 }
 413
 414 #ifdef LDAP_CONTROL_SUBENTRIES
 415 static int parseSubentries (
 416         Connection *conn,
 417         Operation *op,
 418         LDAPControl *ctrl,
 419         const char **text )
 420 {
 421         if ( op->o_subentries != SLAP_NO_CONTROL ) {
 422                 *text = "subentries control specified multiple times";
 423                 return LDAP_PROTOCOL_ERROR;
 424         }
 425
 426         /* FIXME: should use BER library */
 427         if( ( ctrl->ldctl_value.bv_len != 3 )
 428                 && ( ctrl->ldctl_value.bv_val[0] != 0x01 )
 429                 && ( ctrl->ldctl_value.bv_val[1] != 0x01 ))
 430         {
 431                 *text = "subentries control value encoding is bogus";
 432                 return LDAP_PROTOCOL_ERROR;
 433         }
 434
 435         op->o_subentries = ctrl->ldctl_iscritical
 436                 ? SLAP_CRITICAL_CONTROL
 437                 : SLAP_NONCRITICAL_CONTROL;
 438
 439         op->o_subentries_visibility = (ctrl->ldctl_value.bv_val[2] != 0x00);
 440
 441         return LDAP_SUCCESS;
 442 }
 443 #endif
 444
 445 #ifdef LDAP_CONTROL_NOOP
 446 static int parseNoOp (
 447         Connection *conn,
 448         Operation *op,
 449         LDAPControl *ctrl,
 450         const char **text )
 451 {
 452         if ( op->o_noop != SLAP_NO_CONTROL ) {
 453                 *text = "noop control specified multiple times";
 454                 return LDAP_PROTOCOL_ERROR;
 455         }
 456
 457         if ( ctrl->ldctl_value.bv_len ) {
 458                 *text = "noop control value not empty";
 459                 return LDAP_PROTOCOL_ERROR;
 460         }
 461
 462         op->o_noop = ctrl->ldctl_iscritical
 463                 ? SLAP_CRITICAL_CONTROL
 464                 : SLAP_NONCRITICAL_CONTROL;
 465
 466         return LDAP_SUCCESS;
 467 }
 468 #endif
 469
 470 #ifdef LDAP_CONTROL_PAGEDRESULTS_REQUEST
 471 static int parsePagedResults (
 472         Connection *conn,
 473         Operation *op,
 474         LDAPControl *ctrl,
 475         const char **text )
 476 {
 477         ber_tag_t tag;
 478         ber_int_t size;
 479         BerElement *ber;
 480         struct berval cookie = { 0, NULL };
 481
 482         if ( op->o_pagedresults != SLAP_NO_CONTROL ) {
 483                 *text = "paged results control specified multiple times";
 484                 return LDAP_PROTOCOL_ERROR;
 485         }
 486
 487         if ( ctrl->ldctl_value.bv_len == 0 ) {
 488                 *text = "paged results control value is empty";
 489                 return LDAP_PROTOCOL_ERROR;
 490         }
 491
 492         /* Parse the control value
 493          *      realSearchControlValue ::= SEQUENCE {
 494          *              size    INTEGER (0..maxInt),
 495          *                              -- requested page size from client
 496          *                              -- result set size estimate from server
 497          *              cookie  OCTET STRING
 498          */
 499         ber = ber_init( &ctrl->ldctl_value );
 500         if( ber == NULL ) {
 501                 *text = "internal error";
 502                 return LDAP_OTHER;
 503         }
 504
 505         tag = ber_scanf( ber, "{im}", &size, &cookie );
 506         (void) ber_free( ber, 1 );
 507
 508         if( tag == LBER_ERROR ) {
 509                 *text = "paged results control could not be decoded";
 510                 return LDAP_PROTOCOL_ERROR;
 511         }
 512
 513         if( size <= 0 ) {
 514                 *text = "paged results control size invalid";
 515                 return LDAP_PROTOCOL_ERROR;
 516         }
 517
 518         if( cookie.bv_len ) {
 519                 PagedResultsCookie reqcookie;
 520                 if( cookie.bv_len != sizeof( reqcookie ) ) {
 521                         /* bad cookie */
 522                         *text = "paged results cookie is invalid";
 523                         return LDAP_PROTOCOL_ERROR;
 524                 }
 525
 526                 AC_MEMCPY( &reqcookie, cookie.bv_val, sizeof( reqcookie ));
 527
 528                 if( reqcookie > op->o_pagedresults_state.ps_cookie ) {
 529                         /* bad cookie */
 530                         *text = "paged results cookie is invalid";
 531                         return LDAP_PROTOCOL_ERROR;
 532
 533                 } else if( reqcookie < op->o_pagedresults_state.ps_cookie ) {
 534                         *text = "paged results cookie is invalid or old";
 535                         return LDAP_UNWILLING_TO_PERFORM;
 536                 }
 537         }
 538
 539         op->o_pagedresults_state.ps_cookie = op->o_opid;
 540         op->o_pagedresults_size = size;
 541
 542         op->o_pagedresults = ctrl->ldctl_iscritical
 543                 ? SLAP_CRITICAL_CONTROL
 544                 : SLAP_NONCRITICAL_CONTROL;
 545
 546         return LDAP_SUCCESS;
 547 }
 548 #endif
 549
 550 #ifdef LDAP_CONTROL_VALUESRETURNFILTER
 551 int parseValuesReturnFilter (
 552         Connection *conn,
 553         Operation *op,
 554         LDAPControl *ctrl,
 555         const char **text )
 556 {
 557         int             rc;
 558         BerElement      *ber;
 559         struct berval   fstr = { 0, NULL };
 560         const char *err_msg = "";
 561
 562         if ( op->o_valuesreturnfilter != SLAP_NO_CONTROL ) {
 563                 *text = "valuesreturnfilter control specified multiple times";
 564                 return LDAP_PROTOCOL_ERROR;
 565         }
 566
 567         ber = ber_init( &(ctrl->ldctl_value) );
 568         if (ber == NULL) {
 569                 *text = "internal error";
 570                 return LDAP_OTHER;
 571         }
 572
 573         rc = get_vrFilter( conn, ber, &(op->vrFilter), &err_msg);
 574
 575         if( rc != LDAP_SUCCESS ) {
 576                 text = &err_msg;
 577                 if( rc == SLAPD_DISCONNECT ) {
 578                         send_ldap_disconnect( conn, op,
 579                                 LDAP_PROTOCOL_ERROR, *text );
 580                 } else {
 581                         send_ldap_result( conn, op, rc,
 582                                 NULL, *text, NULL, NULL );
 583                 }
 584                 if( fstr.bv_val != NULL) free( fstr.bv_val );
 585                 if( op->vrFilter != NULL) vrFilter_free( op->vrFilter );
 586
 587         } else {
 588                 vrFilter2bv( op->vrFilter, &fstr );
 589         }
 590
 591 #ifdef NEW_LOGGING
 592         LDAP_LOG( OPERATION, ARGS,
 593                 "parseValuesReturnFilter: conn %d       vrFilter: %s\n",
 594                 conn->c_connid, fstr.bv_len ? fstr.bv_val : "empty" , 0 );
 595 #else
 596         Debug( LDAP_DEBUG_ARGS, "       vrFilter: %s\n",
 597                 fstr.bv_len ? fstr.bv_val : "empty", 0, 0 );
 598 #endif
 599
 600         op->o_valuesreturnfilter = ctrl->ldctl_iscritical
 601                 ? SLAP_CRITICAL_CONTROL
 602                 : SLAP_NONCRITICAL_CONTROL;
 603
 604         return LDAP_SUCCESS;
 605 }
 606 #endif
 607
 608 #ifdef LDAP_CLIENT_UPDATE
 609 static int parseClientUpdate (
 610         Connection *conn,
 611         Operation *op,
 612         LDAPControl *ctrl,
 613         const char **text )
 614 {
 615         ber_tag_t tag;
 616         BerElement *ber;
 617         ber_int_t type;
 618         ber_int_t interval;
 619         ber_len_t len;
 620         struct berval scheme = { 0, NULL };
 621         struct berval cookie = { 0, NULL };
 622
 623         if ( op->o_clientupdate != SLAP_NO_CONTROL ) {
 624                 *text = "LCUP client update control specified multiple times";
 625                 return LDAP_PROTOCOL_ERROR;
 626         }
 627
 628         if ( ctrl->ldctl_value.bv_len == 0 ) {
 629                 *text = "LCUP client update control value is empty";
 630                 return LDAP_PROTOCOL_ERROR;
 631         }
 632
 633         /* Parse the control value
 634          *      ClientUpdateControlValue ::= SEQUENCE {
 635          *              updateType      ENUMERATED {
 636          *                                      synchronizeOnly {0},
 637          *                                      synchronizeAndPersist {1},
 638          *                                      persistOnly {2} },
 639          *              sendCookieInterval INTEGER OPTIONAL,
 640          *              cookie          LCUPCookie OPTIONAL
 641          *      }
 642          */
 643
 644         ber = ber_init( &ctrl->ldctl_value );
 645         if( ber == NULL ) {
 646                 *text = "internal error";
 647                 return LDAP_OTHER;
 648         }
 649
 650         if ( (tag = ber_scanf( ber, "{i" /*}*/, &type )) == LBER_ERROR ) {
 651                 *text = "LCUP client update control : decoding error";
 652                 return LDAP_PROTOCOL_ERROR;
 653         }
 654
 655         switch( type ) {
 656         case LDAP_CUP_SYNC_ONLY:
 657                 type = SLAP_LCUP_SYNC;
 658                 break;
 659         case LDAP_CUP_SYNC_AND_PERSIST:
 660                 type = SLAP_LCUP_SYNC_AND_PERSIST;
 661                 break;
 662         case LDAP_CUP_PERSIST_ONLY:
 663                 type = SLAP_LCUP_PERSIST;
 664                 break;
 665         default:
 666                 *text = "LCUP client update control : unknown update type";
 667                 return LDAP_PROTOCOL_ERROR;
 668         }
 669
 670         if ( (tag = ber_peek_tag( ber, &len )) == LBER_DEFAULT ) {
 671                 *text = "LCUP client update control : decoding error";
 672                 return LDAP_PROTOCOL_ERROR;
 673         }
 674
 675         if ( tag == LDAP_TAG_INTERVAL ) {
 676                 if ( (tag = ber_scanf( ber, "i", &interval )) == LBER_ERROR ) {
 677                         *text = "LCUP client update control : decoding error";
 678                         return LDAP_PROTOCOL_ERROR;
 679                 }
 680
 681                 if ( interval <= 0 ) {
 682                         /* server chooses interval */
 683                         interval = LDAP_CUP_DEFAULT_SEND_COOKIE_INTERVAL;
 684                 }
 685
 686         } else {
 687                 /* server chooses interval */
 688                 interval = LDAP_CUP_DEFAULT_SEND_COOKIE_INTERVAL;
 689         }
 690
 691         if ( (tag = ber_peek_tag( ber, &len )) == LBER_DEFAULT ) {
 692                 *text = "LCUP client update control : decoding error";
 693                 return LDAP_PROTOCOL_ERROR;
 694         }
 695
 696         if ( tag == LDAP_TAG_COOKIE ) {
 697                 if ( (tag = ber_scanf( ber, /*{*/ "{mm}}",
 698                                         &scheme, &cookie )) == LBER_ERROR ) {
 699                         *text = "LCUP client update control : decoding error";
 700                         return LDAP_PROTOCOL_ERROR;
 701                 }
 702         }
 703
 704         /* TODO : Cookie Scheme Validation */
 705 #if 0
 706         if ( lcup_cookie_scheme_validate(scheme) != LDAP_SUCCESS ) {
 707                 *text = "Unsupported LCUP cookie scheme";
 708                 return LCUP_UNSUPPORTED_SCHEME;
 709         }
 710
 711         if ( lcup_cookie_validate(scheme, cookie) != LDAP_SUCCESS ) {
 712                 *text = "Invalid LCUP cookie";
 713                 return LCUP_INVALID_COOKIE;
 714         }
 715 #endif
 716
 717         ber_dupbv( &op->o_clientupdate_state, &cookie );
 718
 719         (void) ber_free( ber, 1 );
 720
 721         op->o_clientupdate_type = (char) type;
 722         op->o_clientupdate_interval = interval;
 723
 724         op->o_clientupdate = ctrl->ldctl_iscritical
 725                 ? SLAP_CRITICAL_CONTROL
 726                 : SLAP_NONCRITICAL_CONTROL;
 727
 728         return LDAP_SUCCESS;
 729 }
 730 #endif /* LDAP_CLIENT_UPDATE */