/usr/include/ptclib/pnat.h is in libpt-dev 2.10.11~dfsg-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* pnat.h
*
* NAT Strategy support for Portable Windows Library.
*
* Virteos is a Trade Mark of ISVO (Asia) Pte Ltd.
*
* Copyright (c) 2004 ISVO (Asia) Pte Ltd. All Rights Reserved.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
*
* The Original Code is derived from and used in conjunction with the
* OpenH323 Project (www.openh323.org/)
*
* The Initial Developer of the Original Code is ISVO (Asia) Pte Ltd.
*
*
* Contributor(s): ______________________________________.
*
* $Revision: 26549 $
* $Author: rjongbloed $
* $Date: 2011-10-05 23:24:38 -0500 (Wed, 05 Oct 2011) $
*/
#include <ptlib/sockets.h>
#ifndef PTLIB_PNAT_H
#define PTLIB_PNAT_H
#include <ptlib/plugin.h>
#include <ptlib/pluginmgr.h>
/** PNatMethod
Base Network Address Traversal Method class
All NAT Traversal Methods are derived off this class.
There are quite a few methods of NAT Traversal. The
only purpose of this class is to provide a common
interface. It is intentionally minimalistic.
*/
class PNatMethod : public PObject
{
PCLASSINFO(PNatMethod,PObject);
public:
/**@name Construction */
//@{
/** Default Contructor
*/
PNatMethod();
/** Deconstructor
*/
~PNatMethod();
//@}
/**@name Overrides from PObject */
//@{
virtual void PrintOn(
ostream & strm
) const;
//@}
/**@name General Functions */
//@{
/** Factory Create
*/
static PNatMethod * Create(
const PString & name, ///< Feature Name Expression
PPluginManager * pluginMgr = NULL ///< Plugin Manager
);
/** Get the NAT traversal method Name
*/
virtual PString GetName() const = 0;
/**Get the current server address name.
Defaults to be "address:port" string form.
*/
virtual PString GetServer() const;
/**Get the current server address and port being used.
*/
virtual bool GetServerAddress(
PIPSocket::Address & address, ///< Address of server
WORD & port ///< Port server is using.
) const = 0;
/** Get the acquired External IP Address.
*/
virtual PBoolean GetExternalAddress(
PIPSocket::Address & externalAddress, ///< External address of router
const PTimeInterval & maxAge = 1000 ///< Maximum age for caching
) = 0;
/**Return the interface NAT router is using.
*/
virtual bool GetInterfaceAddress(
PIPSocket::Address & internalAddress ///< NAT router internal address returned.
) const = 0;
/**Create a single socket.
The NAT traversal protocol is used to create a socket for which the
external IP address and port numbers are known. A PUDPSocket descendant
is returned which will, in response to GetLocalAddress() return the
externally visible IP and port rather than the local machines IP and
socket.
The will create a new socket pointer. It is up to the caller to make
sure the socket is deleted to avoid memory leaks.
The socket pointer is set to NULL if the function fails and returns
false.
*/
virtual PBoolean CreateSocket(
PUDPSocket * & socket,
const PIPSocket::Address & binding = PIPSocket::GetDefaultIpAny(),
WORD localPort = 0
) = 0;
/**Create a socket pair.
The NAT traversal protocol is used to create a pair of sockets with
adjacent port numbers for which the external IP address and port
numbers are known. PUDPSocket descendants are returned which will, in
response to GetLocalAddress() return the externally visible IP and port
rather than the local machines IP and socket.
The will create new socket pointers. It is up to the caller to make
sure the sockets are deleted to avoid memory leaks.
The socket pointers are set to NULL if the function fails and returns
false.
*/
virtual PBoolean CreateSocketPair(
PUDPSocket * & socket1,
PUDPSocket * & socket2,
const PIPSocket::Address & binding = PIPSocket::GetDefaultIpAny()
) = 0;
/**Create a socket pair.
The NAT traversal protocol is used to create a pair of sockets with
adjacent port numbers for which the external IP address and port
numbers are known. PUDPSocket descendants are returned which will, in
response to GetLocalAddress() return the externally visible IP and port
rather than the local machines IP and socket.
The will create new socket pointers. It is up to the caller to make
sure the sockets are deleted to avoid memory leaks.
The socket pointers are set to NULL if the function fails and returns
false.
*/
virtual PBoolean CreateSocketPair(
PUDPSocket * & socket1,
PUDPSocket * & socket2,
const PIPSocket::Address & binding,
void * userData
);
/**Returns whether the Nat Method is ready and available in
assisting in NAT Traversal. The principal is function is
to allow the EP to detect various methods and if a method
is detected then this method is available for NAT traversal
The Order of adding to the PNstStrategy determines which method
is used
*/
virtual bool IsAvailable(
const PIPSocket::Address & binding = PIPSocket::GetDefaultIpAny() ///< Interface to see if NAT is available on
) = 0;
/**Acrivate
Activate/DeActivate the NAT Method on a call by call basis
Default does notthing
*/
virtual void Activate(bool active);
/**Set Alternate Candidate (ICE) or probe (H.460.24A) addresses.
Default does nothing.
*/
virtual void SetAlternateAddresses(
const PStringArray & addresses, ///< List of probe/candidates
void * userData = NULL ///< User data to link to NAT handler.
);
enum RTPSupportTypes {
RTPSupported,
RTPIfSendMedia,
RTPUnsupported,
RTPUnknown,
NumRTPSupportTypes
};
/**Return an indication if the current STUN type supports RTP
Use the force variable to guarantee an up to date test
*/
virtual RTPSupportTypes GetRTPSupport(
PBoolean force = false ///< Force a new check
) = 0;
/**Set the port ranges to be used on local machine.
Note that the ports used on the NAT router may not be the same unless
some form of port forwarding is present.
If the port base is zero then standard operating system port allocation
method is used.
If the max port is zero then it will be automatically set to the port
base + 99.
*/
virtual void SetPortRanges(
WORD portBase, ///< Single socket port number base
WORD portMax = 0, ///< Single socket port number max
WORD portPairBase = 0, ///< Socket pair port number base
WORD portPairMax = 0 ///< Socket pair port number max
);
//@}
protected:
struct PortInfo {
PortInfo(WORD port = 0)
: basePort(port)
, maxPort(port)
, currentPort(port)
{
}
PMutex mutex;
WORD basePort;
WORD maxPort;
WORD currentPort;
} singlePortInfo, pairedPortInfo;
/** RandomPortPair
This function returns a random port pair base number in the specified range for
the creation of the RTP port pairs (this used to avoid issues with multiple
NATed devices opening the same local ports and experiencing issues with
the behaviour of the NAT device Refer: draft-jennings-behave-test-results-04 sect 3
*/
WORD RandomPortPair(unsigned int start, unsigned int end);
};
/////////////////////////////////////////////////////////////
PLIST(PNatList, PNatMethod);
/////////////////////////////////////////////////////////////
/** PNatStrategy
The main container for all
NAT traversal Strategies.
*/
class PNatStrategy : public PObject
{
PCLASSINFO(PNatStrategy,PObject);
public :
/**@name Construction */
//@{
/** Default Contructor
*/
PNatStrategy();
/** Deconstructor
*/
~PNatStrategy();
//@}
/**@name Method Handling */
//@{
/** AddMethod
This function is used to add the required NAT
Traversal Method. The Order of Loading is important
The first added has the highest priority.
*/
void AddMethod(PNatMethod * method);
/** GetMethod
This function retrieves the first available NAT
Traversal Method. If no available NAT Method is found
then NULL is returned.
*/
PNatMethod * GetMethod(const PIPSocket::Address & address = PIPSocket::GetDefaultIpAny());
/** GetMethodByName
This function retrieves the NAT Traversal Method with the given name.
If it is not found then NULL is returned.
*/
PNatMethod * GetMethodByName(const PString & name);
/** RemoveMethod
This function removes a NAT method from the NATlist matching the supplied method name
*/
PBoolean RemoveMethod(const PString & meth);
/**Set the port ranges to be used on local machine.
Note that the ports used on the NAT router may not be the same unless
some form of port forwarding is present.
If the port base is zero then standard operating system port allocation
method is used.
If the max port is zero then it will be automatically set to the port
base + 99.
*/
void SetPortRanges(
WORD portBase, ///< Single socket port number base
WORD portMax = 0, ///< Single socket port number max
WORD portPairBase = 0, ///< Socket pair port number base
WORD portPairMax = 0 ///< Socket pair port number max
);
/** Get Loaded NAT Method List
*/
PNatList & GetNATList() { return natlist; };
PNatMethod * LoadNatMethod(const PString & name);
static PStringArray GetRegisteredList();
//@}
private:
PNatList natlist;
PPluginManager * pluginMgr;
};
////////////////////////////////////////////////////////
//
// declare macros and structures needed for NAT plugins
//
template <class className> class PNatMethodServiceDescriptor : public PDevicePluginServiceDescriptor
{
public:
virtual PObject * CreateInstance(int /*userData*/) const { return (PNatMethod *)new className; }
virtual PStringArray GetDeviceNames(int /*userData*/) const { return className::GetNatMethodName(); }
virtual bool ValidateDeviceName(const PString & deviceName, int /*userData*/) const {
return (deviceName == GetDeviceNames(0)[0]);
}
};
#define PDECLARE_NAT_METHOD(method, cls) PFACTORY_CREATE(PFactory<PNatMethod>, cls, #method)
#define PCREATE_NAT_PLUGIN(name) \
static PNatMethodServiceDescriptor<PNatMethod_##name> PNatMethod_##name##_descriptor; \
PCREATE_PLUGIN_STATIC(name, PNatMethod, &PNatMethod_##name##_descriptor)
#if P_STUN
PFACTORY_LOAD(PSTUNClient);
#endif
#if P_TURN
PFACTORY_LOAD(PTURNClient);
#endif
#endif // PTLIB_PNAT_H
// End Of File ///////////////////////////////////////////////////////////////
|