/*
* Copyright (c) 2010, 2011, 2012, 2013, 2016
* Jonathan Schleifer <js@heap.zone>
* Copyright (c) 2011, 2012, Florian Zeitz <florob@babelmonkeys.de>
*
* https://heap.zone/objxmpp/
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice is present in all copies.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#import <ObjFW/ObjFW.h>
#import "XMPPCallback.h"
#import "XMPPStorage.h"
OF_ASSUME_NONNULL_BEGIN
@class XMPPConnection;
@class XMPPJID;
@class XMPPIQ;
@class XMPPMessage;
@class XMPPPresence;
@class XMPPAuthenticator;
@class SSLSocket;
@class XMPPMulticastDelegate;
/*!
* @brief A protocol that should be (partially) implemented by delegates of a
* @ref XMPPConnection
*/
@protocol XMPPConnectionDelegate
@optional
/*!
* @brief This callback is called when the connection received an element.
*
* @param connection The connection that received the element
* @param element The element that was received
*/
- (void)connection: (XMPPConnection *)connection
didReceiveElement: (OFXMLElement *)element;
/*!
* @brief This callback is called when the connection sent an element.
*
* @param connection The connection that sent the element
* @param element The element that was sent
*/
- (void)connection: (XMPPConnection *)connection
didSendElement: (OFXMLElement *)element;
/*!
* @brief This callback is called when the connection sucessfully authenticated.
*
* @param connection The connection that was authenticated
*/
- (void)connectionWasAuthenticated: (XMPPConnection *)connection;
/*!
* @brief This callback is called when the connection was bound to a JID.
*
* @param connection The connection that was bound to a JID
* @param JID The JID the conecction was bound to
*/
- (void)connection: (XMPPConnection *)connection
wasBoundToJID: (XMPPJID *)JID;
/*!
* @brief This callback is called when the connection received an IQ stanza.
*
* @param connection The connection that received the stanza
* @param iq The IQ stanza that was received
*/
- (bool)connection: (XMPPConnection *)connection
didReceiveIQ: (XMPPIQ *)iq;
/*!
* @brief This callback is called when the connection received a presence
* stanza.
*
* @param connection The connection that received the stanza
* @param presence The presence stanza that was received
*/
- (void)connection: (XMPPConnection *)connection
didReceivePresence: (XMPPPresence *)presence;
/*!
* @brief This callback is called when the connection received a message stanza.
*
* @param connection The connection that received the stanza
* @param message The message stanza that was received
*/
- (void)connection: (XMPPConnection *)connection
didReceiveMessage: (XMPPMessage *)message;
/*!
* @brief This callback is called when the connection was closed.
*
* @param connection The connection that was closed
*/
- (void)connectionWasClosed: (XMPPConnection *)connection;
/*!
* @brief This callback is called when the connection threw an exception.
*
* This is only called for connections on which
* @ref XMPPConnection::handleConnection has been called.
*
* @param connection The connection which threw an exception
* @param exception The exception the connection threw
*/
- (void)connection: (XMPPConnection *)connection
didThrowException: (OFException *)exception;
/*!
* @brief This callback is called when the connection is about to upgrade to
* TLS.
*
* @param connection The connection that will upgraded to TLS
*/
- (void)connectionWillUpgradeToTLS: (XMPPConnection *)connection;
/*!
* @brief This callback is called when the connection was upgraded to use TLS.
*
* @param connection The connection that was upgraded to TLS
*/
- (void)connectionDidUpgradeToTLS: (XMPPConnection *)connection;
@end
/*!
* @brief A class which abstracts a connection to an XMPP service.
*/
@interface XMPPConnection: OFObject <OFXMLParserDelegate,
OFXMLElementBuilderDelegate>
{
id _socket;
OFXMLParser *_parser, *_oldParser;
OFXMLElementBuilder *_elementBuilder, *_oldElementBuilder;
OFString *_username, *_password, *_server, *_resource;
OFString *_privateKeyFile, *_certificateFile;
const char *_privateKeyPassphrase;
OFString *_domain, *_domainToASCII;
XMPPJID *_JID;
uint16_t _port;
id <XMPPStorage> _dataStorage;
OFString *_language;
XMPPMulticastDelegate *_delegates;
OFMutableDictionary OF_GENERIC(OFString *, XMPPCallback *) *_callbacks;
XMPPAuthenticator *_authModule;
bool _streamOpen;
bool _needsSession;
bool _encryptionRequired, _encrypted;
bool _supportsRosterVersioning;
bool _supportsStreamManagement;
unsigned int _lastID;
}
/*!
* The username to use for authentication.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *username;
/*!
* The password to use for authentication.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *password;
/*!
* The server to use for the connection.
*
* This is useful if the address of the server is different from the domain.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *server;
/*!
* The domain to connect to.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *domain;
/*!
* The resource to request for the connection.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *resource;
/*!
* The language to request for the connection.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *language;
/*!
* A private key file to use for authentication.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *privateKeyFile;
/*!
* A certificate file to use for authentication.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *certificateFile;
/*!
* The JID the server assigned to the connection after binding.
*/
@property (readonly, nonatomic) XMPPJID *JID;
/*!
* The port to connect to.
*/
@property uint16_t port;
/*!
* An object for data storage, conforming to the XMPPStorage protocol.
*/
@property OF_NULLABLE_PROPERTY (assign) id <XMPPStorage> dataStorage;
/*!
* The socket used for the connection.
*/
@property (readonly, nonatomic) OFTCPSocket *socket;
/*!
* Whether encryption is required.
*/
@property bool encryptionRequired;
/*!
* Whether the connection is encrypted.
*/
@property (readonly) bool encrypted;
/*!
* Whether roster versioning is supported.
*/
@property (readonly) bool supportsRosterVersioning;
/*!
* Whether stream management is supported.
*/
@property (readonly) bool supportsStreamManagement;
/*!
* Creates a new autoreleased XMPPConnection.
*
* @return A new autoreleased XMPPConnection
*/
+ (instancetype)connection;
/*!
* @brief Adds the specified delegate.
*
* @param delegate The delegate to add
*/
- (void)addDelegate: (id <XMPPConnectionDelegate>)delegate;
/*!
* @brief Removes the specified delegate.
*
* @param delegate The delegate to remove
*/
- (void)removeDelegate: (id <XMPPConnectionDelegate>)delegate;
/*!
* @brief Connects to the XMPP service.
*/
- (void)connect;
/*!
* @brief Closes the stream to the XMPP service
*/
- (void)close;
/*!
* @brief Checks the certificate presented by the server and sets the specified
* pointer to the reason why the certificate is not valid
*
* @param reason A pointer to an OFString which is set to a reason in case the
* certificate is not valid (otherwise, it does not touch it).
* Passing NULL means the reason is not stored anywhere.
* @return Whether the certificate is valid
*/
- (bool)checkCertificateAndGetReason:
(OFString *__autoreleasing _Nonnull *_Nullable)reason;
/*!
* @brief Adds the connection to the run loop.
*/
- (void)handleConnection;
/*!
* @brief Asynchronously connects to the server and adds the connection to the
* run loop.
*/
- (void)asyncConnectAndHandle;
/*!
* @brief Parses the specified buffer.
*
* This is useful for handling multiple connections at once.
*
* @param buffer The buffer to parse
* @param length The length of the buffer. If length is 0, it is assumed that
* the connection was closed.
*/
- (void)parseBuffer: (const void *)buffer
length: (size_t)length;
/*!
* @brief Sends an OFXMLElement, usually an XMPPStanza.
*
* @param element The element to send
*/
- (void)sendStanza: (OFXMLElement *)element;
/*!
* @brief Sends an XMPPIQ, registering a callback method.
*
* @param IQ The IQ to send
* @param target The object that contains the callback method
* @param selector The selector of the callback method,
* must take exactly one parameter of type `XMPPIQ *`
*/
- (void)sendIQ: (XMPPIQ *)IQ
callbackTarget: (id)target
selector: (SEL)selector;
#ifdef OF_HAVE_BLOCKS
/*!
* @brief Sends an XMPPIQ, registering a callback block.
*
* @param IQ The IQ to send
* @param block The callback block
*/
- (void)sendIQ: (XMPPIQ *)IQ
callbackBlock: (xmpp_callback_block_t)block;
#endif
/*!
* @brief Generates a new, unique stanza ID.
*
* @return A new, generated, unique stanza ID.
*/
- (OFString *)generateStanzaID;
@end
OF_ASSUME_NONNULL_END