1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
|
/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.impl.netaddr;
import java.net.*;
import net.java.sip.communicator.service.configuration.*;
import net.java.sip.communicator.service.configuration.event.*;
import net.java.sip.communicator.service.netaddr.*;
import net.java.sip.communicator.util.*;
import net.java.stun4j.*;
import net.java.stun4j.client.*;
/**
* This implementation of the Network Address Manager allows you to
* intelligently retrieve the address of your localhost according to preferences
* specified in a number of properties like:
* <br>
* net.java.sip.communicator.STUN_SERVER_ADDRESS - the address of the stun
* server to use for NAT traversal
* <br>
* net.java.sip.communicator.STUN_SERVER_PORT - the port of the stun server
* to use for NAT traversal
* <br>
* java.net.preferIPv6Addresses - a system property specifying weather ipv6
* addresses are to be preferred in address resolution (default is false for
* backward compatibility)
* <br>
* net.java.sip.communicator.common.PREFERRED_NETWORK_ADDRESS - the address
* that the user would like to use. (If this is a valid address it will be
* returned in getLocalhost() calls)
* <br>
* net.java.sip.communicator.common.PREFERRED_NETWORK_INTERFACE - the network
* interface that the user would like to use for fommunication (addresses
* belonging to that interface will be prefered when selecting a localhost
* address)
*
* @todo further explain the way the service works. explain address selection
* algorithms and priorities.
*
* @author Emil Ivov
*/
public class NetworkAddressManagerServiceImpl
implements NetworkAddressManagerService, VetoableChangeListener
{
private static Logger logger =
Logger.getLogger(NetworkAddressManagerServiceImpl.class);
/**
* The name of the property containing the stun server address.
*/
private static final String PROP_STUN_SERVER_ADDRESS
= "net.java.sip.communicator.STUN_SERVER_ADDRESS";
/**
* The port number of the stun server to use for NAT traversal
*/
private static final String PROP_STUN_SERVER_PORT
= "net.java.sip.communicator.STUN_SERVER_PORT";
/**
* A stun4j address resolver
*/
private SimpleAddressDetector detector = null;
/**
* Specifies whether or not STUN should be used for NAT traversal
*/
private boolean useStun = true;
/**
* The address of the stun server that we're currently using.
*/
private StunAddress stunServerAddress = null;
/**
* The socket that we use for dummy connections during selection of a local
* address that has to be used when communicating with a specific location.
*/
DatagramSocket localHostFinderSocket = null;
/**
* A random (unused)local port to use when trying to select a local host
* address to use when sending messages to a specific destination.
*/
private static final int RANDOM_ADDR_DISC_PORT = 55721;
/**
* The prefix used for Dynamic Configuration of IPv4 Link-Local Addresses.
* <br>
* {@link http://ietf.org/rfc/rfc3927.txt}
*/
private static final String DYNAMIC_CONF_FOR_IPV4_ADDR_PREFIX = "169.254";
/**
* The name of the property containing the number of binds that we should
* should execute in case a port is already bound to (each retry would be on
* a new random port).
*/
public static final String BIND_RETRIES_PROPERTY_NAME
= "net.java.sip.communicator.service.netaddr.BIND_RETRIES";
/**
* Default STUN server address.
*/
public static final String DEFAULT_STUN_SERVER_ADDRESS
= "stun.iptel.org";
/**
* Default STUN server port.
*/
public static final int DEFAULT_STUN_SERVER_PORT = 3478;
/**
* Initializes this network address manager service implementation and
* starts all processes/threads associated with this address manager, such
* as a stun firewall/nat detector, keep alive threads, binding lifetime
* discovery threads and etc. The method may also be used after a call to
* stop() as a reinitialization technique.
*/
public void start()
{
// init stun
String stunAddressStr = null;
int port = -1;
stunAddressStr = NetaddrActivator.getConfigurationService().getString(
PROP_STUN_SERVER_ADDRESS);
String portStr = NetaddrActivator.getConfigurationService().getString(
PROP_STUN_SERVER_PORT);
//we use the default stun server address only for chosing a public
//route and not for stun queries.
stunServerAddress = new StunAddress(DEFAULT_STUN_SERVER_ADDRESS
, DEFAULT_STUN_SERVER_PORT);
if (stunAddressStr == null
|| portStr == null)
{
useStun = false;
}
else
{
port = Integer.valueOf(portStr).intValue();
stunServerAddress = new StunAddress(stunAddressStr, port);
detector = new SimpleAddressDetector(stunServerAddress);
if (logger.isDebugEnabled())
logger.debug(
"Created a STUN Address detector for the following "
+ "STUN server: "
+ stunAddressStr + ":" + port);
try
{
detector.start();
logger.debug("STUN server started;");
}
catch (StunException ex)
{
logger.error(
"Failed to start the STUN Address Detector. " +
detector.toString(), ex);
logger.debug("Disabling stun and continuing bravely!");
detector = null;
useStun = false;
}
//make sure that someone doesn't set invalid stun address and port
NetaddrActivator.getConfigurationService().addVetoableChangeListener(
PROP_STUN_SERVER_ADDRESS, this);
NetaddrActivator.getConfigurationService().addVetoableChangeListener(
PROP_STUN_SERVER_PORT, this);
}
initializeLocalHostFinderSocket();
}
/**
* Kills all threads/processes lauched by this thread and prepares it for
* shutdown. You may use this method as a reinitialization technique (
* you'll have to call start afterwards)
*/
public void stop()
{
try
{
try{
detector.shutDown();
}catch (Exception ex){
logger.debug("Failed to properly shutdown a stun detector: "
+ex.getMessage());
}
detector = null;
useStun = false;
//remove the listeners
NetaddrActivator.getConfigurationService()
.removeVetoableChangeListener( PROP_STUN_SERVER_ADDRESS, this);
NetaddrActivator.getConfigurationService()
.removeVetoableChangeListener( PROP_STUN_SERVER_PORT, this);
}
finally
{
logger.logExit();
}
}
/**
* Returns an InetAddress instance that represents the localhost, and that
* a socket can bind upon or distribute to peers as a contact address.
*
* @param intendedDestination the destination that we'd like to use the
* localhost address with.
*
* @return an InetAddress instance representing the local host, and that
* a socket can bind upon or distribute to peers as a contact address.
*/
public InetAddress getLocalHost(InetAddress intendedDestination)
{
//no point in making sure that the localHostFinderSocket is initialized.
//better let it through a NullPointerException.
localHostFinderSocket.connect(intendedDestination
, this.RANDOM_ADDR_DISC_PORT);
InetAddress localHost = localHostFinderSocket.getLocalAddress();
localHostFinderSocket.disconnect();
//windows socket implementations return the any address so we need to
//find something else here ... InetAddress.getLocalHost seems to work
//better on windows so lets hope it'll do the trick.
if( localHost.isAnyLocalAddress())
{
try
{
localHost = InetAddress.getLocalHost();
/** @todo test on windows for ipv6 cases */
}
catch (UnknownHostException ex)
{
//sigh ... ok return 0.0.0.0
logger.warn("Failed to get localhost ", ex);
}
}
return localHost;
}
/**
* The method queries a Stun server for a binding for the specified port.
* @param port the port to resolve (the stun message gets sent trhough that
* port)
* @return StunAddress the address returned by the stun server or null
* if an error occurred or no address was returned
*/
private StunAddress queryStunServer(int port)
{
try{
logger.logEntry();
StunAddress mappedAddress = null;
if (detector != null && useStun) {
try {
mappedAddress = detector.getMappingFor(port);
if (logger.isDebugEnabled())
logger.debug("For port:"
+ port + "a Stun server returned the "
+"following mapping [" + mappedAddress);
}
catch (StunException ex) {
logger.error(
"Failed to retrive mapped address port:" +port, ex);
mappedAddress = null;
}
}
return mappedAddress;
}
finally{
logger.logExit();
}
}
/**
* Tries to obtain a mapped/public address for the specified port (possibly
* by executing a STUN query).
*
* @param dst the destination that we'd like to use this address with.
* @param port the port whose mapping we are interested in.
* @return a public address corresponding to the specified port or null
* if all attempts to retrieve such an address have failed.
*/
public InetSocketAddress getPublicAddressFor(InetAddress dst, int port)
{
try {
logger.logEntry();
if (!useStun) {
logger.debug(
"Stun is disabled, skipping mapped address recovery.");
return new InetSocketAddress(getLocalHost(dst), port);
}
StunAddress mappedAddress = queryStunServer(port);
InetSocketAddress result = null;
if (mappedAddress != null)
result = mappedAddress.getSocketAddress();
else {
//Apparently STUN failed. Let's try to temporarily disble it
//and use algorithms in getLocalHost(). ... We should probably
//eveng think about completely disabling stun, and not only
//temporarily.
//Bug report - John J. Barton - IBM
InetAddress localHost = getLocalHost(dst);
result = new InetSocketAddress(localHost, port);
}
if (logger.isDebugEnabled())
logger.debug("Returning mapping for port:"
+ port +" as follows: " + result);
return result;
}
finally {
logger.logExit();
}
}
/**
* Tries to obtain a mapped/public address for the specified port (possibly
* by executing a STUN query).
*
* @param port the port whose mapping we are interested in.
* @return a public address corresponding to the specified port or null
* if all attempts to retrieve such an address have failed.
*/
public InetSocketAddress getPublicAddressFor(int port)
{
return getPublicAddressFor(
this.stunServerAddress.getSocketAddress().getAddress()
, port);
}
/**
* This method gets called when a bound property is changed.
* @param evt A PropertyChangeEvent object describing the event source
* and the property that has changed.
*/
public void propertyChange(PropertyChangeEvent evt)
{
//there's no point in implementing this method as we have no way of
//knowing whether the current property change event is the only event
//we're going to get or whether another one is going to follow..
//in the case of a STUN_SERVER_ADDRESS property change for example
//there's no way of knowing whether a STUN_SERVER_PORT property change
//will follow or not.
//Reinitializaion will therefore only happen if the reinitialize()
//method is called.
}
/**
* This method gets called when a property we're interested in is about to
* change. In case we don't like the new value we throw a
* PropertyVetoException to prevent the actual change from happening.
*
* @param evt a <tt>PropertyChangeEvent</tt> object describing the
* event source and the property that will change.
* @exception PropertyVetoException if we don't want the change to happen.
*/
public void vetoableChange(PropertyChangeEvent evt) throws
PropertyVetoException
{
if (evt.getPropertyName().equals(PROP_STUN_SERVER_ADDRESS))
{
//make sure that we have a valid fqdn or ip address.
//null or empty port is ok since it implies turning STUN off.
if (evt.getNewValue() == null)
return;
String host = evt.getNewValue().toString();
if (host.trim().length() == 0)
return;
boolean ipv6Expected = false;
if (host.charAt(0) == '[')
{
// This is supposed to be an IPv6 litteral
if (host.length() > 2 &&
host.charAt(host.length() - 1) == ']')
{
host = host.substring(1, host.length() - 1);
ipv6Expected = true;
}
else
{
// This was supposed to be a IPv6 address, but it's not!
throw new PropertyVetoException(
"Invalid address string" + host, evt);
}
}
for(int i = 0; i < host.length(); i++)
{
char c = host.charAt(i);
if( Character.isLetterOrDigit(c))
continue;
if( (c != '.' && c!= ':')
||( c == '.' && ipv6Expected)
||( c == ':' && !ipv6Expected))
throw new PropertyVetoException(
host + " is not a valid address nor host name",
evt);
}
}//is prop_stun_server_address
else if (evt.getPropertyName().equals(PROP_STUN_SERVER_PORT)){
//null or empty port is ok since it implies turning STUN off.
if (evt.getNewValue() == null)
return;
String port = evt.getNewValue().toString();
if (port.trim().length() == 0)
return;
try
{
Integer.valueOf(evt.getNewValue().toString());
}
catch (NumberFormatException ex)
{
throw new PropertyVetoException(
port + " is not a valid port! " + ex.getMessage(), evt);
}
}
}
/**
* Initializes and binds the socket that we use when selecting local host
* address. The method would try to bind on a random port and retry 5 times
* until a free port is found.
*/
private void initializeLocalHostFinderSocket()
{
String bindRetriesStr
= NetaddrActivator.getConfigurationService().getString(
BIND_RETRIES_PROPERTY_NAME);
int bindRetries = 5;
if (bindRetriesStr != null)
{
try
{
bindRetries = Integer.parseInt(bindRetriesStr);
}
catch (NumberFormatException ex)
{
logger.error(bindRetriesStr
+ " does not appear to be an integer. "
+ "Defaulting port bind retries to " + bindRetries
, ex);
}
}
int currentlyTriedPort = NetworkUtils.getRandomPortNumber();
//we'll first try to bind to a random port. if this fails we'll try
//again (bindRetries times in all) until we find a free local port.
for (int i = 0; i < bindRetries; i++)
{
try
{
localHostFinderSocket = new DatagramSocket(currentlyTriedPort);
//we succeeded - break so that we don't try to bind again
break;
}
catch (SocketException exc)
{
if (exc.getMessage().indexOf("Address already in use") == -1)
{
logger.fatal("An exception occurred while trying to create"
+ "a local host discovery socket.", exc);
localHostFinderSocket = null;
return;
}
//port seems to be taken. try another one.
logger.debug("Port " + currentlyTriedPort
+ " seems in use.");
currentlyTriedPort
= NetworkUtils.getRandomPortNumber();
logger.debug("Retrying bind on port "
+ currentlyTriedPort);
}
}
}
}
|