3 * Copyright 1999-2002 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.
15 #include <ac/string.h>
16 #include <ac/socket.h>
20 #include "../../libraries/liblber/lber-int.h"
22 #define SLAP_CTRL_FRONTEND 0x80000000U
23 #define SLAP_CTRL_FRONTEND_SEARCH 0x01000000U /* for NOOP */
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
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)
41 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
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;
53 #ifdef LDAP_CLIENT_UPDATE
54 static SLAP_CTRL_PARSE_FN parseClientUpdate;
55 #endif /* LDAP_CLIENT_UPDATE */
57 #undef sc_mask /* avoid conflict with Irix 6.5 <sys/signal.h> */
59 static struct slap_control {
62 char **sc_extendedops;
63 SLAP_CTRL_PARSE_FN *sc_parse;
65 } supportedControls[] = {
66 { LDAP_CONTROL_MANAGEDSAIT,
67 SLAP_CTRL_ACCESS, NULL,
69 #ifdef LDAP_CONTROL_SUBENTRIES
70 { LDAP_CONTROL_SUBENTRIES,
71 SLAP_CTRL_SEARCH, NULL,
74 #ifdef LDAP_CONTROL_NOOP
76 SLAP_CTRL_ACCESS, NULL,
79 #ifdef LDAP_CONTROL_PAGEDRESULTS_REQUEST
80 { LDAP_CONTROL_PAGEDRESULTS_REQUEST,
81 SLAP_CTRL_SEARCH, NULL,
84 #ifdef LDAP_CONTROL_VALUESRETURNFILTER
85 { LDAP_CONTROL_VALUESRETURNFILTER,
86 SLAP_CTRL_SEARCH, NULL,
87 parseValuesReturnFilter },
89 #ifdef LDAP_CLIENT_UPDATE
90 { LDAP_CONTROL_CLIENT_UPDATE,
91 SLAP_CTRL_SEARCH, NULL,
93 #endif /* LDAP_CLIENT_UPDATE */
98 get_supported_ctrl(int index)
100 return supportedControls[index].sc_oid;
103 static struct slap_control *
104 find_ctrl( const char *oid )
107 for( i=0; supportedControls[i].sc_oid; i++ ) {
108 if( strcmp( oid, supportedControls[i].sc_oid ) == 0 ) {
109 return &supportedControls[i];
124 BerElement *ber = op->o_ber;
125 struct slap_control *sc;
126 int rc = LDAP_SUCCESS;
127 const char *errmsg = NULL;
129 len = ber_pvt_ber_remaining(ber);
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";
147 LDAP_LOG( OPERATION, ENTRY, "get_ctrls: conn %lu\n", conn->c_connid, 0, 0 );
149 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls\n", 0, 0, 0 );
151 if( op->o_protocol < LDAP_VERSION3 ) {
152 rc = SLAPD_DISCONNECT;
153 errmsg = "controls require LDAPv3";
157 /* one for first control, one for termination */
158 op->o_ctrls = ch_malloc( 2 * sizeof(LDAPControl *) );
161 if( op->ctrls == NULL ) {
163 errmsg = "no memory";
168 op->o_ctrls[nctrls] = NULL;
170 /* step through each element */
171 for( tag = ber_first_element( ber, &len, &opaque );
173 tag = ber_next_element( ber, &len, opaque ) )
176 LDAPControl **tctrls;
178 c = ch_calloc( 1, sizeof(LDAPControl) );
182 ldap_controls_free(op->o_ctrls);
186 errmsg = "no memory";
191 /* allocate pointer space for current controls (nctrls)
192 * + this control + extra NULL
194 tctrls = ch_realloc( op->o_ctrls,
195 (nctrls+2) * sizeof(LDAPControl *));
198 if( tctrls == NULL ) {
200 ldap_controls_free(op->o_ctrls);
204 errmsg = "no memory";
208 op->o_ctrls = tctrls;
210 op->o_ctrls[nctrls++] = c;
211 op->o_ctrls[nctrls] = NULL;
213 tag = ber_scanf( ber, "{a" /*}*/, &c->ldctl_oid );
215 if( tag == LBER_ERROR ) {
217 LDAP_LOG( OPERATION, INFO, "get_ctrls: conn %lu get OID failed.\n",
218 conn->c_connid, 0, 0 );
220 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: get oid failed.\n",
223 ldap_controls_free( op->o_ctrls );
225 rc = SLAPD_DISCONNECT;
226 errmsg = "decoding controls error";
230 tag = ber_peek_tag( ber, &len );
232 if( tag == LBER_BOOLEAN ) {
234 tag = ber_scanf( ber, "b", &crit );
236 if( tag == LBER_ERROR ) {
238 LDAP_LOG( OPERATION, INFO,
239 "get_ctrls: conn %lu get crit failed.\n",
240 conn->c_connid, 0, 0 );
242 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: get crit failed.\n",
245 ldap_controls_free( op->o_ctrls );
247 rc = SLAPD_DISCONNECT;
248 errmsg = "decoding controls error";
252 c->ldctl_iscritical = (crit != 0);
253 tag = ber_peek_tag( ber, &len );
256 if( tag == LBER_OCTETSTRING ) {
257 tag = ber_scanf( ber, "o", &c->ldctl_value );
259 if( tag == LBER_ERROR ) {
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" );
266 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: conn %lu: "
267 "%s (%scritical): get value failed.\n",
269 c->ldctl_oid ? c->ldctl_oid : "(NULL)",
270 c->ldctl_iscritical ? "" : "non" );
272 ldap_controls_free( op->o_ctrls );
274 rc = SLAPD_DISCONNECT;
275 errmsg = "decoding controls error";
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" );
286 Debug( LDAP_DEBUG_TRACE, "=> get_ctrls: oid=\"%s\" (%scritical)\n",
287 c->ldctl_oid ? c->ldctl_oid : "(NULL)",
288 c->ldctl_iscritical ? "" : "non",
292 sc = find_ctrl( c->ldctl_oid );
294 /* recognized control */
296 switch( op->o_tag ) {
298 tagmask = SLAP_CTRL_ADD;
301 tagmask = SLAP_CTRL_BIND;
303 case LDAP_REQ_COMPARE:
304 tagmask = SLAP_CTRL_COMPARE;
306 case LDAP_REQ_DELETE:
307 tagmask = SLAP_CTRL_DELETE;
309 case LDAP_REQ_MODIFY:
310 tagmask = SLAP_CTRL_MODIFY;
312 case LDAP_REQ_RENAME:
313 tagmask = SLAP_CTRL_RENAME;
315 case LDAP_REQ_SEARCH:
316 tagmask = SLAP_CTRL_SEARCH;
318 case LDAP_REQ_UNBIND:
319 tagmask = SLAP_CTRL_UNBIND;
321 case LDAP_REQ_EXTENDED:
322 /* FIXME: check list of extended operations */
327 errmsg = "controls internal error";
331 if (( sc->sc_mask & tagmask ) == tagmask ) {
332 /* available extension */
334 if( !sc->sc_parse ) {
336 errmsg = "not yet implemented";
340 rc = sc->sc_parse( conn, op, c, &errmsg );
342 if( rc != LDAP_SUCCESS ) goto return_results;
344 if ( sc->sc_mask & SLAP_CTRL_FRONTEND ) {
345 /* kludge to disable backend_control() check */
346 c->ldctl_iscritical = 0;
348 } else if ( tagmask == SLAP_CTRL_SEARCH &&
349 sc->sc_mask & SLAP_CTRL_FRONTEND_SEARCH )
351 /* kludge to disable backend_control() check */
352 c->ldctl_iscritical = 0;
355 } else if( c->ldctl_iscritical ) {
356 /* unavailable CRITICAL control */
357 rc = LDAP_UNAVAILABLE_CRITICAL_EXTENSION;
358 errmsg = "critical extension is unavailable";
362 } else if( c->ldctl_iscritical ) {
363 /* unrecognized CRITICAL control */
364 rc = LDAP_UNAVAILABLE_CRITICAL_EXTENSION;
365 errmsg = "critical extension is not recognized";
372 LDAP_LOG( OPERATION, RESULTS,
373 "get_ctrls: n=%d rc=%d err=%s\n", nctrls, rc, errmsg ? errmsg : "" );
375 Debug( LDAP_DEBUG_TRACE, "<= get_ctrls: n=%d rc=%d err=%s\n",
376 nctrls, rc, errmsg ? errmsg : "");
379 if( sendres && rc != LDAP_SUCCESS ) {
380 if( rc == SLAPD_DISCONNECT ) {
381 send_ldap_disconnect( conn, op, LDAP_PROTOCOL_ERROR, errmsg );
383 send_ldap_result( conn, op, rc,
384 NULL, errmsg, NULL, NULL );
391 static int parseManageDSAit (
397 if ( op->o_managedsait != SLAP_NO_CONTROL ) {
398 *text = "manageDSAit control specified multiple times";
399 return LDAP_PROTOCOL_ERROR;
402 if ( ctrl->ldctl_value.bv_len ) {
403 *text = "manageDSAit control value not empty";
404 return LDAP_PROTOCOL_ERROR;
407 op->o_managedsait = ctrl->ldctl_iscritical
408 ? SLAP_CRITICAL_CONTROL
409 : SLAP_NONCRITICAL_CONTROL;
414 #ifdef LDAP_CONTROL_SUBENTRIES
415 static int parseSubentries (
421 if ( op->o_subentries != SLAP_NO_CONTROL ) {
422 *text = "subentries control specified multiple times";
423 return LDAP_PROTOCOL_ERROR;
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 ))
431 *text = "subentries control value encoding is bogus";
432 return LDAP_PROTOCOL_ERROR;
435 op->o_subentries = ctrl->ldctl_iscritical
436 ? SLAP_CRITICAL_CONTROL
437 : SLAP_NONCRITICAL_CONTROL;
439 op->o_subentries_visibility = (ctrl->ldctl_value.bv_val[2] != 0x00);
445 #ifdef LDAP_CONTROL_NOOP
446 static int parseNoOp (
452 if ( op->o_noop != SLAP_NO_CONTROL ) {
453 *text = "noop control specified multiple times";
454 return LDAP_PROTOCOL_ERROR;
457 if ( ctrl->ldctl_value.bv_len ) {
458 *text = "noop control value not empty";
459 return LDAP_PROTOCOL_ERROR;
462 op->o_noop = ctrl->ldctl_iscritical
463 ? SLAP_CRITICAL_CONTROL
464 : SLAP_NONCRITICAL_CONTROL;
470 #ifdef LDAP_CONTROL_PAGEDRESULTS_REQUEST
471 static int parsePagedResults (
480 struct berval cookie = { 0, NULL };
482 if ( op->o_pagedresults != SLAP_NO_CONTROL ) {
483 *text = "paged results control specified multiple times";
484 return LDAP_PROTOCOL_ERROR;
487 if ( ctrl->ldctl_value.bv_len == 0 ) {
488 *text = "paged results control value is empty";
489 return LDAP_PROTOCOL_ERROR;
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
499 ber = ber_init( &ctrl->ldctl_value );
501 *text = "internal error";
505 tag = ber_scanf( ber, "{im}", &size, &cookie );
506 (void) ber_free( ber, 1 );
508 if( tag == LBER_ERROR ) {
509 *text = "paged results control could not be decoded";
510 return LDAP_PROTOCOL_ERROR;
514 *text = "paged results control size invalid";
515 return LDAP_PROTOCOL_ERROR;
518 if( cookie.bv_len ) {
519 PagedResultsCookie reqcookie;
520 if( cookie.bv_len != sizeof( reqcookie ) ) {
522 *text = "paged results cookie is invalid";
523 return LDAP_PROTOCOL_ERROR;
526 AC_MEMCPY( &reqcookie, cookie.bv_val, sizeof( reqcookie ));
528 if( reqcookie > op->o_pagedresults_state.ps_cookie ) {
530 *text = "paged results cookie is invalid";
531 return LDAP_PROTOCOL_ERROR;
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;
539 op->o_pagedresults_state.ps_cookie = op->o_opid;
540 op->o_pagedresults_size = size;
542 op->o_pagedresults = ctrl->ldctl_iscritical
543 ? SLAP_CRITICAL_CONTROL
544 : SLAP_NONCRITICAL_CONTROL;
550 #ifdef LDAP_CONTROL_VALUESRETURNFILTER
551 int parseValuesReturnFilter (
559 struct berval fstr = { 0, NULL };
560 const char *err_msg = "";
562 if ( op->o_valuesreturnfilter != SLAP_NO_CONTROL ) {
563 *text = "valuesreturnfilter control specified multiple times";
564 return LDAP_PROTOCOL_ERROR;
567 ber = ber_init( &(ctrl->ldctl_value) );
569 *text = "internal error";
573 rc = get_vrFilter( conn, ber, &(op->vrFilter), &err_msg);
575 if( rc != LDAP_SUCCESS ) {
577 if( rc == SLAPD_DISCONNECT ) {
578 send_ldap_disconnect( conn, op,
579 LDAP_PROTOCOL_ERROR, *text );
581 send_ldap_result( conn, op, rc,
582 NULL, *text, NULL, NULL );
584 if( fstr.bv_val != NULL) free( fstr.bv_val );
585 if( op->vrFilter != NULL) vrFilter_free( op->vrFilter );
588 vrFilter2bv( op->vrFilter, &fstr );
592 LDAP_LOG( OPERATION, ARGS,
593 "parseValuesReturnFilter: conn %d vrFilter: %s\n",
594 conn->c_connid, fstr.bv_len ? fstr.bv_val : "empty" , 0 );
596 Debug( LDAP_DEBUG_ARGS, " vrFilter: %s\n",
597 fstr.bv_len ? fstr.bv_val : "empty", 0, 0 );
600 op->o_valuesreturnfilter = ctrl->ldctl_iscritical
601 ? SLAP_CRITICAL_CONTROL
602 : SLAP_NONCRITICAL_CONTROL;
608 #ifdef LDAP_CLIENT_UPDATE
609 static int parseClientUpdate (
620 struct berval scheme = { 0, NULL };
621 struct berval cookie = { 0, NULL };
623 if ( op->o_clientupdate != SLAP_NO_CONTROL ) {
624 *text = "LCUP client update control specified multiple times";
625 return LDAP_PROTOCOL_ERROR;
628 if ( ctrl->ldctl_value.bv_len == 0 ) {
629 *text = "LCUP client update control value is empty";
630 return LDAP_PROTOCOL_ERROR;
633 /* Parse the control value
634 * ClientUpdateControlValue ::= SEQUENCE {
635 * updateType ENUMERATED {
636 * synchronizeOnly {0},
637 * synchronizeAndPersist {1},
639 * sendCookieInterval INTEGER OPTIONAL,
640 * cookie LCUPCookie OPTIONAL
644 ber = ber_init( &ctrl->ldctl_value );
646 *text = "internal error";
650 if ( (tag = ber_scanf( ber, "{i" /*}*/, &type )) == LBER_ERROR ) {
651 *text = "LCUP client update control : decoding error";
652 return LDAP_PROTOCOL_ERROR;
656 case LDAP_CUP_SYNC_ONLY:
657 type = SLAP_LCUP_SYNC;
659 case LDAP_CUP_SYNC_AND_PERSIST:
660 type = SLAP_LCUP_SYNC_AND_PERSIST;
662 case LDAP_CUP_PERSIST_ONLY:
663 type = SLAP_LCUP_PERSIST;
666 *text = "LCUP client update control : unknown update type";
667 return LDAP_PROTOCOL_ERROR;
670 if ( (tag = ber_peek_tag( ber, &len )) == LBER_DEFAULT ) {
671 *text = "LCUP client update control : decoding error";
672 return LDAP_PROTOCOL_ERROR;
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;
681 if ( interval <= 0 ) {
682 /* server chooses interval */
683 interval = LDAP_CUP_DEFAULT_SEND_COOKIE_INTERVAL;
687 /* server chooses interval */
688 interval = LDAP_CUP_DEFAULT_SEND_COOKIE_INTERVAL;
691 if ( (tag = ber_peek_tag( ber, &len )) == LBER_DEFAULT ) {
692 *text = "LCUP client update control : decoding error";
693 return LDAP_PROTOCOL_ERROR;
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;
704 /* TODO : Cookie Scheme Validation */
706 if ( lcup_cookie_scheme_validate(scheme) != LDAP_SUCCESS ) {
707 *text = "Unsupported LCUP cookie scheme";
708 return LCUP_UNSUPPORTED_SCHEME;
711 if ( lcup_cookie_validate(scheme, cookie) != LDAP_SUCCESS ) {
712 *text = "Invalid LCUP cookie";
713 return LCUP_INVALID_COOKIE;
717 ber_dupbv( &op->o_clientupdate_state, &cookie );
719 (void) ber_free( ber, 1 );
721 op->o_clientupdate_type = (char) type;
722 op->o_clientupdate_interval = interval;
724 op->o_clientupdate = ctrl->ldctl_iscritical
725 ? SLAP_CRITICAL_CONTROL
726 : SLAP_NONCRITICAL_CONTROL;
730 #endif /* LDAP_CLIENT_UPDATE */