/usr/include/qxmpp/QXmppStun.h is in libqxmpp-dev 0.9.3-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 | /*
* Copyright (C) 2008-2014 The QXmpp developers
*
* Author:
* Jeremy Lainé
*
* Source:
* https://github.com/qxmpp-project/qxmpp
*
* This file is a part of QXmpp library.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
*/
#ifndef QXMPPSTUN_H
#define QXMPPSTUN_H
#include <QObject>
#include "QXmppLogger.h"
#include "QXmppJingleIq.h"
class CandidatePair;
class QDataStream;
class QUdpSocket;
class QTimer;
class QXmppIceComponentPrivate;
class QXmppIceConnectionPrivate;
class QXmppIcePrivate;
/// \internal
///
/// The QXmppStunMessage class represents a STUN message.
///
class QXMPP_EXPORT QXmppStunMessage
{
public:
enum MethodType {
Binding = 0x1,
SharedSecret = 0x2,
Allocate = 0x3,
Refresh = 0x4,
Send = 0x6,
Data = 0x7,
CreatePermission = 0x8,
ChannelBind = 0x9
};
enum ClassType {
Request = 0x000,
Indication = 0x010,
Response = 0x100,
Error = 0x110
};
QXmppStunMessage();
quint32 cookie() const;
void setCookie(quint32 cookie);
QByteArray id() const;
void setId(const QByteArray &id);
quint16 messageClass() const;
quint16 messageMethod() const;
quint16 type() const;
void setType(quint16 type);
// attributes
quint32 changeRequest() const;
void setChangeRequest(quint32 changeRequest);
quint16 channelNumber() const;
void setChannelNumber(quint16 channelNumber);
QByteArray data() const;
void setData(const QByteArray &data);
quint32 lifetime() const;
void setLifetime(quint32 changeRequest);
QByteArray nonce() const;
void setNonce(const QByteArray &nonce);
quint32 priority() const;
void setPriority(quint32 priority);
QString realm() const;
void setRealm(const QString &realm);
QByteArray reservationToken() const;
void setReservationToken(const QByteArray &reservationToken);
quint8 requestedTransport() const;
void setRequestedTransport(quint8 requestedTransport);
QString software() const;
void setSoftware(const QString &software);
QString username() const;
void setUsername(const QString &username);
QByteArray encode(const QByteArray &key = QByteArray(), bool addFingerprint = true) const;
bool decode(const QByteArray &buffer, const QByteArray &key = QByteArray(), QStringList *errors = 0);
QString toString() const;
static quint16 peekType(const QByteArray &buffer, quint32 &cookie, QByteArray &id);
// attributes
int errorCode;
QString errorPhrase;
QByteArray iceControlling;
QByteArray iceControlled;
QHostAddress changedHost;
quint16 changedPort;
QHostAddress mappedHost;
quint16 mappedPort;
QHostAddress otherHost;
quint16 otherPort;
QHostAddress sourceHost;
quint16 sourcePort;
QHostAddress xorMappedHost;
quint16 xorMappedPort;
QHostAddress xorPeerHost;
quint16 xorPeerPort;
QHostAddress xorRelayedHost;
quint16 xorRelayedPort;
bool useCandidate;
private:
quint32 m_cookie;
QByteArray m_id;
quint16 m_type;
// attributes
QSet<quint16> m_attributes;
quint32 m_changeRequest;
quint16 m_channelNumber;
QByteArray m_data;
quint32 m_lifetime;
QByteArray m_nonce;
quint32 m_priority;
QString m_realm;
quint8 m_requestedTransport;
QByteArray m_reservationToken;
QString m_software;
QString m_username;
};
/// \brief The QXmppIceComponent class represents a piece of a media stream
/// requiring a single transport address, as defined by RFC 5245
/// (Interactive Connectivity Establishment).
class QXMPP_EXPORT QXmppIceComponent : public QXmppLoggable
{
Q_OBJECT
public:
~QXmppIceComponent();
int component() const;
bool isConnected() const;
QList<QXmppJingleCandidate> localCandidates() const;
static QList<QHostAddress> discoverAddresses();
static QList<QUdpSocket*> reservePorts(const QList<QHostAddress> &addresses, int count, QObject *parent = 0);
public slots:
void close();
void connectToHost();
qint64 sendDatagram(const QByteArray &datagram);
private slots:
void checkCandidates();
void handleDatagram(const QByteArray &datagram, const QHostAddress &host, quint16 port);
void turnConnected();
void transactionFinished();
void updateGatheringState();
void writeStun(const QXmppStunMessage &request);
signals:
/// \brief This signal is emitted once ICE negotiation succeeds.
void connected();
/// \brief This signal is emitted when a data packet is received.
void datagramReceived(const QByteArray &datagram);
/// \internal This signal is emitted when the gathering state of local candidates changes.
void gatheringStateChanged();
/// \brief This signal is emitted when the list of local candidates changes.
void localCandidatesChanged();
private:
QXmppIceComponent(int component, QXmppIcePrivate *config, QObject *parent=0);
QXmppIceComponentPrivate *d;
friend class QXmppIceComponentPrivate;
friend class QXmppIceConnection;
};
/// \brief The QXmppIceConnection class represents a set of UDP sockets
/// capable of performing Interactive Connectivity Establishment (RFC 5245).
///
/// A typical example is:
///
/// \code
/// QXmppIceConnection *connection = new QXmppIceConnection();
/// connection->setIceControlling(true);
/// connection->addComponent(1);
///
/// // if needed, set STUN / TURN configuration
/// // connection->setStunServer(..);
/// // connection->setTurnServer(..);
///
/// // start listening
/// connection->bind(QXmppIceComponent::discoverAddresses());
///
/// // receive remote information: user, password, candidates
/// // ...
///
/// // set remote information and start connecting
/// connection->setRemoteUser("foo");
/// connection->setRemoteUser("bar");
/// connection->addRemoteCandidate(..);
/// connection->connectToHost();
///
/// \endcode
class QXMPP_EXPORT QXmppIceConnection : public QXmppLoggable
{
Q_OBJECT
Q_ENUMS(GatheringState)
Q_PROPERTY(QXmppIceConnection::GatheringState gatheringState READ gatheringState NOTIFY gatheringStateChanged)
public:
enum GatheringState
{
NewGatheringState,
BusyGatheringState,
CompleteGatheringState
};
QXmppIceConnection(QObject *parent = 0);
~QXmppIceConnection();
QXmppIceComponent *component(int component);
void addComponent(int component);
void setIceControlling(bool controlling);
QList<QXmppJingleCandidate> localCandidates() const;
QString localUser() const;
QString localPassword() const;
void addRemoteCandidate(const QXmppJingleCandidate &candidate);
void setRemoteUser(const QString &user);
void setRemotePassword(const QString &password);
void setStunServer(const QHostAddress &host, quint16 port = 3478);
void setTurnServer(const QHostAddress &host, quint16 port = 3478);
void setTurnUser(const QString &user);
void setTurnPassword(const QString &password);
bool bind(const QList<QHostAddress> &addresses);
bool isConnected() const;
GatheringState gatheringState() const;
signals:
/// \brief This signal is emitted once ICE negotiation succeeds.
void connected();
/// \brief This signal is emitted when ICE negotiation fails.
void disconnected();
/// \brief This signal is emitted when the gathering state of local candidates changes.
void gatheringStateChanged();
/// \brief This signal is emitted when the list of local candidates changes.
void localCandidatesChanged();
public slots:
void close();
void connectToHost();
private slots:
void slotConnected();
void slotGatheringStateChanged();
void slotTimeout();
private:
QXmppIceConnectionPrivate *d;
};
#endif
|