home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ldapsdk.zip / libraries / libldap / request.c < prev    next >
C/C++ Source or Header  |  2001-07-22  |  27KB  |  1,080 lines
  1. /* $OpenLDAP: pkg/ldap/libraries/libldap/request.c,v 1.30.2.14 2001/07/21 19:01:40 kurt Exp $ */
  2. /*
  3.  * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
  4.  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  5.  */
  6. /*  Portions
  7.  *  Copyright (c) 1995 Regents of the University of Michigan.
  8.  *  All rights reserved.
  9.  */
  10. /*---
  11.  * This notice applies to changes, created by or for Novell, Inc.,
  12.  * to preexisting works for which notices appear elsewhere in this file.
  13.  *
  14.  * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
  15.  *
  16.  * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES.
  17.  * USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT TO VERSION
  18.  * 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS AVAILABLE AT
  19.  * HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE" IN THE
  20.  * TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION OF THIS
  21.  * WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP PUBLIC
  22.  * LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT THE
  23.  * PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY. 
  24.  *---
  25.  * Modification to OpenLDAP source by Novell, Inc.
  26.  * April 2000 sfs  Added code to chase V3 referrals
  27.  *  request.c - sending of ldap requests; handling of referrals
  28.  */
  29.  
  30. #include "portable.h"
  31.  
  32. #include <stdio.h>
  33.  
  34. #include <ac/stdlib.h>
  35.  
  36. #include <ac/errno.h>
  37. #include <ac/socket.h>
  38. #include <ac/string.h>
  39. #include <ac/time.h>
  40. #include <ac/unistd.h>
  41.  
  42. #include "ldap-int.h"
  43. #include "lber.h"
  44.  
  45. static LDAPConn *find_connection LDAP_P(( LDAP *ld, LDAPURLDesc *srv, int any ));
  46. static void use_connection LDAP_P(( LDAP *ld, LDAPConn *lc ));
  47.  
  48. static BerElement *
  49. re_encode_request( LDAP *ld,
  50.     BerElement *origber,
  51.     ber_int_t msgid,
  52.     int sref,
  53.     LDAPURLDesc *srv,
  54.     int *type );
  55.  
  56. BerElement *
  57. ldap_alloc_ber_with_options( LDAP *ld )
  58. {
  59.     BerElement    *ber;
  60.  
  61.     if (( ber = ber_alloc_t( ld->ld_lberoptions )) == NULL ) {
  62.         ld->ld_errno = LDAP_NO_MEMORY;
  63.     }
  64.  
  65.     return( ber );
  66. }
  67.  
  68.  
  69. void
  70. ldap_set_ber_options( LDAP *ld, BerElement *ber )
  71. {
  72.     ber->ber_options = ld->ld_lberoptions;
  73. }
  74.  
  75.  
  76. ber_int_t
  77. ldap_send_initial_request(
  78.     LDAP *ld,
  79.     ber_tag_t msgtype,
  80.     const char *dn,
  81.     BerElement *ber )
  82. {
  83.     LDAPURLDesc    *servers;
  84.     int rc;
  85.  
  86.     Debug( LDAP_DEBUG_TRACE, "ldap_send_initial_request\n", 0, 0, 0 );
  87.  
  88.     if ( ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, NULL ) == -1 ) {
  89.         /* not connected yet */
  90.         int rc = ldap_open_defconn( ld );
  91.  
  92.         if( rc < 0 ) {
  93.             ber_free( ber, 1 );
  94.             return( -1 );
  95.         }
  96.  
  97.         Debug( LDAP_DEBUG_TRACE,
  98.             "ldap_open_defconn: successful\n",
  99.             0, 0, 0 );
  100.     }
  101.  
  102.     {
  103.         /*
  104.          * use of DNS is turned off or this is an X.500 DN...
  105.          * use our default connection
  106.          */
  107.         servers = NULL;
  108.     }    
  109.  
  110.     rc = ldap_send_server_request( ld, ber, ld->ld_msgid, NULL,
  111.                                     servers, NULL, NULL );
  112.     if (servers)
  113.         ldap_free_urllist(servers);
  114.     return(rc);
  115. }
  116.  
  117.  
  118.  
  119. int
  120. ldap_send_server_request(
  121.     LDAP *ld,
  122.     BerElement *ber,
  123.     ber_int_t msgid,
  124.     LDAPRequest *parentreq,
  125.     LDAPURLDesc *srvlist,
  126.     LDAPConn *lc,
  127.     LDAPreqinfo *bind )
  128. {
  129.     LDAPRequest    *lr;
  130.     int incparent;
  131.  
  132.     Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
  133.  
  134.     incparent = 0;
  135.     ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
  136.  
  137.     if ( lc == NULL ) {
  138.         if ( srvlist == NULL ) {
  139.             lc = ld->ld_defconn;
  140.         } else {
  141.             if (( lc = find_connection( ld, srvlist, 1 )) ==
  142.                 NULL ) {
  143.                 if ( (bind != NULL) && (parentreq != NULL) ) {
  144.                     /* Remember the bind in the parent */
  145.                     incparent = 1;
  146.                     ++parentreq->lr_outrefcnt;
  147.                 }
  148.                 lc = ldap_new_connection( ld, srvlist, 0, 1, bind );
  149.             }
  150.         }
  151.     }
  152.  
  153.     if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
  154.         ber_free( ber, 1 );
  155.         if ( ld->ld_errno == LDAP_SUCCESS ) {
  156.             ld->ld_errno = LDAP_SERVER_DOWN;
  157.         }
  158.         if ( incparent ) {
  159.             /* Forget about the bind */
  160.             --parentreq->lr_outrefcnt; 
  161.         }
  162.         return( -1 );
  163.     }
  164.  
  165.     use_connection( ld, lc );
  166.     if (( lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ))) ==
  167.         NULL ) {
  168.         ld->ld_errno = LDAP_NO_MEMORY;
  169.         ldap_free_connection( ld, lc, 0, 0 );
  170.         ber_free( ber, 1 );
  171.         if ( incparent ) {
  172.             /* Forget about the bind */
  173.             --parentreq->lr_outrefcnt; 
  174.         }
  175.         return( -1 );
  176.     } 
  177.     lr->lr_msgid = msgid;
  178.     lr->lr_status = LDAP_REQST_INPROGRESS;
  179.     lr->lr_res_errno = LDAP_SUCCESS;    /* optimistic */
  180.     lr->lr_ber = ber;
  181.     lr->lr_conn = lc;
  182.     if ( parentreq != NULL ) {    /* sub-request */
  183.         if ( !incparent ) { 
  184.             /* Increment if we didn't do it before the bind */
  185.             ++parentreq->lr_outrefcnt;
  186.         }
  187.         lr->lr_origid = parentreq->lr_origid;
  188.         lr->lr_parentcnt = parentreq->lr_parentcnt + 1;
  189.         lr->lr_parent = parentreq;
  190.         lr->lr_refnext = parentreq->lr_refnext;
  191.         parentreq->lr_refnext = lr;
  192.     } else {            /* original request */
  193.         lr->lr_origid = lr->lr_msgid;
  194.     }
  195.  
  196.     if (( lr->lr_next = ld->ld_requests ) != NULL ) {
  197.         lr->lr_next->lr_prev = lr;
  198.     }
  199.     ld->ld_requests = lr;
  200.     lr->lr_prev = NULL;
  201.  
  202.     if ( ber_flush( lc->lconn_sb, ber, 0 ) != 0 ) {
  203. #ifdef notyet
  204.         if ( errno == EWOULDBLOCK ) {
  205.             /* need to continue write later */
  206.             lr->lr_status = LDAP_REQST_WRITING;
  207.             ldap_mark_select_write( ld, lc->lconn_sb );
  208.         } else {
  209. #else /* notyet */
  210.             ld->ld_errno = LDAP_SERVER_DOWN;
  211.             ldap_free_request( ld, lr );
  212.             ldap_free_connection( ld, lc, 0, 0 );
  213.             return( -1 );
  214. #endif /* notyet */
  215. #ifdef notyet
  216.         }
  217. #endif /* notyet */
  218.     } else {
  219.         if ( parentreq == NULL ) {
  220.             ber->ber_end = ber->ber_ptr;
  221.             ber->ber_ptr = ber->ber_buf;
  222.         }
  223.  
  224.         /* sent -- waiting for a response */
  225.         ldap_mark_select_read( ld, lc->lconn_sb );
  226.     }
  227.  
  228.     ld->ld_errno = LDAP_SUCCESS;
  229.     return( msgid );
  230. }
  231.  
  232. LDAPConn *
  233. ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb,
  234.     int connect, LDAPreqinfo *bind )
  235. {
  236.     LDAPConn    *lc;
  237.     LDAPURLDesc    *srv;
  238.     Sockbuf        *sb = NULL;
  239.  
  240.     Debug( LDAP_DEBUG_TRACE, "ldap_new_connection\n", 0, 0, 0 );
  241.     /*
  242.      * make a new LDAP server connection
  243.      * XXX open connection synchronously for now
  244.      */
  245.     if (( lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ))) == NULL ||
  246.         ( !use_ldsb && ( (sb = ber_sockbuf_alloc()) == NULL ))) {
  247.         if ( lc != NULL ) {
  248.             LDAP_FREE( (char *)lc );
  249.         }
  250.         ld->ld_errno = LDAP_NO_MEMORY;
  251.         return( NULL );
  252.     }
  253.  
  254.     lc->lconn_sb = ( use_ldsb ) ? ld->ld_sb : sb;
  255.  
  256.     if ( connect ) {
  257.         for ( srv = srvlist; srv != NULL; srv = srv->lud_next ) {
  258.             if ( ldap_int_open_connection( ld, lc, srv, 0 ) != -1 ) {
  259.                 break;
  260.             }
  261.         }
  262.  
  263.         if ( srv == NULL ) {
  264.             if ( !use_ldsb ) {
  265.                 ber_sockbuf_free( lc->lconn_sb );
  266.             }
  267.             LDAP_FREE( (char *)lc );
  268.             ld->ld_errno = LDAP_SERVER_DOWN;
  269.             return( NULL );
  270.         }
  271.  
  272.         lc->lconn_server = ldap_url_dup(srv);
  273.     }
  274.  
  275.     lc->lconn_status = LDAP_CONNST_CONNECTED;
  276.     lc->lconn_next = ld->ld_conns;
  277.     ld->ld_conns = lc;
  278.  
  279.     /*
  280.      * XXX for now, we always do a synchronous bind.  This will have
  281.      * to change in the long run...
  282.      */
  283.     if ( bind != NULL) {
  284.         int        err = 0;
  285.         LDAPConn    *savedefconn;
  286.  
  287.         /* Set flag to prevent additional referrals from being processed on this
  288.          * connection until the bind has completed
  289.          */
  290.         lc->lconn_rebind_inprogress = 1;
  291.         /* V3 rebind function */
  292.         if ( ld->ld_rebindproc != NULL) {
  293.             LDAPURLDesc    *srvfunc;
  294.             if( ( srvfunc = ldap_url_dup( srvlist)) == NULL) {
  295.                 ld->ld_errno = LDAP_NO_MEMORY;
  296.                 err = -1;
  297.             } else {
  298.                 savedefconn = ld->ld_defconn;
  299.                 ++lc->lconn_refcnt;    /* avoid premature free */
  300.                 ld->ld_defconn = lc;
  301.  
  302.                 Debug( LDAP_DEBUG_TRACE, "Call application rebindproc\n", 0, 0, 0);
  303.                 err = (*ld->ld_rebindproc)( ld, bind->ri_url, bind->ri_request, bind->ri_msgid);
  304.  
  305.                 ld->ld_defconn = savedefconn;
  306.                 --lc->lconn_refcnt;
  307.  
  308.                 if( err != 0) {
  309.                 err = -1;
  310.                     ldap_free_connection( ld, lc, 1, 0 );
  311.                     lc = NULL;
  312.             }
  313.                 ldap_free_urldesc( srvfunc);
  314.         }
  315.         } else {
  316.             savedefconn = ld->ld_defconn;
  317.             ++lc->lconn_refcnt;    /* avoid premature free */
  318.             ld->ld_defconn = lc;
  319.  
  320.             Debug( LDAP_DEBUG_TRACE, "anonymous rebind via ldap_bind_s\n", 0, 0, 0);
  321.             if ( ldap_bind_s( ld, "", "", LDAP_AUTH_SIMPLE ) != LDAP_SUCCESS ) {
  322.                 err = -1;
  323.             }
  324.             ld->ld_defconn = savedefconn;
  325.             --lc->lconn_refcnt;
  326.  
  327.         if ( err != 0 ) {
  328.             ldap_free_connection( ld, lc, 1, 0 );
  329.             lc = NULL;
  330.         }
  331.     }
  332.         if( lc != NULL)
  333.             lc->lconn_rebind_inprogress = 0;
  334.     }
  335.  
  336.     return( lc );
  337. }
  338.  
  339.  
  340. static LDAPConn *
  341. find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
  342. /*
  343.  * return an existing connection (if any) to the server srv
  344.  * if "any" is non-zero, check for any server in the "srv" chain
  345.  */
  346. {
  347.     LDAPConn    *lc;
  348.     LDAPURLDesc    *ls;
  349.  
  350.     for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
  351.         for ( ls = srv; ls != NULL; ls = ls->lud_next ) {
  352.             if ( lc->lconn_server->lud_host != NULL &&
  353.                 *lc->lconn_server->lud_host != '\0' &&
  354.                 ls->lud_host != NULL && *ls->lud_host != '\0' &&
  355.                 strcasecmp( ls->lud_host, lc->lconn_server->lud_host ) == 0
  356.                 && ls->lud_port == lc->lconn_server->lud_port ) {
  357.                 return lc;
  358.             }
  359.             if ( !any ) {
  360.                 break;
  361.             }
  362.         }
  363.     }
  364.  
  365.     return NULL;
  366. }
  367.  
  368.  
  369.  
  370. static void
  371. use_connection( LDAP *ld, LDAPConn *lc )
  372. {
  373.     ++lc->lconn_refcnt;
  374.     lc->lconn_lastused = time( NULL );
  375. }
  376.  
  377.  
  378. void
  379. ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
  380. {
  381.     LDAPConn    *tmplc, *prevlc;
  382.  
  383.     Debug( LDAP_DEBUG_TRACE, "ldap_free_connection\n", 0, 0, 0 );
  384.  
  385.     if ( force || --lc->lconn_refcnt <= 0 ) {
  386.         if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
  387.             ldap_mark_select_clear( ld, lc->lconn_sb );
  388.             if ( unbind ) {
  389.                 ldap_send_unbind( ld, lc->lconn_sb, NULL, NULL );
  390.             }
  391.         }
  392.  
  393.         if( lc->lconn_ber != NULL ) {
  394.             ber_free( lc->lconn_ber, 1 );
  395.         }
  396.  
  397.         ldap_int_sasl_close( ld, lc );
  398.  
  399.         prevlc = NULL;
  400.         for ( tmplc = ld->ld_conns; tmplc != NULL;
  401.             tmplc = tmplc->lconn_next ) {
  402.             if ( tmplc == lc ) {
  403.                 if ( prevlc == NULL ) {
  404.                     ld->ld_conns = tmplc->lconn_next;
  405.                 } else {
  406.                     prevlc->lconn_next = tmplc->lconn_next;
  407.                 }
  408.                 break;
  409.             }
  410.             prevlc = tmplc;
  411.         }
  412.         ldap_free_urllist( lc->lconn_server );
  413. #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
  414.         if ( lc->lconn_krbinstance != NULL ) {
  415.             LDAP_FREE( lc->lconn_krbinstance );
  416.         }
  417. #endif
  418.         if ( lc->lconn_sb != ld->ld_sb ) {
  419.             ber_sockbuf_free( lc->lconn_sb );
  420.         }
  421.         if( lc->lconn_rebind_queue != NULL) {
  422.             int i;
  423.             for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++) {
  424.                 LDAP_VFREE(lc->lconn_rebind_queue[i]);
  425.             }
  426.             LDAP_FREE( lc->lconn_rebind_queue);
  427.         }
  428.         LDAP_FREE( lc );
  429.         Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: actually freed\n",
  430.             0, 0, 0 );
  431.     } else {
  432.         lc->lconn_lastused = time( NULL );
  433.         Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
  434.             lc->lconn_refcnt, 0, 0 );
  435.     }
  436. }
  437.  
  438.  
  439. #ifdef LDAP_DEBUG
  440. void
  441. ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
  442. {
  443.     LDAPConn    *lc;
  444.        char        timebuf[32];
  445.  
  446.     fprintf( stderr, "** Connection%s:\n", all ? "s" : "" );
  447.     for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
  448.         if ( lc->lconn_server != NULL ) {
  449.             fprintf( stderr, "* host: %s  port: %d%s\n",
  450.                 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
  451.                 : lc->lconn_server->lud_host,
  452.                 lc->lconn_server->lud_port, ( lc->lconn_sb ==
  453.                 ld->ld_sb ) ? "  (default)" : "" );
  454.         }
  455.         fprintf( stderr, "  refcnt: %d  status: %s\n", lc->lconn_refcnt,
  456.             ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET ) ?
  457.             "NeedSocket" : ( lc->lconn_status ==
  458.             LDAP_CONNST_CONNECTING ) ? "Connecting" : "Connected" );
  459.         fprintf( stderr, "  last used: %s",
  460.             ldap_pvt_ctime( &lc->lconn_lastused, timebuf ));
  461.         if( lc->lconn_rebind_inprogress ) {
  462.             fprintf( stderr, "  rebind in progress\n");
  463.             if( lc->lconn_rebind_queue != NULL) {
  464.                 int i = 0;
  465.                 for( ;lc->lconn_rebind_queue[i] != NULL; i++) {
  466.                     int j = 0;
  467.                     for( ;lc->lconn_rebind_queue[i][j] != 0; j++) {
  468.                         fprintf( stderr, "    queue %d entry %d - %s\n",
  469.                             i, j, lc->lconn_rebind_queue[i][j]);
  470.                     }
  471.                 }
  472.             } else {
  473.                 fprintf( stderr, "    queue is empty\n");
  474.             }
  475.         }
  476.         fprintf(stderr, "\n");
  477.         if ( !all ) {
  478.             break;
  479.         }
  480.     }
  481. }
  482.  
  483.  
  484. void
  485. ldap_dump_requests_and_responses( LDAP *ld )
  486. {
  487.     LDAPRequest    *lr;
  488.     LDAPMessage    *lm, *l;
  489.  
  490.     fprintf( stderr, "** Outstanding Requests:\n" );
  491.     if (( lr = ld->ld_requests ) == NULL ) {
  492.         fprintf( stderr, "   Empty\n" );
  493.     }
  494.     for ( ; lr != NULL; lr = lr->lr_next ) {
  495.         fprintf( stderr, " * msgid %d,  origid %d, status %s\n",
  496.         lr->lr_msgid, lr->lr_origid,
  497.         ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
  498.         ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
  499.         ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
  500.         ( lr->lr_status == LDAP_REQST_WRITING) ? "Writing" :
  501.         ( lr->lr_status == LDAP_REQST_COMPLETED ? "Request Completed" : "Invalid Status"));
  502.         fprintf( stderr, "   outstanding referrals %d, parent count %d\n",
  503.             lr->lr_outrefcnt, lr->lr_parentcnt );
  504.     }
  505.  
  506.     fprintf( stderr, "** Response Queue:\n" );
  507.     if (( lm = ld->ld_responses ) == NULL ) {
  508.         fprintf( stderr, "   Empty\n" );
  509.     }
  510.     for ( ; lm != NULL; lm = lm->lm_next ) {
  511.         fprintf( stderr, " * msgid %d,  type %lu\n",
  512.             lm->lm_msgid, (unsigned long) lm->lm_msgtype );
  513.         if (( l = lm->lm_chain ) != NULL ) {
  514.             fprintf( stderr, "   chained responses:\n" );
  515.             for ( ; l != NULL; l = l->lm_chain ) {
  516.                 fprintf( stderr,
  517.                     "  * msgid %d,  type %lu\n",
  518.                     l->lm_msgid,
  519.                     (unsigned long) l->lm_msgtype );
  520.             }
  521.         }
  522.     }
  523. }
  524. #endif /* LDAP_DEBUG */
  525.  
  526.  
  527. void
  528. ldap_free_request( LDAP *ld, LDAPRequest *lr )
  529. {
  530.     LDAPRequest    *tmplr, *nextlr;
  531.  
  532.     Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
  533.         lr->lr_origid, lr->lr_msgid, 0 );
  534.  
  535.     if ( lr->lr_parent != NULL ) {
  536.         --lr->lr_parent->lr_outrefcnt;
  537.     } else {
  538.         /* free all referrals (child requests) */
  539.         for ( tmplr = lr->lr_refnext; tmplr != NULL; tmplr = nextlr ) {
  540.             nextlr = tmplr->lr_refnext;
  541.             ldap_free_request( ld, tmplr );
  542.         }
  543.     }
  544.  
  545.     if ( lr->lr_prev == NULL ) {
  546.         ld->ld_requests = lr->lr_next;
  547.     } else {
  548.         lr->lr_prev->lr_next = lr->lr_next;
  549.     }
  550.  
  551.     if ( lr->lr_next != NULL ) {
  552.         lr->lr_next->lr_prev = lr->lr_prev;
  553.     }
  554.  
  555.     if ( lr->lr_ber != NULL ) {
  556.         ber_free( lr->lr_ber, 1 );
  557.     }
  558.  
  559.     if ( lr->lr_res_error != NULL ) {
  560.         LDAP_FREE( lr->lr_res_error );
  561.     }
  562.  
  563.     if ( lr->lr_res_matched != NULL ) {
  564.         LDAP_FREE( lr->lr_res_matched );
  565.     }
  566.  
  567.     LDAP_FREE( lr );
  568. }
  569.  
  570. /*
  571.  * Chase v3 referrals
  572.  *
  573.  * Parameters:
  574.  *  (IN) ld = LDAP connection handle
  575.  *  (IN) lr = LDAP Request structure
  576.  *  (IN) refs = array of pointers to referral strings that we will chase
  577.  *              The array will be free'd by this function when no longer needed
  578.  *  (IN) sref != 0 if following search reference
  579.  *  (OUT) errstrp = Place to return a string of referrals which could not be followed
  580.  *  (OUT) hadrefp = 1 if sucessfully followed referral
  581.  *
  582.  * Return value - number of referrals followed
  583.  */
  584. int
  585. ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
  586. {
  587.     char        *unfollowed;
  588.     int             unfollowedcnt = 0;
  589.     LDAPRequest    *origreq;
  590.     LDAPURLDesc    *srv = NULL;
  591.     BerElement    *ber;
  592.     char        **refarray = NULL;
  593.     LDAPConn    *lc;
  594.     int             rc, count, i, j;
  595.     LDAPreqinfo  rinfo;
  596.  
  597.     ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
  598.     *hadrefp = 0;
  599.  
  600.     Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
  601.  
  602.     unfollowed = NULL;
  603.     rc = count = 0;
  604.  
  605.     /* If no referrals in array, return */
  606.     if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
  607.         rc = 0;
  608.         goto done;
  609.     }
  610.  
  611.     /* Check for hop limit exceeded */
  612.     if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
  613.         Debug( LDAP_DEBUG_ANY,
  614.             "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
  615.         ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
  616.         rc = -1;
  617.         goto done;
  618.     }
  619.  
  620.     /* find original request */
  621.     for ( origreq = lr; origreq->lr_parent != NULL; origreq = origreq->lr_parent ) {
  622.         ;
  623.     }
  624.  
  625.     refarray = refs;
  626.     refs = NULL;
  627.     /* parse out & follow referrals */
  628.     for( i=0; refarray[i] != NULL; i++) {
  629.         /* Parse the referral URL */
  630.         if (( rc = ldap_url_parse_ext( refarray[i], &srv)) != LDAP_SUCCESS) {
  631.             ld->ld_errno = rc;
  632.             rc = -1;
  633.             goto done;
  634.         }
  635.  
  636.         if( srv->lud_crit_exts ) {
  637.             /* we do not support any extensions */
  638.             ld->ld_errno = LDAP_NOT_SUPPORTED;
  639.             rc = -1;
  640.             goto done;
  641.         }
  642.  
  643.         /* treat ldap://hostpart and ldap://hostpart/ the same */
  644.         if ( srv->lud_dn && srv->lud_dn[0] == '\0' ) {
  645.             LDAP_FREE( srv->lud_dn );
  646.             srv->lud_dn = NULL;
  647.         }
  648.  
  649.         /* check connection for re-bind in progress */
  650.         if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
  651.             if( lc->lconn_rebind_inprogress) {
  652.                 /* We are already chasing a referral or search reference and a
  653.                  * bind on that connection is in progress.  We must queue
  654.                  * referrals on that connection, so we don't get a request
  655.                  * going out before the bind operation completes. This happens
  656.                  * if two search references come in one behind the other
  657.                  * for the same server with different contexts.
  658.                  */
  659.                 Debug( LDAP_DEBUG_TRACE,
  660.                     "ldap_chase_v3referrals: queue referral \"%s\"\n",
  661.                     refarray[i], 0, 0);
  662.                 if( lc->lconn_rebind_queue == NULL ) {
  663.                     /* Create a referral list */
  664.                     if( (lc->lconn_rebind_queue = (char ***)LDAP_MALLOC( sizeof(void *) * 2)) == NULL) {
  665.                         ld->ld_errno = LDAP_NO_MEMORY;
  666.                         rc = -1;
  667.                         goto done;
  668.                     }
  669.                     lc->lconn_rebind_queue[0] = refarray;
  670.                     lc->lconn_rebind_queue[1] = NULL;
  671.                     refarray = NULL;
  672.                 } else {
  673.                     /* Count how many referral arrays we already have */
  674.                     for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
  675.                         ;
  676.                     }
  677.                     /* Add the new referral to the list */
  678.                     if( (lc->lconn_rebind_queue = (char ***)LDAP_REALLOC(
  679.                             lc->lconn_rebind_queue, sizeof(void *) * (j + 2))) == NULL) {
  680.                         ld->ld_errno = LDAP_NO_MEMORY;
  681.                         rc = -1;
  682.                         goto done;
  683.                     }
  684.                     lc->lconn_rebind_queue[j] = refarray;
  685.                     lc->lconn_rebind_queue[j+1] = NULL;
  686.                     refarray = NULL;
  687.                 }
  688.                 /* We have queued the referral/reference, now just return */
  689.                 rc = 0;
  690.                 *hadrefp = 1;
  691.                 count = 1; /* Pretend we already followed referral */
  692.                 goto done;
  693.             }
  694.         } 
  695.         /* Re-encode the request with the new starting point of the search.
  696.          * Note: In the future we also need to replace the filter if one
  697.          * was provided with the search reference
  698.          */
  699.  
  700.         /* For references we don't want old dn if new dn empty */
  701.         if ( sref && srv->lud_dn == NULL ) {
  702.             srv->lud_dn = LDAP_STRDUP( "" );
  703.         }
  704.  
  705.         ber = re_encode_request( ld, origreq->lr_ber, ++ld->ld_msgid,
  706.             sref, srv, &rinfo.ri_request );
  707.  
  708.         if( ber == NULL ) {
  709.             ld->ld_errno = LDAP_ENCODING_ERROR;
  710.             rc = -1;
  711.             goto done;
  712.         }
  713.  
  714.         Debug( LDAP_DEBUG_TRACE,
  715.             "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
  716.             lr->lr_msgid, refarray[i], 0);
  717.  
  718.         /* Send the new request to the server - may require a bind */
  719.         rinfo.ri_msgid = origreq->lr_origid;
  720.         rinfo.ri_url = refarray[i];
  721.         if ( (rc = ldap_send_server_request( ld, ber, ld->ld_msgid,
  722.                 origreq, srv, NULL, &rinfo )) < 0 ) {
  723.             /* Failure, try next referral in the list */
  724.             Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%s)\n", 
  725.                 refarray[i], ldap_err2string( ld->ld_errno ), 0);
  726.             unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i]);
  727.             ldap_free_urllist(srv);
  728.             srv = NULL;
  729.         } else {
  730.             /* Success, no need to try this referral list further */
  731.             rc = 0;
  732.             ++count;
  733.             *hadrefp = 1;
  734.  
  735.             /* check if there is a queue of referrals that came in during bind */
  736.             if( lc == NULL) {
  737.                 if (( lc = find_connection( ld, srv, 1 )) == NULL ) {
  738.                     ld->ld_errno = LDAP_OPERATIONS_ERROR;
  739.                     rc = -1;
  740.                     goto done;
  741.                 }
  742.             }
  743.  
  744.             if( lc->lconn_rebind_queue != NULL) {
  745.                 /* Release resources of previous list */
  746.                 LDAP_VFREE(refarray);
  747.                 refarray = NULL;
  748.                 ldap_free_urllist(srv);
  749.                 srv = NULL;
  750.  
  751.                 /* Pull entries off end of queue so list always null terminated */
  752.                 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
  753.                     ;
  754.                 }
  755.                 refarray = lc->lconn_rebind_queue[j-1];
  756.                 lc->lconn_rebind_queue[j-1] = NULL;
  757.                 /* we pulled off last entry from queue, free queue */
  758.                 if ( j == 1 ) {
  759.                     LDAP_FREE( lc->lconn_rebind_queue);
  760.                     lc->lconn_rebind_queue = NULL;
  761.                 }
  762.                 /* restart the loop the with new referral list */
  763.                 i = -1;
  764.                 continue;
  765.             }
  766.             break; /* referral followed, break out of for loop */
  767.         }
  768.     } /* end for loop */
  769. done:
  770.     LDAP_VFREE(refarray);
  771.     ldap_free_urllist(srv);
  772.     LDAP_FREE( *errstrp );
  773.     
  774.     if( rc == 0) {
  775.         *errstrp = NULL;
  776.         LDAP_FREE( unfollowed );
  777.         return count;
  778.     } else {
  779.         ld->ld_errno = LDAP_REFERRAL;
  780.         *errstrp = unfollowed;
  781.         return rc;
  782.     }
  783. }
  784.  
  785. /*
  786.  * XXX merging of errors in this routine needs to be improved
  787.  */
  788. int
  789. ldap_chase_referrals( LDAP *ld,
  790.     LDAPRequest *lr,
  791.     char **errstrp,
  792.     int sref,
  793.     int *hadrefp )
  794. {
  795.     int        rc, count, len;
  796.     char        *p, *ref, *unfollowed;
  797.     LDAPRequest    *origreq;
  798.     LDAPURLDesc    *srv;
  799.     BerElement    *ber;
  800.     LDAPreqinfo  rinfo;
  801.  
  802.     Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
  803.  
  804.     ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
  805.     *hadrefp = 0;
  806.  
  807.     if ( *errstrp == NULL ) {
  808.         return( 0 );
  809.     }
  810.  
  811.     len = strlen( *errstrp );
  812.     for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
  813.         if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
  814.             *p = '\0';
  815.             p += LDAP_REF_STR_LEN;
  816.             break;
  817.         }
  818.     }
  819.  
  820.     if ( len < LDAP_REF_STR_LEN ) {
  821.         return( 0 );
  822.     }
  823.  
  824.     if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
  825.         Debug( LDAP_DEBUG_ANY,
  826.             "more than %d referral hops (dropping)\n",
  827.             ld->ld_refhoplimit, 0, 0 );
  828.             /* XXX report as error in ld->ld_errno? */
  829.             return( 0 );
  830.     }
  831.  
  832.     /* find original request */
  833.     for ( origreq = lr; origreq->lr_parent != NULL;
  834.          origreq = origreq->lr_parent ) {
  835.         /* empty */;
  836.     }
  837.  
  838.     unfollowed = NULL;
  839.     rc = count = 0;
  840.  
  841.     /* parse out & follow referrals */
  842.     for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
  843.         if (( p = strchr( ref, '\n' )) != NULL ) {
  844.             *p++ = '\0';
  845.         } else {
  846.             p = NULL;
  847.         }
  848.  
  849.         rc = ldap_url_parse_ext( ref, &srv );
  850.  
  851.         if ( rc != LDAP_URL_SUCCESS ) {
  852.             Debug( LDAP_DEBUG_TRACE,
  853.                 "ignoring unknown referral <%s>\n", ref, 0, 0 );
  854.             rc = ldap_append_referral( ld, &unfollowed, ref );
  855.             *hadrefp = 1;
  856.             continue;
  857.         }
  858.  
  859.         if( srv->lud_dn != NULL && srv->lud_dn == '\0' ) {
  860.             LDAP_FREE( srv->lud_dn );
  861.             srv->lud_dn = NULL;
  862.         }
  863.  
  864.         Debug( LDAP_DEBUG_TRACE,
  865.             "chasing LDAP referral: <%s>\n", ref, 0, 0 );
  866.  
  867.         *hadrefp = 1;
  868.  
  869.         ber = re_encode_request( ld, origreq->lr_ber,
  870.             ++ld->ld_msgid, sref, srv, &rinfo.ri_request );
  871.  
  872.         if( ber == NULL ) {
  873.             return -1 ;
  874.         }
  875.  
  876.         /* copy the complete referral for rebind process */
  877.         rinfo.ri_url = LDAP_STRDUP( ref );
  878.  
  879.         rinfo.ri_msgid = origreq->lr_origid;
  880.  
  881.         rc = ldap_send_server_request( ld, ber, ld->ld_msgid,
  882.             lr, srv, NULL, &rinfo );
  883.  
  884.         LDAP_FREE( rinfo.ri_url );
  885.  
  886.         if( rc >= 0 ) {
  887.             ++count;
  888.         } else {
  889.             Debug( LDAP_DEBUG_ANY,
  890.                 "Unable to chase referral (%s)\n", 
  891.                 ldap_err2string( ld->ld_errno ), 0, 0 );
  892.             rc = ldap_append_referral( ld, &unfollowed, ref );
  893.         }
  894.  
  895.         ldap_free_urllist(srv);
  896.     }
  897.  
  898.     LDAP_FREE( *errstrp );
  899.     *errstrp = unfollowed;
  900.  
  901.     return(( rc == 0 ) ? count : rc );
  902. }
  903.  
  904.  
  905. int
  906. ldap_append_referral( LDAP *ld, char **referralsp, char *s )
  907. {
  908.     int    first;
  909.  
  910.     if ( *referralsp == NULL ) {
  911.         first = 1;
  912.         *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
  913.             + 1 );
  914.     } else {
  915.         first = 0;
  916.         *referralsp = (char *)LDAP_REALLOC( *referralsp,
  917.             strlen( *referralsp ) + strlen( s ) + 2 );
  918.     }
  919.  
  920.     if ( *referralsp == NULL ) {
  921.         ld->ld_errno = LDAP_NO_MEMORY;
  922.         return( -1 );
  923.     }
  924.  
  925.     if ( first ) {
  926.         strcpy( *referralsp, LDAP_REF_STR );
  927.     } else {
  928.         strcat( *referralsp, "\n" );
  929.     }
  930.     strcat( *referralsp, s );
  931.  
  932.     return( 0 );
  933. }
  934.  
  935.  
  936.  
  937. static BerElement *
  938. re_encode_request( LDAP *ld,
  939.     BerElement *origber,
  940.     ber_int_t msgid,
  941.     int sref,
  942.     LDAPURLDesc *srv,
  943.     int *type )
  944. {
  945.     /*
  946.      * XXX this routine knows way too much about how the lber library works!
  947.      */
  948.     ber_int_t    along;
  949.     ber_tag_t    tag;
  950.     ber_int_t    ver;
  951.     ber_int_t    scope;
  952.     int        rc;
  953.     BerElement    tmpber, *ber;
  954.     char        *orig_dn;
  955.     char        *dn;
  956.  
  957.     Debug( LDAP_DEBUG_TRACE,
  958.         "re_encode_request: new msgid %ld, new dn <%s>\n",
  959.         (long) msgid,
  960.         ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
  961.  
  962.     tmpber = *origber;
  963.  
  964.     /*
  965.      * all LDAP requests are sequences that start with a message id.
  966.      * For all except delete, this is followed by a sequence that is
  967.      * tagged with the operation code.  For delete, the provided DN
  968.      * is not wrapped by a sequence.
  969.      */
  970.     rc = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
  971.  
  972.     if ( rc == LBER_ERROR ) {
  973.         ld->ld_errno = LDAP_DECODING_ERROR;
  974.         return( NULL );
  975.     }
  976.  
  977.     assert( tag != 0);
  978.     if ( tag == LDAP_REQ_BIND ) {
  979.         /* bind requests have a version number before the DN & other stuff */
  980.         rc = ber_scanf( &tmpber, "{ia" /*}*/, &ver, &orig_dn );
  981.  
  982.     } else if ( tag == LDAP_REQ_DELETE ) {
  983.         /* delete requests don't have a DN wrapping sequence */
  984.         rc = ber_scanf( &tmpber, "a", &orig_dn );
  985.  
  986.     } else if ( tag == LDAP_REQ_SEARCH ) {
  987.         /* search requests need to be re-scope-ed */
  988.         rc = ber_scanf( &tmpber, "{ae" /*"}"*/, &orig_dn, &scope );
  989.  
  990.         if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
  991.             /* use the scope provided in reference */
  992.             scope = srv->lud_scope;
  993.  
  994.         } else if ( sref && scope != LDAP_SCOPE_SUBTREE ) {
  995.             /* use scope implied by previous operation */
  996.             /*   base -> base */
  997.             /*   one -> base */
  998.             /*   subtree -> subtree */
  999.             scope = LDAP_SCOPE_BASE;
  1000.         }
  1001.  
  1002.     } else {
  1003.         rc = ber_scanf( &tmpber, "{a" /*}*/, &orig_dn );
  1004.     }
  1005.  
  1006.     if( rc == LBER_ERROR ) {
  1007.         ld->ld_errno = LDAP_DECODING_ERROR;
  1008.         return NULL;
  1009.     }
  1010.  
  1011.     if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
  1012.         return NULL;
  1013.     }
  1014.  
  1015.     if ( srv->lud_dn == NULL ) {
  1016.         dn = orig_dn;
  1017.     } else {
  1018.         dn = srv->lud_dn;
  1019.     }
  1020.  
  1021.     if ( tag == LDAP_REQ_BIND ) {
  1022.         rc = ber_printf( ber, "{it{is" /*}}*/, msgid, tag, ver, dn );
  1023.     } else if ( tag == LDAP_REQ_DELETE ) {
  1024.         rc = ber_printf( ber, "{itsN}", msgid, tag, dn );
  1025.     } else if ( tag == LDAP_REQ_SEARCH ) {
  1026.         rc = ber_printf( ber, "{it{se" /*}}*/, msgid, tag, dn, scope );
  1027.     } else {
  1028.         rc = ber_printf( ber, "{it{s" /*}}*/, msgid, tag, dn );
  1029.     }
  1030.  
  1031.     LDAP_FREE( orig_dn );
  1032.  
  1033.     if ( rc == -1 ) {
  1034.         ld->ld_errno = LDAP_ENCODING_ERROR;
  1035.         ber_free( ber, 1 );
  1036.         return NULL;
  1037.     }
  1038.  
  1039.     if ( tag != LDAP_REQ_DELETE && (
  1040.         ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
  1041.         != ( tmpber.ber_end - tmpber.ber_ptr ) ||
  1042.         ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
  1043.     {
  1044.         ld->ld_errno = LDAP_ENCODING_ERROR;
  1045.         ber_free( ber, 1 );
  1046.         return NULL;
  1047.     }
  1048.  
  1049. #ifdef LDAP_DEBUG
  1050.     if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
  1051.         Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
  1052.             0, 0, 0 );
  1053.         ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
  1054.     }
  1055. #endif /* LDAP_DEBUG */
  1056.  
  1057.     *type = tag;    /* return request type */
  1058.     return ber;
  1059. }
  1060.  
  1061.  
  1062. LDAPRequest *
  1063. ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
  1064. {
  1065.     LDAPRequest    *lr;
  1066.  
  1067.     for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
  1068.         if( lr->lr_status == LDAP_REQST_COMPLETED ) {
  1069.             continue;    /* Skip completed requests */
  1070.         }
  1071.         if ( msgid == lr->lr_msgid ) {
  1072.             break;
  1073.         }
  1074.     }
  1075.  
  1076.     return( lr );
  1077. }
  1078.  
  1079.  
  1080.