git.sur5r.net Git - openldap/blob - libraries/libldap/extended.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2017 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 #include "portable.h"
  17
  18 #include <stdio.h>
  19 #include <ac/stdlib.h>
  20
  21 #include <ac/socket.h>
  22 #include <ac/string.h>
  23 #include <ac/time.h>
  24
  25 #include "ldap-int.h"
  26 #include "ldap_log.h"
  27
  28 BerElement *
  29 ldap_build_extended_req(
  30         LDAP                    *ld,
  31         LDAP_CONST char *reqoid,
  32         struct berval   *reqdata,
  33         LDAPControl             **sctrls,
  34         LDAPControl             **cctrls,
  35         ber_int_t               *msgidp )
  36 {
  37         BerElement *ber;
  38         int rc;
  39
  40         /* create a message to send */
  41         if ( (ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
  42                 return( NULL );
  43         }
  44
  45         LDAP_NEXT_MSGID( ld, *msgidp );
  46         if ( reqdata != NULL ) {
  47                 rc = ber_printf( ber, "{it{tstON}", /* '}' */
  48                         *msgidp, LDAP_REQ_EXTENDED,
  49                         LDAP_TAG_EXOP_REQ_OID, reqoid,
  50                         LDAP_TAG_EXOP_REQ_VALUE, reqdata );
  51
  52         } else {
  53                 rc = ber_printf( ber, "{it{tsN}", /* '}' */
  54                         *msgidp, LDAP_REQ_EXTENDED,
  55                         LDAP_TAG_EXOP_REQ_OID, reqoid );
  56         }
  57
  58         if( rc == -1 ) {
  59                 ld->ld_errno = LDAP_ENCODING_ERROR;
  60                 ber_free( ber, 1 );
  61                 return( NULL );
  62         }
  63
  64         /* Put Server Controls */
  65         if( ldap_int_put_controls( ld, sctrls, ber ) != LDAP_SUCCESS ) {
  66                 ber_free( ber, 1 );
  67                 return( NULL );
  68         }
  69
  70         if ( ber_printf( ber, /*{*/ "N}" ) == -1 ) {
  71                 ld->ld_errno = LDAP_ENCODING_ERROR;
  72                 ber_free( ber, 1 );
  73                 return( NULL );
  74         }
  75
  76         return( ber );
  77 }
  78
  79 /*
  80  * LDAPv3 Extended Operation Request
  81  *      ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
  82  *              requestName      [0] LDAPOID,
  83  *              requestValue     [1] OCTET STRING OPTIONAL
  84  *      }
  85  *
  86  * LDAPv3 Extended Operation Response
  87  *      ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
  88  *              COMPONENTS OF LDAPResult,
  89  *              responseName     [10] LDAPOID OPTIONAL,
  90  *              response         [11] OCTET STRING OPTIONAL
  91  *      }
  92  *
  93  * (Source RFC 4511)
  94  */
  95
  96 int
  97 ldap_extended_operation(
  98         LDAP                    *ld,
  99         LDAP_CONST char *reqoid,
 100         struct berval   *reqdata,
 101         LDAPControl             **sctrls,
 102         LDAPControl             **cctrls,
 103         int                             *msgidp )
 104 {
 105         BerElement *ber;
 106         int rc;
 107         ber_int_t id;
 108
 109         Debug( LDAP_DEBUG_TRACE, "ldap_extended_operation\n", 0, 0, 0 );
 110
 111         assert( ld != NULL );
 112         assert( LDAP_VALID( ld ) );
 113         assert( reqoid != NULL && *reqoid != '\0' );
 114         assert( msgidp != NULL );
 115
 116         /* must be version 3 (or greater) */
 117         if ( ld->ld_version < LDAP_VERSION3 ) {
 118                 ld->ld_errno = LDAP_NOT_SUPPORTED;
 119                 return( ld->ld_errno );
 120         }
 121
 122         ber = ldap_build_extended_req( ld, reqoid, reqdata,
 123                 sctrls, cctrls, &id );
 124         if ( !ber )
 125                 return( ld->ld_errno );
 126
 127         /* send the message */
 128         *msgidp = ldap_send_initial_request( ld, LDAP_REQ_EXTENDED, NULL, ber, id );
 129
 130         return( *msgidp < 0 ? ld->ld_errno : LDAP_SUCCESS );
 131 }
 132
 133 int
 134 ldap_extended_operation_s(
 135         LDAP                    *ld,
 136         LDAP_CONST char *reqoid,
 137         struct berval   *reqdata,
 138         LDAPControl             **sctrls,
 139         LDAPControl             **cctrls,
 140         char                    **retoidp,
 141         struct berval   **retdatap )
 142 {
 143     int     rc;
 144     int     msgid;
 145     LDAPMessage *res;
 146
 147         Debug( LDAP_DEBUG_TRACE, "ldap_extended_operation_s\n", 0, 0, 0 );
 148
 149         assert( ld != NULL );
 150         assert( LDAP_VALID( ld ) );
 151         assert( reqoid != NULL && *reqoid != '\0' );
 152
 153     rc = ldap_extended_operation( ld, reqoid, reqdata,
 154                 sctrls, cctrls, &msgid );
 155
 156     if ( rc != LDAP_SUCCESS ) {
 157         return( rc );
 158         }
 159
 160     if ( ldap_result( ld, msgid, LDAP_MSG_ALL, (struct timeval *) NULL, &res ) == -1 || !res ) {
 161         return( ld->ld_errno );
 162         }
 163
 164         if ( retoidp != NULL ) *retoidp = NULL;
 165         if ( retdatap != NULL ) *retdatap = NULL;
 166
 167         rc = ldap_parse_extended_result( ld, res, retoidp, retdatap, 0 );
 168
 169         if( rc != LDAP_SUCCESS ) {
 170                 ldap_msgfree( res );
 171                 return rc;
 172         }
 173
 174     return( ldap_result2error( ld, res, 1 ) );
 175 }
 176
 177 /* Parse an extended result */
 178 int
 179 ldap_parse_extended_result (
 180         LDAP                    *ld,
 181         LDAPMessage             *res,
 182         char                    **retoidp,
 183         struct berval   **retdatap,
 184         int                             freeit )
 185 {
 186         BerElement *ber;
 187         ber_tag_t rc;
 188         ber_tag_t tag;
 189         ber_len_t len;
 190         struct berval *resdata;
 191         ber_int_t errcode;
 192         char *resoid;
 193
 194         assert( ld != NULL );
 195         assert( LDAP_VALID( ld ) );
 196         assert( res != NULL );
 197
 198         Debug( LDAP_DEBUG_TRACE, "ldap_parse_extended_result\n", 0, 0, 0 );
 199
 200         if( ld->ld_version < LDAP_VERSION3 ) {
 201                 ld->ld_errno = LDAP_NOT_SUPPORTED;
 202                 return ld->ld_errno;
 203         }
 204
 205         if( res->lm_msgtype != LDAP_RES_EXTENDED ) {
 206                 ld->ld_errno = LDAP_PARAM_ERROR;
 207                 return ld->ld_errno;
 208         }
 209
 210         if( retoidp != NULL ) *retoidp = NULL;
 211         if( retdatap != NULL ) *retdatap = NULL;
 212
 213         if ( ld->ld_error ) {
 214                 LDAP_FREE( ld->ld_error );
 215                 ld->ld_error = NULL;
 216         }
 217
 218         if ( ld->ld_matched ) {
 219                 LDAP_FREE( ld->ld_matched );
 220                 ld->ld_matched = NULL;
 221         }
 222
 223         ber = ber_dup( res->lm_ber );
 224
 225         if ( ber == NULL ) {
 226                 ld->ld_errno = LDAP_NO_MEMORY;
 227                 return ld->ld_errno;
 228         }
 229
 230         rc = ber_scanf( ber, "{eAA" /*}*/, &errcode,
 231                 &ld->ld_matched, &ld->ld_error );
 232
 233         if( rc == LBER_ERROR ) {
 234                 ld->ld_errno = LDAP_DECODING_ERROR;
 235                 ber_free( ber, 0 );
 236                 return ld->ld_errno;
 237         }
 238
 239         resoid = NULL;
 240         resdata = NULL;
 241
 242         tag = ber_peek_tag( ber, &len );
 243
 244         if( tag == LDAP_TAG_REFERRAL ) {
 245                 /* skip over referral */
 246                 if( ber_scanf( ber, "x" ) == LBER_ERROR ) {
 247                         ld->ld_errno = LDAP_DECODING_ERROR;
 248                         ber_free( ber, 0 );
 249                         return ld->ld_errno;
 250                 }
 251
 252                 tag = ber_peek_tag( ber, &len );
 253         }
 254
 255         if( tag == LDAP_TAG_EXOP_RES_OID ) {
 256                 /* we have a resoid */
 257                 if( ber_scanf( ber, "a", &resoid ) == LBER_ERROR ) {
 258                         ld->ld_errno = LDAP_DECODING_ERROR;
 259                         ber_free( ber, 0 );
 260                         return ld->ld_errno;
 261                 }
 262
 263                 assert( resoid[ 0 ] != '\0' );
 264
 265                 tag = ber_peek_tag( ber, &len );
 266         }
 267
 268         if( tag == LDAP_TAG_EXOP_RES_VALUE ) {
 269                 /* we have a resdata */
 270                 if( ber_scanf( ber, "O", &resdata ) == LBER_ERROR ) {
 271                         ld->ld_errno = LDAP_DECODING_ERROR;
 272                         ber_free( ber, 0 );
 273                         if( resoid != NULL ) LDAP_FREE( resoid );
 274                         return ld->ld_errno;
 275                 }
 276         }
 277
 278         ber_free( ber, 0 );
 279
 280         if( retoidp != NULL ) {
 281                 *retoidp = resoid;
 282         } else {
 283                 LDAP_FREE( resoid );
 284         }
 285
 286         if( retdatap != NULL ) {
 287                 *retdatap = resdata;
 288         } else {
 289                 ber_bvfree( resdata );
 290         }
 291
 292         ld->ld_errno = errcode;
 293
 294         if( freeit ) {
 295                 ldap_msgfree( res );
 296         }
 297
 298         return LDAP_SUCCESS;
 299 }
 300
 301
 302 /* Parse an extended partial */
 303 int
 304 ldap_parse_intermediate (
 305         LDAP                    *ld,
 306         LDAPMessage             *res,
 307         char                    **retoidp,
 308         struct berval   **retdatap,
 309         LDAPControl             ***serverctrls,
 310         int                             freeit )
 311 {
 312         BerElement *ber;
 313         ber_tag_t tag;
 314         ber_len_t len;
 315         struct berval *resdata;
 316         char *resoid;
 317
 318         assert( ld != NULL );
 319         assert( LDAP_VALID( ld ) );
 320         assert( res != NULL );
 321
 322         Debug( LDAP_DEBUG_TRACE, "ldap_parse_intermediate\n", 0, 0, 0 );
 323
 324         if( ld->ld_version < LDAP_VERSION3 ) {
 325                 ld->ld_errno = LDAP_NOT_SUPPORTED;
 326                 return ld->ld_errno;
 327         }
 328
 329         if( res->lm_msgtype != LDAP_RES_INTERMEDIATE ) {
 330                 ld->ld_errno = LDAP_PARAM_ERROR;
 331                 return ld->ld_errno;
 332         }
 333
 334         if( retoidp != NULL ) *retoidp = NULL;
 335         if( retdatap != NULL ) *retdatap = NULL;
 336         if( serverctrls != NULL ) *serverctrls = NULL;
 337
 338         ber = ber_dup( res->lm_ber );
 339
 340         if ( ber == NULL ) {
 341                 ld->ld_errno = LDAP_NO_MEMORY;
 342                 return ld->ld_errno;
 343         }
 344
 345         tag = ber_scanf( ber, "{" /*}*/ );
 346
 347         if( tag == LBER_ERROR ) {
 348                 ld->ld_errno = LDAP_DECODING_ERROR;
 349                 ber_free( ber, 0 );
 350                 return ld->ld_errno;
 351         }
 352
 353         resoid = NULL;
 354         resdata = NULL;
 355
 356         tag = ber_peek_tag( ber, &len );
 357
 358         /*
 359          * NOTE: accept intermediate and extended response tag values
 360          * as older versions of slapd(8) incorrectly used extended
 361          * response tags.
 362          * Should be removed when 2.2 is moved to Historic.
 363          */
 364         if( tag == LDAP_TAG_IM_RES_OID || tag == LDAP_TAG_EXOP_RES_OID ) {
 365                 /* we have a resoid */
 366                 if( ber_scanf( ber, "a", &resoid ) == LBER_ERROR ) {
 367                         ld->ld_errno = LDAP_DECODING_ERROR;
 368                         ber_free( ber, 0 );
 369                         return ld->ld_errno;
 370                 }
 371
 372                 assert( resoid[ 0 ] != '\0' );
 373
 374                 tag = ber_peek_tag( ber, &len );
 375         }
 376
 377         if( tag == LDAP_TAG_IM_RES_VALUE || tag == LDAP_TAG_EXOP_RES_VALUE ) {
 378                 /* we have a resdata */
 379                 if( ber_scanf( ber, "O", &resdata ) == LBER_ERROR ) {
 380                         ld->ld_errno = LDAP_DECODING_ERROR;
 381                         ber_free( ber, 0 );
 382                         if( resoid != NULL ) LDAP_FREE( resoid );
 383                         return ld->ld_errno;
 384                 }
 385         }
 386
 387         if ( serverctrls == NULL ) {
 388                 ld->ld_errno = LDAP_SUCCESS;
 389                 goto free_and_return;
 390         }
 391
 392         if ( ber_scanf( ber, /*{*/ "}" ) == LBER_ERROR ) {
 393                 ld->ld_errno = LDAP_DECODING_ERROR;
 394                 goto free_and_return;
 395         }
 396
 397         ld->ld_errno = ldap_pvt_get_controls( ber, serverctrls );
 398
 399 free_and_return:
 400         ber_free( ber, 0 );
 401
 402         if( retoidp != NULL ) {
 403                 *retoidp = resoid;
 404         } else {
 405                 LDAP_FREE( resoid );
 406         }
 407
 408         if( retdatap != NULL ) {
 409                 *retdatap = resdata;
 410         } else {
 411                 ber_bvfree( resdata );
 412         }
 413
 414         if( freeit ) {
 415                 ldap_msgfree( res );
 416         }
 417
 418         return ld->ld_errno;
 419 }
 420