1 /*
2 * Copyright (c) 1999, 2020, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.jndi.ldap;
27
28 import java.io.BufferedInputStream;
29 import java.io.BufferedOutputStream;
30 import java.io.InterruptedIOException;
31 import java.io.IOException;
32 import java.io.OutputStream;
33 import java.io.InputStream;
34 import java.net.InetSocketAddress;
35 import java.net.Socket;
36 import javax.net.ssl.SSLSocket;
37
38 import javax.naming.CommunicationException;
39 import javax.naming.ServiceUnavailableException;
40 import javax.naming.NamingException;
41 import javax.naming.InterruptedNamingException;
42
43 import javax.naming.ldap.Control;
44
45 import java.lang.reflect.Method;
46 import java.lang.reflect.InvocationTargetException;
47 import java.security.AccessController;
48 import java.security.PrivilegedAction;
49 import java.util.Arrays;
50 import javax.net.SocketFactory;
51 import javax.net.ssl.SSLParameters;
52
53 /**
54 * A thread that creates a connection to an LDAP server.
55 * After the connection, the thread reads from the connection.
56 * A caller can invoke methods on the instance to read LDAP responses
57 * and to send LDAP requests.
58 * <p>
59 * There is a one-to-one correspondence between an LdapClient and
60 * a Connection. Access to Connection and its methods is only via
61 * LdapClient with two exceptions: SASL authentication and StartTLS.
62 * SASL needs to access Connection's socket IO streams (in order to do encryption
63 * of the security layer). StartTLS needs to do replace IO streams
64 * and close the IO streams on nonfatal close. The code for SASL
65 * authentication can be treated as being the same as from LdapClient
66 * because the SASL code is only ever called from LdapClient, from
67 * inside LdapClient's synchronized authenticate() method. StartTLS is called
68 * directly by the application but should only occur when the underlying
69 * connection is quiet.
70 * <p>
71 * In terms of synchronization, worry about data structures
72 * used by the Connection thread because that usage might contend
73 * with calls by the main threads (i.e., those that call LdapClient).
74 * Main threads need to worry about contention with each other.
75 * Fields that Connection thread uses:
76 * inStream - synced access and update; initialized in constructor;
77 * referenced outside class unsync'ed (by LdapSasl) only
78 * when connection is quiet
79 * traceFile, traceTagIn, traceTagOut - no sync; debugging only
80 * parent - no sync; initialized in constructor; no updates
81 * pendingRequests - sync
82 * pauseLock - per-instance lock;
83 * paused - sync via pauseLock (pauseReader())
84 * Members used by main threads (LdapClient):
85 * host, port - unsync; read-only access for StartTLS and debug messages
86 * setBound(), setV3() - no sync; called only by LdapClient.authenticate(),
87 * which is a sync method called only when connection is "quiet"
88 * getMsgId() - sync
89 * writeRequest(), removeRequest(),findRequest(), abandonOutstandingReqs() -
90 * access to shared pendingRequests is sync
91 * writeRequest(), abandonRequest(), ldapUnbind() - access to outStream sync
92 * cleanup() - sync
93 * readReply() - access to sock sync
94 * unpauseReader() - (indirectly via writeRequest) sync on pauseLock
95 * Members used by SASL auth (main thread):
96 * inStream, outStream - no sync; used to construct new stream; accessed
97 * only when conn is "quiet" and not shared
98 * replaceStreams() - sync method
99 * Members used by StartTLS:
100 * inStream, outStream - no sync; used to record the existing streams;
101 * accessed only when conn is "quiet" and not shared
102 * replaceStreams() - sync method
103 * <p>
104 * Handles anonymous, simple, and SASL bind for v3; anonymous and simple
105 * for v2.
106 * %%% made public for access by LdapSasl %%%
107 *
108 * @author Vincent Ryan
109 * @author Rosanna Lee
110 * @author Jagane Sundar
111 */
112 public final class Connection implements Runnable {
113
114 private static final boolean debug = false;
115 private static final int dump = 0; // > 0 r, > 1 rw
116
117
118 final private Thread worker; // Initialized in constructor
119
120 private boolean v3 = true; // Set in setV3()
121
122 final public String host; // used by LdapClient for generating exception messages
123 // used by StartTlsResponse when creating an SSL socket
124 final public int port; // used by LdapClient for generating exception messages
125 // used by StartTlsResponse when creating an SSL socket
126
127 private boolean bound = false; // Set in setBound()
128
129 // All three are initialized in constructor and read-only afterwards
130 private OutputStream traceFile = null;
131 private String traceTagIn = null;
132 private String traceTagOut = null;
133
134 // Initialized in constructor; read and used externally (LdapSasl);
135 // Updated in replaceStreams() during "quiet", unshared, period
136 public InputStream inStream; // must be public; used by LdapSasl
137
138 // Initialized in constructor; read and used externally (LdapSasl);
139 // Updated in replaceOutputStream() during "quiet", unshared, period
140 public OutputStream outStream; // must be public; used by LdapSasl
141
142 // Initialized in constructor; read and used externally (TLS) to
143 // get new IO streams; closed during cleanup
144 public Socket sock; // for TLS
145
146 // For processing "disconnect" unsolicited notification
147 // Initialized in constructor
148 final private LdapClient parent;
149
150 // Incremented and returned in sync getMsgId()
151 private int outMsgId = 0;
152
153 //
154 // The list of ldapRequests pending on this binding
155 //
156 // Accessed only within sync methods
157 private LdapRequest pendingRequests = null;
158
159 volatile IOException closureReason = null;
160 volatile boolean useable = true; // is Connection still useable
161
162 int readTimeout;
163 int connectTimeout;
164 private static final boolean IS_HOSTNAME_VERIFICATION_DISABLED
165 = hostnameVerificationDisabledValue();
166
167 private static boolean hostnameVerificationDisabledValue() {
168 PrivilegedAction<String> act = () -> System.getProperty(
169 "com.sun.jndi.ldap.object.disableEndpointIdentification");
170 String prop = AccessController.doPrivileged(act);
171 if (prop == null) {
172 return false;
173 }
174 return prop.isEmpty() ? true : Boolean.parseBoolean(prop);
175 }
176 // true means v3; false means v2
177 // Called in LdapClient.authenticate() (which is synchronized)
178 // when connection is "quiet" and not shared; no need to synchronize
179 void setV3(boolean v) {
180 v3 = v;
181 }
182
183 // A BIND request has been successfully made on this connection
184 // When cleaning up, remember to do an UNBIND
185 // Called in LdapClient.authenticate() (which is synchronized)
186 // when connection is "quiet" and not shared; no need to synchronize
187 void setBound() {
188 bound = true;
189 }
190
191 ////////////////////////////////////////////////////////////////////////////
192 //
193 // Create an LDAP Binding object and bind to a particular server
194 //
195 ////////////////////////////////////////////////////////////////////////////
196
197 Connection(LdapClient parent, String host, int port, String socketFactory,
198 int connectTimeout, int readTimeout, OutputStream trace) throws NamingException {
199
200 this.host = host;
201 this.port = port;
202 this.parent = parent;
203 this.readTimeout = readTimeout;
204 this.connectTimeout = connectTimeout;
205
206 if (trace != null) {
207 traceFile = trace;
208 traceTagIn = "<- " + host + ":" + port + "\n\n";
209 traceTagOut = "-> " + host + ":" + port + "\n\n";
210 }
211
212 //
213 // Connect to server
214 //
215 try {
216 sock = createSocket(host, port, socketFactory, connectTimeout);
217
218 if (debug) {
219 System.err.println("Connection: opening socket: " + host + "," + port);
220 }
221
222 inStream = new BufferedInputStream(sock.getInputStream());
223 outStream = new BufferedOutputStream(sock.getOutputStream());
224
225 } catch (InvocationTargetException e) {
226 Throwable realException = e.getTargetException();
227 // realException.printStackTrace();
228
229 CommunicationException ce =
230 new CommunicationException(host + ":" + port);
231 ce.setRootCause(realException);
232 throw ce;
233 } catch (Exception e) {
234 // We need to have a catch all here and
235 // ignore generic exceptions.
236 // Also catches all IO errors generated by socket creation.
237 CommunicationException ce =
238 new CommunicationException(host + ":" + port);
239 ce.setRootCause(e);
240 throw ce;
241 }
242
243 worker = Obj.helper.createThread(this);
244 worker.setDaemon(true);
245 worker.start();
246 }
247
248 /*
249 * Create an InetSocketAddress using the specified hostname and port number.
250 */
251 private InetSocketAddress createInetSocketAddress(String host, int port) {
252 return new InetSocketAddress(host, port);
253 }
254
255 /*
256 * Create a Socket object using the specified socket factory and time limit.
257 *
258 * If a timeout is supplied and unconnected sockets are supported then
259 * an unconnected socket is created and the timeout is applied when
260 * connecting the socket. If a timeout is supplied but unconnected sockets
261 * are not supported then the timeout is ignored and a connected socket
262 * is created.
263 */
264 private Socket createSocket(String host, int port, String socketFactory,
265 int connectTimeout) throws Exception {
266
267 Socket socket = null;
268
269 if (socketFactory != null) {
270
271 // create the factory
272
273 @SuppressWarnings("unchecked")
274 Class<? extends SocketFactory> socketFactoryClass =
275 (Class<? extends SocketFactory>)Obj.helper.loadClass(socketFactory);
276 Method getDefault =
277 socketFactoryClass.getMethod("getDefault", new Class<?>[]{});
278 SocketFactory factory = (SocketFactory) getDefault.invoke(null, new Object[]{});
279
280 // create the socket
281
282 if (connectTimeout > 0) {
283
284 InetSocketAddress endpoint =
285 createInetSocketAddress(host, port);
286
287 // unconnected socket
288 socket = factory.createSocket();
289
290 if (debug) {
291 System.err.println("Connection: creating socket with " +
292 "a timeout using supplied socket factory");
293 }
294
295 // connected socket
296 socket.connect(endpoint, connectTimeout);
297 }
298
299 // continue (but ignore connectTimeout)
300 if (socket == null) {
301 if (debug) {
302 System.err.println("Connection: creating socket using " +
303 "supplied socket factory");
304 }
305 // connected socket
306 socket = factory.createSocket(host, port);
307 }
308 } else {
309
310 if (connectTimeout > 0) {
311
312 InetSocketAddress endpoint = createInetSocketAddress(host, port);
313
314 socket = new Socket();
315
316 if (debug) {
317 System.err.println("Connection: creating socket with " +
318 "a timeout");
319 }
320 socket.connect(endpoint, connectTimeout);
321 }
322
323 // continue (but ignore connectTimeout)
324
325 if (socket == null) {
326 if (debug) {
327 System.err.println("Connection: creating socket");
328 }
329 // connected socket
330 socket = new Socket(host, port);
331 }
332 }
333
334 // For LDAP connect timeouts on LDAP over SSL connections must treat
335 // the SSL handshake following socket connection as part of the timeout.
336 // So explicitly set a socket read timeout, trigger the SSL handshake,
337 // then reset the timeout.
338 if (socket instanceof SSLSocket) {
339 SSLSocket sslSocket = (SSLSocket) socket;
340 if (!IS_HOSTNAME_VERIFICATION_DISABLED) {
341 SSLParameters param = sslSocket.getSSLParameters();
342 param.setEndpointIdentificationAlgorithm("LDAPS");
343 sslSocket.setSSLParameters(param);
344 }
345 if (connectTimeout > 0) {
346 int socketTimeout = sslSocket.getSoTimeout();
347 sslSocket.setSoTimeout(connectTimeout); // reuse full timeout value
348 sslSocket.startHandshake();
349 sslSocket.setSoTimeout(socketTimeout);
350 }
351 }
352 return socket;
353 }
354
355 ////////////////////////////////////////////////////////////////////////////
356 //
357 // Methods to IO to the LDAP server
358 //
359 ////////////////////////////////////////////////////////////////////////////
360
361 synchronized int getMsgId() {
362 return ++outMsgId;
363 }
364
365 LdapRequest writeRequest(BerEncoder ber, int msgId) throws IOException {
366 return writeRequest(ber, msgId, false /* pauseAfterReceipt */, -1);
367 }
368
369 LdapRequest writeRequest(BerEncoder ber, int msgId,
370 boolean pauseAfterReceipt) throws IOException {
371 return writeRequest(ber, msgId, pauseAfterReceipt, -1);
372 }
373
374 LdapRequest writeRequest(BerEncoder ber, int msgId,
375 boolean pauseAfterReceipt, int replyQueueCapacity) throws IOException {
376
377 LdapRequest req =
378 new LdapRequest(msgId, pauseAfterReceipt, replyQueueCapacity);
379 addRequest(req);
380
381 if (traceFile != null) {
382 Ber.dumpBER(traceFile, traceTagOut, ber.getBuf(), 0, ber.getDataLen());
383 }
384
385
386 // unpause reader so that it can get response
387 // NOTE: Must do this before writing request, otherwise might
388 // create a race condition where the writer unblocks its own response
389 unpauseReader();
390
391 if (debug) {
392 System.err.println("Writing request to: " + outStream);
393 }
394
395 try {
396 synchronized (this) {
397 outStream.write(ber.getBuf(), 0, ber.getDataLen());
398 outStream.flush();
399 }
400 } catch (IOException e) {
401 cleanup(null, true);
402 throw (closureReason = e); // rethrow
403 }
404
405 return req;
406 }
407
408 /**
409 * Reads a reply; waits until one is ready.
410 */
411 BerDecoder readReply(LdapRequest ldr) throws IOException, NamingException {
412 BerDecoder rber;
413
414 // If socket closed, don't even try
415 synchronized (this) {
416 if (sock == null) {
417 throw new ServiceUnavailableException(host + ":" + port +
418 "; socket closed");
419 }
420 }
421
422 NamingException namingException = null;
423 try {
424 // if no timeout is set so we wait infinitely until
425 // a response is received OR until the connection is closed or cancelled
426 // http://docs.oracle.com/javase/8/docs/technotes/guides/jndi/jndi-ldap.html#PROP
427 rber = ldr.getReplyBer(readTimeout);
428 } catch (InterruptedException ex) {
429 throw new InterruptedNamingException(
430 "Interrupted during LDAP operation");
431 } catch (CommunicationException ce) {
432 // Re-throw
433 throw ce;
434 } catch (NamingException ne) {
435 // Connection is timed out OR closed/cancelled
436 namingException = ne;
437 rber = null;
438 }
439
440 if (rber == null) {
441 abandonRequest(ldr, null);
442 }
443 // namingException can be not null in the following cases:
444 // a) The response is timed-out
445 // b) LDAP request connection has been closed or cancelled
446 // The exception message is initialized in LdapRequest::getReplyBer
447 if (namingException != null) {
448 // Re-throw NamingException after all cleanups are done
449 throw namingException;
450 }
451 return rber;
452 }
453
454 ////////////////////////////////////////////////////////////////////////////
455 //
456 // Methods to add, find, delete, and abandon requests made to server
457 //
458 ////////////////////////////////////////////////////////////////////////////
459
460 private synchronized void addRequest(LdapRequest ldapRequest) {
461
462 LdapRequest ldr = pendingRequests;
463 if (ldr == null) {
464 pendingRequests = ldapRequest;
465 ldapRequest.next = null;
466 } else {
467 ldapRequest.next = pendingRequests;
468 pendingRequests = ldapRequest;
469 }
470 }
471
472 synchronized LdapRequest findRequest(int msgId) {
473
474 LdapRequest ldr = pendingRequests;
475 while (ldr != null) {
476 if (ldr.msgId == msgId) {
477 return ldr;
478 }
479 ldr = ldr.next;
480 }
481 return null;
482
483 }
484
485 synchronized void removeRequest(LdapRequest req) {
486 LdapRequest ldr = pendingRequests;
487 LdapRequest ldrprev = null;
488
489 while (ldr != null) {
490 if (ldr == req) {
491 ldr.cancel();
492
493 if (ldrprev != null) {
494 ldrprev.next = ldr.next;
495 } else {
496 pendingRequests = ldr.next;
497 }
498 ldr.next = null;
499 }
500 ldrprev = ldr;
501 ldr = ldr.next;
502 }
503 }
504
505 void abandonRequest(LdapRequest ldr, Control[] reqCtls) {
506 // Remove from queue
507 removeRequest(ldr);
508
509 BerEncoder ber = new BerEncoder(256);
510 int abandonMsgId = getMsgId();
511
512 //
513 // build the abandon request.
514 //
515 try {
516 ber.beginSeq(Ber.ASN_SEQUENCE | Ber.ASN_CONSTRUCTOR);
517 ber.encodeInt(abandonMsgId);
518 ber.encodeInt(ldr.msgId, LdapClient.LDAP_REQ_ABANDON);
519
520 if (v3) {
521 LdapClient.encodeControls(ber, reqCtls);
522 }
523 ber.endSeq();
524
525 if (traceFile != null) {
526 Ber.dumpBER(traceFile, traceTagOut, ber.getBuf(), 0,
527 ber.getDataLen());
528 }
529
530 synchronized (this) {
531 outStream.write(ber.getBuf(), 0, ber.getDataLen());
532 outStream.flush();
533 }
534
535 } catch (IOException ex) {
536 //System.err.println("ldap.abandon: " + ex);
537 }
538
539 // Don't expect any response for the abandon request.
540 }
541
542 synchronized void abandonOutstandingReqs(Control[] reqCtls) {
543 LdapRequest ldr = pendingRequests;
544
545 while (ldr != null) {
546 abandonRequest(ldr, reqCtls);
547 pendingRequests = ldr = ldr.next;
548 }
549 }
550
551 ////////////////////////////////////////////////////////////////////////////
552 //
553 // Methods to unbind from server and clear up resources when object is
554 // destroyed.
555 //
556 ////////////////////////////////////////////////////////////////////////////
557
558 private void ldapUnbind(Control[] reqCtls) {
559
560 BerEncoder ber = new BerEncoder(256);
561 int unbindMsgId = getMsgId();
562
563 //
564 // build the unbind request.
565 //
566
567 try {
568
569 ber.beginSeq(Ber.ASN_SEQUENCE | Ber.ASN_CONSTRUCTOR);
570 ber.encodeInt(unbindMsgId);
571 // IMPLICIT TAGS
572 ber.encodeByte(LdapClient.LDAP_REQ_UNBIND);
573 ber.encodeByte(0);
574
575 if (v3) {
576 LdapClient.encodeControls(ber, reqCtls);
577 }
578 ber.endSeq();
579
580 if (traceFile != null) {
581 Ber.dumpBER(traceFile, traceTagOut, ber.getBuf(),
582 0, ber.getDataLen());
583 }
584
585 synchronized (this) {
586 outStream.write(ber.getBuf(), 0, ber.getDataLen());
587 outStream.flush();
588 }
589
590 } catch (IOException ex) {
591 //System.err.println("ldap.unbind: " + ex);
592 }
593
594 // Don't expect any response for the unbind request.
595 }
596
597 /**
598 * @param reqCtls Possibly null request controls that accompanies the
599 * abandon and unbind LDAP request.
600 * @param notifyParent true means to call parent LdapClient back, notifying
601 * it that the connection has been closed; false means not to notify
602 * parent. If LdapClient invokes cleanup(), notifyParent should be set to
603 * false because LdapClient already knows that it is closing
604 * the connection. If Connection invokes cleanup(), notifyParent should be
605 * set to true because LdapClient needs to know about the closure.
606 */
607 void cleanup(Control[] reqCtls, boolean notifyParent) {
608 boolean nparent = false;
609
610 synchronized (this) {
611 useable = false;
612
613 if (sock != null) {
614 if (debug) {
615 System.err.println("Connection: closing socket: " + host + "," + port);
616 }
617 try {
618 if (!notifyParent) {
619 abandonOutstandingReqs(reqCtls);
620 }
621 if (bound) {
622 ldapUnbind(reqCtls);
623 }
624 } finally {
625 try {
626 outStream.flush();
627 sock.close();
628 unpauseReader();
629 } catch (IOException ie) {
630 if (debug)
631 System.err.println("Connection: problem closing socket: " + ie);
632 }
633 if (!notifyParent) {
634 LdapRequest ldr = pendingRequests;
635 while (ldr != null) {
636 ldr.cancel();
637 ldr = ldr.next;
638 }
639 }
640 sock = null;
641 }
642 nparent = notifyParent;
643 }
644 if (nparent) {
645 LdapRequest ldr = pendingRequests;
646 while (ldr != null) {
647 ldr.close();
648 ldr = ldr.next;
649 }
650 }
651 }
652 if (nparent) {
653 parent.processConnectionClosure();
654 }
655 }
656
657
658 // Assume everything is "quiet"
659 // "synchronize" might lead to deadlock so don't synchronize method
660 // Use streamLock instead for synchronizing update to stream
661
662 synchronized public void replaceStreams(InputStream newIn, OutputStream newOut) {
663 if (debug) {
664 System.err.println("Replacing " + inStream + " with: " + newIn);
665 System.err.println("Replacing " + outStream + " with: " + newOut);
666 }
667
668 inStream = newIn;
669
670 // Cleanup old stream
671 try {
672 outStream.flush();
673 } catch (IOException ie) {
674 if (debug)
675 System.err.println("Connection: cannot flush outstream: " + ie);
676 }
677
678 // Replace stream
679 outStream = newOut;
680 }
681
682 /**
683 * Used by Connection thread to read inStream into a local variable.
684 * This ensures that there is no contention between the main thread
685 * and the Connection thread when the main thread updates inStream.
686 */
687 synchronized private InputStream getInputStream() {
688 return inStream;
689 }
690
691
692 ////////////////////////////////////////////////////////////////////////////
693 //
694 // Code for pausing/unpausing the reader thread ('worker')
695 //
696 ////////////////////////////////////////////////////////////////////////////
697
698 /*
699 * The main idea is to mark requests that need the reader thread to
700 * pause after getting the response. When the reader thread gets the response,
701 * it waits on a lock instead of returning to the read(). The next time a
702 * request is sent, the reader is automatically unblocked if necessary.
703 * Note that the reader must be unblocked BEFORE the request is sent.
704 * Otherwise, there is a race condition where the request is sent and
705 * the reader thread might read the response and be unblocked
706 * by writeRequest().
707 *
708 * This pause gives the main thread (StartTLS or SASL) an opportunity to
709 * update the reader's state (e.g., its streams) if necessary.
710 * The assumption is that the connection will remain quiet during this pause
711 * (i.e., no intervening requests being sent).
712 *<p>
713 * For dealing with StartTLS close,
714 * when the read() exits either due to EOF or an exception,
715 * the reader thread checks whether there is a new stream to read from.
716 * If so, then it reattempts the read. Otherwise, the EOF or exception
717 * is processed and the reader thread terminates.
718 * In a StartTLS close, the client first replaces the SSL IO streams with
719 * plain ones and then closes the SSL socket.
720 * If the reader thread attempts to read, or was reading, from
721 * the SSL socket (that is, it got to the read BEFORE replaceStreams()),
722 * the SSL socket close will cause the reader thread to
723 * get an EOF/exception and reexamine the input stream.
724 * If the reader thread sees a new stream, it reattempts the read.
725 * If the underlying socket is still alive, then the new read will succeed.
726 * If the underlying socket has been closed also, then the new read will
727 * fail and the reader thread exits.
728 * If the reader thread attempts to read, or was reading, from the plain
729 * socket (that is, it got to the read AFTER replaceStreams()), the
730 * SSL socket close will have no effect on the reader thread.
731 *
732 * The check for new stream is made only
733 * in the first attempt at reading a BER buffer; the reader should
734 * never be in midst of reading a buffer when a nonfatal close occurs.
735 * If this occurs, then the connection is in an inconsistent state and
736 * the safest thing to do is to shut it down.
737 */
738
739 private final Object pauseLock = new Object(); // lock for reader to wait on while paused
740 private boolean paused = false; // paused state of reader
741
742 /*
743 * Unpauses reader thread if it was paused
744 */
745 private void unpauseReader() throws IOException {
746 synchronized (pauseLock) {
747 if (paused) {
748 if (debug) {
749 System.err.println("Unpausing reader; read from: " +
750 inStream);
751 }
752 paused = false;
753 pauseLock.notify();
754 }
755 }
756 }
757
758 /*
759 * Pauses reader so that it stops reading from the input stream.
760 * Reader blocks on pauseLock instead of read().
761 * MUST be called from within synchronized (pauseLock) clause.
762 */
763 private void pauseReader() throws IOException {
764 if (debug) {
765 System.err.println("Pausing reader; was reading from: " +
766 inStream);
767 }
768 paused = true;
769 try {
770 while (paused) {
771 pauseLock.wait(); // notified by unpauseReader
772 }
773 } catch (InterruptedException e) {
774 throw new InterruptedIOException(
775 "Pause/unpause reader has problems.");
776 }
777 }
778
779
780 ////////////////////////////////////////////////////////////////////////////
781 //
782 // The LDAP Binding thread. It does the mux/demux of multiple requests
783 // on the same TCP connection.
784 //
785 ////////////////////////////////////////////////////////////////////////////
786
787
788 public void run() {
789 byte inbuf[]; // Buffer for reading incoming bytes
790 int inMsgId; // Message id of incoming response
791 int bytesread; // Number of bytes in inbuf
792 int br; // Temp; number of bytes read from stream
793 int offset; // Offset of where to store bytes in inbuf
794 int seqlen; // Length of ASN sequence
795 int seqlenlen; // Number of sequence length bytes
796 boolean eos; // End of stream
797 BerDecoder retBer; // Decoder for ASN.1 BER data from inbuf
798 InputStream in = null;
799
800 try {
801 while (true) {
802 try {
803 // type and length (at most 128 octets for long form)
804 inbuf = new byte[129];
805
806 offset = 0;
807 seqlen = 0;
808 seqlenlen = 0;
809
810 in = getInputStream();
811
812 // check that it is the beginning of a sequence
813 bytesread = in.read(inbuf, offset, 1);
814 if (bytesread < 0) {
815 if (in != getInputStream()) {
816 continue; // a new stream to try
817 } else {
818 break; // EOF
819 }
820 }
821
822 if (inbuf[offset++] != (Ber.ASN_SEQUENCE | Ber.ASN_CONSTRUCTOR))
823 continue;
824
825 // get length of sequence
826 bytesread = in.read(inbuf, offset, 1);
827 if (bytesread < 0)
828 break; // EOF
829 seqlen = inbuf[offset++];
830
831 // if high bit is on, length is encoded in the
832 // subsequent length bytes and the number of length bytes
833 // is equal to & 0x80 (i.e. length byte with high bit off).
834 if ((seqlen & 0x80) == 0x80) {
835 seqlenlen = seqlen & 0x7f; // number of length bytes
836
837 bytesread = 0;
838 eos = false;
839
840 // Read all length bytes
841 while (bytesread < seqlenlen) {
842 br = in.read(inbuf, offset+bytesread,
843 seqlenlen-bytesread);
844 if (br < 0) {
845 eos = true;
846 break; // EOF
847 }
848 bytesread += br;
849 }
850
851 // end-of-stream reached before length bytes are read
852 if (eos)
853 break; // EOF
854
855 // Add contents of length bytes to determine length
856 seqlen = 0;
857 for( int i = 0; i < seqlenlen; i++) {
858 seqlen = (seqlen << 8) + (inbuf[offset+i] & 0xff);
859 }
860 offset += bytesread;
861 }
862
863 // read in seqlen bytes
864 byte[] left = readFully(in, seqlen);
865 inbuf = Arrays.copyOf(inbuf, offset + left.length);
866 System.arraycopy(left, 0, inbuf, offset, left.length);
867 offset += left.length;
868
869 try {
870 retBer = new BerDecoder(inbuf, 0, offset);
871
872 if (traceFile != null) {
873 Ber.dumpBER(traceFile, traceTagIn, inbuf, 0, offset);
874 }
875
876 retBer.parseSeq(null);
877 inMsgId = retBer.parseInt();
878 retBer.reset(); // reset offset
879
880 boolean needPause = false;
881
882 if (inMsgId == 0) {
883 // Unsolicited Notification
884 parent.processUnsolicited(retBer);
885 } else {
886 LdapRequest ldr = findRequest(inMsgId);
887
888 if (ldr != null) {
889
890 /**
891 * Grab pauseLock before making reply available
892 * to ensure that reader goes into paused state
893 * before writer can attempt to unpause reader
894 */
895 synchronized (pauseLock) {
896 needPause = ldr.addReplyBer(retBer);
897 if (needPause) {
898 /*
899 * Go into paused state; release
900 * pauseLock
901 */
902 pauseReader();
903 }
904
905 // else release pauseLock
906 }
907 } else {
908 // System.err.println("Cannot find" +
909 // "LdapRequest for " + inMsgId);
910 }
911 }
912 } catch (Ber.DecodeException e) {
913 //System.err.println("Cannot parse Ber");
914 }
915 } catch (IOException ie) {
916 if (debug) {
917 System.err.println("Connection: Inside Caught " + ie);
918 ie.printStackTrace();
919 }
920
921 if (in != getInputStream()) {
922 // A new stream to try
923 // Go to top of loop and continue
924 } else {
925 if (debug) {
926 System.err.println("Connection: rethrowing " + ie);
927 }
928 throw ie; // rethrow exception
929 }
930 }
931 }
932
933 if (debug) {
934 System.err.println("Connection: end-of-stream detected: "
935 + in);
936 }
937 } catch (IOException ex) {
938 if (debug) {
939 System.err.println("Connection: Caught " + ex);
940 }
941 closureReason = ex;
942 } finally {
943 cleanup(null, true); // cleanup
944 }
945 if (debug) {
946 System.err.println("Connection: Thread Exiting");
947 }
948 }
949
950 private static byte[] readFully(InputStream is, int length)
951 throws IOException
952 {
953 byte[] buf = new byte[Math.min(length, 8192)];
954 int nread = 0;
955 while (nread < length) {
956 int bytesToRead;
957 if (nread >= buf.length) { // need to allocate a larger buffer
958 bytesToRead = Math.min(length - nread, buf.length + 8192);
959 if (buf.length < nread + bytesToRead) {
960 buf = Arrays.copyOf(buf, nread + bytesToRead);
961 }
962 } else {
963 bytesToRead = buf.length - nread;
964 }
965 int count = is.read(buf, nread, bytesToRead);
966 if (count < 0) {
967 if (buf.length != nread)
968 buf = Arrays.copyOf(buf, nread);
969 break;
970 }
971 nread += count;
972 }
973 return buf;
974 }
975 }