/usr/include/openh323/gkclient.h is in libh323plus-dev 1.21.0~dfsg-1build1.
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 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 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 | /*
* gkclient.h
*
* Gatekeeper client protocol handler
*
* Open H323 Library
*
* Copyright (c) 1998-2000 Equivalence Pty. Ltd.
*
* 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 Open H323 Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Portions of this code were written with the assisance of funding from
* iFace, Inc. http://www.iface.com
*
* Contributor(s): ______________________________________.
*
* $Log: gkclient.h,v $
* Revision 1.7 2009/02/22 02:44:41 shorne
* Added ability to enable SCI/SCR without needing H248 support
*
* Revision 1.6 2009/02/21 13:59:05 shorne
* Added Registration Mutex
*
* Revision 1.5 2008/05/23 11:19:17 willamowius
* switch BOOL to PBoolean to be able to compile with Ptlib 2.2.x
*
* Revision 1.4 2008/01/29 04:33:24 shorne
* Added SendServiceControlIndication - fixed Endpoint initiation with H.460
*
* Revision 1.3 2008/01/04 06:23:07 shorne
* Cleaner setup and teardown of h460 module
*
* Revision 1.2 2007/10/16 16:54:32 shorne
* Fix for H.235.1 on full reregistration
*
* Revision 1.1 2007/08/06 20:50:48 shorne
* First commit of h323plus
*
* Revision 1.58.2.1 2006/12/23 19:08:02 shorne
* Plugin video codecs & sundry
*
* Revision 1.58 2006/05/30 11:14:55 hfriederich
* Switch from DISABLE_H460 to H323_H460
*
* Revision 1.57 2006/05/18 17:16:34 shorne
* Added H460 Support
*
* Revision 1.56 2005/11/30 13:05:01 csoutheren
* Changed tags for Doxygen
*
* Revision 1.55 2005/01/03 14:03:19 csoutheren
* Added new configure options and ability to disable/enable modules
*
* Revision 1.54 2005/01/03 06:25:52 csoutheren
* Added extensive support for disabling code modules at compile time
*
* Revision 1.53 2004/09/03 01:06:08 csoutheren
* Added initial hooks for H.460 GEF
* Thanks to Simon Horne and ISVO (Asia) Pte Ltd. for this contribution
*
* Revision 1.52 2004/03/04 04:49:34 csoutheren
* Added access function for gatekeeper routed address
*
* Revision 1.51 2003/03/26 00:46:25 robertj
* Had another go at making H323Transactor being able to be created
* without having a listener running.
*
* Revision 1.50 2003/02/12 23:59:22 robertj
* Fixed adding missing endpoint identifer in SETUP packet when gatekeeper
* routed, pointed out by Stefan Klein
* Also fixed correct rutrn of gk routing in IRR packet.
*
* Revision 1.49 2003/02/07 06:37:42 robertj
* Changed registration state to an enum so can determine why the RRQ failed.
*
* Revision 1.48 2003/01/06 07:09:28 robertj
* Further fixes for alternate gatekeeper, thanks Kevin Bouchard
*
* Revision 1.47 2002/12/23 22:46:38 robertj
* Changed gatekeeper discovery so an GRJ does not indicate "discovered".
* Added trace output of alternate gatekeepers list.
*
* Revision 1.46 2002/11/28 04:41:44 robertj
* Added support for RAS ServiceControlIndication command.
*
* Revision 1.45 2002/11/27 06:54:52 robertj
* Added Service Control Session management as per Annex K/H.323 via RAS
* only at this stage.
* Added H.248 ASN and very primitive infrastructure for linking into the
* Service Control Session management system.
* Added basic infrastructure for Annex K/H.323 HTTP transport system.
* Added Call Credit Service Control to display account balances.
*
* Revision 1.44 2002/11/21 07:21:46 robertj
* Improvements to alternate gatekeeper client code, thanks Kevin Bouchard
*
* Revision 1.43 2002/09/18 06:58:29 robertj
* Fixed setting of IRR frequency, an RCF could reset timer so it did not time
* out correctly and send IRR in time causing problems with gatekeeper.
*
* Revision 1.42 2002/09/16 01:14:15 robertj
* Added #define so can select if #pragma interface/implementation is used on
* platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
*
* Revision 1.41 2002/09/03 06:19:36 robertj
* Normalised the multi-include header prevention ifdef/define symbol.
*
* Revision 1.40 2002/08/15 04:13:21 robertj
* Fixed correct status of isRegistered flag on various reject/errors.
*
* Revision 1.39 2002/08/12 05:38:20 robertj
* Changes to the RAS subsystem to support ability to make requests to client
* from gkserver without causing bottlenecks and race conditions.
*
* Revision 1.38 2002/08/05 05:17:36 robertj
* Fairly major modifications to support different authentication credentials
* in ARQ to the logged in ones on RRQ. For both client and server.
* Various other H.235 authentication bugs and anomalies fixed on the way.
*
* Revision 1.37 2002/07/18 03:03:38 robertj
* Fixed bug with continually doing lightweight RRQ if no timeToLive present
* and it should not be doing it at all, ditto for unsolicited IRR.
*
* Revision 1.36 2002/07/16 11:06:21 robertj
* Added more alternate gatekeeper implementation, thanks Kevin Bouchard
*
* Revision 1.35 2002/06/26 03:47:45 robertj
* Added support for alternate gatekeepers.
*
* Revision 1.34 2002/05/29 00:03:15 robertj
* Fixed unsolicited IRR support in gk client and server,
* including support for IACK and INAK.
*
* Revision 1.33 2002/05/17 04:12:38 robertj
* Added support for unsolicited IRR transmission in background (heartbeat).
*
* Revision 1.32 2002/03/19 05:17:11 robertj
* Normalised ACF destExtraCallIInfo to be same as other parameters.
* Added ability to get multiple endpoint addresses and tokens from ACF.
*
* Revision 1.31 2001/09/26 07:02:49 robertj
* Added needed mutex for SeparateAuthenticationInARQ mode, thanks Nick Hoath
*
* Revision 1.30 2001/09/18 10:36:54 robertj
* Allowed multiple overlapping requests in RAS channel.
*
* Revision 1.29 2001/09/13 03:21:16 robertj
* Added ability to override authentication credentials for ARQ, thanks Nick Hoath
*
* Revision 1.28 2001/09/12 06:57:58 robertj
* Added support for iNow Access Token from gk, thanks Nick Hoath
*
* Revision 1.27 2001/09/12 06:04:36 robertj
* Added support for sending UUIE's to gk on request, thanks Nick Hoath
*
* Revision 1.26 2001/09/06 02:32:26 robertj
* Added overloaded AdmissionRequest for backward compatibility.
*
* Revision 1.25 2001/08/14 04:26:46 robertj
* Completed the Cisco compatible MD5 authentications, thanks Wolfgang Platzer.
*
* Revision 1.24 2001/08/13 01:27:00 robertj
* Changed GK admission so can return multiple aliases to be used in
* setup packet, thanks Nick Hoath.
*
* Revision 1.23 2001/08/10 11:03:49 robertj
* Major changes to H.235 support in RAS to support server.
*
* Revision 1.22 2001/08/06 07:44:52 robertj
* Fixed problems with building without SSL
*
* Revision 1.21 2001/08/06 03:18:35 robertj
* Fission of h323.h to h323ep.h & h323con.h, h323.h now just includes files.
* Improved access to H.235 secure RAS functionality.
* Changes to H.323 secure RAS contexts to help use with gk server.
*
* Revision 1.20 2001/08/02 04:30:09 robertj
* Added ability for AdmissionRequest to alter destination alias used in
* the outgoing call.
*
* Revision 1.19 2001/06/18 06:23:47 robertj
* Split raw H.225 RAS protocol out of gatekeeper client class.
*
* Revision 1.18 2001/04/05 03:39:42 robertj
* Fixed deadlock if tried to do discovery in time to live timeout.
*
* Revision 1.17 2001/03/28 07:12:56 robertj
* Changed RAS thread interlock to allow for what should not happen, the
* syncpoint being signalled before receiving any packets.
*
* Revision 1.16 2001/03/27 02:18:41 robertj
* Changed to send gk a GRQ if it gives a discoveryRequired error on RRQ.
*
* Revision 1.15 2001/03/17 00:05:52 robertj
* Fixed problems with Gatekeeper RIP handling.
*
* Revision 1.14 2001/02/28 00:20:15 robertj
* Added DiscoverByNameAndAddress() function, thanks Chris Purvis.
*
* Revision 1.13 2001/02/09 05:16:24 robertj
* Added #pragma interface for GNU C++.
*
* Revision 1.12 2000/09/25 06:47:54 robertj
* Removed use of alias if there is no alias present, ie only have transport address.
*
* Revision 1.11 2000/09/01 02:12:54 robertj
* Added ability to select a gatekeeper on LAN via it's identifier name.
*
* Revision 1.10 2000/07/11 19:20:02 robertj
* Fixed problem with endpoint identifiers from some gatekeepers not being a string, just binary info.
*
* Revision 1.9 2000/06/20 03:17:56 robertj
* Added function to get name of gatekeeper, subtle difference from getting identifier.
*
* Revision 1.8 2000/05/18 11:53:33 robertj
* Changes to support doc++ documentation generation.
*
* Revision 1.7 2000/05/09 08:52:36 robertj
* Added support for preGrantedARQ fields on registration.
*
* Revision 1.6 2000/05/02 04:32:24 robertj
* Fixed copyright notice comment.
*
* Revision 1.5 2000/04/11 03:10:40 robertj
* Added ability to reject reason on gatekeeper requests.
* Added ability to get the transport being used to talk to the gatekeeper.
*
* Revision 1.4 2000/04/10 17:37:13 robertj
* Added access function to get the gatekeeper identification string.
*
* Revision 1.3 1999/12/09 21:49:17 robertj
* Added reregister on unregister and time to live reregistration
*
* Revision 1.2 1999/09/14 06:52:54 robertj
* Added better support for multi-homed client hosts.
*
* Revision 1.1 1999/08/31 12:34:18 robertj
* Added gatekeeper support.
*
*/
#ifndef __OPAL_GKCLIENT_H
#define __OPAL_GKCLIENT_H
#include "h323.h"
#include "h225ras.h"
#include "h235auth.h"
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#ifdef H323_H460
class H460_FeatureSet;
#endif
class H225_ArrayOf_AliasAddress;
class H225_H323_UU_PDU;
class H225_AlternateGK;
class H225_ArrayOf_AlternateGK;
class H225_ArrayOf_ServiceControlSession;
///////////////////////////////////////////////////////////////////////////////
/**This class embodies the H.225.0 RAS protocol to gatekeepers.
*/
class H323Gatekeeper : public H225_RAS
{
PCLASSINFO(H323Gatekeeper, H225_RAS);
public:
/**@name Construction */
//@{
/**Create a new gatekeeper.
*/
H323Gatekeeper(
H323EndPoint & endpoint, ///< Endpoint gatekeeper is associated with.
H323Transport * transport ///< Transport over which gatekeepers communicates.
);
/**Destroy gatekeeper.
*/
~H323Gatekeeper();
//@}
/**@name Overrides from H225_RAS */
//@{
PBoolean OnReceiveGatekeeperConfirm(const H225_GatekeeperConfirm & gcf);
PBoolean OnReceiveGatekeeperReject(const H225_GatekeeperReject & grj);
PBoolean OnReceiveRegistrationConfirm(const H225_RegistrationConfirm & rcf);
PBoolean OnReceiveRegistrationReject(const H225_RegistrationReject & rrj);
PBoolean OnReceiveUnregistrationRequest(const H225_UnregistrationRequest & urq);
PBoolean OnReceiveUnregistrationConfirm(const H225_UnregistrationConfirm & ucf);
PBoolean OnReceiveUnregistrationReject(const H225_UnregistrationReject & urj);
PBoolean OnReceiveAdmissionConfirm(const H225_AdmissionConfirm & acf);
PBoolean OnReceiveAdmissionReject(const H225_AdmissionReject & arj);
PBoolean OnReceiveDisengageRequest(const H225_DisengageRequest & drq);
PBoolean OnReceiveBandwidthConfirm(const H225_BandwidthConfirm & bcf);
PBoolean OnReceiveBandwidthRequest(const H225_BandwidthRequest & brq);
PBoolean OnReceiveInfoRequest(const H225_InfoRequest & irq);
PBoolean OnReceiveServiceControlIndication(const H225_ServiceControlIndication &);
PBoolean SendServiceControlIndication();
void OnSendGatekeeperRequest(H225_GatekeeperRequest & grq);
void OnSendAdmissionRequest(H225_AdmissionRequest & arq);
PBoolean OnSendFeatureSet(unsigned, H225_FeatureSet & features) const;
void OnReceiveFeatureSet(unsigned, const H225_FeatureSet & features) const;
//@}
/**@name Protocol operations */
//@{
/**Discover a gatekeeper on the local network.
*/
PBoolean DiscoverAny();
/**Discover a gatekeeper on the local network.
If the identifier string is empty then the first gatekeeper to respond
to a broadcast is used.
*/
PBoolean DiscoverByName(
const PString & identifier ///< Gatekeeper identifier to find
);
/**Discover a gatekeeper on the local network.
If the address string is empty then the first gatekeeper to respond
to a broadcast is used.
*/
PBoolean DiscoverByAddress(
const H323TransportAddress & address ///< Address of gatekeeper.
);
/**Discover a gatekeeper on the local network.
Combination of DiscoverByName() and DiscoverByAddress().
*/
PBoolean DiscoverByNameAndAddress(
const PString & identifier,
const H323TransportAddress & address
);
/**Register with gatekeeper.
*/
PBoolean RegistrationRequest(
PBoolean autoReregister = TRUE ///< Automatic register on unregister
);
/**Unregister with gatekeeper.
*/
PBoolean UnregistrationRequest(
int reason ///< Reason for unregistration
);
/**Location request to gatekeeper.
*/
PBoolean LocationRequest(
const PString & alias, ///< Alias name we wish to find.
H323TransportAddress & address ///< Resultant transport address.
);
/**Location request to gatekeeper.
*/
PBoolean LocationRequest(
const PStringList & aliases, ///< Alias names we wish to find.
H323TransportAddress & address ///< Resultant transport address.
);
struct AdmissionResponse {
AdmissionResponse();
unsigned rejectReason; ///< Reject reason if returns FALSE
PBoolean gatekeeperRouted; ///< Flag for call is through gk
PINDEX endpointCount; ///< Number of endpoints that can be returned
H323TransportAddress * transportAddress; ///< Transport address or remote endpoint.
PBYTEArray * accessTokenData; ///< iNow Gatekeeper Access Token data
H225_ArrayOf_AliasAddress * aliasAddresses; ///< DestinationInfo to use in SETUP if not empty
H225_ArrayOf_AliasAddress * destExtraCallInfo; ///< DestinationInfo to use in SETUP if not empty
};
/**Admission request to gatekeeper.
*/
PBoolean AdmissionRequest(
H323Connection & connection, ///< Connection we wish to change.
AdmissionResponse & response, ///< Response parameters to ARQ
PBoolean ignorePreGrantedARQ = FALSE ///< Flag to force ARQ to be sent
);
/**Disengage request to gatekeeper.
*/
PBoolean DisengageRequest(
const H323Connection & connection, ///< Connection we wish admitted.
unsigned reason ///< Reason code for disengage
);
/**Bandwidth request to gatekeeper.
*/
PBoolean BandwidthRequest(
H323Connection & connection, ///< Connection we wish to change.
unsigned requestedBandwidth ///< New bandwidth wanted in 0.1kbps
);
/**Send an unsolicited info response to the gatekeeper.
*/
void InfoRequestResponse();
/**Send an unsolicited info response to the gatekeeper.
*/
void InfoRequestResponse(
const H323Connection & connection ///< Connection to send info about
);
/**Send an unsolicited info response to the gatekeeper.
*/
void InfoRequestResponse(
const H323Connection & connection, ///< Connection to send info about
const H225_H323_UU_PDU & pdu, ///< PDU that was sent or received
PBoolean sent ///< Flag for PDU was sent or received
);
#ifdef H323_H248
/**Handle incoming service control session information.
*/
virtual void OnServiceControlSessions(
const H225_ArrayOf_ServiceControlSession & serviceControl,
H323Connection * connection
);
#endif
//@}
/**@name Member variable access */
//@{
/**Determine if the endpoint has discovered the gatekeeper.
*/
PBoolean IsDiscoveryComplete() const { return discoveryComplete; }
/**Determine if the endpoint is registered with the gatekeeper.
*/
PBoolean IsRegistered() const { return registrationFailReason == RegistrationSuccessful; }
/** Force the client to reregister with gatekeeper (used with H.460 features)
*/
void ReRegisterNow();
enum RegistrationFailReasons {
RegistrationSuccessful,
UnregisteredLocally,
UnregisteredByGatekeeper,
GatekeeperLostRegistration,
InvalidListener,
DuplicateAlias,
SecurityDenied,
TransportError,
NumRegistrationFailReasons,
RegistrationRejectReasonMask = 0x8000
};
/**Get the registration fail reason.
*/
RegistrationFailReasons GetRegistrationFailReason() const { return registrationFailReason; }
/**Get the gatekeeper name.
The gets the name of the gatekeeper. It will be of the form id@address
where id is the gatekeeperIdentifier and address is the transport
address used. If the gatekeeperIdentifier is empty the '@' is not
included and only the transport is shown. The transport is minimised
also, with the type removed if IP is used and the :port removed if the
default port is used.
*/
PString GetName() const;
/** Get the endpoint identifier
*/
const PString & GetEndpointIdentifier() const { return endpointIdentifier; }
/**Set the H.235 password in the gatekeeper.
If no username is present then it will default to the endpoint local
user name (ie first alias).
*/
void SetPassword(
const PString & password, ///< New password
const PString & username = PString() ///< Username for password
);
/*
* Return the call signalling address for the gatekeeper (if present)
*/
H323TransportAddress GetGatekeeperRouteAddress() const
{ return gkRouteAddress; }
//@}
protected:
PBoolean StartDiscovery(const H323TransportAddress & address);
unsigned SetupGatekeeperRequest(H323RasPDU & request);
void Connect(const H323TransportAddress & address, const PString & gatekeeperIdentifier);
PDECLARE_NOTIFIER(PThread, H323Gatekeeper, MonitorMain);
PDECLARE_NOTIFIER(PTimer, H323Gatekeeper, TickleMonitor);
void RegistrationTimeToLive();
void SetInfoRequestRate(
const PTimeInterval & rate
);
void ClearInfoRequestRate();
H225_InfoRequestResponse & BuildInfoRequestResponse(
H323RasPDU & response,
unsigned seqNum
);
PBoolean SendUnsolicitedIRR(
H225_InfoRequestResponse & irr,
H323RasPDU & response
);
void SetAlternates(
const H225_ArrayOf_AlternateGK & alts,
PBoolean permanent
);
void SetAssignedGatekeeper(
const H225_AlternateGK & gk
);
PBoolean GetAssignedGatekeeper(
H225_AlternateGK & gk
);
virtual PBoolean MakeRequest(
Request & request
);
PBoolean MakeRequestWithReregister(
Request & request,
unsigned unregisteredTag
);
// Gatekeeper registration state variables
PBoolean discoveryComplete;
PString endpointIdentifier;
PString localId;
RegistrationFailReasons registrationFailReason;
PMutex RegisterMutex;
class AlternateInfo : public PObject {
PCLASSINFO(AlternateInfo, PObject);
public:
AlternateInfo(const H225_AlternateGK & alt);
~AlternateInfo();
H225_AlternateGK GetAlternate();
Comparison Compare(const PObject & obj);
void PrintOn(ostream & strm) const;
H323TransportAddress rasAddress;
PString gatekeeperIdentifier;
unsigned priority;
enum {
NoRegistrationNeeded,
NeedToRegister,
Register,
IsRegistered,
RegistrationFailed
} registrationState;
private:
// Disable copy constructor and assignment
AlternateInfo(const AlternateInfo &) { }
AlternateInfo & operator=(const AlternateInfo &) { return *this; }
};
PSortedList<AlternateInfo> alternates;
PBoolean alternatePermanent;
PSemaphore requestMutex;
H235Authenticators authenticators;
AlternateInfo * assignedGK;
enum {
RequireARQ,
PregrantARQ,
PreGkRoutedARQ
} pregrantMakeCall, pregrantAnswerCall;
H323TransportAddress gkRouteAddress;
// Gatekeeper operation variables
PBoolean autoReregister;
PBoolean reregisterNow;
PTimer timeToLive;
PBoolean requiresDiscovery;
PTimer infoRequestRate;
PBoolean willRespondToIRR;
PThread * monitor;
PBoolean monitorStop;
PSyncPoint monitorTickle;
#ifdef H323_H248
PDictionary<POrdinalKey, H323ServiceControlSession> serviceControlSessions;
#endif
#ifdef H323_H460
H460_FeatureSet * features;
#endif
};
PLIST(H323GatekeeperList, H323Gatekeeper);
#endif // __OPAL_GKCLIENT_H
/////////////////////////////////////////////////////////////////////////////
|