add tls options and quic test case

Author: sutext

Demo/MQTTDemo.xcodeproj/project.pbxproj

@@ -35,9 +35,22 @@
 		33CC16C22D0994790063F140 /* MQTTDemoUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = MQTTDemoUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 /* End PBXFileReference section */
 
+/* Begin PBXFileSystemSynchronizedBuildFileExceptionSet section */
+		33F3395E2D1D59C0006B97F0 /* Exceptions for "MQTTDemo" folder in "MQTTDemo" target */ = {
+			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
+			membershipExceptions = (
+				Info.plist,
+			);
+			target = 33CC16A72D0994760063F140 /* MQTTDemo */;
+		};
+/* End PBXFileSystemSynchronizedBuildFileExceptionSet section */
+
 /* Begin PBXFileSystemSynchronizedRootGroup section */
 		33CC16AA2D0994760063F140 /* MQTTDemo */ = {
 			isa = PBXFileSystemSynchronizedRootGroup;
+			exceptions = (
+				33F3395E2D1D59C0006B97F0 /* Exceptions for "MQTTDemo" folder in "MQTTDemo" target */,
+			);
 			path = MQTTDemo;
 			sourceTree = "<group>";
 		};
@@ -424,6 +437,7 @@
 				DEVELOPMENT_TEAM = 24L372QN9V;
 				ENABLE_PREVIEWS = YES;
 				GENERATE_INFOPLIST_FILE = YES;
+				INFOPLIST_FILE = MQTTDemo/Info.plist;
 				INFOPLIST_KEY_UIApplicationSceneManifest_Generation = YES;
 				INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
 				INFOPLIST_KEY_UILaunchScreen_Generation = YES;
@@ -453,6 +467,7 @@
 				DEVELOPMENT_TEAM = 24L372QN9V;
 				ENABLE_PREVIEWS = YES;
 				GENERATE_INFOPLIST_FILE = YES;
+				INFOPLIST_FILE = MQTTDemo/Info.plist;
 				INFOPLIST_KEY_UIApplicationSceneManifest_Generation = YES;
 				INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
 				INFOPLIST_KEY_UILaunchScreen_Generation = YES;

Demo/MQTTDemo/Info.plist

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>NSAppTransportSecurity</key>
+	<dict>
+		<key>NSAllowsArbitraryLoads</key>
+		<true/>
+	</dict>
+</dict>
+</plist>

Demo/MQTTDemo/MQTTClient.swift

@@ -9,7 +9,6 @@ import MQTTNIO
 import MQTT
 import CocoaMQTT
 import Foundation
-import Network
 
 let client = MQTTClient()
 //let mqtt = {
@@ -23,37 +22,31 @@ let client = MQTTClient()
 //    m.delegate = client
 //    return m
 //}()
+
 let mqtt = {
-    let params = NWParameters.tls
-    let endpoint = NWEndpoint.hostPort(host: "broker.beta.jagat.io", port: 1883)
-    let m = MQTT.ClientV5("swift-mqtt", endpoint: endpoint, params: .tcp)
+    var options = TLS.Options()
+    if let file = Bundle.main.path(forResource: "client", ofType: "p12"){
+        do {
+            options.credential = try .create(from: file, passwd: "123456")
+        } catch  {
+            print(error)
+        }
+    }
+    options.verify = .trustAll
+    options.serverName = "docs"
+    options.minVersion = .v1_3
+    options.maxVersion = .v1_3
+    options.quicOptions = .init()
+    options.quicOptions?.isDatagram = true
+    let m = MQTT.ClientV5("swift-mqtt", endpoint: .quic(host: "docs.lerjin.com",options: options))
     m.config.username = "jagat-mqtt-pwd-im"
     m.config.password = "jagat-mqtt-pwd-im"
     m.usingMonitor()
     m.usingRetrier()
     MQTT.Logger.level = .debug
     return m
 }()
-extension NWParameters{
-    var isTCP:Bool{
-        if let _ = self.defaultProtocolStack.transportProtocol as? NWProtocolTCP.Options{
-            return true
-        }
-        return false
-    }
-    var isUDP:Bool{
-        if let _ = self.defaultProtocolStack.transportProtocol as? NWProtocolUDP.Options{
-            return true
-        }
-        return false
-    }
-    var isQUIC:Bool{
-        if let _ = self.defaultProtocolStack.transportProtocol as? NWProtocolQUIC.Options{
-            return true
-        }
-        return false
-    }
-}
+
 //let mqtt = {
 //    let params = NWParameters.tls
 //    let endpoint = NWEndpoint.hostPort(host: "broker.beta.jagat.io", port: 1883)

Package.resolved

@@ -13,7 +13,7 @@ import Promise
 
 public protocol MQTTDelegate:AnyObject{
     func mqtt(_ mqtt: MQTT, didUpdate status:MQTT.Status,prev:MQTT.Status)
-    func mqtt(_ mqtt: MQTT, didReceive error:Message)
+    func mqtt(_ mqtt: MQTT, didReceive error:MQTT.Message)
     func mqtt(_ mqtt: MQTT, didReceive error:Error)
 
 }
@@ -34,9 +34,9 @@ extension MQTT{
         ///   - clientID: Client Identifier
         ///   - endpoint:The network endpoint
         ///   - params: The connection parameters `default` is `.tls`
-        public init(_ clientId: String, endpoint:NWEndpoint,params:NWParameters = .tls) {
+        public init(_ clientId: String, endpoint:Endpoint) {
             self.config = Config(.v3_1_1,clientId:clientId)
-            self.socket = Socket(self.config,endpoint: endpoint, params: params)
+            self.socket = Socket(self.config,endpoint: endpoint)
         }
     }
 }
@@ -75,10 +75,26 @@ extension MQTT.Client{
     }
 }
 extension MQTT.Client{
-    /// Close  gracefully by sending close frame
+    /// Close from server
+    /// - Parameters:
+    ///   - reason: close reason code send to the server
+    /// - Returns: Future waiting on disconnect message to be sent
+    ///
     @discardableResult
-    public func close(_ code:ReasonCode = .success)->Promise<Void>{
-        self.close(packet: DisconnectPacket(reason: code))
+    public func close(_ reason:MQTT.CloseReason = .normalClose)->Promise<Void>{
+        var packet = DisconnectPacket()
+        if case .disconnect(let reasonCode, let properties) = reason{
+            switch config.version {
+            case .v5_0:
+                packet = .init(reason: reasonCode,properties: properties)
+            case .v3_1_1:
+                packet = .init(reason: reasonCode)
+            }
+        }
+        return self.socket.sendNoWait(packet).map { _ in
+            self.socket.directClose(reason: reason)
+            return Promise(())
+        }
     }
     /// Connect to MQTT server
     ///
@@ -102,7 +118,7 @@ extension MQTT.Client{
     ) -> Promise<Bool> {
 
         let message = will.map {
-            Message(
+            MQTT.Message(
                 qos: .atMostOnce,
                 dup: false,
                 topic: $0.topic,
@@ -146,7 +162,7 @@ extension MQTT.Client{
         qos: MQTTQoS  = .atLeastOnce,
         retain: Bool = false
     ) -> Promise<Void> {
-        let message = Message(qos: qos, dup: false, topic: topic, retain: retain, payload: payload, properties: [])
+        let message = MQTT.Message(qos: qos, dup: false, topic: topic, retain: retain, payload: payload, properties: [])
         let packetId = self.nextPacketId()
         let packet = PublishPacket(id:packetId,message: message)
         return self.publish(packet: packet).then { _ in }
@@ -255,7 +271,7 @@ extension MQTT.Client {
         switch self.config.version {
         case .v3_1_1:
             if connack.returnCode != 0 {
-                let returnCode = MQTTError.ConnectionReturnValue(rawValue: connack.returnCode) ?? .unrecognizedReturnValue
+                let returnCode = ConnectRetrunCode(rawValue: connack.returnCode) ?? .unrecognizedReturnValue
                 throw MQTTError.connectionError(returnCode)
             }
         case .v5_0:
@@ -319,26 +335,26 @@ extension MQTT.Client {
         // check publish validity
         // check qos against server max qos
         guard self.connParams.maxQoS.rawValue >= packet.message.qos.rawValue else {
-            return .init(MQTTPacketError.qosInvalid)
+            return .init(PacketError.qosInvalid)
         }
         // check if retain is available
         guard packet.message.retain == false || self.connParams.retainAvailable else {
-            return .init(MQTTPacketError.retainUnavailable)
+            return .init(PacketError.retainUnavailable)
         }
         for p in packet.message.properties {
             // check topic alias
             if case .topicAlias(let alias) = p {
                 guard alias <= self.connParams.maxTopicAlias, alias != 0 else {
-                    return .init(MQTTPacketError.topicAliasOutOfRange)
+                    return .init(PacketError.topicAliasOutOfRange)
                 }
             }
             if case .subscriptionIdentifier = p {
-                return .init(MQTTPacketError.publishIncludesSubscription)
+                return .init(PacketError.publishIncludesSubscription)
             }
         }
         // check topic name
         guard !packet.message.topic.contains(where: { $0 == "#" || $0 == "+" }) else {
-            return .init(MQTTPacketError.invalidTopicName)
+            return .init(PacketError.invalidTopicName)
         }
 
         if packet.message.qos == .atMostOnce {
@@ -390,7 +406,7 @@ extension MQTT.Client {
     /// - Returns: Future waiting for subscribe to complete. Will wait for SUBACK message from server
     func subscribe(packet: SubscribePacket) -> Promise<SubackPacket> {
         guard packet.subscriptions.count > 0 else {
-            return .init((MQTTPacketError.atLeastOneTopicRequired))
+            return .init((PacketError.atLeastOneTopicRequired))
         }
         return self.socket.sendPacket(packet).then { ack in
             if let suback = ack as? SubackPacket{
@@ -404,7 +420,7 @@ extension MQTT.Client {
     /// - Returns: Future waiting for subscribe to complete. Will wait for SUBACK message from server
     func unsubscribe(packet: UnsubscribePacket) -> Promise<SubackPacket> {
         guard packet.subscriptions.count > 0 else {
-            return .init((MQTTPacketError.atLeastOneTopicRequired))
+            return .init((PacketError.atLeastOneTopicRequired))
         }
         return self.socket.sendPacket(packet).then { ack in
             if let suback = ack as? SubackPacket{
@@ -413,11 +429,6 @@ extension MQTT.Client {
             throw MQTTError.unexpectedMessage
         }
     }
-    /// Close  from server
-    /// - Returns: Future waiting on disconnect message to be sent
-    func close(packet: DisconnectPacket) -> Promise<Void> {
-        return self.socket.sendNoWait(packet)
-    }
 
     func auth(packet: AuthPacket) -> Promise<Packet> {
         return self.socket.sendPacket(packet)

Sources/MQTT/Client.swift

@@ -21,8 +21,8 @@ extension MQTT{
         ///   - clientID: Client Identifier
         ///   - endpoint:The network endpoint
         ///   - params: The connection parameters `default` is `.tls`
-        public init(_ clientId: String, endpoint:NWEndpoint,params:NWParameters = .tls) {
-            self.client = Client(clientId, endpoint: endpoint,params: params)
+        public init(_ clientId: String, endpoint:Endpoint) {
+            self.client = Client(clientId, endpoint: endpoint)
             self.client.config.version = .v5_0
         }
     }
@@ -83,7 +83,7 @@ extension MQTT.ClientV5{
     ///     received. QoS1 and above return an `MQTTAckV5` which contains a `reason` and `properties`
     @discardableResult
     public func publish(to topic:String,payload:Data,qos:MQTTQoS = .atLeastOnce, retain:Bool = false,properties:Properties = []) ->Promise<AckV5?> {
-        let message = Message(qos: qos, dup: false, topic: topic, retain: retain, payload: payload, properties: properties)
+        let message = MQTT.Message(qos: qos, dup: false, topic: topic, retain: retain, payload: payload, properties: properties)
         let packet = PublishPacket(id: client.nextPacketId(),message: message)
         return client.publish(packet: packet)
     }
@@ -168,7 +168,7 @@ extension MQTT.ClientV5{
     ) -> Promise<ConnackV5> {
 
         let publish = will.map {
-            Message(
+            MQTT.Message(
                 qos: .atMostOnce,
                 dup: false,
                 topic: $0.topic,
@@ -197,13 +197,12 @@ extension MQTT.ClientV5{
     }
     /// Close from server
     /// - Parameters:
-    ///   - code: close reason code send to the server
-    ///   - properties: properties to attach to disconnect packet
+    ///   - reason: close reason code send to the server
     /// - Returns: Future waiting on disconnect message to be sent
     ///
     @discardableResult
-    public func close(_ code:ReasonCode = .success,properties:Properties = [])->Promise<Void>{
-        self.client.close(packet: DisconnectPacket(reason: code,properties: properties))
+    public func close(_ reason:MQTT.CloseReason = .normalClose)->Promise<Void>{
+        self.client.close(reason)
     }
     /// Re-authenticate with server
     ///

Sources/MQTT/ClientV5.swift

@@ -6,29 +6,11 @@
 //
 
 import Foundation
-
+import Network
 
 
 /// MQTTClient errors
-public enum MQTTError: Error {
-    /// Value returned in connection error
-    public enum ConnectionReturnValue: UInt8, Sendable {
-        /// connection was accepted
-        case accepted = 0
-        /// The Server does not support the version of the MQTT protocol requested by the Client.
-        case unacceptableProtocolVersion = 1
-        /// The Client Identifier is a valid string but is not allowed by the Server.
-        case identifierRejected = 2
-        /// The MQTT Server is not available.
-        case serverUnavailable = 3
-        /// The Server does not accept the User Name or Password specified by the Client
-        case badUserNameOrPassword = 4
-        /// The client is not authorized to connect
-        case notAuthorized = 5
-        /// Return code was unrecognised
-        case unrecognizedReturnValue = 0xFF
-    }
-
+public enum MQTTError:Sendable,Equatable, Swift.Error {
     /// You called connect on a client that is already connected to the broker
     case alreadyConnected
     /// You called connect on a client that is already connected to the broker
@@ -38,7 +20,7 @@ public enum MQTTError: Error {
     /// We received an unexpected message while connecting
     case failedToConnect
     /// We received an unsuccessful connection return value
-    case connectionError(ConnectionReturnValue)
+    case connectionError(ConnectRetrunCode)
     /// We received an unsuccessful return value from either a connect or publish
     case reasonError(ReasonCode)
     /// client in not connected
@@ -69,7 +51,7 @@ public enum MQTTError: Error {
 }
 
 /// Errors generated by bad packets sent by the client
-public enum MQTTPacketError:Swift.Error {
+public enum PacketError:Sendable,Equatable,Swift.Error {
     case badParameter
     /// Packet sent contained invalid entries
     /// QoS is not accepted by this connection as it is greater than the accepted value
@@ -85,3 +67,14 @@ public enum MQTTPacketError:Swift.Error {
     /// client to server publish packets cannot include a subscription identifier
     case publishIncludesSubscription
 }
+
+public enum DecodeError:Sendable,Equatable,Swift.Error{
+    /// Read variable length overflow
+    case variableLengthOverflow
+    /// some network error
+    case networkError(_ error:NWError)
+    /// got unexpected data length when read
+    case unexpectedDataLength
+    /// Failed to recognise the packet control type
+    case unrecognisedPacketType
+}

Sources/MQTT/MQTTError.swift renamed to Sources/MQTT/Errors.swift

@@ -43,6 +43,7 @@ extension MQTT.Logger{
         case debug = 0, info, warning, error, off
     }
 }
+
 /// Indicates the level of assurance for delivery of a packet.
 public enum MQTTQoS: UInt8, Sendable {
     /// fire and forget