diff --git a/Build/MQTTnet.Extensions.WebSocket4Net.nuspec b/Build/MQTTnet.Extensions.WebSocket4Net.nuspec new file mode 100644 index 00000000..054933ed --- /dev/null +++ b/Build/MQTTnet.Extensions.WebSocket4Net.nuspec @@ -0,0 +1,42 @@ + + + + MQTTnet.Extensions.WebSocket4Net + 0.0.0 + Christian Kratky + Christian Kratky + LICENSE + https://github.com/chkr1011/MQTTnet + https://raw.githubusercontent.com/chkr1011/MQTTnet/master/Images/Logo_128x128.png + false + This is an extension library which allows using _WebSocket4Net_ as transport for MQTTnet clients. + For release notes please go to MQTTnet release notes (https://www.nuget.org/packages/MQTTnet/). + Copyright Christian Kratky 2016-2019 + MQTT Message Queue Telemetry Transport MQTTClient MQTTServer Server MQTTBroker Broker NETStandard IoT InternetOfThings Messaging Hardware Arduino Sensor Actuator M2M ESP Smart Home Cities Automation Xamarin + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Build/MQTTnet.NETStandard.nuspec b/Build/MQTTnet.NETStandard.nuspec index 492532dd..c505dd18 100644 --- a/Build/MQTTnet.NETStandard.nuspec +++ b/Build/MQTTnet.NETStandard.nuspec @@ -9,7 +9,7 @@ https://github.com/chkr1011/MQTTnet https://raw.githubusercontent.com/chkr1011/MQTTnet/master/Images/Logo_128x128.png false - MQTTnet is a high performance .NET library for MQTT based communication. It provides a MQTT client and a MQTT server (broker). This package contains the .NET Standard version of the library only. + This package contains the .NET Standard version of MQTTnet only. For release notes please go to MQTTnet release notes (https://www.nuget.org/packages/MQTTnet/). Copyright Christian Kratky 2016-2019 MQTT Message Queue Telemetry Transport MQTTClient MQTTServer Server MQTTBroker Broker NETStandard IoT InternetOfThings Messaging Hardware Arduino Sensor Actuator M2M ESP Smart Home Cities Automation Xamarin diff --git a/Build/MQTTnet.nuspec b/Build/MQTTnet.nuspec index 2ecfc072..f0e4c3d3 100644 --- a/Build/MQTTnet.nuspec +++ b/Build/MQTTnet.nuspec @@ -9,9 +9,23 @@ https://github.com/chkr1011/MQTTnet https://raw.githubusercontent.com/chkr1011/MQTTnet/master/Images/Logo_128x128.png false - MQTTnet is a high performance .NET library for MQTT based communication. It provides a MQTT client and a MQTT server (broker). + MQTTnet is a high performance .NET library for MQTT based communication. It provides a MQTT client and a MQTT server (broker) and supports v3.1.0, v3.1.1 and v5.0.0 of the MQTT protocol. * [Core] Fixed issues in MQTTv5 message encoding and decoding. +* [Core] Added extension method to allow usage of _WebSocket4Net_ in clients to fix issues with AWS and Xamarin. +* [Core] Fixed usage of wrong data type for passwords (string -> byte[]). +* [Core] Fixed an _ObjectDisposedException_ when sending data using a WebSocket channel. +* [Client] Added support for extended authentication exchange. +* [Client] Exposed MQTTv5 CONNACK values to client. +* [Client] Added _MqttClientSubscribeOptionsBuilder_. +* [Client] The disconnected handler is now executed in a new task to prevent deadlocks when reconnecting etc. (thanks to @lizziebeans). +* [Client] Converted option _DualMode_ into nullable boolean to preserve original value and avoid exceptions in IPv4 only networks (thanks to @lavaflo). +* [Server] Exposed _ClientCertificateRequired_ and _CheckCertificateRevocation_ at TLS options. +* [Server] Exposed client certificate at client connection validator. +* [Server] The subscription interceptor now supports altering the entire topic filter. +* [Server] Exposed more properties to the connection validator context. +* [MQTTnet.Server] Added authentication support via Python script file. +* [MQTTnet.Server] Migrated the result of connection validations to _ReasonCode_ (MQTTv5) instead of _ReturnCode_ (MQTTv3 only) (BREAKING CHANGE!). Copyright Christian Kratky 2016-2019 MQTT Message Queue Telemetry Transport MQTTClient MQTTServer Server MQTTBroker Broker NETStandard IoT InternetOfThings Messaging Hardware Arduino Sensor Actuator M2M ESP Smart Home Cities Automation Xamarin diff --git a/Build/build.ps1 b/Build/build.ps1 index 3f5c487d..ac6e5c21 100644 --- a/Build/build.ps1 +++ b/Build/build.ps1 @@ -36,16 +36,59 @@ Write-Host &$msbuild ..\Source\MQTTnet.Extensions.ManagedClient\MQTTnet.Extensions.ManagedClient.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="netstandard2.0" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" &$msbuild ..\Source\MQTTnet.Extensions.ManagedClient\MQTTnet.Extensions.ManagedClient.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="uap10.0" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" -# Build MQTTnet.Server -Remove-Item ..\Source\MQTTnet.Server\bin\Release\netcoreapp2.2 -Recurse -Force -ErrorAction SilentlyContinue -&$msbuild ..\Source\MQTTnet.Server\MQTTnet.Server.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="netcoreapp2.2" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" +# Build the WebSocket4Net extension +&$msbuild ..\Source\MQTTnet.Extensions.WebSocket4Net\MQTTnet.Extensions.WebSocket4Net.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="net452" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" +&$msbuild ..\Source\MQTTnet.Extensions.WebSocket4Net\MQTTnet.Extensions.WebSocket4Net.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="net461" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" +&$msbuild ..\Source\MQTTnet.Extensions.WebSocket4Net\MQTTnet.Extensions.WebSocket4Net.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="netstandard1.3" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" +&$msbuild ..\Source\MQTTnet.Extensions.WebSocket4Net\MQTTnet.Extensions.WebSocket4Net.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="netstandard2.0" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" +&$msbuild ..\Source\MQTTnet.Extensions.WebSocket4Net\MQTTnet.Extensions.WebSocket4Net.csproj /t:Build /p:Configuration="Release" /p:TargetFramework="uap10.0" /p:FileVersion=$assemblyVersion /p:AssemblyVersion=$assemblyVersion /verbosity:m /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=".\..\..\Build\codeSigningKey.pfx" -$source = "..\Source\MQTTnet.Server\bin\Release\netcoreapp2.2" +#################################################################### + +# Build MQTTnet.Server Portable +&dotnet publish ..\Source\MQTTnet.Server\MQTTnet.Server.csproj --configuration Release /p:FileVersion=$assemblyVersion /p:Version=$nugetVersion + +$source = "..\Source\MQTTnet.Server\bin\Release\netcoreapp2.2\publish" $destination = "..\Source\MQTTnet.Server\bin\MQTTnet.Server-Portable-v$nugetVersion.zip" If(Test-path $destination) {Remove-item $destination} Add-Type -assembly "system.io.compression.filesystem" [io.compression.zipfile]::CreateFromDirectory($source, $destination) +#################################################################### + +# Build MQTTnet.Server Linux-x64 +&dotnet publish ..\Source\MQTTnet.Server\MQTTnet.Server.csproj --configuration Release /p:FileVersion=$assemblyVersion /p:Version=$nugetVersion --self-contained --runtime linux-x64 + +$source = "..\Source\MQTTnet.Server\bin\Release\netcoreapp2.2\linux-x64\publish" +$destination = "..\Source\MQTTnet.Server\bin\MQTTnet.Server-Linux-x64-v$nugetVersion.zip" +If(Test-path $destination) {Remove-item $destination} + Add-Type -assembly "system.io.compression.filesystem" +[io.compression.zipfile]::CreateFromDirectory($source, $destination) + +#################################################################### + +# Build MQTTnet.Server Linux-ARM +&dotnet publish ..\Source\MQTTnet.Server\MQTTnet.Server.csproj --configuration Release /p:FileVersion=$assemblyVersion /p:Version=$nugetVersion --self-contained --runtime linux-arm + +$source = "..\Source\MQTTnet.Server\bin\Release\netcoreapp2.2\linux-ARM\publish" +$destination = "..\Source\MQTTnet.Server\bin\MQTTnet.Server-Linux-ARM-v$nugetVersion.zip" +If(Test-path $destination) {Remove-item $destination} + Add-Type -assembly "system.io.compression.filesystem" +[io.compression.zipfile]::CreateFromDirectory($source, $destination) + +#################################################################### + +# Build MQTTnet.Server Windows-x64 +&dotnet publish ..\Source\MQTTnet.Server\MQTTnet.Server.csproj --configuration Release /p:FileVersion=$assemblyVersion /p:Version=$nugetVersion --self-contained --runtime win-x64 + +$source = "..\Source\MQTTnet.Server\bin\Release\netcoreapp2.2\win-x64\publish" +$destination = "..\Source\MQTTnet.Server\bin\MQTTnet.Server-Windows-x64-v$nugetVersion.zip" +If(Test-path $destination) {Remove-item $destination} + Add-Type -assembly "system.io.compression.filesystem" +[io.compression.zipfile]::CreateFromDirectory($source, $destination) + +#################################################################### + # Create NuGet packages. Remove-Item .\NuGet -Force -Recurse -ErrorAction SilentlyContinue @@ -55,6 +98,8 @@ Copy-Item MQTTnet.Extensions.Rpc.nuspec -Destination MQTTnet.Extensions.Rpc.nusp (Get-Content MQTTnet.Extensions.Rpc.nuspec) -replace '\$nugetVersion', $nugetVersion | Set-Content MQTTnet.Extensions.Rpc.nuspec Copy-Item MQTTnet.Extensions.ManagedClient.nuspec -Destination MQTTnet.Extensions.ManagedClient.nuspec.old -Force (Get-Content MQTTnet.Extensions.ManagedClient.nuspec) -replace '\$nugetVersion', $nugetVersion | Set-Content MQTTnet.Extensions.ManagedClient.nuspec +Copy-Item MQTTnet.Extensions.WebSocket4Net.nuspec -Destination MQTTnet.Extensions.WebSocket4Net.nuspec.old -Force +(Get-Content MQTTnet.Extensions.WebSocket4Net.nuspec) -replace '\$nugetVersion', $nugetVersion | Set-Content MQTTnet.Extensions.WebSocket4Net.nuspec New-Item -ItemType Directory -Force -Path .\NuGet .\nuget.exe pack MQTTnet.nuspec -Verbosity detailed -Symbols -OutputDir "NuGet" -Version $nugetVersion @@ -62,7 +107,9 @@ New-Item -ItemType Directory -Force -Path .\NuGet .\nuget.exe pack MQTTnet.AspNetCore.nuspec -Verbosity detailed -Symbols -OutputDir "NuGet" -Version $nugetVersion .\nuget.exe pack MQTTnet.Extensions.Rpc.nuspec -Verbosity detailed -Symbols -OutputDir "NuGet" -Version $nugetVersion .\nuget.exe pack MQTTnet.Extensions.ManagedClient.nuspec -Verbosity detailed -Symbols -OutputDir "NuGet" -Version $nugetVersion +.\nuget.exe pack MQTTnet.Extensions.WebSocket4Net.nuspec -Verbosity detailed -Symbols -OutputDir "NuGet" -Version $nugetVersion Move-Item MQTTnet.AspNetCore.nuspec.old -Destination MQTTnet.AspNetCore.nuspec -Force Move-Item MQTTnet.Extensions.Rpc.nuspec.old -Destination MQTTnet.Extensions.Rpc.nuspec -Force -Move-Item MQTTnet.Extensions.ManagedClient.nuspec.old -Destination MQTTnet.Extensions.ManagedClient.nuspec -Force \ No newline at end of file +Move-Item MQTTnet.Extensions.ManagedClient.nuspec.old -Destination MQTTnet.Extensions.ManagedClient.nuspec -Force +Move-Item MQTTnet.Extensions.WebSocket4Net.nuspec.old -Destination MQTTnet.Extensions.WebSocket4Net.nuspec -Force \ No newline at end of file diff --git a/MQTTnet.noUWP.sln b/MQTTnet.noUWP.sln index 1d24ba22..3d842a5e 100644 --- a/MQTTnet.noUWP.sln +++ b/MQTTnet.noUWP.sln @@ -47,6 +47,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MQTTnet.Tests", "Tests\MQTT EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MQTTnet.Server", "Source\MQTTnet.Server\MQTTnet.Server.csproj", "{DADEA836-5CC3-474C-A2D8-4D0F31118CD7}" EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MQTTnet.Extensions.WebSocket4Net", "Source\MQTTnet.Extensions.WebSocket4Net\MQTTnet.Extensions.WebSocket4Net.csproj", "{9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -219,6 +221,22 @@ Global {DADEA836-5CC3-474C-A2D8-4D0F31118CD7}.Release|x64.Build.0 = Release|Any CPU {DADEA836-5CC3-474C-A2D8-4D0F31118CD7}.Release|x86.ActiveCfg = Release|Any CPU {DADEA836-5CC3-474C-A2D8-4D0F31118CD7}.Release|x86.Build.0 = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|ARM.ActiveCfg = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|ARM.Build.0 = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|x64.ActiveCfg = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|x64.Build.0 = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|x86.ActiveCfg = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Debug|x86.Build.0 = Debug|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|Any CPU.Build.0 = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|ARM.ActiveCfg = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|ARM.Build.0 = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|x64.ActiveCfg = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|x64.Build.0 = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|x86.ActiveCfg = Release|Any CPU + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -234,6 +252,7 @@ Global {61B62223-F5D0-48E4-BBD6-2CBA9353CB5E} = {9248C2E1-B9D6-40BF-81EC-86004D7765B4} {9C7106CA-96B8-4ABE-B3B4-9357AB8ACB41} = {9248C2E1-B9D6-40BF-81EC-86004D7765B4} {DADEA836-5CC3-474C-A2D8-4D0F31118CD7} = {32A630A7-2598-41D7-B625-204CD906F5FB} + {9AE2F8DA-4178-470B-B8C4-88BE1DAE7D5F} = {12816BCC-AF9E-44A9-9AE5-C246AF2A0587} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {07536672-5CBC-4BE3-ACE0-708A431A7894} diff --git a/MQTTnet.sln b/MQTTnet.sln index 28d5dcab..22fd0ad6 100644 --- a/MQTTnet.sln +++ b/MQTTnet.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 -VisualStudioVersion = 16.0.28729.10 +VisualStudioVersion = 16.0.29009.5 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MQTTnet.Tests", "Tests\MQTTnet.Core.Tests\MQTTnet.Tests.csproj", "{A7FF0C91-25DE-4BA6-B39E-F54E8DADF1CC}" EndProject @@ -19,6 +19,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{67C28AC1 Build\MQTTnet.AspNetCore.nuspec = Build\MQTTnet.AspNetCore.nuspec Build\MQTTnet.Extensions.ManagedClient.nuspec = Build\MQTTnet.Extensions.ManagedClient.nuspec Build\MQTTnet.Extensions.Rpc.nuspec = Build\MQTTnet.Extensions.Rpc.nuspec + Build\MQTTnet.Extensions.WebSocket4Net.nuspec = Build\MQTTnet.Extensions.WebSocket4Net.nuspec Build\MQTTnet.NETStandard.nuspec = Build\MQTTnet.NETStandard.nuspec Build\MQTTnet.nuspec = Build\MQTTnet.nuspec Build\upload.ps1 = Build\upload.ps1 @@ -50,6 +51,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MQTTnet.AspNetCore.Tests", EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MQTTnet.Server", "Source\MQTTnet.Server\MQTTnet.Server.csproj", "{5699FB8C-838C-4AB0-80A5-9CA809F9B65B}" EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MQTTnet.Extensions.WebSocket4Net", "Source\MQTTnet.Extensions.WebSocket4Net\MQTTnet.Extensions.WebSocket4Net.csproj", "{2BD01D53-4CA5-4142-BE8D-313876395E3E}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -245,6 +248,22 @@ Global {5699FB8C-838C-4AB0-80A5-9CA809F9B65B}.Release|x64.Build.0 = Release|Any CPU {5699FB8C-838C-4AB0-80A5-9CA809F9B65B}.Release|x86.ActiveCfg = Release|Any CPU {5699FB8C-838C-4AB0-80A5-9CA809F9B65B}.Release|x86.Build.0 = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|ARM.ActiveCfg = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|ARM.Build.0 = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|x64.ActiveCfg = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|x64.Build.0 = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|x86.ActiveCfg = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Debug|x86.Build.0 = Debug|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|Any CPU.Build.0 = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|ARM.ActiveCfg = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|ARM.Build.0 = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|x64.ActiveCfg = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|x64.Build.0 = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|x86.ActiveCfg = Release|Any CPU + {2BD01D53-4CA5-4142-BE8D-313876395E3E}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -261,6 +280,7 @@ Global {C400533A-8EBA-4F0B-BF4D-295C3708604B} = {12816BCC-AF9E-44A9-9AE5-C246AF2A0587} {61B62223-F5D0-48E4-BBD6-2CBA9353CB5E} = {9248C2E1-B9D6-40BF-81EC-86004D7765B4} {5699FB8C-838C-4AB0-80A5-9CA809F9B65B} = {32A630A7-2598-41D7-B625-204CD906F5FB} + {2BD01D53-4CA5-4142-BE8D-313876395E3E} = {12816BCC-AF9E-44A9-9AE5-C246AF2A0587} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {07536672-5CBC-4BE3-ACE0-708A431A7894} diff --git a/README.md b/README.md index cb1db456..c6f79e6e 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ MQTTnet is a high performance .NET library for MQTT based communication. It prov * Uniform API across all supported versions of the MQTT protocol * Interfaces included for mocking and testing * Access to internal trace messages -* Unit tested (~200 tests) +* Unit tested (~210 tests) * No external dependencies \* Tested on local machine (Intel i7 8700K) with MQTTnet client and server running in the same process using the TCP channel. The app for verification is part of this repository and stored in _/Tests/MQTTnet.TestApp.NetCore_. diff --git a/Source/MQTTnet.AspnetCore/MqttConnectionContext.cs b/Source/MQTTnet.AspnetCore/MqttConnectionContext.cs index 6febcba5..f50d85db 100644 --- a/Source/MQTTnet.AspnetCore/MqttConnectionContext.cs +++ b/Source/MQTTnet.AspnetCore/MqttConnectionContext.cs @@ -7,6 +7,7 @@ using MQTTnet.Formatter; using MQTTnet.Packets; using System; using System.IO.Pipelines; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; @@ -48,6 +49,8 @@ namespace MQTTnet.AspNetCore public bool IsSecureConnection => Http?.HttpContext?.Request?.IsHttps ?? false; + public X509Certificate2 ClientCertificate => Http?.HttpContext?.Connection?.ClientCertificate; + private IHttpContextFeature Http => Connection.Features.Get(); public ConnectionContext Connection { get; } @@ -142,6 +145,12 @@ namespace MQTTnet.AspNetCore return null; } + public void ResetStatistics() + { + BytesReceived = 0; + BytesSent = 0; + } + public async Task SendPacketAsync(MqttBasePacket packet, TimeSpan timeout, CancellationToken cancellationToken) { var formatter = PacketFormatterAdapter; diff --git a/Source/MQTTnet.AspnetCore/MqttWebSocketServerAdapter.cs b/Source/MQTTnet.AspnetCore/MqttWebSocketServerAdapter.cs index 455840cd..a052dae0 100644 --- a/Source/MQTTnet.AspnetCore/MqttWebSocketServerAdapter.cs +++ b/Source/MQTTnet.AspnetCore/MqttWebSocketServerAdapter.cs @@ -40,19 +40,26 @@ namespace MQTTnet.AspNetCore var endpoint = $"{httpContext.Connection.RemoteIpAddress}:{httpContext.Connection.RemotePort}"; var clientCertificate = await httpContext.Connection.GetClientCertificateAsync().ConfigureAwait(false); - var isSecureConnection = clientCertificate != null; - clientCertificate?.Dispose(); - - var clientHandler = ClientHandler; - if (clientHandler != null) + try { - var writer = new SpanBasedMqttPacketWriter(); - var formatter = new MqttPacketFormatterAdapter(writer); - var channel = new MqttWebSocketChannel(webSocket, endpoint, isSecureConnection); - using (var channelAdapter = new MqttChannelAdapter(channel, formatter, _logger.CreateChildLogger(nameof(MqttWebSocketServerAdapter)))) + var isSecureConnection = clientCertificate != null; + + var clientHandler = ClientHandler; + if (clientHandler != null) { - await clientHandler(channelAdapter).ConfigureAwait(false); - } + var writer = new SpanBasedMqttPacketWriter(); + var formatter = new MqttPacketFormatterAdapter(writer); + var channel = new MqttWebSocketChannel(webSocket, endpoint, isSecureConnection, clientCertificate); + + using (var channelAdapter = new MqttChannelAdapter(channel, formatter, _logger.CreateChildLogger(nameof(MqttWebSocketServerAdapter)))) + { + await clientHandler(channelAdapter).ConfigureAwait(false); + } + } + } + finally + { + clientCertificate?.Dispose(); } } diff --git a/Source/MQTTnet.Extensions.ManagedClient/MQTTnet.Extensions.ManagedClient.csproj b/Source/MQTTnet.Extensions.ManagedClient/MQTTnet.Extensions.ManagedClient.csproj index 09dce3f3..b59b7f40 100644 --- a/Source/MQTTnet.Extensions.ManagedClient/MQTTnet.Extensions.ManagedClient.csproj +++ b/Source/MQTTnet.Extensions.ManagedClient/MQTTnet.Extensions.ManagedClient.csproj @@ -3,7 +3,7 @@ netstandard1.3;netstandard2.0 $(TargetFrameworks);net452;net461 - $(TargetFrameworks);uap10.0 + $(TargetFrameworks);uap10.0 diff --git a/Source/MQTTnet.Extensions.Rpc/MQTTnet.Extensions.Rpc.csproj b/Source/MQTTnet.Extensions.Rpc/MQTTnet.Extensions.Rpc.csproj index 09dce3f3..b59b7f40 100644 --- a/Source/MQTTnet.Extensions.Rpc/MQTTnet.Extensions.Rpc.csproj +++ b/Source/MQTTnet.Extensions.Rpc/MQTTnet.Extensions.Rpc.csproj @@ -3,7 +3,7 @@ netstandard1.3;netstandard2.0 $(TargetFrameworks);net452;net461 - $(TargetFrameworks);uap10.0 + $(TargetFrameworks);uap10.0 diff --git a/Source/MQTTnet.Extensions.WebSocket4Net/MQTTnet.Extensions.WebSocket4Net.csproj b/Source/MQTTnet.Extensions.WebSocket4Net/MQTTnet.Extensions.WebSocket4Net.csproj new file mode 100644 index 00000000..bdf26c6f --- /dev/null +++ b/Source/MQTTnet.Extensions.WebSocket4Net/MQTTnet.Extensions.WebSocket4Net.csproj @@ -0,0 +1,34 @@ + + + + netstandard1.3;netstandard2.0 + $(TargetFrameworks);net452;net461 + $(TargetFrameworks);uap10.0 + + + + + + + + false + UAP,Version=v10.0 + UAP + 10.0.17134.0 + 10.0.10240.0 + .NETCore + v5.0 + $(DefineConstants);WINDOWS_UWP + en + $(MSBuildExtensionsPath)\Microsoft\WindowsXaml\v$(VisualStudioVersion)\Microsoft.Windows.UI.Xaml.CSharp.targets + + + + + + + + + + + diff --git a/Source/MQTTnet.Extensions.WebSocket4Net/MqttFactoryExtensions.cs b/Source/MQTTnet.Extensions.WebSocket4Net/MqttFactoryExtensions.cs new file mode 100644 index 00000000..e593a883 --- /dev/null +++ b/Source/MQTTnet.Extensions.WebSocket4Net/MqttFactoryExtensions.cs @@ -0,0 +1,14 @@ +using System; + +namespace MQTTnet.Extensions.WebSocket4Net +{ + public static class MqttFactoryExtensions + { + public static IMqttFactory UseWebSocket4Net(this IMqttFactory mqttFactory) + { + if (mqttFactory == null) throw new ArgumentNullException(nameof(mqttFactory)); + + return mqttFactory.UseClientAdapterFactory(new WebSocket4NetMqttClientAdapterFactory()); + } + } +} diff --git a/Source/MQTTnet.Extensions.WebSocket4Net/WebSocket4NetMqttChannel.cs b/Source/MQTTnet.Extensions.WebSocket4Net/WebSocket4NetMqttChannel.cs new file mode 100644 index 00000000..68b12ef4 --- /dev/null +++ b/Source/MQTTnet.Extensions.WebSocket4Net/WebSocket4NetMqttChannel.cs @@ -0,0 +1,233 @@ +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Linq; +using System.Net; +using System.Security.Authentication; +using System.Security.Cryptography.X509Certificates; +using System.Threading; +using System.Threading.Tasks; +using MQTTnet.Channel; +using MQTTnet.Client.Options; +using MQTTnet.Exceptions; +using MQTTnet.Internal; +using SuperSocket.ClientEngine; +using WebSocket4Net; + +namespace MQTTnet.Extensions.WebSocket4Net +{ + public class WebSocket4NetMqttChannel : IMqttChannel + { + private readonly BlockingCollection _receiveBuffer = new BlockingCollection(); + + private readonly IMqttClientOptions _clientOptions; + private readonly MqttClientWebSocketOptions _webSocketOptions; + + private WebSocket _webSocket; + + public WebSocket4NetMqttChannel(IMqttClientOptions clientOptions, MqttClientWebSocketOptions webSocketOptions) + { + _clientOptions = clientOptions ?? throw new ArgumentNullException(nameof(clientOptions)); + _webSocketOptions = webSocketOptions ?? throw new ArgumentNullException(nameof(webSocketOptions)); + } + + public string Endpoint => _webSocketOptions.Uri; + + public bool IsSecureConnection { get; private set; } + + public X509Certificate2 ClientCertificate { get; } + + public async Task ConnectAsync(CancellationToken cancellationToken) + { + var uri = _webSocketOptions.Uri; + if (!uri.StartsWith("ws://", StringComparison.OrdinalIgnoreCase) && !uri.StartsWith("wss://", StringComparison.OrdinalIgnoreCase)) + { + if (_webSocketOptions.TlsOptions?.UseTls == false) + { + uri = "ws://" + uri; + } + else + { + uri = "wss://" + uri; + } + } + + var sslProtocols = _webSocketOptions?.TlsOptions?.SslProtocol ?? SslProtocols.None; + var subProtocol = _webSocketOptions.SubProtocols.FirstOrDefault() ?? string.Empty; + + var cookies = new List>(); + if (_webSocketOptions.CookieContainer != null) + { + throw new NotSupportedException("Cookies are not supported."); + } + + List> customHeaders = null; + if (_webSocketOptions.RequestHeaders != null) + { + customHeaders = _webSocketOptions.RequestHeaders.Select(i => new KeyValuePair(i.Key, i.Value)).ToList(); + } + + EndPoint proxy = null; + if (_webSocketOptions.ProxyOptions != null) + { + throw new NotSupportedException("Proxies are not supported."); + } + + // The user agent can be empty always because it is just added to the custom headers as "User-Agent". + var userAgent = string.Empty; + + var origin = string.Empty; + var webSocketVersion = WebSocketVersion.None; + var receiveBufferSize = 0; + + var certificates = new X509CertificateCollection(); + if (_webSocketOptions?.TlsOptions?.Certificates != null) + { + foreach (var certificate in _webSocketOptions.TlsOptions.Certificates) + { + certificates.Add(new X509Certificate(certificate)); + } + } + + _webSocket = new WebSocket(uri, subProtocol, cookies, customHeaders, userAgent, origin, webSocketVersion, proxy, sslProtocols, receiveBufferSize) + { + NoDelay = true, + Security = + { + AllowUnstrustedCertificate = _webSocketOptions?.TlsOptions?.AllowUntrustedCertificates == true, + AllowCertificateChainErrors = _webSocketOptions?.TlsOptions?.IgnoreCertificateChainErrors == true, + Certificates = certificates + } + }; + + await ConnectInternalAsync(cancellationToken).ConfigureAwait(false); + + IsSecureConnection = uri.StartsWith("wss://", StringComparison.OrdinalIgnoreCase); + } + + public Task DisconnectAsync(CancellationToken cancellationToken) + { + if (_webSocket != null && _webSocket.State == WebSocketState.Open) + { + _webSocket.Close(); + } + + return Task.FromResult(0); + } + + public Task ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) + { + var readBytes = 0; + while (count > 0 && !cancellationToken.IsCancellationRequested) + { + if (!_receiveBuffer.TryTake(out var @byte)) + { + if (readBytes == 0) + { + // Block until at least one byte was received. + @byte = _receiveBuffer.Take(cancellationToken); + } + else + { + return Task.FromResult(readBytes); + } + } + + buffer[offset] = @byte; + offset++; + count--; + readBytes++; + } + + return Task.FromResult(readBytes); + } + + public Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) + { + _webSocket.Send(buffer, offset, count); + return Task.FromResult(0); + } + + public void Dispose() + { + if (_webSocket == null) + { + return; + } + + _webSocket.DataReceived -= OnDataReceived; + _webSocket.Error -= OnError; + _webSocket.Dispose(); + _webSocket = null; + } + + private void OnError(object sender, ErrorEventArgs e) + { + System.Diagnostics.Debug.Write(e.Exception.ToString()); + } + + private void OnDataReceived(object sender, DataReceivedEventArgs e) + { + foreach (var @byte in e.Data) + { + _receiveBuffer.Add(@byte); + } + } + + private async Task ConnectInternalAsync(CancellationToken cancellationToken) + { + _webSocket.Error += OnError; + _webSocket.DataReceived += OnDataReceived; + + var taskCompletionSource = new TaskCompletionSource(); + + void ErrorHandler(object sender, ErrorEventArgs e) + { + taskCompletionSource.TrySetResult(e.Exception); + } + + void SuccessHandler(object sender, EventArgs e) + { + taskCompletionSource.TrySetResult(null); + } + + try + { + _webSocket.Opened += SuccessHandler; + _webSocket.Error += ErrorHandler; + + _webSocket.Open(); + + var exception = await MqttTaskTimeout.WaitAsync(c => + { + c.Register(() => taskCompletionSource.TrySetCanceled()); + return taskCompletionSource.Task; + }, _clientOptions.CommunicationTimeout, cancellationToken).ConfigureAwait(false); + + if (exception != null) + { + if (exception is AuthenticationException authenticationException) + { + throw new MqttCommunicationException(authenticationException.InnerException); + } + + if (exception is OperationCanceledException) + { + throw new MqttCommunicationTimedOutException(); + } + + throw new MqttCommunicationException(exception); + } + } + catch (OperationCanceledException) + { + throw new MqttCommunicationTimedOutException(); + } + finally + { + _webSocket.Opened -= SuccessHandler; + _webSocket.Error -= ErrorHandler; + } + } + } +} diff --git a/Source/MQTTnet.Extensions.WebSocket4Net/WebSocket4NetMqttClientAdapterFactory.cs b/Source/MQTTnet.Extensions.WebSocket4Net/WebSocket4NetMqttClientAdapterFactory.cs new file mode 100644 index 00000000..7625fc92 --- /dev/null +++ b/Source/MQTTnet.Extensions.WebSocket4Net/WebSocket4NetMqttClientAdapterFactory.cs @@ -0,0 +1,36 @@ +using System; +using MQTTnet.Adapter; +using MQTTnet.Client.Options; +using MQTTnet.Diagnostics; +using MQTTnet.Formatter; +using MQTTnet.Implementations; + +namespace MQTTnet.Extensions.WebSocket4Net +{ + public class WebSocket4NetMqttClientAdapterFactory : IMqttClientAdapterFactory + { + public IMqttChannelAdapter CreateClientAdapter(IMqttClientOptions options, IMqttNetChildLogger logger) + { + if (options == null) throw new ArgumentNullException(nameof(options)); + if (logger == null) throw new ArgumentNullException(nameof(logger)); + + switch (options.ChannelOptions) + { + case MqttClientTcpOptions _: + { + return new MqttChannelAdapter(new MqttTcpChannel(options), new MqttPacketFormatterAdapter(options.ProtocolVersion), logger); + } + + case MqttClientWebSocketOptions webSocketOptions: + { + return new MqttChannelAdapter(new WebSocket4NetMqttChannel(options, webSocketOptions), new MqttPacketFormatterAdapter(options.ProtocolVersion), logger); + } + + default: + { + throw new NotSupportedException(); + } + } + } + } +} diff --git a/Source/MQTTnet.Server/Configuration/SettingsModel.cs b/Source/MQTTnet.Server/Configuration/MqttSettingsModel.cs similarity index 96% rename from Source/MQTTnet.Server/Configuration/SettingsModel.cs rename to Source/MQTTnet.Server/Configuration/MqttSettingsModel.cs index ce5336d2..8faa8087 100644 --- a/Source/MQTTnet.Server/Configuration/SettingsModel.cs +++ b/Source/MQTTnet.Server/Configuration/MqttSettingsModel.cs @@ -1,9 +1,9 @@ namespace MQTTnet.Server.Configuration { /// - /// Main Settings Model + /// MQTT settings Model /// - public class SettingsModel + public class MqttSettingsModel { /// /// Set default connection timeout in seconds diff --git a/Source/MQTTnet.Server/Configuration/PathHelper.cs b/Source/MQTTnet.Server/Configuration/PathHelper.cs new file mode 100644 index 00000000..84327ac9 --- /dev/null +++ b/Source/MQTTnet.Server/Configuration/PathHelper.cs @@ -0,0 +1,24 @@ +using System; +using System.IO; + +namespace MQTTnet.Server.Configuration +{ + public static class PathHelper + { + public static string ExpandPath(string path) + { + if (path == null) + { + return null; + } + + var uri = new Uri(path, UriKind.RelativeOrAbsolute); + if (!uri.IsAbsoluteUri) + { + return Path.Combine(AppDomain.CurrentDomain.BaseDirectory, path); + } + + return path; + } + } +} diff --git a/Source/MQTTnet.Server/Configuration/RetainedApplicationMessagesModel.cs b/Source/MQTTnet.Server/Configuration/RetainedApplicationMessagesModel.cs index 7abae83f..a9342177 100644 --- a/Source/MQTTnet.Server/Configuration/RetainedApplicationMessagesModel.cs +++ b/Source/MQTTnet.Server/Configuration/RetainedApplicationMessagesModel.cs @@ -6,6 +6,6 @@ public int WriteInterval { get; set; } = 10; - public string Filename { get; set; } = "RetainedApplicationMessages.json"; + public string Path { get; set; } } } diff --git a/Source/MQTTnet.Server/Configuration/ScriptingSettingsModel.cs b/Source/MQTTnet.Server/Configuration/ScriptingSettingsModel.cs new file mode 100644 index 00000000..702ef638 --- /dev/null +++ b/Source/MQTTnet.Server/Configuration/ScriptingSettingsModel.cs @@ -0,0 +1,11 @@ +using System.Collections.Generic; + +namespace MQTTnet.Server.Configuration +{ + public class ScriptingSettingsModel + { + public string ScriptsPath { get; set; } + + public List IncludePaths { get; set; } + } +} diff --git a/Source/MQTTnet.Server/Controllers/ClientsController.cs b/Source/MQTTnet.Server/Controllers/ClientsController.cs index afc75119..6898375b 100644 --- a/Source/MQTTnet.Server/Controllers/ClientsController.cs +++ b/Source/MQTTnet.Server/Controllers/ClientsController.cs @@ -4,12 +4,14 @@ using System.Linq; using System.Net; using System.Threading.Tasks; using System.Web; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using MQTTnet.Server.Mqtt; using MQTTnet.Server.Status; namespace MQTTnet.Server.Controllers { + [Authorize] [ApiController] public class ClientsController : ControllerBase { @@ -57,5 +59,21 @@ namespace MQTTnet.Server.Controllers await client.DisconnectAsync(); return StatusCode((int)HttpStatusCode.NoContent); } + + [Route("api/v1/clients/{clientId}/statistics")] + [HttpDelete] + public async Task DeleteClientStatistics(string clientId) + { + clientId = HttpUtility.UrlDecode(clientId); + + var client = (await _mqttServerService.GetClientStatusAsync()).FirstOrDefault(c => c.ClientId == clientId); + if (client == null) + { + return new StatusCodeResult((int)HttpStatusCode.NotFound); + } + + client.ResetStatistics(); + return StatusCode((int)HttpStatusCode.NoContent); + } } } diff --git a/Source/MQTTnet.Server/Controllers/RetainedApplicationMessagesController.cs b/Source/MQTTnet.Server/Controllers/RetainedApplicationMessagesController.cs index 30110b38..9c9f2734 100644 --- a/Source/MQTTnet.Server/Controllers/RetainedApplicationMessagesController.cs +++ b/Source/MQTTnet.Server/Controllers/RetainedApplicationMessagesController.cs @@ -4,11 +4,13 @@ using System.Linq; using System.Net; using System.Threading.Tasks; using System.Web; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using MQTTnet.Server.Mqtt; namespace MQTTnet.Server.Controllers { + [Authorize] [ApiController] public class RetainedApplicationMessagesController : ControllerBase { diff --git a/Source/MQTTnet.Server/Controllers/ScriptsController.cs b/Source/MQTTnet.Server/Controllers/ScriptsController.cs index 1b2a7032..23cff06a 100644 --- a/Source/MQTTnet.Server/Controllers/ScriptsController.cs +++ b/Source/MQTTnet.Server/Controllers/ScriptsController.cs @@ -1,11 +1,65 @@ using System; using System.Collections.Generic; -using System.Linq; +using System.Threading; using System.Threading.Tasks; +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Mvc; +using MQTTnet.Server.Scripting; +using MQTTnet.Server.Web; namespace MQTTnet.Server.Controllers { - public class ScriptsController + [Authorize] + [ApiController] + public class ScriptsController : Controller { + private readonly PythonScriptHostService _pythonScriptHostService; + + public ScriptsController(PythonScriptHostService pythonScriptHostService) + { + _pythonScriptHostService = pythonScriptHostService ?? throw new ArgumentNullException(nameof(pythonScriptHostService)); + } + + [Route("api/v1/scripts")] + [HttpGet] + public ActionResult> GetScriptUids() + { + return _pythonScriptHostService.GetScriptUids(); + } + + [Route("api/v1/scripts/uid")] + [HttpGet] + public async Task> GetScript(string uid) + { + var script = await _pythonScriptHostService.ReadScriptAsync(uid, HttpContext.RequestAborted); + if (script == null) + { + return NotFound(); + } + + return Content(script); + } + + [Route("api/v1/scripts/uid")] + [HttpPost] + public Task PostScript(string uid) + { + var code = HttpContext.Request.ReadBodyAsString(); + return _pythonScriptHostService.WriteScriptAsync(uid, code, CancellationToken.None); + } + + [Route("api/v1/scripts/uid")] + [HttpDelete] + public Task DeleteScript(string uid) + { + return _pythonScriptHostService.DeleteScriptAsync(uid); + } + + [Route("api/v1/scripts/initialize")] + [HttpPost] + public Task PostInitializeScripts() + { + return _pythonScriptHostService.TryInitializeScriptsAsync(); + } } } diff --git a/Source/MQTTnet.Server/Controllers/SessionsController.cs b/Source/MQTTnet.Server/Controllers/SessionsController.cs index 415d4b9c..463c0047 100644 --- a/Source/MQTTnet.Server/Controllers/SessionsController.cs +++ b/Source/MQTTnet.Server/Controllers/SessionsController.cs @@ -4,12 +4,14 @@ using System.Linq; using System.Net; using System.Threading.Tasks; using System.Web; +using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using MQTTnet.Server.Mqtt; using MQTTnet.Server.Status; namespace MQTTnet.Server.Controllers { + [Authorize] [ApiController] public class SessionsController : ControllerBase { diff --git a/Source/MQTTnet.Server/LICENSE b/Source/MQTTnet.Server/LICENSE index 7d84e2b1..3b188816 100644 --- a/Source/MQTTnet.Server/LICENSE +++ b/Source/MQTTnet.Server/LICENSE @@ -1,6 +1,7 @@ +# MQTTnet MIT License -Copyright (c) 2017 Christian Kratky +Copyright (c) 2019 MQTTnet Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -19,3 +20,78 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +# Swashbuckle +Copyright (c) 2013, Richard Morris +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +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 HOLDER 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 + +# IronPython +Copyright (c) .NET Foundation and Contributors + All Rights Reserved + +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. + +"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: + +You must give any other recipients of the Work or Derivative Works a copy of this License; and + + +You must cause any modified files to carry prominent notices stating that You changed the files; and + + +You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and + + +If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. +You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. + diff --git a/Source/MQTTnet.Server/MQTTnet.Server.csproj b/Source/MQTTnet.Server/MQTTnet.Server.csproj index c322548c..bbd3ceb6 100644 --- a/Source/MQTTnet.Server/MQTTnet.Server.csproj +++ b/Source/MQTTnet.Server/MQTTnet.Server.csproj @@ -1,4 +1,4 @@ - + netcoreapp2.2 @@ -14,11 +14,13 @@ false false latest + 1.0.0 3.3 + c564f0de-28b4-45bf-b726-4d665d705653 @@ -27,6 +29,13 @@ 1701;1702 + + + + + + + Always @@ -53,22 +62,23 @@ Always - + Always - - Always - - + Always Always + + Always + - + + diff --git a/Source/MQTTnet.Server/Mqtt/CustomMqttFactory.cs b/Source/MQTTnet.Server/Mqtt/CustomMqttFactory.cs index 06bf5467..3eba2ca4 100644 --- a/Source/MQTTnet.Server/Mqtt/CustomMqttFactory.cs +++ b/Source/MQTTnet.Server/Mqtt/CustomMqttFactory.cs @@ -12,7 +12,7 @@ namespace MQTTnet.Server.Mqtt { private readonly MqttFactory _mqttFactory; - public CustomMqttFactory(SettingsModel settings, ILogger logger) + public CustomMqttFactory(MqttSettingsModel settings, ILogger logger) { if (settings == null) throw new ArgumentNullException(nameof(settings)); if (logger == null) throw new ArgumentNullException(nameof(logger)); diff --git a/Source/MQTTnet.Server/Mqtt/MqttConnectionValidator.cs b/Source/MQTTnet.Server/Mqtt/MqttServerConnectionValidator.cs similarity index 69% rename from Source/MQTTnet.Server/Mqtt/MqttConnectionValidator.cs rename to Source/MQTTnet.Server/Mqtt/MqttServerConnectionValidator.cs index 83f66039..4e13c83b 100644 --- a/Source/MQTTnet.Server/Mqtt/MqttConnectionValidator.cs +++ b/Source/MQTTnet.Server/Mqtt/MqttServerConnectionValidator.cs @@ -7,12 +7,12 @@ using MQTTnet.Server.Scripting; namespace MQTTnet.Server.Mqtt { - public class MqttConnectionValidator : IMqttServerConnectionValidator + public class MqttServerConnectionValidator : IMqttServerConnectionValidator { private readonly PythonScriptHostService _pythonScriptHostService; private readonly ILogger _logger; - public MqttConnectionValidator(PythonScriptHostService pythonScriptHostService, ILogger logger) + public MqttServerConnectionValidator(PythonScriptHostService pythonScriptHostService, ILogger logger) { _pythonScriptHostService = pythonScriptHostService ?? throw new ArgumentNullException(nameof(pythonScriptHostService)); _logger = logger ?? throw new ArgumentNullException(nameof(logger)); @@ -24,17 +24,22 @@ namespace MQTTnet.Server.Mqtt { var pythonContext = new PythonDictionary { - { "client_id", context.ClientId }, { "endpoint", context.Endpoint }, { "is_secure_connection", context.IsSecureConnection }, + { "client_id", context.ClientId }, { "username", context.Username }, { "password", context.Password }, - { "result", PythonConvert.Pythonfy(context.ReturnCode) } + { "raw_password", new Bytes(context.RawPassword) }, + { "clean_session", context.CleanSession}, + { "authentication_method", context.AuthenticationMethod}, + { "authentication_data", new Bytes(context.AuthenticationData)}, + + { "result", PythonConvert.Pythonfy(context.ReasonCode) } }; _pythonScriptHostService.InvokeOptionalFunction("on_validate_client_connection", pythonContext); - context.ReturnCode = PythonConvert.ParseEnum((string)pythonContext["result"]); + context.ReasonCode = PythonConvert.ParseEnum((string)pythonContext["result"]); } catch (Exception exception) { diff --git a/Source/MQTTnet.Server/Mqtt/MqttServerService.cs b/Source/MQTTnet.Server/Mqtt/MqttServerService.cs index 42ec60b8..63237382 100644 --- a/Source/MQTTnet.Server/Mqtt/MqttServerService.cs +++ b/Source/MQTTnet.Server/Mqtt/MqttServerService.cs @@ -23,34 +23,34 @@ namespace MQTTnet.Server.Mqtt { private readonly ILogger _logger; - private readonly SettingsModel _settings; + private readonly MqttSettingsModel _settings; private readonly MqttApplicationMessageInterceptor _mqttApplicationMessageInterceptor; private readonly MqttServerStorage _mqttServerStorage; private readonly MqttClientConnectedHandler _mqttClientConnectedHandler; private readonly MqttClientDisconnectedHandler _mqttClientDisconnectedHandler; private readonly MqttClientSubscribedTopicHandler _mqttClientSubscribedTopicHandler; private readonly MqttClientUnsubscribedTopicHandler _mqttClientUnsubscribedTopicHandler; - private readonly MqttConnectionValidator _mqttConnectionValidator; + private readonly MqttServerConnectionValidator _mqttConnectionValidator; private readonly IMqttServer _mqttServer; private readonly MqttSubscriptionInterceptor _mqttSubscriptionInterceptor; private readonly PythonScriptHostService _pythonScriptHostService; private readonly MqttWebSocketServerAdapter _webSocketServerAdapter; public MqttServerService( - SettingsModel settings, + MqttSettingsModel mqttSettings, CustomMqttFactory mqttFactory, MqttClientConnectedHandler mqttClientConnectedHandler, MqttClientDisconnectedHandler mqttClientDisconnectedHandler, MqttClientSubscribedTopicHandler mqttClientSubscribedTopicHandler, MqttClientUnsubscribedTopicHandler mqttClientUnsubscribedTopicHandler, - MqttConnectionValidator mqttConnectionValidator, + MqttServerConnectionValidator mqttConnectionValidator, MqttSubscriptionInterceptor mqttSubscriptionInterceptor, MqttApplicationMessageInterceptor mqttApplicationMessageInterceptor, MqttServerStorage mqttServerStorage, PythonScriptHostService pythonScriptHostService, ILogger logger) { - _settings = settings ?? throw new ArgumentNullException(nameof(settings)); + _settings = mqttSettings ?? throw new ArgumentNullException(nameof(mqttSettings)); _mqttClientConnectedHandler = mqttClientConnectedHandler ?? throw new ArgumentNullException(nameof(mqttClientConnectedHandler)); _mqttClientDisconnectedHandler = mqttClientDisconnectedHandler ?? throw new ArgumentNullException(nameof(mqttClientDisconnectedHandler)); _mqttClientSubscribedTopicHandler = mqttClientSubscribedTopicHandler ?? throw new ArgumentNullException(nameof(mqttClientSubscribedTopicHandler)); diff --git a/Source/MQTTnet.Server/Mqtt/MqttServerStorage.cs b/Source/MQTTnet.Server/Mqtt/MqttServerStorage.cs index 39b65d51..a2878846 100644 --- a/Source/MQTTnet.Server/Mqtt/MqttServerStorage.cs +++ b/Source/MQTTnet.Server/Mqtt/MqttServerStorage.cs @@ -14,27 +14,28 @@ namespace MQTTnet.Server.Mqtt { private readonly List _messages = new List(); - private readonly SettingsModel _settings; + private readonly MqttSettingsModel _mqttSettings; private readonly ILogger _logger; - private string _filename; + private string _path; private bool _messagesHaveChanged; - public MqttServerStorage(SettingsModel settings, ILogger logger) + public MqttServerStorage(MqttSettingsModel mqttSettings, ILogger logger) { - _settings = settings ?? throw new ArgumentNullException(nameof(settings)); + _mqttSettings = mqttSettings ?? throw new ArgumentNullException(nameof(mqttSettings)); _logger = logger ?? throw new ArgumentNullException(nameof(logger)); } public void Configure() { - if (_settings.RetainedApplicationMessages?.Persist != true) + if (_mqttSettings.RetainedApplicationMessages?.Persist != true || + string.IsNullOrEmpty(_mqttSettings.RetainedApplicationMessages.Path)) { _logger.LogInformation("Persisting of retained application messages is disabled."); return; } - _filename = ExpandFilename(); + _path = PathHelper.ExpandPath(_mqttSettings.RetainedApplicationMessages.Path); // The retained application messages are stored in a separate thread. // This is mandatory because writing them to a slow storage (like RaspberryPi SD card) @@ -61,7 +62,7 @@ namespace MQTTnet.Server.Mqtt { try { - await Task.Delay(TimeSpan.FromSeconds(_settings.RetainedApplicationMessages.WriteInterval)).ConfigureAwait(false); + await Task.Delay(TimeSpan.FromSeconds(_mqttSettings.RetainedApplicationMessages.WriteInterval)).ConfigureAwait(false); List messages; lock (_messages) @@ -76,7 +77,7 @@ namespace MQTTnet.Server.Mqtt } var json = JsonConvert.SerializeObject(messages); - await File.WriteAllTextAsync(_filename, json, Encoding.UTF8).ConfigureAwait(false); + await File.WriteAllTextAsync(_path, json, Encoding.UTF8).ConfigureAwait(false); _logger.LogInformation($"{messages.Count} retained MQTT messages written."); } @@ -89,19 +90,19 @@ namespace MQTTnet.Server.Mqtt public async Task> LoadRetainedMessagesAsync() { - if (_settings.RetainedApplicationMessages?.Persist != true) + if (_mqttSettings.RetainedApplicationMessages?.Persist != true) { return null; } - if (!File.Exists(_filename)) + if (!File.Exists(_path)) { return null; } try { - var json = await File.ReadAllTextAsync(_filename).ConfigureAwait(false); + var json = await File.ReadAllTextAsync(_path).ConfigureAwait(false); var applicationMessages = JsonConvert.DeserializeObject>(json); _logger.LogInformation($"{applicationMessages.Count} retained MQTT messages loaded."); @@ -114,18 +115,5 @@ namespace MQTTnet.Server.Mqtt return null; } } - - private string ExpandFilename() - { - var filename = _settings.RetainedApplicationMessages.Filename; - - var uri = new Uri(filename, UriKind.RelativeOrAbsolute); - if (!uri.IsAbsoluteUri) - { - filename = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, filename); - } - - return filename; - } } } diff --git a/Source/MQTTnet.Server/Program.cs b/Source/MQTTnet.Server/Program.cs index 3e8a0a0a..f5df1d02 100644 --- a/Source/MQTTnet.Server/Program.cs +++ b/Source/MQTTnet.Server/Program.cs @@ -2,6 +2,7 @@ using System.Reflection; using Microsoft.AspNetCore; using Microsoft.AspNetCore.Hosting; +using MQTTnet.Server.Web; namespace MQTTnet.Server { @@ -27,45 +28,42 @@ namespace MQTTnet.Server private static void PrintLogo() { Console.ResetColor(); - Console.ForegroundColor = ConsoleColor.White; - Console.BackgroundColor = ConsoleColor.Red; + Console.ForegroundColor = ConsoleColor.Red; const string LogoText = -@"| | -| __ __ ____ _______ _______ _ _____ | -| | \/ |/ __ \__ __|__ __| | | / ____| | -| | \ / | | | | | | | |_ __ ___| |_ | (___ ___ _ ____ _____ _ __ | -| | |\/| | | | | | | | | '_ \ / _ \ __| \___ \ / _ \ '__\ \ / / _ \ '__| | -| | | | | |__| | | | | | | | | __/ |_ ____) | __/ | \ V / __/ | | -| |_| |_|\___\_\ |_| |_|_| |_|\___|\__| |_____/ \___|_| \_/ \___|_| | -| | -| |"; +@" + +███╗ ███╗ ██████╗ ████████╗████████╗███╗ ██╗███████╗████████╗ ███████╗███████╗██████╗ ██╗ ██╗███████╗██████╗ +████╗ ████║██╔═══██╗╚══██╔══╝╚══██╔══╝████╗ ██║██╔════╝╚══██╔══╝ ██╔════╝██╔════╝██╔══██╗██║ ██║██╔════╝██╔══██╗ +██╔████╔██║██║ ██║ ██║ ██║ ██╔██╗ ██║█████╗ ██║ ███████╗█████╗ ██████╔╝██║ ██║█████╗ ██████╔╝ +██║╚██╔╝██║██║▄▄ ██║ ██║ ██║ ██║╚██╗██║██╔══╝ ██║ ╚════██║██╔══╝ ██╔══██╗╚██╗ ██╔╝██╔══╝ ██╔══██╗ +██║ ╚═╝ ██║╚██████╔╝ ██║ ██║ ██║ ╚████║███████╗ ██║ ███████║███████╗██║ ██║ ╚████╔╝ ███████╗██║ ██║ +╚═╝ ╚═╝ ╚══▀▀═╝ ╚═╝ ╚═╝ ╚═╝ ╚═══╝╚══════╝ ╚═╝ ╚══════╝╚══════╝╚═╝ ╚═╝ ╚═══╝ ╚══════╝╚═╝ ╚═╝ + +"; Console.WriteLine(LogoText); Console.ResetColor(); Console.WriteLine(); Console.ForegroundColor = ConsoleColor.White; - Console.WriteLine(@" - -- The official MQTT server implementation of MQTTnet -- - Copyright (c) 2017-2019 The MQTTnet Team"); + Console.WriteLine("The official MQTT server implementation of MQTTnet"); + Console.WriteLine("Copyright (c) 2017-2019 The MQTTnet Team"); Console.ForegroundColor = ConsoleColor.Blue; - Console.WriteLine(@" - https://github.com/chkr1011/MQTTnet"); + Console.WriteLine(@"https://github.com/chkr1011/MQTTnet"); Console.ForegroundColor = ConsoleColor.White; Console.WriteLine($@" - Version: {Assembly.GetExecutingAssembly().GetName().Version} - License: MIT (read LICENSE file) - Sponsoring: https://opencollective.com/mqttnet - Support: https://github.com/chkr1011/MQTTnet/issues - Docs: https://github.com/chkr1011/MQTTnet/wiki/MQTTnetServer +Version: {Assembly.GetExecutingAssembly().GetCustomAttribute().InformationalVersion} +License: MIT (read LICENSE file) +Sponsoring: https://opencollective.com/mqttnet +Support: https://github.com/chkr1011/MQTTnet/issues +Docs: https://github.com/chkr1011/MQTTnet/wiki/MQTTnetServer "); - Console.BackgroundColor = ConsoleColor.White; Console.ForegroundColor = ConsoleColor.Red; Console.WriteLine(" ! THIS IS AN ALPHA VERSION! IT IS NOT RECOMMENDED TO USE IT FOR ANY DIFFERENT PURPOSE THAN TESTING OR EVALUATING!"); - Console.WriteLine(); Console.ResetColor(); + Console.WriteLine(); } } } \ No newline at end of file diff --git a/Source/MQTTnet.Server/README.md b/Source/MQTTnet.Server/README.md new file mode 100644 index 00000000..782ba959 --- /dev/null +++ b/Source/MQTTnet.Server/README.md @@ -0,0 +1,10 @@ +# Starting portable version +The portable version requires a local installation of the .net core runtime. With that runtime installed the server can be started via the following comand. + +dotnet .\MQTTnet.Server.dll + +# Starting self contained versions +The self contained versions are fully portable versions including the .net core runtime. The server can be started using the contained executable files. + +Windows: MQTTnet.Server.exe +Linux: MQTTnet.Server (must be set to _executable_ first) diff --git a/Source/MQTTnet.Server/RetainedApplicationMessages.json b/Source/MQTTnet.Server/RetainedApplicationMessages.json deleted file mode 100644 index 04c16db3..00000000 --- a/Source/MQTTnet.Server/RetainedApplicationMessages.json +++ /dev/null @@ -1 +0,0 @@ -[{"Topic":"a","Payload":"YWFzYXNhc2E=","QualityOfServiceLevel":0,"Retain":true,"UserProperties":[],"ContentType":null,"ResponseTopic":null,"PayloadFormatIndicator":null,"MessageExpiryInterval":null,"TopicAlias":null,"CorrelationData":null,"SubscriptionIdentifier":null},{"Topic":"fgdfgd","Payload":"YWFzYXNhc2E=","QualityOfServiceLevel":0,"Retain":true,"UserProperties":[],"ContentType":null,"ResponseTopic":null,"PayloadFormatIndicator":null,"MessageExpiryInterval":null,"TopicAlias":null,"CorrelationData":null,"SubscriptionIdentifier":null}] \ No newline at end of file diff --git a/Source/MQTTnet.Server/Scripting/PythonScriptHostService.cs b/Source/MQTTnet.Server/Scripting/PythonScriptHostService.cs index 1acc58c4..c521d9d6 100644 --- a/Source/MQTTnet.Server/Scripting/PythonScriptHostService.cs +++ b/Source/MQTTnet.Server/Scripting/PythonScriptHostService.cs @@ -4,9 +4,12 @@ using System.Dynamic; using System.IO; using System.Linq; using System.Text; +using System.Threading; +using System.Threading.Tasks; using Microsoft.Extensions.Logging; using Microsoft.Scripting; using Microsoft.Scripting.Hosting; +using MQTTnet.Server.Configuration; namespace MQTTnet.Server.Scripting { @@ -14,26 +17,27 @@ namespace MQTTnet.Server.Scripting { private readonly IDictionary _proxyObjects = new ExpandoObject(); private readonly List _scriptInstances = new List(); + private readonly string _scriptsPath; + private readonly ScriptingSettingsModel _scriptingSettings; private readonly ILogger _logger; private readonly ScriptEngine _scriptEngine; - public PythonScriptHostService(PythonIOStream pythonIOStream, ILogger logger) + public PythonScriptHostService(ScriptingSettingsModel scriptingSettings, PythonIOStream pythonIOStream, ILogger logger) { + _scriptingSettings = scriptingSettings ?? throw new ArgumentNullException(nameof(scriptingSettings)); _logger = logger ?? throw new ArgumentNullException(nameof(logger)); _scriptEngine = IronPython.Hosting.Python.CreateEngine(); _scriptEngine.Runtime.IO.SetOutput(pythonIOStream, Encoding.UTF8); + + _scriptsPath = PathHelper.ExpandPath(scriptingSettings.ScriptsPath); } public void Configure() { AddSearchPaths(_scriptEngine); - var scriptsDirectory = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Scripts"); - foreach (var filename in Directory.GetFiles(scriptsDirectory, "*.py", SearchOption.AllDirectories).OrderBy(file => file)) - { - TryInitializeScript(filename); - } + TryInitializeScriptsAsync().GetAwaiter().GetResult(); } public void RegisterProxyObject(string name, object @object) @@ -58,35 +62,109 @@ namespace MQTTnet.Server.Scripting } catch (Exception exception) { - _logger.LogError(exception, $"Error while invoking function '{name}' at script '{pythonScriptInstance.Name}'."); + _logger.LogError(exception, $"Error while invoking function '{name}' at script '{pythonScriptInstance.Uid}'."); } } } } - private void TryInitializeScript(string filename) + public List GetScriptUids() { - try + lock (_scriptInstances) { - var scriptName = new FileInfo(filename).Name; - - _logger.LogTrace($"Initializing Python script '{scriptName}'..."); - var code = File.ReadAllText(filename); - - var scriptInstance = CreateScriptInstance(scriptName, code); - scriptInstance.InvokeOptionalFunction("initialize"); - - _scriptInstances.Add(scriptInstance); - - _logger.LogInformation($"Initialized script '{scriptName}'."); - } - catch (Exception exception) - { - _logger.LogError(exception, $"Error while initializing script '{new FileInfo(filename).Name}'."); + return _scriptInstances.Select(si => si.Uid).ToList(); } } - private PythonScriptInstance CreateScriptInstance(string name, string code) + public Task ReadScriptAsync(string uid, CancellationToken cancellationToken) + { + if (uid == null) throw new ArgumentNullException(nameof(uid)); + + string path; + + lock (_scriptInstances) + { + path = _scriptInstances.FirstOrDefault(si => si.Uid == uid)?.Path; + } + + if (path == null || !File.Exists(path)) + { + return null; + } + + return File.ReadAllTextAsync(path, Encoding.UTF8, cancellationToken); + } + + public async Task WriteScriptAsync(string uid, string code, CancellationToken cancellationToken) + { + var path = Path.Combine(_scriptsPath, uid + ".py"); + + await File.WriteAllTextAsync(path, code, Encoding.UTF8, cancellationToken).ConfigureAwait(false); + await TryInitializeScriptsAsync().ConfigureAwait(false); + } + + public async Task DeleteScriptAsync(string uid) + { + var path = Path.Combine(_scriptsPath, uid + ".py"); + + if (File.Exists(path)) + { + File.Delete(path); + await TryInitializeScriptsAsync().ConfigureAwait(false); + } + } + + public async Task TryInitializeScriptsAsync() + { + lock (_scriptInstances) + { + foreach (var scriptInstance in _scriptInstances) + { + try + { + scriptInstance.InvokeOptionalFunction("destroy"); + } + catch (Exception exception) + { + _logger.LogWarning(exception, $"Error while unloading script '{scriptInstance.Uid}'."); + } + } + + _scriptInstances.Clear(); + } + + foreach (var path in Directory.GetFiles(_scriptsPath, "*.py", SearchOption.AllDirectories).OrderBy(file => file)) + { + await TryInitializeScriptAsync(path).ConfigureAwait(false); + } + } + + private async Task TryInitializeScriptAsync(string path) + { + var uid = new FileInfo(path).Name.Replace(".py", string.Empty, StringComparison.OrdinalIgnoreCase); + + try + { + _logger.LogTrace($"Initializing Python script '{uid}'..."); + var code = await File.ReadAllTextAsync(path).ConfigureAwait(false); + + var scriptInstance = CreateScriptInstance(uid, path, code); + scriptInstance.InvokeOptionalFunction("initialize"); + + lock (_scriptInstances) + { + _scriptInstances.Add(scriptInstance); + } + + _logger.LogInformation($"Initialized script '{uid}'."); + } + catch (Exception exception) + { + _logger.LogError(exception, $"Error while initializing script '{uid}'."); + } + } + + private PythonScriptInstance CreateScriptInstance(string uid, string path, string code) { var scriptScope = _scriptEngine.CreateScope(); @@ -96,31 +174,26 @@ namespace MQTTnet.Server.Scripting scriptScope.SetVariable("mqtt_net_server", _proxyObjects); compiledCode.Execute(scriptScope); - return new PythonScriptInstance(name, scriptScope); + return new PythonScriptInstance(uid, path, scriptScope); } private void AddSearchPaths(ScriptEngine scriptEngine) { - var paths = new List + if (_scriptingSettings.IncludePaths?.Any() != true) { - Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Lib"), - "/usr/lib/python2.7", - @"C:\Python27\Lib" - }; - - AddSearchPaths(scriptEngine, paths); - } + return; + } - private void AddSearchPaths(ScriptEngine scriptEngine, IEnumerable paths) - { var searchPaths = scriptEngine.GetSearchPaths(); - foreach (var path in paths) + foreach (var path in _scriptingSettings.IncludePaths) { - if (Directory.Exists(path)) + var effectivePath = PathHelper.ExpandPath(path); + + if (Directory.Exists(effectivePath)) { - searchPaths.Add(path); - _logger.LogInformation($"Added Python lib path: {path}"); + searchPaths.Add(effectivePath); + _logger.LogInformation($"Added Python lib path: {effectivePath}"); } } diff --git a/Source/MQTTnet.Server/Scripting/PythonScriptInstance.cs b/Source/MQTTnet.Server/Scripting/PythonScriptInstance.cs index 91a46340..5d28f1e5 100644 --- a/Source/MQTTnet.Server/Scripting/PythonScriptInstance.cs +++ b/Source/MQTTnet.Server/Scripting/PythonScriptInstance.cs @@ -8,14 +8,17 @@ namespace MQTTnet.Server.Scripting { private readonly ScriptScope _scriptScope; - public PythonScriptInstance(string name, ScriptScope scriptScope) + public PythonScriptInstance(string uid, string path, ScriptScope scriptScope) { - _scriptScope = scriptScope; + Uid = uid; + Path = path; - Name = name; + _scriptScope = scriptScope; } - public string Name { get; } + public string Uid { get; } + + public string Path { get; } public bool InvokeOptionalFunction(string name, params object[] parameters) { diff --git a/Source/MQTTnet.Server/Scripts/00_sample.py b/Source/MQTTnet.Server/Scripts/00_sample.py index 845a2164..fb6c290e 100644 --- a/Source/MQTTnet.Server/Scripts/00_sample.py +++ b/Source/MQTTnet.Server/Scripts/00_sample.py @@ -7,9 +7,17 @@ def initialize(): It will be executed only one time. """ - print("Hello World from Sample script.") + print("Hello World from sample script.") +def destroy(): + """ + This function is invoked when the script is unloaded due to a script file update etc. + """ + + print("Bye from sample script.") + + def on_validate_client_connection(context): """ This function is invoked whenever a client wants to connect. It can be used to validate the connection. @@ -17,20 +25,45 @@ def on_validate_client_connection(context): print(context) + # Access some custom data here which was inserted upon connect and may use it for validation. mqtt_net_server.write_shared_data(context["client_id"], {"custom_value_1": 1, "custom_value_2": True}) return + + # Supported results: + # * success + # * unspecified_error + # * malformed_packet + # * protocol_error + # * implementation_specific_error + # * unsupported_protocol_version + # * client_identifier_not_valid + # * bad_user_name_or_password + # * not_authorized + # * server_unavailable + # * server_busy + # * banned + # * bad_authentication_method + # * topic_name_invalid + # * packet_too_large + # * quota_exceeded + # * payload_format_invalid + # * retain_not_supported + # * qos_not_supported + # * use_another_server + # * server_moved + # * connection_rate_exceeded if context["client_id"] != "test_client": - context["result"] = "connection_refused_not_authorized" + context["result"] = "bad_user_name_or_password" return if context["username"] != "bud spencer": - context["result"] = "connection_refused_not_authorized" + context["result"] = "bad_user_name_or_password" return - if context["password"] != "secret": - context["result"] = "connection_refused_not_authorized" + if context["password_string"] != "secret": + context["result"] = "bad_user_name_or_password" print(context) diff --git a/Source/MQTTnet.Server/Scripts/readme.md b/Source/MQTTnet.Server/Scripts/readme.md index fb4cc996..7a34835c 100644 --- a/Source/MQTTnet.Server/Scripts/readme.md +++ b/Source/MQTTnet.Server/Scripts/readme.md @@ -1,9 +1,11 @@ -This directory contains scripts which are loaded by the server and can be used to perform the following tasks. +# MQTT Scripts -1. Validation of client connections via credentials, client IDs etc. -2. Manipulation of every processed message. -3. Validation of subscription attempts. -4. Publishing of custom application messages. +This directory contains scripts which are loaded by the server and can be used to perform the following tasks. + +* Validation of client connections via credentials, client IDs etc. +* Manipulation of every processed message. +* Validation of subscription attempts. +* Publishing of custom application messages. All scripts are loaded and _MQTTnet Server_ will invoke functions according to predefined naming conventions. If a function is implemented in multiple scripts the context will be moved throug all instances. This allows overriding of results or passing data to other (following) scripts. diff --git a/Source/MQTTnet.Server/Web/BasicAuthenticationHandler.cs b/Source/MQTTnet.Server/Web/BasicAuthenticationHandler.cs new file mode 100644 index 00000000..8b5ed214 --- /dev/null +++ b/Source/MQTTnet.Server/Web/BasicAuthenticationHandler.cs @@ -0,0 +1,118 @@ +using System; +using System.IO; +using System.Net.Http.Headers; +using System.Security.Claims; +using System.Text; +using System.Text.Encodings.Web; +using System.Threading.Tasks; +using IronPython.Runtime; +using Microsoft.AspNetCore.Authentication; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; +using Microsoft.Net.Http.Headers; +using Microsoft.Scripting; + +namespace MQTTnet.Server.Web +{ + public class AuthenticationHandler : AuthenticationHandler + { + private readonly ILogger _logger; + + public AuthenticationHandler( + IOptionsMonitor options, + ILoggerFactory loggerFactory, + UrlEncoder encoder, + ISystemClock clock, + ILogger logger) + : base(options, loggerFactory, encoder, clock) + { + _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + } + + protected override async Task HandleAuthenticateAsync() + { + if (!Request.Headers.ContainsKey(HeaderNames.Authorization)) + { + return AuthenticateResult.NoResult(); + } + + try + { + var headerValue = Request.Headers[HeaderNames.Authorization]; + var parsedHeaderValue = AuthenticationHeaderValue.Parse(Request.Headers[HeaderNames.Authorization]); + + var scheme = parsedHeaderValue.Scheme; + var parameter = parsedHeaderValue.Parameter; + string username = null; + string password = null; + + if (scheme.Equals("Basic", StringComparison.OrdinalIgnoreCase)) + { + var credentialBytes = Convert.FromBase64String(parsedHeaderValue.Parameter); + var credentials = Encoding.UTF8.GetString(credentialBytes).Split(':'); + username = credentials[0]; + password = credentials[1]; + } + + var context = new PythonDictionary + { + ["header_value"] = headerValue, + ["scheme"] = scheme, + ["parameter"] = parameter, + ["username"] = username, + ["password"] = password, + ["is_authenticated"] = false + }; + + if (!ValidateUser(context)) + { + return AuthenticateResult.Fail("Invalid credentials."); + } + + var claims = new[] + { + new Claim(ClaimTypes.NameIdentifier, context.get("username") as string ?? string.Empty) + }; + + var identity = new ClaimsIdentity(claims, Scheme.Name); + var principal = new ClaimsPrincipal(identity); + var ticket = new AuthenticationTicket(principal, Scheme.Name); + + return AuthenticateResult.Success(ticket); + } + catch (Exception exception) + { + _logger.LogWarning("Error while authenticating user.", exception); + + return AuthenticateResult.Fail(exception); + } + finally + { + await Task.CompletedTask; + } + } + + private bool ValidateUser(PythonDictionary context) + { + var handlerPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Web", "authorization_handler.py"); + if (!File.Exists(handlerPath)) + { + return false; + } + + var code = File.ReadAllText(handlerPath); + + var scriptEngine = IronPython.Hosting.Python.CreateEngine(); + //scriptEngine.Runtime.IO.SetOutput(new PythonIOStream(_logger.), Encoding.UTF8); + + var scriptScope = scriptEngine.CreateScope(); + var scriptSource = scriptScope.Engine.CreateScriptSourceFromString(code, SourceCodeKind.File); + var compiledCode = scriptSource.Compile(); + compiledCode.Execute(scriptScope); + var function = scriptScope.Engine.Operations.GetMember(scriptScope, "handle_authenticate"); + scriptScope.Engine.Operations.Invoke(function, context); + + return context.get("is_authenticated", false) as bool? == true; + } + } +} diff --git a/Source/MQTTnet.Server/Web/Extensions.cs b/Source/MQTTnet.Server/Web/Extensions.cs new file mode 100644 index 00000000..ef136dc2 --- /dev/null +++ b/Source/MQTTnet.Server/Web/Extensions.cs @@ -0,0 +1,20 @@ +using System; +using System.IO; +using System.Text; +using Microsoft.AspNetCore.Http; + +namespace MQTTnet.Server.Web +{ + public static class Extensions + { + public static string ReadBodyAsString(this HttpRequest request) + { + if (request == null) throw new ArgumentNullException(nameof(request)); + + using (var reader = new StreamReader(request.Body, Encoding.UTF8)) + { + return reader.ReadToEnd(); + } + } + } +} diff --git a/Source/MQTTnet.Server/Startup.cs b/Source/MQTTnet.Server/Web/Startup.cs similarity index 68% rename from Source/MQTTnet.Server/Startup.cs rename to Source/MQTTnet.Server/Web/Startup.cs index 7135508e..8ef622e2 100644 --- a/Source/MQTTnet.Server/Startup.cs +++ b/Source/MQTTnet.Server/Web/Startup.cs @@ -1,10 +1,14 @@ using System; +using System.Collections.Generic; +using System.Linq; +using System.Net; +using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.Mvc; -using Microsoft.EntityFrameworkCore.Internal; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; +using Microsoft.Net.Http.Headers; using Microsoft.OpenApi.Models; using Microsoft.Scripting.Utils; using MQTTnet.Server.Configuration; @@ -14,7 +18,7 @@ using MQTTnet.Server.Scripting; using MQTTnet.Server.Scripting.DataSharing; using Swashbuckle.AspNetCore.SwaggerUI; -namespace MQTTnet.Server +namespace MQTTnet.Server.Web { public class Startup { @@ -35,7 +39,7 @@ namespace MQTTnet.Server MqttServerService mqttServerService, PythonScriptHostService pythonScriptHostService, DataSharingService dataSharingService, - SettingsModel settings) + MqttSettingsModel mqttSettings) { if (environment.IsDevelopment()) { @@ -46,12 +50,20 @@ namespace MQTTnet.Server application.UseHsts(); } + application.UseCors(x => x + .AllowAnyOrigin() + .AllowAnyMethod() + .AllowAnyHeader() + .AllowCredentials()); + + application.UseAuthentication(); + application.UseStaticFiles(); application.UseHttpsRedirection(); application.UseMvc(); - ConfigureWebSocketEndpoint(application, mqttServerService, settings); + ConfigureWebSocketEndpoint(application, mqttServerService, mqttSettings); dataSharingService.Configure(); pythonScriptHostService.Configure(); @@ -73,6 +85,8 @@ namespace MQTTnet.Server public void ConfigureServices(IServiceCollection services) { + services.AddCors(); + services.AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_2) .AddJsonOptions(options => @@ -80,7 +94,7 @@ namespace MQTTnet.Server options.SerializerSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter()); }); - services.AddSingleton(ReadSettings()); + ReadMqttSettings(services); services.AddSingleton(); services.AddSingleton(); @@ -95,13 +109,29 @@ namespace MQTTnet.Server services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); - services.AddSingleton(); + services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); - + services.AddSwaggerGen(c => { c.DescribeAllEnumsAsStrings(); + + var securityScheme = new OpenApiSecurityScheme + { + Scheme = "Basic", + Name = HeaderNames.Authorization, + Type = SecuritySchemeType.Http, + In = ParameterLocation.Header + }; + + c.AddSecurityDefinition("Swagger", securityScheme); + + c.AddSecurityRequirement(new OpenApiSecurityRequirement + { + [securityScheme] = new List() + }); + c.SwaggerDoc("v1", new OpenApiInfo { Title = "MQTTnet.Server API", @@ -120,46 +150,54 @@ namespace MQTTnet.Server }, }); }); + + services.AddAuthentication("Basic") + .AddScheme("Basic", null) + .AddCookie(); } - private SettingsModel ReadSettings() + private void ReadMqttSettings(IServiceCollection services) { - var settings = new Configuration.SettingsModel(); - Configuration.Bind("MQTT", settings); - return settings; + var mqttSettings = new MqttSettingsModel(); + Configuration.Bind("MQTT", mqttSettings); + services.AddSingleton(mqttSettings); + + var scriptingSettings = new ScriptingSettingsModel(); + Configuration.Bind("Scripting", scriptingSettings); + services.AddSingleton(scriptingSettings); } private static void ConfigureWebSocketEndpoint( IApplicationBuilder application, MqttServerService mqttServerService, - SettingsModel settings) + MqttSettingsModel mqttSettings) { - if (settings?.WebSocketEndPoint?.Enabled != true) + if (mqttSettings?.WebSocketEndPoint?.Enabled != true) { return; } - if (string.IsNullOrEmpty(settings.WebSocketEndPoint.Path)) + if (string.IsNullOrEmpty(mqttSettings.WebSocketEndPoint.Path)) { return; } var webSocketOptions = new WebSocketOptions { - KeepAliveInterval = TimeSpan.FromSeconds(settings.WebSocketEndPoint.KeepAliveInterval), - ReceiveBufferSize = settings.WebSocketEndPoint.ReceiveBufferSize + KeepAliveInterval = TimeSpan.FromSeconds(mqttSettings.WebSocketEndPoint.KeepAliveInterval), + ReceiveBufferSize = mqttSettings.WebSocketEndPoint.ReceiveBufferSize }; - if (settings.WebSocketEndPoint.AllowedOrigins?.Any() == true) + if (mqttSettings.WebSocketEndPoint.AllowedOrigins?.Any() == true) { - webSocketOptions.AllowedOrigins.AddRange(settings.WebSocketEndPoint.AllowedOrigins); + webSocketOptions.AllowedOrigins.AddRange(mqttSettings.WebSocketEndPoint.AllowedOrigins); } - + application.UseWebSockets(webSocketOptions); application.Use(async (context, next) => { - if (context.Request.Path == settings.WebSocketEndPoint.Path) + if (context.Request.Path == mqttSettings.WebSocketEndPoint.Path) { if (context.WebSockets.IsWebSocketRequest) { @@ -170,7 +208,7 @@ namespace MQTTnet.Server } else { - context.Response.StatusCode = 400; + context.Response.StatusCode = (int)HttpStatusCode.BadRequest; } } else diff --git a/Source/MQTTnet.Server/Web/authorization_handler.py b/Source/MQTTnet.Server/Web/authorization_handler.py new file mode 100644 index 00000000..1cda11ff --- /dev/null +++ b/Source/MQTTnet.Server/Web/authorization_handler.py @@ -0,0 +1,20 @@ +def handle_authenticate(context): + """ + This function is invoked whenever a user tries to access protected HTTP resources. + This function must exist and return a proper value. Otherwise the request is denied. + All authentication data must be sent via using the "Authorization" header. This header + will be parsed and all values will be exposed to the context. + """ + header_value = context["header_value"] # The untouched header value. + + scheme = context["scheme"] + parameter = context["parameter"] + + username = context["username"] # Only set if proper "Basic" authorization is used. + password = context["password"] # Only set if proper "Basic" authorization is used. + + context["is_authenticated"] = True # Change this to _False_ in case of invalid credentials. + + # Example for an API key with proper format. + if header_value == "APIKey 123456": + context["is_authenticated"] = True \ No newline at end of file diff --git a/Source/MQTTnet.Server/appsettings.json b/Source/MQTTnet.Server/appsettings.json index 2ee0eaf3..9a9ce0d2 100644 --- a/Source/MQTTnet.Server/appsettings.json +++ b/Source/MQTTnet.Server/appsettings.json @@ -37,15 +37,23 @@ "AllowedOrigins": [] // List of strings with URLs. }, "CommunicationTimeout": 15, // In seconds. - "ConnectionBacklog": 0, /* Set 0 to disable */ - "EnablePersistentSessions": false, + "ConnectionBacklog": 10, // Set 0 to disable + "EnablePersistentSessions": true, "MaxPendingMessagesPerClient": 250, "RetainedApplicationMessages": { "Persist": true, - "Filename": "RetainedApplicationMessages.json", + "Path": "RetainedApplicationMessages.json", "WriteInterval": 10 // In seconds. }, - "EnableDebugLogging": true + "EnableDebugLogging": false + }, + "Scripting": { + "ScriptsPath": "Scripts", + "IncludePaths": [ + "Lib", + "/usr/lib/python2.7", + "C:\\Python27\\Lib" + ] }, "Logging": { "LogLevel": { diff --git a/Source/MQTTnet.Server/run.bat b/Source/MQTTnet.Server/run.bat deleted file mode 100644 index 016447e6..00000000 --- a/Source/MQTTnet.Server/run.bat +++ /dev/null @@ -1,2 +0,0 @@ -@echo off -START "MQTTnet Server" dotnet .\MQTTnet.Server.dll \ No newline at end of file diff --git a/Source/MQTTnet.Server/run.sh b/Source/MQTTnet.Server/run.sh deleted file mode 100644 index 1f755ad2..00000000 --- a/Source/MQTTnet.Server/run.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash -echo "Starting MQTTnet Server.." -dotnet .\MQTTnet.Server.dll \ No newline at end of file diff --git a/Source/MQTTnet/Adapter/IMqttChannelAdapter.cs b/Source/MQTTnet/Adapter/IMqttChannelAdapter.cs index 08bc8098..a41e8c1a 100644 --- a/Source/MQTTnet/Adapter/IMqttChannelAdapter.cs +++ b/Source/MQTTnet/Adapter/IMqttChannelAdapter.cs @@ -1,4 +1,5 @@ using System; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; using MQTTnet.Formatter; @@ -12,6 +13,8 @@ namespace MQTTnet.Adapter bool IsSecureConnection { get; } + X509Certificate2 ClientCertificate { get; } + MqttPacketFormatterAdapter PacketFormatterAdapter { get; } long BytesSent { get; } @@ -29,5 +32,7 @@ namespace MQTTnet.Adapter Task SendPacketAsync(MqttBasePacket packet, TimeSpan timeout, CancellationToken cancellationToken); Task ReceivePacketAsync(TimeSpan timeout, CancellationToken cancellationToken); + + void ResetStatistics(); } } diff --git a/Source/MQTTnet/Adapter/MqttChannelAdapter.cs b/Source/MQTTnet/Adapter/MqttChannelAdapter.cs index a4d71b39..4a0a85dd 100644 --- a/Source/MQTTnet/Adapter/MqttChannelAdapter.cs +++ b/Source/MQTTnet/Adapter/MqttChannelAdapter.cs @@ -2,6 +2,7 @@ using System; using System.IO; using System.Net.Sockets; using System.Runtime.InteropServices; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; using MQTTnet.Channel; @@ -47,6 +48,8 @@ namespace MQTTnet.Adapter public bool IsSecureConnection => _channel.IsSecureConnection; + public X509Certificate2 ClientCertificate => _channel.ClientCertificate; + public MqttPacketFormatterAdapter PacketFormatterAdapter { get; } public long BytesSent => Interlocked.Read(ref _bytesSent); diff --git a/Source/MQTTnet/Channel/IMqttChannel.cs b/Source/MQTTnet/Channel/IMqttChannel.cs index 4848b46d..188e55f4 100644 --- a/Source/MQTTnet/Channel/IMqttChannel.cs +++ b/Source/MQTTnet/Channel/IMqttChannel.cs @@ -1,4 +1,5 @@ using System; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; @@ -8,6 +9,7 @@ namespace MQTTnet.Channel { string Endpoint { get; } bool IsSecureConnection { get; } + X509Certificate2 ClientCertificate { get; } Task ConnectAsync(CancellationToken cancellationToken); Task DisconnectAsync(CancellationToken cancellationToken); diff --git a/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs b/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs index db6e5be5..21d646ba 100644 --- a/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs +++ b/Source/MQTTnet/Client/Connecting/MqttClientAuthenticateResult.cs @@ -1,9 +1,45 @@ -namespace MQTTnet.Client.Connecting +using System.Collections.Generic; +using MQTTnet.Packets; + +namespace MQTTnet.Client.Connecting { + // TODO: Consider renaming this to _MqttClientConnectResult_ public class MqttClientAuthenticateResult { + public MqttClientConnectResultCode ResultCode { get; set; } + public bool IsSessionPresent { get; set; } - public MqttClientConnectResultCode ResultCode { get; set; } + public bool? WildcardSubscriptionAvailable { get; set; } + + public bool? RetainAvailable { get; set; } + + public string AssignedClientIdentifier { get; set; } + + public string AuthenticationMethod { get; set; } + + public byte[] AuthenticationData { get; set; } + + public uint? MaximumPacketSize { get; set; } + + public string ReasonString { get; set; } + + public ushort? ReceiveMaximum { get; set; } + + public string ResponseInformation { get; set; } + + public ushort? TopicAliasMaximum { get; set; } + + public string ServerReference { get; set; } + + public ushort? ServerKeepAlive { get; set; } + + public uint? SessionExpiryInterval { get; set; } + + public bool? SubscriptionIdentifiersAvailable { get; set; } + + public bool? SharedSubscriptionAvailable { get; set; } + + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs new file mode 100644 index 00000000..8cd35420 --- /dev/null +++ b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs @@ -0,0 +1,9 @@ +using System.Threading.Tasks; + +namespace MQTTnet.Client.ExtendedAuthenticationExchange +{ + public interface IMqttExtendedAuthenticationExchangeHandler + { + Task HandleRequestAsync(MqttExtendedAuthenticationExchangeContext context); + } +} diff --git a/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs new file mode 100644 index 00000000..9e88f039 --- /dev/null +++ b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using MQTTnet.Packets; +using MQTTnet.Protocol; + +namespace MQTTnet.Client.ExtendedAuthenticationExchange +{ + public class MqttExtendedAuthenticationExchangeContext + { + public MqttExtendedAuthenticationExchangeContext(MqttAuthPacket authPacket, IMqttClient client) + { + if (authPacket == null) throw new ArgumentNullException(nameof(authPacket)); + + ReasonCode = authPacket.ReasonCode; + ReasonString = authPacket.Properties?.ReasonString; + AuthenticationMethod = authPacket.Properties?.AuthenticationMethod; + AuthenticationData = authPacket.Properties?.AuthenticationData; + UserProperties = authPacket.Properties?.UserProperties; + + Client = client ?? throw new ArgumentNullException(nameof(client)); + } + + public MqttAuthenticateReasonCode ReasonCode { get; } + + public string ReasonString { get; } + + public string AuthenticationMethod { get; } + + public byte[] AuthenticationData { get; } + + public List UserProperties { get; } + + public IMqttClient Client { get; } + } +} diff --git a/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeData.cs b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeData.cs new file mode 100644 index 00000000..8a49b08a --- /dev/null +++ b/Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeData.cs @@ -0,0 +1,17 @@ +using System.Collections.Generic; +using MQTTnet.Packets; +using MQTTnet.Protocol; + +namespace MQTTnet.Client.ExtendedAuthenticationExchange +{ + public class MqttExtendedAuthenticationExchangeData + { + public MqttAuthenticateReasonCode ReasonCode { get; set; } + + public string ReasonString { get; set; } + + public byte[] AuthenticationData { get; set; } + + public List UserProperties { get; } + } +} diff --git a/Source/MQTTnet/Client/IMqttClient.cs b/Source/MQTTnet/Client/IMqttClient.cs index 70259cf6..059f2e60 100644 --- a/Source/MQTTnet/Client/IMqttClient.cs +++ b/Source/MQTTnet/Client/IMqttClient.cs @@ -3,6 +3,7 @@ using System.Threading; using System.Threading.Tasks; using MQTTnet.Client.Connecting; using MQTTnet.Client.Disconnecting; +using MQTTnet.Client.ExtendedAuthenticationExchange; using MQTTnet.Client.Options; using MQTTnet.Client.Subscribing; using MQTTnet.Client.Unsubscribing; @@ -21,6 +22,7 @@ namespace MQTTnet.Client Task ConnectAsync(IMqttClientOptions options, CancellationToken cancellationToken); Task DisconnectAsync(MqttClientDisconnectOptions options, CancellationToken cancellationToken); + Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken); Task SubscribeAsync(MqttClientSubscribeOptions options, CancellationToken cancellationToken); Task UnsubscribeAsync(MqttClientUnsubscribeOptions options, CancellationToken cancellationToken); } diff --git a/Source/MQTTnet/Client/IMqttClientFactory.cs b/Source/MQTTnet/Client/IMqttClientFactory.cs index 95d567ea..bae75aca 100644 --- a/Source/MQTTnet/Client/IMqttClientFactory.cs +++ b/Source/MQTTnet/Client/IMqttClientFactory.cs @@ -5,6 +5,8 @@ namespace MQTTnet.Client { public interface IMqttClientFactory { + IMqttFactory UseClientAdapterFactory(IMqttClientAdapterFactory clientAdapterFactory); + IMqttClient CreateMqttClient(); IMqttClient CreateMqttClient(IMqttNetLogger logger); diff --git a/Source/MQTTnet/Client/MqttClient.cs b/Source/MQTTnet/Client/MqttClient.cs index 8d877f68..e29e9d00 100644 --- a/Source/MQTTnet/Client/MqttClient.cs +++ b/Source/MQTTnet/Client/MqttClient.cs @@ -5,6 +5,7 @@ using System.Threading.Tasks; using MQTTnet.Adapter; using MQTTnet.Client.Connecting; using MQTTnet.Client.Disconnecting; +using MQTTnet.Client.ExtendedAuthenticationExchange; using MQTTnet.Client.Options; using MQTTnet.Client.Publishing; using MQTTnet.Client.Receiving; @@ -12,6 +13,7 @@ using MQTTnet.Client.Subscribing; using MQTTnet.Client.Unsubscribing; using MQTTnet.Diagnostics; using MQTTnet.Exceptions; +using MQTTnet.Internal; using MQTTnet.PacketDispatcher; using MQTTnet.Packets; using MQTTnet.Protocol; @@ -138,6 +140,23 @@ namespace MQTTnet.Client } } + public Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken) + { + if (data == null) throw new ArgumentNullException(nameof(data)); + + return SendAsync(new MqttAuthPacket + { + Properties = new MqttAuthPacketProperties + { + // This must always be equal to the value from the CONNECT packet. So we use it here to ensure that. + AuthenticationMethod = Options.AuthenticationMethod, + AuthenticationData = data.AuthenticationData, + ReasonString = data.ReasonString, + UserProperties = data.UserProperties + } + }, cancellationToken); + } + public async Task SubscribeAsync(MqttClientSubscribeOptions options, CancellationToken cancellationToken) { if (options == null) throw new ArgumentNullException(nameof(options)); @@ -269,7 +288,9 @@ namespace MQTTnet.Client var disconnectedHandler = DisconnectedHandler; if (disconnectedHandler != null) { - await disconnectedHandler.HandleDisconnectedAsync(new MqttClientDisconnectedEventArgs(clientWasConnected, exception, authenticateResult)).ConfigureAwait(false); + // This handler must be executed in a new thread because otherwise a dead lock may happen + // when trying to reconnect in that handler etc. + Task.Run(() => disconnectedHandler.HandleDisconnectedAsync(new MqttClientDisconnectedEventArgs(clientWasConnected, exception, authenticateResult))).Forget(_logger); } } } @@ -341,6 +362,7 @@ namespace MQTTnet.Client while (!cancellationToken.IsCancellationRequested) { + // Values described here: [MQTT-3.1.2-24]. var keepAliveSendInterval = TimeSpan.FromSeconds(Options.KeepAlivePeriod.TotalSeconds * 0.75); if (Options.KeepAliveSendInterval.HasValue) { @@ -474,6 +496,14 @@ namespace MQTTnet.Client await DisconnectAsync(null, cancellationToken).ConfigureAwait(false); } + else if (packet is MqttAuthPacket authPacket) + { + var extendedAuthenticationExchangeHandler = Options.ExtendedAuthenticationExchangeHandler; + if (extendedAuthenticationExchangeHandler != null) + { + await extendedAuthenticationExchangeHandler.HandleRequestAsync(new MqttExtendedAuthenticationExchangeContext(authPacket, this)).ConfigureAwait(false); + } + } else { _packetDispatcher.Dispatch(packet); @@ -622,4 +652,4 @@ namespace MQTTnet.Client return Interlocked.CompareExchange(ref _disconnectGate, 1, 0) != 0; } } -} +} \ No newline at end of file diff --git a/Source/MQTTnet/Client/MqttClientExtensions.cs b/Source/MQTTnet/Client/MqttClientExtensions.cs index e5e3cd75..58040f7d 100644 --- a/Source/MQTTnet/Client/MqttClientExtensions.cs +++ b/Source/MQTTnet/Client/MqttClientExtensions.cs @@ -4,6 +4,7 @@ using System.Threading; using System.Threading.Tasks; using MQTTnet.Client.Connecting; using MQTTnet.Client.Disconnecting; +using MQTTnet.Client.ExtendedAuthenticationExchange; using MQTTnet.Client.Options; using MQTTnet.Client.Publishing; using MQTTnet.Client.Receiving; @@ -170,21 +171,36 @@ namespace MQTTnet.Client public static Task ConnectAsync(this IMqttClient client, IMqttClientOptions options) { + if (client == null) throw new ArgumentNullException(nameof(client)); + return client.ConnectAsync(options, CancellationToken.None); } public static Task DisconnectAsync(this IMqttClient client, MqttClientDisconnectOptions options) { + if (client == null) throw new ArgumentNullException(nameof(client)); + return client.DisconnectAsync(options, CancellationToken.None); } + public static Task SendExtendedAuthenticationExchangeDataAsync(this IMqttClient client, MqttExtendedAuthenticationExchangeData data) + { + if (client == null) throw new ArgumentNullException(nameof(client)); + + return client.SendExtendedAuthenticationExchangeDataAsync(data, CancellationToken.None); + } + public static Task SubscribeAsync(this IMqttClient client, MqttClientSubscribeOptions options) { + if (client == null) throw new ArgumentNullException(nameof(client)); + return client.SubscribeAsync(options, CancellationToken.None); } public static Task UnsubscribeAsync(this IMqttClient client, MqttClientUnsubscribeOptions options) { + if (client == null) throw new ArgumentNullException(nameof(client)); + return client.UnsubscribeAsync(options, CancellationToken.None); } diff --git a/Source/MQTTnet/Client/Options/IMqttClientCredentials.cs b/Source/MQTTnet/Client/Options/IMqttClientCredentials.cs index ec188673..1caa9f09 100644 --- a/Source/MQTTnet/Client/Options/IMqttClientCredentials.cs +++ b/Source/MQTTnet/Client/Options/IMqttClientCredentials.cs @@ -2,7 +2,7 @@ { public interface IMqttClientCredentials { - string Password { get; } string Username { get; } + byte[] Password { get; } } } \ No newline at end of file diff --git a/Source/MQTTnet/Client/Options/IMqttClientOptions.cs b/Source/MQTTnet/Client/Options/IMqttClientOptions.cs index 3150baa3..822603dc 100644 --- a/Source/MQTTnet/Client/Options/IMqttClientOptions.cs +++ b/Source/MQTTnet/Client/Options/IMqttClientOptions.cs @@ -1,4 +1,5 @@ using System; +using MQTTnet.Client.ExtendedAuthenticationExchange; using MQTTnet.Formatter; namespace MQTTnet.Client.Options @@ -8,6 +9,7 @@ namespace MQTTnet.Client.Options string ClientId { get; } bool CleanSession { get; } IMqttClientCredentials Credentials { get; } + IMqttExtendedAuthenticationExchangeHandler ExtendedAuthenticationExchangeHandler { get; } MqttProtocolVersion ProtocolVersion { get; } IMqttClientChannelOptions ChannelOptions { get; } diff --git a/Source/MQTTnet/Client/Options/MqttClientCredentials.cs b/Source/MQTTnet/Client/Options/MqttClientCredentials.cs index 8836e364..e0686391 100644 --- a/Source/MQTTnet/Client/Options/MqttClientCredentials.cs +++ b/Source/MQTTnet/Client/Options/MqttClientCredentials.cs @@ -4,6 +4,6 @@ { public string Username { get; set; } - public string Password { get; set; } + public byte[] Password { get; set; } } } diff --git a/Source/MQTTnet/Client/Options/MqttClientOptions.cs b/Source/MQTTnet/Client/Options/MqttClientOptions.cs index be9dc7b0..c47f5c6a 100644 --- a/Source/MQTTnet/Client/Options/MqttClientOptions.cs +++ b/Source/MQTTnet/Client/Options/MqttClientOptions.cs @@ -1,4 +1,5 @@ using System; +using MQTTnet.Client.ExtendedAuthenticationExchange; using MQTTnet.Formatter; namespace MQTTnet.Client.Options @@ -8,6 +9,7 @@ namespace MQTTnet.Client.Options public string ClientId { get; set; } = Guid.NewGuid().ToString("N"); public bool CleanSession { get; set; } = true; public IMqttClientCredentials Credentials { get; set; } + public IMqttExtendedAuthenticationExchangeHandler ExtendedAuthenticationExchangeHandler { get; set; } public MqttProtocolVersion ProtocolVersion { get; set; } = MqttProtocolVersion.V311; public IMqttClientChannelOptions ChannelOptions { get; set; } diff --git a/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs b/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs index c4d7e6cb..a7aefd18 100644 --- a/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs +++ b/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs @@ -1,5 +1,7 @@ using System; using System.Linq; +using System.Text; +using MQTTnet.Client.ExtendedAuthenticationExchange; using MQTTnet.Formatter; namespace MQTTnet.Client.Options @@ -115,6 +117,18 @@ namespace MQTTnet.Client.Options } public MqttClientOptionsBuilder WithCredentials(string username, string password = null) + { + byte[] passwordBuffer = null; + + if (password != null) + { + passwordBuffer = Encoding.UTF8.GetBytes(password); + } + + return WithCredentials(username, passwordBuffer); + } + + public MqttClientOptionsBuilder WithCredentials(string username, byte[] password = null) { _options.Credentials = new MqttClientCredentials { @@ -125,6 +139,12 @@ namespace MQTTnet.Client.Options return this; } + public MqttClientOptionsBuilder WithExtendedAuthenticationExchangeHandler(IMqttExtendedAuthenticationExchangeHandler handler) + { + _options.ExtendedAuthenticationExchangeHandler = handler; + return this; + } + public MqttClientOptionsBuilder WithTcpServer(string server, int? port = null) { _tcpOptions = new MqttClientTcpOptions @@ -136,6 +156,7 @@ namespace MQTTnet.Client.Options return this; } + // TODO: Consider creating _MqttClientTcpOptionsBuilder_ as overload. public MqttClientOptionsBuilder WithTcpServer(Action optionsBuilder) { if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder)); diff --git a/Source/MQTTnet/Client/Options/MqttClientTcpOptions.cs b/Source/MQTTnet/Client/Options/MqttClientTcpOptions.cs index c7b0e809..63a9e026 100644 --- a/Source/MQTTnet/Client/Options/MqttClientTcpOptions.cs +++ b/Source/MQTTnet/Client/Options/MqttClientTcpOptions.cs @@ -10,7 +10,7 @@ namespace MQTTnet.Client.Options public int BufferSize { get; set; } = 65536; - public bool DualMode { get; set; } = true; + public bool? DualMode { get; set; } public bool NoDelay { get; set; } = true; diff --git a/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptions.cs b/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptions.cs index 49cf551b..dc4be2f9 100644 --- a/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptions.cs +++ b/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptions.cs @@ -9,6 +9,6 @@ namespace MQTTnet.Client.Subscribing public uint? SubscriptionIdentifier { get; set; } - public List UserProperties { get; set; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs b/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs new file mode 100644 index 00000000..c33f9313 --- /dev/null +++ b/Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs @@ -0,0 +1,87 @@ +using System; +using System.Collections.Generic; +using MQTTnet.Packets; +using MQTTnet.Protocol; + +namespace MQTTnet.Client.Subscribing +{ + public class MqttClientSubscribeOptionsBuilder + { + private readonly MqttClientSubscribeOptions _subscribeOptions = new MqttClientSubscribeOptions(); + + public MqttClientSubscribeOptionsBuilder WithUserProperty(string name, string value) + { + if (name == null) throw new ArgumentNullException(nameof(name)); + if (value == null) throw new ArgumentNullException(nameof(value)); + + if (_subscribeOptions.UserProperties == null) + { + _subscribeOptions.UserProperties = new List(); + } + + _subscribeOptions.UserProperties.Add(new MqttUserProperty(name, value)); + + return this; + } + + public MqttClientSubscribeOptionsBuilder WithSubscriptionIdentifier(uint? subscriptionIdentifier) + { + _subscribeOptions.SubscriptionIdentifier = subscriptionIdentifier; + + return this; + } + + public MqttClientSubscribeOptionsBuilder WithTopicFilter( + string topic, + MqttQualityOfServiceLevel qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce, + bool? noLocal = null, + bool? retainAsPublished = null, + MqttRetainHandling? retainHandling = null) + { + return WithTopicFilter(new TopicFilter + { + Topic = topic, + QualityOfServiceLevel = qualityOfServiceLevel, + NoLocal = noLocal, + RetainAsPublished = retainAsPublished, + RetainHandling = retainHandling + }); + } + + public MqttClientSubscribeOptionsBuilder WithTopicFilter(Action topicFilterBuilder) + { + if (topicFilterBuilder == null) throw new ArgumentNullException(nameof(topicFilterBuilder)); + + var internalTopicFilterBuilder = new TopicFilterBuilder(); + topicFilterBuilder(internalTopicFilterBuilder); + + return WithTopicFilter(internalTopicFilterBuilder); + } + + public MqttClientSubscribeOptionsBuilder WithTopicFilter(TopicFilterBuilder topicFilterBuilder) + { + if (topicFilterBuilder == null) throw new ArgumentNullException(nameof(topicFilterBuilder)); + + return WithTopicFilter(topicFilterBuilder.Build()); + } + + public MqttClientSubscribeOptionsBuilder WithTopicFilter(TopicFilter topicFilter) + { + if (topicFilter == null) throw new ArgumentNullException(nameof(topicFilter)); + + if (_subscribeOptions.TopicFilters == null) + { + _subscribeOptions.TopicFilters = new List(); + } + + _subscribeOptions.TopicFilters.Add(topicFilter); + + return this; + } + + public MqttClientSubscribeOptions Build() + { + return _subscribeOptions; + } + } +} diff --git a/Source/MQTTnet/Formatter/IMqttDataConverter.cs b/Source/MQTTnet/Formatter/IMqttDataConverter.cs index c4540e73..79c91921 100644 --- a/Source/MQTTnet/Formatter/IMqttDataConverter.cs +++ b/Source/MQTTnet/Formatter/IMqttDataConverter.cs @@ -5,6 +5,8 @@ using MQTTnet.Client.Publishing; using MQTTnet.Client.Subscribing; using MQTTnet.Client.Unsubscribing; using MQTTnet.Packets; +using MQTTnet.Server; +using MqttClientSubscribeResult = MQTTnet.Client.Subscribing.MqttClientSubscribeResult; namespace MQTTnet.Formatter { @@ -20,6 +22,8 @@ namespace MQTTnet.Formatter MqttConnectPacket CreateConnectPacket(MqttApplicationMessage willApplicationMessage, IMqttClientOptions options); + MqttConnAckPacket CreateConnAckPacket(MqttConnectionValidatorContext connectionValidatorContext); + MqttClientSubscribeResult CreateClientSubscribeResult(MqttSubscribePacket subscribePacket, MqttSubAckPacket subAckPacket); MqttClientUnsubscribeResult CreateClientUnsubscribeResult(MqttUnsubscribePacket unsubscribePacket, MqttUnsubAckPacket unsubAckPacket); diff --git a/Source/MQTTnet/Formatter/V3/MqttV310DataConverter.cs b/Source/MQTTnet/Formatter/V3/MqttV310DataConverter.cs index 58b58c21..48d42cd0 100644 --- a/Source/MQTTnet/Formatter/V3/MqttV310DataConverter.cs +++ b/Source/MQTTnet/Formatter/V3/MqttV310DataConverter.cs @@ -9,6 +9,8 @@ using MQTTnet.Client.Unsubscribing; using MQTTnet.Exceptions; using MQTTnet.Packets; using MQTTnet.Protocol; +using MQTTnet.Server; +using MqttClientSubscribeResult = MQTTnet.Client.Subscribing.MqttClientSubscribeResult; namespace MQTTnet.Formatter.V3 { @@ -124,6 +126,16 @@ namespace MQTTnet.Formatter.V3 }; } + public MqttConnAckPacket CreateConnAckPacket(MqttConnectionValidatorContext connectionValidatorContext) + { + if (connectionValidatorContext == null) throw new ArgumentNullException(nameof(connectionValidatorContext)); + + return new MqttConnAckPacket + { + ReturnCode = new MqttConnectReasonCodeConverter().ToConnectReturnCode(connectionValidatorContext.ReasonCode) + }; + } + public MqttClientSubscribeResult CreateClientSubscribeResult(MqttSubscribePacket subscribePacket, MqttSubAckPacket subAckPacket) { if (subscribePacket == null) throw new ArgumentNullException(nameof(subscribePacket)); diff --git a/Source/MQTTnet/Formatter/V3/MqttV310PacketFormatter.cs b/Source/MQTTnet/Formatter/V3/MqttV310PacketFormatter.cs index 70af10e6..248b8bb0 100644 --- a/Source/MQTTnet/Formatter/V3/MqttV310PacketFormatter.cs +++ b/Source/MQTTnet/Formatter/V3/MqttV310PacketFormatter.cs @@ -10,7 +10,11 @@ namespace MQTTnet.Formatter.V3 public class MqttV310PacketFormatter : IMqttPacketFormatter { private const int FixedHeaderSize = 1; - + + private static readonly MqttPingReqPacket PingReqPacket = new MqttPingReqPacket(); + private static readonly MqttPingRespPacket PingRespPacket = new MqttPingRespPacket(); + private static readonly MqttDisconnectPacket DisconnectPacket = new MqttDisconnectPacket(); + private readonly IMqttPacketWriter _packetWriter; public MqttV310PacketFormatter() @@ -67,14 +71,14 @@ namespace MQTTnet.Formatter.V3 { case MqttControlPacketType.Connect: return DecodeConnectPacket(receivedMqttPacket.Body); case MqttControlPacketType.ConnAck: return DecodeConnAckPacket(receivedMqttPacket.Body); - case MqttControlPacketType.Disconnect: return new MqttDisconnectPacket(); + case MqttControlPacketType.Disconnect: return DisconnectPacket; case MqttControlPacketType.Publish: return DecodePublishPacket(receivedMqttPacket); case MqttControlPacketType.PubAck: return DecodePubAckPacket(receivedMqttPacket.Body); case MqttControlPacketType.PubRec: return DecodePubRecPacket(receivedMqttPacket.Body); case MqttControlPacketType.PubRel: return DecodePubRelPacket(receivedMqttPacket.Body); case MqttControlPacketType.PubComp: return DecodePubCompPacket(receivedMqttPacket.Body); - case MqttControlPacketType.PingReq: return new MqttPingReqPacket(); - case MqttControlPacketType.PingResp: return new MqttPingRespPacket(); + case MqttControlPacketType.PingReq: return PingReqPacket; + case MqttControlPacketType.PingResp: return PingRespPacket; case MqttControlPacketType.Subscribe: return DecodeSubscribePacket(receivedMqttPacket.Body); case MqttControlPacketType.SubAck: return DecodeSubAckPacket(receivedMqttPacket.Body); case MqttControlPacketType.Unsubscibe: return DecodeUnsubscribePacket(receivedMqttPacket.Body); @@ -229,7 +233,7 @@ namespace MQTTnet.Formatter.V3 if (!receivedMqttPacket.Body.EndOfStream) { - packet.Payload = receivedMqttPacket.Body.ReadRemainingData().ToArray(); + packet.Payload = receivedMqttPacket.Body.ReadRemainingData(); } return packet; @@ -289,7 +293,7 @@ namespace MQTTnet.Formatter.V3 if (passwordFlag) { - packet.Password = body.ReadStringWithLengthPrefix(); + packet.Password = body.ReadWithLengthPrefix(); } ValidateConnectPacket(packet); diff --git a/Source/MQTTnet/Formatter/V5/MqttV500DataConverter.cs b/Source/MQTTnet/Formatter/V5/MqttV500DataConverter.cs index 92766177..42d3241d 100644 --- a/Source/MQTTnet/Formatter/V5/MqttV500DataConverter.cs +++ b/Source/MQTTnet/Formatter/V5/MqttV500DataConverter.cs @@ -10,6 +10,9 @@ using MQTTnet.Client.Unsubscribing; using MQTTnet.Exceptions; using MQTTnet.Packets; using MQTTnet.Protocol; +using MQTTnet.Server; + +using MqttClientSubscribeResult = MQTTnet.Client.Subscribing.MqttClientSubscribeResult; namespace MQTTnet.Formatter.V5 { @@ -82,7 +85,23 @@ namespace MQTTnet.Formatter.V5 return new MqttClientAuthenticateResult { IsSessionPresent = connAckPacket.IsSessionPresent, - ResultCode = (MqttClientConnectResultCode)connAckPacket.ReasonCode.Value + ResultCode = (MqttClientConnectResultCode)connAckPacket.ReasonCode.Value, + WildcardSubscriptionAvailable = connAckPacket.Properties?.WildcardSubscriptionAvailable, + RetainAvailable = connAckPacket.Properties?.RetainAvailable, + AssignedClientIdentifier = connAckPacket.Properties?.AssignedClientIdentifier, + AuthenticationMethod = connAckPacket.Properties?.AuthenticationMethod, + AuthenticationData = connAckPacket.Properties?.AuthenticationData, + MaximumPacketSize = connAckPacket.Properties?.MaximumPacketSize, + ReasonString = connAckPacket.Properties?.ReasonString, + ReceiveMaximum = connAckPacket.Properties?.ReceiveMaximum, + ResponseInformation = connAckPacket.Properties?.ResponseInformation, + TopicAliasMaximum = connAckPacket.Properties?.TopicAliasMaximum, + ServerReference = connAckPacket.Properties?.ServerReference, + ServerKeepAlive = connAckPacket.Properties?.ServerKeepAlive, + SessionExpiryInterval = connAckPacket.Properties?.SessionExpiryInterval, + SubscriptionIdentifiersAvailable = connAckPacket.Properties?.SubscriptionIdentifiersAvailable, + SharedSubscriptionAvailable = connAckPacket.Properties?.SharedSubscriptionAvailable, + UserProperties = connAckPacket.Properties?.UserProperties }; } @@ -113,6 +132,22 @@ namespace MQTTnet.Formatter.V5 }; } + public MqttConnAckPacket CreateConnAckPacket(MqttConnectionValidatorContext connectionValidatorContext) + { + return new MqttConnAckPacket + { + ReasonCode = connectionValidatorContext.ReasonCode, + Properties = new MqttConnAckPacketProperties + { + UserProperties = connectionValidatorContext.UserProperties, + AuthenticationMethod = connectionValidatorContext.AuthenticationMethod, + AuthenticationData = connectionValidatorContext.ResponseAuthenticationData, + AssignedClientIdentifier = connectionValidatorContext.AssignedClientIdentifier, + ReasonString = connectionValidatorContext.ReasonString + } + }; + } + public MqttClientSubscribeResult CreateClientSubscribeResult(MqttSubscribePacket subscribePacket, MqttSubAckPacket subAckPacket) { if (subscribePacket == null) throw new ArgumentNullException(nameof(subscribePacket)); @@ -160,7 +195,7 @@ namespace MQTTnet.Formatter.V5 packet.TopicFilters.AddRange(options.TopicFilters); packet.Properties.SubscriptionIdentifier = options.SubscriptionIdentifier; - packet.Properties.UserProperties.AddRange(options.UserProperties); + packet.Properties.UserProperties = options.UserProperties; return packet; } @@ -175,7 +210,7 @@ namespace MQTTnet.Formatter.V5 }; packet.TopicFilters.AddRange(options.TopicFilters); - packet.Properties.UserProperties.AddRange(options.UserProperties); + packet.Properties.UserProperties = options.UserProperties; return packet; } diff --git a/Source/MQTTnet/Formatter/V5/MqttV500PacketDecoder.cs b/Source/MQTTnet/Formatter/V5/MqttV500PacketDecoder.cs index 4c394e46..23a6d7e7 100644 --- a/Source/MQTTnet/Formatter/V5/MqttV500PacketDecoder.cs +++ b/Source/MQTTnet/Formatter/V5/MqttV500PacketDecoder.cs @@ -1,6 +1,5 @@ using System; using System.Collections.Generic; -using System.Linq; using MQTTnet.Adapter; using MQTTnet.Exceptions; using MQTTnet.Packets; @@ -10,6 +9,10 @@ namespace MQTTnet.Formatter.V5 { public class MqttV500PacketDecoder { + private static readonly MqttPingReqPacket PingReqPacket = new MqttPingReqPacket(); + + private static readonly MqttPingRespPacket PingRespPacket = new MqttPingRespPacket(); + public MqttBasePacket Decode(ReceivedMqttPacket receivedMqttPacket) { if (receivedMqttPacket == null) throw new ArgumentNullException(nameof(receivedMqttPacket)); @@ -46,10 +49,7 @@ namespace MQTTnet.Formatter.V5 { ThrowIfBodyIsEmpty(body); - var packet = new MqttConnectPacket - { - Properties = new MqttConnectPacketProperties() - }; + var packet = new MqttConnectPacket(); var protocolName = body.ReadStringWithLengthPrefix(); var protocolVersion = body.ReadByte(); @@ -84,6 +84,11 @@ namespace MQTTnet.Formatter.V5 var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttConnectPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.SessionExpiryInterval) { packet.Properties.SessionExpiryInterval = propertiesReader.ReadSessionExpiryInterval(); @@ -118,6 +123,11 @@ namespace MQTTnet.Formatter.V5 } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -198,7 +208,7 @@ namespace MQTTnet.Formatter.V5 if (passwordFlag) { - packet.Password = body.ReadStringWithLengthPrefix(); + packet.Password = body.ReadWithLengthPrefix(); } return packet; @@ -213,13 +223,17 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttConnAckPacket { IsSessionPresent = (acknowledgeFlags & 0x1) > 0, - ReasonCode = (MqttConnectReasonCode)body.ReadByte(), - Properties = new MqttConnAckPacketProperties() + ReasonCode = (MqttConnectReasonCode)body.ReadByte() }; var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttConnAckPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.SessionExpiryInterval) { packet.Properties.SessionExpiryInterval = propertiesReader.ReadSessionExpiryInterval(); @@ -282,6 +296,11 @@ namespace MQTTnet.Formatter.V5 } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -299,13 +318,17 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttDisconnectPacket { - ReasonCode = (MqttDisconnectReasonCode)body.ReadByte(), - Properties = new MqttDisconnectPacketProperties() + ReasonCode = (MqttDisconnectReasonCode)body.ReadByte() }; var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttDisconnectPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.SessionExpiryInterval) { packet.Properties.SessionExpiryInterval = propertiesReader.ReadSessionExpiryInterval(); @@ -320,6 +343,11 @@ namespace MQTTnet.Formatter.V5 } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -337,19 +365,28 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttSubscribePacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttSubscribePacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttSubscribePacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.SubscriptionIdentifier) { packet.Properties.SubscriptionIdentifier = propertiesReader.ReadSubscriptionIdentifier(); } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -387,19 +424,28 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttSubAckPacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttSubAckPacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttSubAckPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.ReasonString) { packet.Properties.ReasonString = propertiesReader.ReadReasonString(); } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -423,15 +469,24 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttUnsubscribePacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttUnsubscribePacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttUnsubscribePacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -454,19 +509,28 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttUnsubAckPacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttUnsubAckPacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttUnsubAckPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.ReasonString) { packet.Properties.ReasonString = propertiesReader.ReadReasonString(); } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -486,12 +550,12 @@ namespace MQTTnet.Formatter.V5 private static MqttBasePacket DecodePingReqPacket() { - return new MqttPingReqPacket(); + return PingReqPacket; } private static MqttBasePacket DecodePingRespPacket() { - return new MqttPingRespPacket(); + return PingRespPacket; } private static MqttBasePacket DecodePublishPacket(byte header, IMqttPacketBodyReader body) @@ -507,8 +571,7 @@ namespace MQTTnet.Formatter.V5 Topic = body.ReadStringWithLengthPrefix(), Retain = retain, QualityOfServiceLevel = qos, - Dup = dup, - Properties = new MqttPublishPacketProperties() + Dup = dup }; if (qos > 0) @@ -519,6 +582,11 @@ namespace MQTTnet.Formatter.V5 var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttPublishPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.PayloadFormatIndicator) { packet.Properties.PayloadFormatIndicator = propertiesReader.ReadPayloadFormatIndicator(); @@ -569,7 +637,7 @@ namespace MQTTnet.Formatter.V5 if (!body.EndOfStream) { - packet.Payload = body.ReadRemainingData().ToArray(); + packet.Payload = body.ReadRemainingData(); } return packet; @@ -581,8 +649,7 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttPubAckPacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttPubAckPacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; if (body.EndOfStream) @@ -596,12 +663,22 @@ namespace MQTTnet.Formatter.V5 var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttPubAckPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.ReasonString) { packet.Properties.ReasonString = propertiesReader.ReadReasonString(); } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -619,8 +696,7 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttPubRecPacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttPubRecPacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; if (body.EndOfStream) @@ -634,12 +710,22 @@ namespace MQTTnet.Formatter.V5 var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttPubRecPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.ReasonString) { packet.Properties.ReasonString = propertiesReader.ReadReasonString(); } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -657,8 +743,7 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttPubRelPacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttPubRelPacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; if (body.EndOfStream) @@ -672,12 +757,22 @@ namespace MQTTnet.Formatter.V5 var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttPubRelPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.ReasonString) { packet.Properties.ReasonString = propertiesReader.ReadReasonString(); } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -695,8 +790,7 @@ namespace MQTTnet.Formatter.V5 var packet = new MqttPubCompPacket { - PacketIdentifier = body.ReadTwoByteInteger(), - Properties = new MqttPubCompPacketProperties() + PacketIdentifier = body.ReadTwoByteInteger() }; if (body.EndOfStream) @@ -710,12 +804,22 @@ namespace MQTTnet.Formatter.V5 var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttPubCompPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.ReasonString) { packet.Properties.ReasonString = propertiesReader.ReadReasonString(); } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else @@ -731,10 +835,7 @@ namespace MQTTnet.Formatter.V5 { ThrowIfBodyIsEmpty(body); - var packet = new MqttAuthPacket - { - Properties = new MqttAuthPacketProperties() - }; + var packet = new MqttAuthPacket(); if (body.EndOfStream) { @@ -747,6 +848,11 @@ namespace MQTTnet.Formatter.V5 var propertiesReader = new MqttV500PropertiesReader(body); while (propertiesReader.MoveNext()) { + if (packet.Properties == null) + { + packet.Properties = new MqttAuthPacketProperties(); + } + if (propertiesReader.CurrentPropertyId == MqttPropertyId.AuthenticationMethod) { packet.Properties.AuthenticationMethod = propertiesReader.ReadAuthenticationMethod(); @@ -761,6 +867,11 @@ namespace MQTTnet.Formatter.V5 } else if (propertiesReader.CurrentPropertyId == MqttPropertyId.UserProperty) { + if (packet.Properties.UserProperties == null) + { + packet.Properties.UserProperties = new List(); + } + propertiesReader.AddUserPropertyTo(packet.Properties.UserProperties); } else diff --git a/Source/MQTTnet/Implementations/MqttTcpChannel.Uwp.cs b/Source/MQTTnet/Implementations/MqttTcpChannel.Uwp.cs index 1c0f944d..cb0f71c2 100644 --- a/Source/MQTTnet/Implementations/MqttTcpChannel.Uwp.cs +++ b/Source/MQTTnet/Implementations/MqttTcpChannel.Uwp.cs @@ -5,6 +5,7 @@ using System.IO; using System.Linq; using System.Runtime.InteropServices.WindowsRuntime; using System.Security.Authentication; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; using Windows.Networking; @@ -31,7 +32,7 @@ namespace MQTTnet.Implementations _bufferSize = _options.BufferSize; } - public MqttTcpChannel(StreamSocket socket, IMqttServerOptions serverOptions) + public MqttTcpChannel(StreamSocket socket, X509Certificate2 clientCertificate, IMqttServerOptions serverOptions) { _socket = socket ?? throw new ArgumentNullException(nameof(socket)); _bufferSize = serverOptions.DefaultEndpointOptions.BufferSize; @@ -39,6 +40,7 @@ namespace MQTTnet.Implementations CreateStreams(); IsSecureConnection = socket.Information.ProtectionLevel >= SocketProtectionLevel.Tls12; + ClientCertificate = clientCertificate; Endpoint = _socket.Information.RemoteAddress + ":" + _socket.Information.RemotePort; } @@ -49,6 +51,8 @@ namespace MQTTnet.Implementations public bool IsSecureConnection { get; } + public X509Certificate2 ClientCertificate { get; } + public async Task ConnectAsync(CancellationToken cancellationToken) { if (_socket == null) diff --git a/Source/MQTTnet/Implementations/MqttTcpChannel.cs b/Source/MQTTnet/Implementations/MqttTcpChannel.cs index cd4e2900..63adf557 100644 --- a/Source/MQTTnet/Implementations/MqttTcpChannel.cs +++ b/Source/MQTTnet/Implementations/MqttTcpChannel.cs @@ -28,18 +28,22 @@ namespace MQTTnet.Implementations IsSecureConnection = clientOptions.ChannelOptions?.TlsOptions?.UseTls == true; } - public MqttTcpChannel(Stream stream, string endpoint) + public MqttTcpChannel(Stream stream, string endpoint, X509Certificate2 clientCertificate) { _stream = stream ?? throw new ArgumentNullException(nameof(stream)); - IsSecureConnection = stream is SslStream; Endpoint = endpoint; + + IsSecureConnection = stream is SslStream; + ClientCertificate = clientCertificate; } public string Endpoint { get; private set; } public bool IsSecureConnection { get; } + public X509Certificate2 ClientCertificate { get; } + public async Task ConnectAsync(CancellationToken cancellationToken) { Socket socket; @@ -55,9 +59,16 @@ namespace MQTTnet.Implementations socket.ReceiveBufferSize = _options.BufferSize; socket.SendBufferSize = _options.BufferSize; - socket.DualMode = _options.DualMode; socket.NoDelay = _options.NoDelay; + if (_options.DualMode.HasValue) + { + // It is important to avoid setting the flag if no specific value is set by the user + // because on IPv4 only networks the setter will always throw an exception. Regardless + // of the actual value. + socket.DualMode = _options.DualMode.Value; + } + // Workaround for: workaround for https://github.com/dotnet/corefx/issues/24430 using (cancellationToken.Register(() => socket.Dispose())) { diff --git a/Source/MQTTnet/Implementations/MqttTcpServerAdapter.Uwp.cs b/Source/MQTTnet/Implementations/MqttTcpServerAdapter.Uwp.cs index 45290757..3b24bd13 100644 --- a/Source/MQTTnet/Implementations/MqttTcpServerAdapter.Uwp.cs +++ b/Source/MQTTnet/Implementations/MqttTcpServerAdapter.Uwp.cs @@ -1,11 +1,13 @@ #if WINDOWS_UWP -using System; -using System.Threading.Tasks; using Windows.Networking.Sockets; using MQTTnet.Adapter; using MQTTnet.Diagnostics; using MQTTnet.Formatter; using MQTTnet.Server; +using System; +using System.Runtime.InteropServices.WindowsRuntime; +using System.Security.Cryptography.X509Certificates; +using System.Threading.Tasks; namespace MQTTnet.Implementations { @@ -73,7 +75,21 @@ namespace MQTTnet.Implementations var clientHandler = ClientHandler; if (clientHandler != null) { - using (var clientAdapter = new MqttChannelAdapter(new MqttTcpChannel(args.Socket, _options), new MqttPacketFormatterAdapter(), _logger)) + X509Certificate2 clientCertificate = null; + + if (args.Socket.Control.ClientCertificate != null) + { + try + { + clientCertificate = new X509Certificate2(args.Socket.Control.ClientCertificate.GetCertificateBlob().ToArray()); + } + catch (Exception exception) + { + _logger.Warning(exception, "Unable to convert UWP certificate to X509Certificate2."); + } + } + + using (var clientAdapter = new MqttChannelAdapter(new MqttTcpChannel(args.Socket, clientCertificate, _options), new MqttPacketFormatterAdapter(), _logger)) { await clientHandler(clientAdapter).ConfigureAwait(false); } diff --git a/Source/MQTTnet/Implementations/MqttTcpServerListener.cs b/Source/MQTTnet/Implementations/MqttTcpServerListener.cs index cc8246ac..fe03c730 100644 --- a/Source/MQTTnet/Implementations/MqttTcpServerListener.cs +++ b/Source/MQTTnet/Implementations/MqttTcpServerListener.cs @@ -112,17 +112,27 @@ namespace MQTTnet.Implementations stream = new NetworkStream(clientSocket, true); + X509Certificate2 clientCertificate = null; + if (_tlsCertificate != null) { var sslStream = new SslStream(stream, false); - await sslStream.AuthenticateAsServerAsync(_tlsCertificate, false, _tlsOptions.SslProtocol, false).ConfigureAwait(false); + + await sslStream.AuthenticateAsServerAsync( + _tlsCertificate, + _tlsOptions.ClientCertificateRequired, + _tlsOptions.SslProtocol, + _tlsOptions.CheckCertificateRevocation).ConfigureAwait(false); + stream = sslStream; + + clientCertificate = sslStream.RemoteCertificate as X509Certificate2; } var clientHandler = ClientHandler; if (clientHandler != null) { - using (var clientAdapter = new MqttChannelAdapter(new MqttTcpChannel(stream, remoteEndPoint), new MqttPacketFormatterAdapter(), _logger)) + using (var clientAdapter = new MqttChannelAdapter(new MqttTcpChannel(stream, remoteEndPoint, clientCertificate), new MqttPacketFormatterAdapter(), _logger)) { await clientHandler(clientAdapter).ConfigureAwait(false); } diff --git a/Source/MQTTnet/Implementations/MqttWebSocketChannel.cs b/Source/MQTTnet/Implementations/MqttWebSocketChannel.cs index ccc601a7..38e43422 100644 --- a/Source/MQTTnet/Implementations/MqttWebSocketChannel.cs +++ b/Source/MQTTnet/Implementations/MqttWebSocketChannel.cs @@ -11,9 +11,9 @@ namespace MQTTnet.Implementations { public class MqttWebSocketChannel : IMqttChannel { - private readonly SemaphoreSlim _sendLock = new SemaphoreSlim(1, 1); private readonly MqttClientWebSocketOptions _options; + private SemaphoreSlim _sendLock = new SemaphoreSlim(1, 1); private WebSocket _webSocket; public MqttWebSocketChannel(MqttClientWebSocketOptions options) @@ -21,18 +21,21 @@ namespace MQTTnet.Implementations _options = options ?? throw new ArgumentNullException(nameof(options)); } - public MqttWebSocketChannel(WebSocket webSocket, string endpoint, bool isSecureConnection) + public MqttWebSocketChannel(WebSocket webSocket, string endpoint, bool isSecureConnection, X509Certificate2 clientCertificate) { _webSocket = webSocket ?? throw new ArgumentNullException(nameof(webSocket)); Endpoint = endpoint; IsSecureConnection = isSecureConnection; + ClientCertificate = clientCertificate; } public string Endpoint { get; } public bool IsSecureConnection { get; private set; } + public X509Certificate2 ClientCertificate { get; private set; } + public async Task ConnectAsync(CancellationToken cancellationToken) { var uri = _options.Uri; @@ -114,9 +117,14 @@ namespace MQTTnet.Implementations public async Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) { - // This lock is required because the client will throw an exception if _SendAsync_ is + // The lock is required because the client will throw an exception if _SendAsync_ is // called from multiple threads at the same time. But this issue only happens with several // framework versions. + if (_sendLock == null) + { + return; + } + await _sendLock.WaitAsync(cancellationToken).ConfigureAwait(false); try { @@ -124,13 +132,14 @@ namespace MQTTnet.Implementations } finally { - _sendLock.Release(); + _sendLock?.Release(); } } public void Dispose() { _sendLock?.Dispose(); + _sendLock = null; try { diff --git a/Source/MQTTnet/Internal/TaskExtensions.cs b/Source/MQTTnet/Internal/TaskExtensions.cs new file mode 100644 index 00000000..733631c5 --- /dev/null +++ b/Source/MQTTnet/Internal/TaskExtensions.cs @@ -0,0 +1,17 @@ +using System.Threading.Tasks; +using MQTTnet.Diagnostics; + +namespace MQTTnet.Internal +{ + public static class TaskExtensions + { + public static void Forget(this Task task, IMqttNetChildLogger logger) + { + task?.ContinueWith(t => + { + logger.Error(t.Exception, "Unhandled exception."); + }, + TaskContinuationOptions.OnlyOnFaulted); + } + } +} diff --git a/Source/MQTTnet/Internal/TestMqttChannel.cs b/Source/MQTTnet/Internal/TestMqttChannel.cs index 1ef8e5a5..954aa1b9 100644 --- a/Source/MQTTnet/Internal/TestMqttChannel.cs +++ b/Source/MQTTnet/Internal/TestMqttChannel.cs @@ -1,4 +1,5 @@ using System.IO; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; using MQTTnet.Channel; @@ -18,6 +19,8 @@ namespace MQTTnet.Internal public bool IsSecureConnection { get; } = false; + public X509Certificate2 ClientCertificate { get; } + public Task ConnectAsync(CancellationToken cancellationToken) { return Task.FromResult(0); diff --git a/Source/MQTTnet/MQTTnet.csproj b/Source/MQTTnet/MQTTnet.csproj index 5ded88e4..5e0251da 100644 --- a/Source/MQTTnet/MQTTnet.csproj +++ b/Source/MQTTnet/MQTTnet.csproj @@ -3,7 +3,7 @@ netstandard1.3;netstandard2.0 $(TargetFrameworks);net452;net461 - $(TargetFrameworks);uap10.0 + $(TargetFrameworks);uap10.0 MQTTnet MQTTnet False diff --git a/Source/MQTTnet/MqttApplicationMessageBuilder.cs b/Source/MQTTnet/MqttApplicationMessageBuilder.cs index 7d116890..c265e4d1 100644 --- a/Source/MQTTnet/MqttApplicationMessageBuilder.cs +++ b/Source/MQTTnet/MqttApplicationMessageBuilder.cs @@ -29,6 +29,12 @@ namespace MQTTnet return this; } + public MqttApplicationMessageBuilder WithPayload(byte[] payload) + { + _payload = payload; + return this; + } + public MqttApplicationMessageBuilder WithPayload(IEnumerable payload) { if (payload == null) diff --git a/Source/MQTTnet/MqttFactory.cs b/Source/MQTTnet/MqttFactory.cs index ab6cc760..cb835f60 100644 --- a/Source/MQTTnet/MqttFactory.cs +++ b/Source/MQTTnet/MqttFactory.cs @@ -10,6 +10,8 @@ namespace MQTTnet { public class MqttFactory : IMqttFactory { + private IMqttClientAdapterFactory _clientAdapterFactory = new MqttClientAdapterFactory(); + public MqttFactory() : this(new MqttNetLogger()) { } @@ -21,6 +23,12 @@ namespace MQTTnet public IMqttNetLogger DefaultLogger { get; } + public IMqttFactory UseClientAdapterFactory(IMqttClientAdapterFactory clientAdapterFactory) + { + _clientAdapterFactory = clientAdapterFactory ?? throw new ArgumentNullException(nameof(clientAdapterFactory)); + return this; + } + public IMqttClient CreateMqttClient() { return CreateMqttClient(DefaultLogger); @@ -30,22 +38,22 @@ namespace MQTTnet { if (logger == null) throw new ArgumentNullException(nameof(logger)); - return new MqttClient(new MqttClientAdapterFactory(), logger); + return new MqttClient(_clientAdapterFactory, logger); } - public IMqttClient CreateMqttClient(IMqttClientAdapterFactory adapterFactory) + public IMqttClient CreateMqttClient(IMqttClientAdapterFactory clientAdapterFactory) { - if (adapterFactory == null) throw new ArgumentNullException(nameof(adapterFactory)); + if (clientAdapterFactory == null) throw new ArgumentNullException(nameof(clientAdapterFactory)); - return new MqttClient(adapterFactory, DefaultLogger); + return new MqttClient(clientAdapterFactory, DefaultLogger); } - public IMqttClient CreateMqttClient(IMqttNetLogger logger, IMqttClientAdapterFactory adapterFactory) + public IMqttClient CreateMqttClient(IMqttNetLogger logger, IMqttClientAdapterFactory clientAdapterFactory) { if (logger == null) throw new ArgumentNullException(nameof(logger)); - if (adapterFactory == null) throw new ArgumentNullException(nameof(adapterFactory)); + if (clientAdapterFactory == null) throw new ArgumentNullException(nameof(clientAdapterFactory)); - return new MqttClient(adapterFactory, logger); + return new MqttClient(clientAdapterFactory, logger); } public IMqttServer CreateMqttServer() @@ -60,19 +68,19 @@ namespace MQTTnet return CreateMqttServer(new List { new MqttTcpServerAdapter(logger.CreateChildLogger()) }, logger); } - public IMqttServer CreateMqttServer(IEnumerable adapters, IMqttNetLogger logger) + public IMqttServer CreateMqttServer(IEnumerable serverAdapters, IMqttNetLogger logger) { - if (adapters == null) throw new ArgumentNullException(nameof(adapters)); + if (serverAdapters == null) throw new ArgumentNullException(nameof(serverAdapters)); if (logger == null) throw new ArgumentNullException(nameof(logger)); - return new MqttServer(adapters, logger.CreateChildLogger()); + return new MqttServer(serverAdapters, logger.CreateChildLogger()); } - public IMqttServer CreateMqttServer(IEnumerable adapters) + public IMqttServer CreateMqttServer(IEnumerable serverAdapters) { - if (adapters == null) throw new ArgumentNullException(nameof(adapters)); + if (serverAdapters == null) throw new ArgumentNullException(nameof(serverAdapters)); - return new MqttServer(adapters, DefaultLogger.CreateChildLogger()); + return new MqttServer(serverAdapters, DefaultLogger.CreateChildLogger()); } } } \ No newline at end of file diff --git a/Source/MQTTnet/Packets/MqttAuthPacketProperties.cs b/Source/MQTTnet/Packets/MqttAuthPacketProperties.cs index 6ed25ee0..057004d1 100644 --- a/Source/MQTTnet/Packets/MqttAuthPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttAuthPacketProperties.cs @@ -10,6 +10,6 @@ namespace MQTTnet.Packets public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttConnAckPacketProperties.cs b/Source/MQTTnet/Packets/MqttConnAckPacketProperties.cs index 262222db..d59735c6 100644 --- a/Source/MQTTnet/Packets/MqttConnAckPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttConnAckPacketProperties.cs @@ -18,7 +18,7 @@ namespace MQTTnet.Packets public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } public bool? WildcardSubscriptionAvailable { get; set; } diff --git a/Source/MQTTnet/Packets/MqttConnectPacket.cs b/Source/MQTTnet/Packets/MqttConnectPacket.cs index 3465280e..4eae2d6b 100644 --- a/Source/MQTTnet/Packets/MqttConnectPacket.cs +++ b/Source/MQTTnet/Packets/MqttConnectPacket.cs @@ -6,7 +6,7 @@ public string Username { get; set; } - public string Password { get; set; } + public byte[] Password { get; set; } public ushort KeepAlivePeriod { get; set; } @@ -23,13 +23,14 @@ public override string ToString() { - var password = Password; - if (!string.IsNullOrEmpty(password)) + var passwordText = string.Empty; + + if (Password != null) { - password = "****"; + passwordText = "****"; } - return string.Concat("Connect: [ClientId=", ClientId, "] [Username=", Username, "] [Password=", password, "] [KeepAlivePeriod=", KeepAlivePeriod, "] [CleanSession=", CleanSession, "]"); + return string.Concat("Connect: [ClientId=", ClientId, "] [Username=", Username, "] [Password=", passwordText, "] [KeepAlivePeriod=", KeepAlivePeriod, "] [CleanSession=", CleanSession, "]"); } } } diff --git a/Source/MQTTnet/Packets/MqttConnectPacketProperties.cs b/Source/MQTTnet/Packets/MqttConnectPacketProperties.cs index 25cf5bda..4cc405e2 100644 --- a/Source/MQTTnet/Packets/MqttConnectPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttConnectPacketProperties.cs @@ -22,6 +22,6 @@ namespace MQTTnet.Packets public uint? MaximumPacketSize { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } \ No newline at end of file diff --git a/Source/MQTTnet/Packets/MqttDisconnectPacketProperties.cs b/Source/MQTTnet/Packets/MqttDisconnectPacketProperties.cs index a5385cb0..e05529ff 100644 --- a/Source/MQTTnet/Packets/MqttDisconnectPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttDisconnectPacketProperties.cs @@ -8,7 +8,7 @@ namespace MQTTnet.Packets public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } public string ServerReference { get; set; } } diff --git a/Source/MQTTnet/Packets/MqttPubAckPacketProperties.cs b/Source/MQTTnet/Packets/MqttPubAckPacketProperties.cs index 061f72f9..e2debd4a 100644 --- a/Source/MQTTnet/Packets/MqttPubAckPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttPubAckPacketProperties.cs @@ -6,6 +6,6 @@ namespace MQTTnet.Packets { public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttPubCompPacketProperties.cs b/Source/MQTTnet/Packets/MqttPubCompPacketProperties.cs index c29ad6a6..35e040f5 100644 --- a/Source/MQTTnet/Packets/MqttPubCompPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttPubCompPacketProperties.cs @@ -6,6 +6,6 @@ namespace MQTTnet.Packets { public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttPubRecPacketProperties.cs b/Source/MQTTnet/Packets/MqttPubRecPacketProperties.cs index 574bc617..0cd72250 100644 --- a/Source/MQTTnet/Packets/MqttPubRecPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttPubRecPacketProperties.cs @@ -6,6 +6,6 @@ namespace MQTTnet.Packets { public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttPubRelPacketProperties.cs b/Source/MQTTnet/Packets/MqttPubRelPacketProperties.cs index d7a21f64..aa9625db 100644 --- a/Source/MQTTnet/Packets/MqttPubRelPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttPubRelPacketProperties.cs @@ -6,6 +6,6 @@ namespace MQTTnet.Packets { public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttSubAckPacket.cs b/Source/MQTTnet/Packets/MqttSubAckPacket.cs index 053e7137..4600a4e9 100644 --- a/Source/MQTTnet/Packets/MqttSubAckPacket.cs +++ b/Source/MQTTnet/Packets/MqttSubAckPacket.cs @@ -8,7 +8,7 @@ namespace MQTTnet.Packets { public ushort? PacketIdentifier { get; set; } - public List ReturnCodes { get; } = new List(); + public List ReturnCodes { get; set; } = new List(); #region Added in MQTTv5.0.0 diff --git a/Source/MQTTnet/Packets/MqttSubAckPacketProperties.cs b/Source/MQTTnet/Packets/MqttSubAckPacketProperties.cs index b2b3eff5..74d3e7f8 100644 --- a/Source/MQTTnet/Packets/MqttSubAckPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttSubAckPacketProperties.cs @@ -6,6 +6,6 @@ namespace MQTTnet.Packets { public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttSubscribePacket.cs b/Source/MQTTnet/Packets/MqttSubscribePacket.cs index c96c75bc..1ea1685f 100644 --- a/Source/MQTTnet/Packets/MqttSubscribePacket.cs +++ b/Source/MQTTnet/Packets/MqttSubscribePacket.cs @@ -7,7 +7,7 @@ namespace MQTTnet.Packets { public ushort? PacketIdentifier { get; set; } - public List TopicFilters { get; } = new List(); + public List TopicFilters { get; set; } = new List(); #region Added in MQTTv5 diff --git a/Source/MQTTnet/Packets/MqttSubscribePacketProperties.cs b/Source/MQTTnet/Packets/MqttSubscribePacketProperties.cs index 5b92c5f5..34f58f2f 100644 --- a/Source/MQTTnet/Packets/MqttSubscribePacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttSubscribePacketProperties.cs @@ -6,6 +6,6 @@ namespace MQTTnet.Packets { public uint? SubscriptionIdentifier { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttUnsubAckPacket.cs b/Source/MQTTnet/Packets/MqttUnsubAckPacket.cs index 0b45df67..a17261e1 100644 --- a/Source/MQTTnet/Packets/MqttUnsubAckPacket.cs +++ b/Source/MQTTnet/Packets/MqttUnsubAckPacket.cs @@ -12,7 +12,7 @@ namespace MQTTnet.Packets public MqttUnsubAckPacketProperties Properties { get; set; } - public List ReasonCodes { get; } = new List(); + public List ReasonCodes { get; set; } = new List(); #endregion diff --git a/Source/MQTTnet/Packets/MqttUnsubAckPacketProperties.cs b/Source/MQTTnet/Packets/MqttUnsubAckPacketProperties.cs index ca444d9e..2a102c64 100644 --- a/Source/MQTTnet/Packets/MqttUnsubAckPacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttUnsubAckPacketProperties.cs @@ -6,6 +6,6 @@ namespace MQTTnet.Packets { public string ReasonString { get; set; } - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Packets/MqttUnsubscribePacket.cs b/Source/MQTTnet/Packets/MqttUnsubscribePacket.cs index bb1d4c2a..7b07a245 100644 --- a/Source/MQTTnet/Packets/MqttUnsubscribePacket.cs +++ b/Source/MQTTnet/Packets/MqttUnsubscribePacket.cs @@ -6,7 +6,7 @@ namespace MQTTnet.Packets { public ushort? PacketIdentifier { get; set; } - public List TopicFilters { get; } = new List(); + public List TopicFilters { get; set; } = new List(); #region Added in MQTTv5 diff --git a/Source/MQTTnet/Packets/MqttUnsubscribePacketProperties.cs b/Source/MQTTnet/Packets/MqttUnsubscribePacketProperties.cs index 5fb4d66b..3ec68f1d 100644 --- a/Source/MQTTnet/Packets/MqttUnsubscribePacketProperties.cs +++ b/Source/MQTTnet/Packets/MqttUnsubscribePacketProperties.cs @@ -4,6 +4,6 @@ namespace MQTTnet.Packets { public class MqttUnsubscribePacketProperties { - public List UserProperties { get; } = new List(); + public List UserProperties { get; set; } } } diff --git a/Source/MQTTnet/Protocol/MqttConnectReasonCodeConverter.cs b/Source/MQTTnet/Protocol/MqttConnectReasonCodeConverter.cs new file mode 100644 index 00000000..d195b687 --- /dev/null +++ b/Source/MQTTnet/Protocol/MqttConnectReasonCodeConverter.cs @@ -0,0 +1,91 @@ +using MQTTnet.Exceptions; + +namespace MQTTnet.Protocol +{ + public class MqttConnectReasonCodeConverter + { + public MqttConnectReturnCode ToConnectReturnCode(MqttConnectReasonCode reasonCode) + { + switch (reasonCode) + { + case MqttConnectReasonCode.Success: + { + return MqttConnectReturnCode.ConnectionAccepted; + } + + case MqttConnectReasonCode.NotAuthorized: + { + return MqttConnectReturnCode.ConnectionRefusedNotAuthorized; + } + + case MqttConnectReasonCode.BadUserNameOrPassword: + { + return MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword; + } + + case MqttConnectReasonCode.ClientIdentifierNotValid: + { + return MqttConnectReturnCode.ConnectionRefusedIdentifierRejected; + } + + case MqttConnectReasonCode.UnsupportedProtocolVersion: + { + return MqttConnectReturnCode.ConnectionRefusedUnacceptableProtocolVersion; + } + + case MqttConnectReasonCode.ServerUnavailable: + case MqttConnectReasonCode.ServerBusy: + case MqttConnectReasonCode.ServerMoved: + { + return MqttConnectReturnCode.ConnectionRefusedServerUnavailable; + } + + default: + { + throw new MqttProtocolViolationException("Unable to convert connect reason code (MQTTv5) to return code (MQTTv3)."); + } + } + } + + public MqttConnectReasonCode ToConnectReasonCode(MqttConnectReturnCode returnCode) + { + switch (returnCode) + { + case MqttConnectReturnCode.ConnectionAccepted: + { + return MqttConnectReasonCode.Success; + } + + case MqttConnectReturnCode.ConnectionRefusedUnacceptableProtocolVersion: + { + return MqttConnectReasonCode.UnsupportedProtocolVersion; + } + + case MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword: + { + return MqttConnectReasonCode.BadUserNameOrPassword; + } + + case MqttConnectReturnCode.ConnectionRefusedIdentifierRejected: + { + return MqttConnectReasonCode.ClientIdentifierNotValid; + } + + case MqttConnectReturnCode.ConnectionRefusedServerUnavailable: + { + return MqttConnectReasonCode.ServerUnavailable; + } + + case MqttConnectReturnCode.ConnectionRefusedNotAuthorized: + { + return MqttConnectReasonCode.NotAuthorized; + } + + default: + { + throw new MqttProtocolViolationException("Unable to convert connect reason code (MQTTv5) to return code (MQTTv3)."); + } + } + } + } +} diff --git a/Source/MQTTnet/Server/MqttClientConnection.cs b/Source/MQTTnet/Server/MqttClientConnection.cs index d88d9739..5ede2c66 100644 --- a/Source/MQTTnet/Server/MqttClientConnection.cs +++ b/Source/MQTTnet/Server/MqttClientConnection.cs @@ -14,7 +14,7 @@ using MQTTnet.Server.Status; namespace MQTTnet.Server { - public class MqttClientConnection : IMqttClientSession, IDisposable + public class MqttClientConnection : IDisposable { private readonly MqttPacketIdentifierProvider _packetIdentifierProvider = new MqttPacketIdentifierProvider(); private readonly MqttPacketDispatcher _packetDispatcher = new MqttPacketDispatcher(); @@ -31,11 +31,12 @@ namespace MQTTnet.Server private readonly IMqttDataConverter _dataConverter; private readonly string _endpoint; private readonly MqttConnectPacket _connectPacket; + private readonly DateTime _connectedTimestamp; private Task _packageReceiverTask; private DateTime _lastPacketReceivedTimestamp; private DateTime _lastNonKeepAlivePacketReceivedTimestamp; - + private long _receivedPacketsCount; private long _sentPacketsCount = 1; // Start with 1 because the CONNECT packet is not counted anywhere. private long _receivedApplicationMessagesCount; @@ -63,9 +64,10 @@ namespace MQTTnet.Server if (logger == null) throw new ArgumentNullException(nameof(logger)); _logger = logger.CreateChildLogger(nameof(MqttClientConnection)); - _keepAliveMonitor = new MqttClientKeepAliveMonitor(this, _logger); + _keepAliveMonitor = new MqttClientKeepAliveMonitor(_connectPacket.ClientId, StopAsync, _logger); - _lastPacketReceivedTimestamp = DateTime.UtcNow; + _connectedTimestamp = DateTime.UtcNow; + _lastPacketReceivedTimestamp = _connectedTimestamp; _lastNonKeepAlivePacketReceivedTimestamp = _lastPacketReceivedTimestamp; } @@ -84,6 +86,11 @@ namespace MQTTnet.Server } } + public void ResetStatistics() + { + _channelAdapter.ResetStatistics(); + } + public void FillStatus(MqttClientStatus status) { status.ClientId = ClientId; @@ -96,6 +103,7 @@ namespace MQTTnet.Server status.ReceivedPacketsCount = Interlocked.Read(ref _receivedPacketsCount); status.SentPacketsCount = Interlocked.Read(ref _sentPacketsCount); + status.ConnectedTimestamp = _connectedTimestamp; status.LastPacketReceivedTimestamp = _lastPacketReceivedTimestamp; status.LastNonKeepAlivePacketReceivedTimestamp = _lastNonKeepAlivePacketReceivedTimestamp; diff --git a/Source/MQTTnet/Server/MqttClientKeepAliveMonitor.cs b/Source/MQTTnet/Server/MqttClientKeepAliveMonitor.cs index 0ca41abc..32effed4 100644 --- a/Source/MQTTnet/Server/MqttClientKeepAliveMonitor.cs +++ b/Source/MQTTnet/Server/MqttClientKeepAliveMonitor.cs @@ -10,17 +10,18 @@ namespace MQTTnet.Server { private readonly Stopwatch _lastPacketReceivedTracker = new Stopwatch(); - private readonly IMqttClientSession _clientSession; + private readonly string _clientId; + private readonly Func _keepAliveElapsedCallback; private readonly IMqttNetChildLogger _logger; private bool _isPaused; - public MqttClientKeepAliveMonitor(IMqttClientSession clientSession, IMqttNetChildLogger logger) + public MqttClientKeepAliveMonitor(string clientId, Func keepAliveElapsedCallback, IMqttNetChildLogger logger) { + _clientId = clientId ?? throw new ArgumentNullException(nameof(clientId)); + _keepAliveElapsedCallback = keepAliveElapsedCallback ?? throw new ArgumentNullException(nameof(keepAliveElapsedCallback)); + if (logger == null) throw new ArgumentNullException(nameof(logger)); - - _clientSession = clientSession ?? throw new ArgumentNullException(nameof(clientSession)); - _logger = logger.CreateChildLogger(nameof(MqttClientKeepAliveMonitor)); } @@ -62,8 +63,8 @@ namespace MQTTnet.Server // If the client sends 1 sec. the server will allow up to 1.5 seconds. if (!_isPaused && _lastPacketReceivedTracker.Elapsed.TotalSeconds >= keepAlivePeriod * 1.5D) { - _logger.Warning(null, "Client '{0}': Did not receive any packet or keep alive signal.", _clientSession.ClientId); - await _clientSession.StopAsync().ConfigureAwait(false); + _logger.Warning(null, "Client '{0}': Did not receive any packet or keep alive signal.", _clientId); + await _keepAliveElapsedCallback().ConfigureAwait(false); return; } @@ -80,11 +81,11 @@ namespace MQTTnet.Server } catch (Exception exception) { - _logger.Error(exception, "Client '{0}': Unhandled exception while checking keep alive timeouts.", _clientSession.ClientId); + _logger.Error(exception, "Client '{0}': Unhandled exception while checking keep alive timeouts.", _clientId); } finally { - _logger.Verbose("Client '{0}': Stopped checking keep alive timeout.", _clientSession.ClientId); + _logger.Verbose("Client '{0}': Stopped checking keep alive timeout.", _clientId); } } } diff --git a/Source/MQTTnet/Server/MqttClientSessionsManager.cs b/Source/MQTTnet/Server/MqttClientSessionsManager.cs index fdc62b01..b18f4144 100644 --- a/Source/MQTTnet/Server/MqttClientSessionsManager.cs +++ b/Source/MQTTnet/Server/MqttClientSessionsManager.cs @@ -5,6 +5,7 @@ using System.Threading; using System.Threading.Tasks; using MQTTnet.Adapter; using MQTTnet.Diagnostics; +using MQTTnet.Formatter; using MQTTnet.Internal; using MQTTnet.Packets; using MQTTnet.Protocol; @@ -136,7 +137,7 @@ namespace MQTTnet.Server await connection.StopAsync().ConfigureAwait(false); } - if (_sessions.TryRemove(clientId, out var session)) + if (_sessions.TryRemove(clientId, out _)) { } @@ -227,7 +228,7 @@ namespace MQTTnet.Server private async Task HandleClientAsync(IMqttChannelAdapter channelAdapter, CancellationToken cancellationToken) { var disconnectType = MqttClientDisconnectType.NotClean; - var clientId = string.Empty; + string clientId = null; try { @@ -242,20 +243,12 @@ namespace MQTTnet.Server var validatorContext = await ValidateConnectionAsync(connectPacket, channelAdapter).ConfigureAwait(false); - if (validatorContext.ReturnCode != MqttConnectReturnCode.ConnectionAccepted) + if (validatorContext.ReasonCode != MqttConnectReasonCode.Success) { - // TODO: Move to channel adapter data converter. - // Send failure response here without preparing a session. The result for a successful connect // will be sent from the session itself. - await channelAdapter.SendPacketAsync( - new MqttConnAckPacket - { - ReturnCode = validatorContext.ReturnCode, - ReasonCode = MqttConnectReasonCode.NotAuthorized - }, - _options.DefaultCommunicationTimeout, - cancellationToken).ConfigureAwait(false); + var connAckPacket = channelAdapter.PacketFormatterAdapter.DataConverter.CreateConnAckPacket(validatorContext); + await channelAdapter.SendPacketAsync(connAckPacket, _options.DefaultCommunicationTimeout, cancellationToken).ConfigureAwait(false); return; } @@ -275,38 +268,51 @@ namespace MQTTnet.Server } finally { - _connections.TryRemove(clientId, out _); - - if (!_options.EnablePersistentSessions) + if (clientId != null) { - await DeleteSessionAsync(clientId).ConfigureAwait(false); + _connections.TryRemove(clientId, out _); + + if (!_options.EnablePersistentSessions) + { + await DeleteSessionAsync(clientId).ConfigureAwait(false); + } } await TryCleanupChannelAsync(channelAdapter).ConfigureAwait(false); - await _eventDispatcher.HandleClientDisconnectedAsync(clientId, disconnectType).ConfigureAwait(false); + if (clientId != null) + { + await _eventDispatcher.TryHandleClientDisconnectedAsync(clientId, disconnectType).ConfigureAwait(false); + } } } - private async Task ValidateConnectionAsync(MqttConnectPacket connectPacket, IMqttChannelAdapter clientAdapter) + private async Task ValidateConnectionAsync(MqttConnectPacket connectPacket, IMqttChannelAdapter channelAdapter) { - var context = new MqttConnectionValidatorContext( - connectPacket.ClientId, - connectPacket.Username, - connectPacket.Password, - connectPacket.WillMessage, - clientAdapter.Endpoint, - clientAdapter.IsSecureConnection); + var context = new MqttConnectionValidatorContext(connectPacket, channelAdapter); var connectionValidator = _options.ConnectionValidator; if (connectionValidator == null) { - context.ReturnCode = MqttConnectReturnCode.ConnectionAccepted; + context.ReasonCode = MqttConnectReasonCode.Success; return context; } await connectionValidator.ValidateConnectionAsync(context).ConfigureAwait(false); + + // Check the client ID and set a random one if supported. + if (string.IsNullOrEmpty(connectPacket.ClientId) && + channelAdapter.PacketFormatterAdapter.ProtocolVersion == MqttProtocolVersion.V500) + { + connectPacket.ClientId = context.AssignedClientIdentifier; + } + + if (string.IsNullOrEmpty(connectPacket.ClientId)) + { + context.ReasonCode = MqttConnectReasonCode.ClientIdentifierNotValid; + } + return context; } diff --git a/Source/MQTTnet/Server/MqttClientSubscriptionsManager.cs b/Source/MQTTnet/Server/MqttClientSubscriptionsManager.cs index 904474f5..e2024a60 100644 --- a/Source/MQTTnet/Server/MqttClientSubscriptionsManager.cs +++ b/Source/MQTTnet/Server/MqttClientSubscriptionsManager.cs @@ -35,18 +35,21 @@ namespace MQTTnet.Server CloseConnection = false }; - foreach (var topicFilter in subscribePacket.TopicFilters) + foreach (var originalTopicFilter in subscribePacket.TopicFilters) { - var interceptorContext = await InterceptSubscribeAsync(topicFilter).ConfigureAwait(false); - if (!interceptorContext.AcceptSubscription) + var interceptorContext = await InterceptSubscribeAsync(originalTopicFilter).ConfigureAwait(false); + + var finalTopicFilter = interceptorContext.TopicFilter; + + if (finalTopicFilter == null || string.IsNullOrEmpty(finalTopicFilter.Topic) || !interceptorContext.AcceptSubscription) { result.ResponsePacket.ReturnCodes.Add(MqttSubscribeReturnCode.Failure); result.ResponsePacket.ReasonCodes.Add(MqttSubscribeReasonCode.UnspecifiedError); } else { - result.ResponsePacket.ReturnCodes.Add(ConvertToSubscribeReturnCode(topicFilter.QualityOfServiceLevel)); - result.ResponsePacket.ReasonCodes.Add(ConvertToSubscribeReasonCode(topicFilter.QualityOfServiceLevel)); + result.ResponsePacket.ReturnCodes.Add(ConvertToSubscribeReturnCode(finalTopicFilter.QualityOfServiceLevel)); + result.ResponsePacket.ReasonCodes.Add(ConvertToSubscribeReasonCode(finalTopicFilter.QualityOfServiceLevel)); } if (interceptorContext.CloseConnection) @@ -54,14 +57,14 @@ namespace MQTTnet.Server result.CloseConnection = true; } - if (interceptorContext.AcceptSubscription) + if (interceptorContext.AcceptSubscription && !string.IsNullOrEmpty(finalTopicFilter?.Topic)) { lock (_subscriptions) { - _subscriptions[topicFilter.Topic] = topicFilter.QualityOfServiceLevel; + _subscriptions[finalTopicFilter.Topic] = finalTopicFilter.QualityOfServiceLevel; } - await _eventDispatcher.HandleClientSubscribedTopicAsync(_clientId, topicFilter).ConfigureAwait(false); + await _eventDispatcher.HandleClientSubscribedTopicAsync(_clientId, finalTopicFilter).ConfigureAwait(false); } } diff --git a/Source/MQTTnet/Server/MqttConnectionValidatorContext.cs b/Source/MQTTnet/Server/MqttConnectionValidatorContext.cs index b06eb844..45dba132 100644 --- a/Source/MQTTnet/Server/MqttConnectionValidatorContext.cs +++ b/Source/MQTTnet/Server/MqttConnectionValidatorContext.cs @@ -1,31 +1,90 @@ -using MQTTnet.Protocol; +using System; +using System.Collections.Generic; +using System.Security.Cryptography.X509Certificates; +using System.Text; +using MQTTnet.Adapter; +using MQTTnet.Formatter; +using MQTTnet.Packets; +using MQTTnet.Protocol; namespace MQTTnet.Server { public class MqttConnectionValidatorContext { - public MqttConnectionValidatorContext(string clientId, string username, string password, MqttApplicationMessage willMessage, string endpoint, bool isSecureConnection) + private readonly MqttConnectPacket _connectPacket; + private readonly IMqttChannelAdapter _clientAdapter; + + public MqttConnectionValidatorContext(MqttConnectPacket connectPacket, IMqttChannelAdapter clientAdapter) { - ClientId = clientId; - Username = username; - Password = password; - WillMessage = willMessage; - Endpoint = endpoint; - IsSecureConnection = isSecureConnection; + _connectPacket = connectPacket ?? throw new ArgumentNullException(nameof(connectPacket)); + _clientAdapter = clientAdapter ?? throw new ArgumentNullException(nameof(clientAdapter)); } - public string ClientId { get; } + public string ClientId => _connectPacket.ClientId; - public string Username { get; } + public string Username => _connectPacket.Username; - public string Password { get; } + public byte[] RawPassword => _connectPacket.Password; - public MqttApplicationMessage WillMessage { get; } + public string Password => Encoding.UTF8.GetString(RawPassword ?? new byte[0]); - public string Endpoint { get; } + public MqttApplicationMessage WillMessage => _connectPacket.WillMessage; - public bool IsSecureConnection { get; } + public bool CleanSession => _connectPacket.CleanSession; - public MqttConnectReturnCode ReturnCode { get; set; } = MqttConnectReturnCode.ConnectionAccepted; + public ushort KeepAlivePeriod => _connectPacket.KeepAlivePeriod; + + public List UserProperties => _connectPacket.Properties?.UserProperties; + + public byte[] AuthenticationData => _connectPacket.Properties?.AuthenticationData; + + public string AuthenticationMethod => _connectPacket.Properties?.AuthenticationMethod; + + public uint? MaximumPacketSize => _connectPacket.Properties?.MaximumPacketSize; + + public ushort? ReceiveMaximum => _connectPacket.Properties?.ReceiveMaximum; + + public ushort? TopicAliasMaximum => _connectPacket.Properties?.TopicAliasMaximum; + + public bool? RequestProblemInformation => _connectPacket.Properties?.RequestProblemInformation; + + public bool? RequestResponseInformation => _connectPacket.Properties?.RequestResponseInformation; + + public uint? SessionExpiryInterval => _connectPacket.Properties?.SessionExpiryInterval; + + public uint? WillDelayInterval => _connectPacket.Properties?.WillDelayInterval; + + public string Endpoint => _clientAdapter.Endpoint; + + public bool IsSecureConnection => _clientAdapter.IsSecureConnection; + + public X509Certificate2 ClientCertificate => _clientAdapter.ClientCertificate; + + public MqttProtocolVersion ProtocolVersion => _clientAdapter.PacketFormatterAdapter.ProtocolVersion; + + /// + /// This is used for MQTTv3 only. + /// + [Obsolete("Use ReasonCode instead. It is MQTTv5 only but will be converted to a valid ReturnCode.")] + public MqttConnectReturnCode ReturnCode + { + get => new MqttConnectReasonCodeConverter().ToConnectReturnCode(ReasonCode); + set => ReasonCode = new MqttConnectReasonCodeConverter().ToConnectReasonCode(value); + } + + /// + /// This is used for MQTTv5 only. When a MQTTv3 client connects the enum value must be one which is + /// also supported in MQTTv3. Otherwise the connection attempt will fail because not all codes can be + /// converted properly. + /// + public MqttConnectReasonCode ReasonCode { get; set; } = MqttConnectReasonCode.Success; + + public List ResponseUserProperties { get; set; } + + public byte[] ResponseAuthenticationData { get; set; } + + public string AssignedClientIdentifier { get; set; } + + public string ReasonString { get; set; } } } diff --git a/Source/MQTTnet/Server/MqttServer.cs b/Source/MQTTnet/Server/MqttServer.cs index b2c32f45..f902fc02 100644 --- a/Source/MQTTnet/Server/MqttServer.cs +++ b/Source/MQTTnet/Server/MqttServer.cs @@ -14,7 +14,7 @@ namespace MQTTnet.Server { public class MqttServer : IMqttServer { - private readonly MqttServerEventDispatcher _eventDispatcher = new MqttServerEventDispatcher(); + private readonly MqttServerEventDispatcher _eventDispatcher; private readonly ICollection _adapters; private readonly IMqttNetChildLogger _logger; @@ -29,6 +29,8 @@ namespace MQTTnet.Server if (logger == null) throw new ArgumentNullException(nameof(logger)); _logger = logger.CreateChildLogger(nameof(MqttServer)); + + _eventDispatcher = new MqttServerEventDispatcher(logger.CreateChildLogger(nameof(MqttServerEventDispatcher))); } public IMqttServerStartedHandler StartedHandler { get; set; } diff --git a/Source/MQTTnet/Server/MqttServerEventDispatcher.cs b/Source/MQTTnet/Server/MqttServerEventDispatcher.cs index c85805d8..e6e608ac 100644 --- a/Source/MQTTnet/Server/MqttServerEventDispatcher.cs +++ b/Source/MQTTnet/Server/MqttServerEventDispatcher.cs @@ -1,10 +1,19 @@ -using System.Threading.Tasks; +using System; +using System.Threading.Tasks; using MQTTnet.Client.Receiving; +using MQTTnet.Diagnostics; namespace MQTTnet.Server { public class MqttServerEventDispatcher { + private readonly IMqttNetChildLogger _logger; + + public MqttServerEventDispatcher(IMqttNetChildLogger logger) + { + _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + } + public IMqttServerClientConnectedHandler ClientConnectedHandler { get; set; } public IMqttServerClientDisconnectedHandler ClientDisconnectedHandler { get; set; } @@ -26,15 +35,22 @@ namespace MQTTnet.Server return handler.HandleClientConnectedAsync(new MqttServerClientConnectedEventArgs(clientId)); } - public Task HandleClientDisconnectedAsync(string clientId, MqttClientDisconnectType disconnectType) + public async Task TryHandleClientDisconnectedAsync(string clientId, MqttClientDisconnectType disconnectType) { - var handler = ClientDisconnectedHandler; - if (handler == null) + try { - return Task.FromResult(0); - } + var handler = ClientDisconnectedHandler; + if (handler == null) + { + return; + } - return handler.HandleClientDisconnectedAsync(new MqttServerClientDisconnectedEventArgs(clientId, disconnectType)); + await handler.HandleClientDisconnectedAsync(new MqttServerClientDisconnectedEventArgs(clientId, disconnectType)).ConfigureAwait(false); + } + catch (Exception exception) + { + _logger.Error(exception, "Error while handling 'ClientDisconnected' event."); + } } public Task HandleClientSubscribedTopicAsync(string clientId, TopicFilter topicFilter) diff --git a/Source/MQTTnet/Server/MqttServerTlsTcpEndpointOptions.cs b/Source/MQTTnet/Server/MqttServerTlsTcpEndpointOptions.cs index 88d2f86d..212b0521 100644 --- a/Source/MQTTnet/Server/MqttServerTlsTcpEndpointOptions.cs +++ b/Source/MQTTnet/Server/MqttServerTlsTcpEndpointOptions.cs @@ -11,7 +11,10 @@ namespace MQTTnet.Server public byte[] Certificate { get; set; } + public bool ClientCertificateRequired { get; set; } + public bool CheckCertificateRevocation { get; set; } + public SslProtocols SslProtocol { get; set; } = SslProtocols.Tls12; } } diff --git a/Source/MQTTnet/Server/MqttSubscriptionInterceptorContext.cs b/Source/MQTTnet/Server/MqttSubscriptionInterceptorContext.cs index 07b94bb6..ca98c95d 100644 --- a/Source/MQTTnet/Server/MqttSubscriptionInterceptorContext.cs +++ b/Source/MQTTnet/Server/MqttSubscriptionInterceptorContext.cs @@ -12,7 +12,7 @@ namespace MQTTnet.Server public string ClientId { get; } - public TopicFilter TopicFilter { get; } + public TopicFilter TopicFilter { get; set; } public bool AcceptSubscription { get; set; } = true; diff --git a/Source/MQTTnet/Server/Status/IMqttClientStatus.cs b/Source/MQTTnet/Server/Status/IMqttClientStatus.cs index 714b00db..bbf4799f 100644 --- a/Source/MQTTnet/Server/Status/IMqttClientStatus.cs +++ b/Source/MQTTnet/Server/Status/IMqttClientStatus.cs @@ -29,7 +29,9 @@ namespace MQTTnet.Server.Status long BytesSent { get; } long BytesReceived { get; } - + Task DisconnectAsync(); + + void ResetStatistics(); } } diff --git a/Source/MQTTnet/Server/Status/MqttClientStatus.cs b/Source/MQTTnet/Server/Status/MqttClientStatus.cs index cc6e77d3..553795f4 100644 --- a/Source/MQTTnet/Server/Status/MqttClientStatus.cs +++ b/Source/MQTTnet/Server/Status/MqttClientStatus.cs @@ -21,6 +21,8 @@ namespace MQTTnet.Server.Status public DateTime LastPacketReceivedTimestamp { get; set; } + public DateTime ConnectedTimestamp { get; set; } + public DateTime LastNonKeepAlivePacketReceivedTimestamp { get; set; } public long ReceivedApplicationMessagesCount { get; set; } @@ -41,5 +43,10 @@ namespace MQTTnet.Server.Status { return _connection.StopAsync(); } + + public void ResetStatistics() + { + _connection.ResetStatistics(); + } } } diff --git a/Tests/MQTTnet.Benchmarks/SerializerBenchmark.cs b/Tests/MQTTnet.Benchmarks/SerializerBenchmark.cs index c8b3f7c6..7fbb552e 100644 --- a/Tests/MQTTnet.Benchmarks/SerializerBenchmark.cs +++ b/Tests/MQTTnet.Benchmarks/SerializerBenchmark.cs @@ -1,6 +1,7 @@ using BenchmarkDotNet.Attributes; using MQTTnet.Packets; using System; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; using MQTTnet.Adapter; @@ -77,6 +78,8 @@ namespace MQTTnet.Benchmarks public bool IsSecureConnection { get; } = false; + public X509Certificate2 ClientCertificate { get; } + public void Reset() { _position = _buffer.Offset; diff --git a/Tests/MQTTnet.Core.Tests/AsyncAutoResentEvent_Tests.cs b/Tests/MQTTnet.Core.Tests/AsyncAutoResentEvent_Tests.cs index b2b1e50b..d72712d0 100644 --- a/Tests/MQTTnet.Core.Tests/AsyncAutoResentEvent_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/AsyncAutoResentEvent_Tests.cs @@ -24,7 +24,9 @@ namespace MQTTnet.Tests var waitOnePassed = false; +#pragma warning disable 4014 Task.Run(async () => +#pragma warning restore 4014 { await @lock.WaitOneAsync(TimeSpan.FromSeconds(2)); waitOnePassed = true; @@ -121,7 +123,7 @@ namespace MQTTnet.Tests waitTask.GetAwaiter().GetResult(); Assert.IsTrue(false, "Task was expected to transition to a canceled state."); } - catch (OperationCanceledException ex) + catch (OperationCanceledException) { } diff --git a/Tests/MQTTnet.Core.Tests/MQTTv5/Client_Tests.cs b/Tests/MQTTnet.Core.Tests/MQTTv5/Client_Tests.cs index 52b3d5f6..3b813c31 100644 --- a/Tests/MQTTnet.Core.Tests/MQTTv5/Client_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/MQTTv5/Client_Tests.cs @@ -36,7 +36,10 @@ namespace MQTTnet.Tests.MQTTv5 .WithWillDelayInterval(20) .Build()); + MqttApplicationMessage receivedMessage = null; + await client.SubscribeAsync("a"); + client.UseApplicationMessageReceivedHandler(context => { receivedMessage = context.ApplicationMessage; }); await client.PublishAsync(new MqttApplicationMessageBuilder() .WithTopic("a") @@ -48,6 +51,10 @@ namespace MQTTnet.Tests.MQTTv5 .Build()); await Task.Delay(500); + + Assert.IsNotNull(receivedMessage); + + Assert.AreEqual(2, receivedMessage.UserProperties.Count); } } diff --git a/Tests/MQTTnet.Core.Tests/Mockups/TestLogger.cs b/Tests/MQTTnet.Core.Tests/Mockups/TestLogger.cs new file mode 100644 index 00000000..79607d97 --- /dev/null +++ b/Tests/MQTTnet.Core.Tests/Mockups/TestLogger.cs @@ -0,0 +1,40 @@ +using System; +using MQTTnet.Diagnostics; + +namespace MQTTnet.Tests.Mockups +{ + public class TestLogger : IMqttNetLogger, IMqttNetChildLogger + { + public event EventHandler LogMessagePublished; + + IMqttNetChildLogger IMqttNetLogger.CreateChildLogger(string source) + { + return new MqttNetChildLogger(this, source); + } + + IMqttNetChildLogger IMqttNetChildLogger.CreateChildLogger(string source) + { + return new MqttNetChildLogger(this, source); + } + + public void Verbose(string message, params object[] parameters) + { + } + + public void Info(string message, params object[] parameters) + { + } + + public void Warning(Exception exception, string message, params object[] parameters) + { + } + + public void Error(Exception exception, string message, params object[] parameters) + { + } + + public void Publish(MqttNetLogLevel logLevel, string source, string message, object[] parameters, Exception exception) + { + } + } +} diff --git a/Tests/MQTTnet.Core.Tests/Mockups/TestMqttCommunicationAdapter.cs b/Tests/MQTTnet.Core.Tests/Mockups/TestMqttCommunicationAdapter.cs index a58a77f6..07fff2a7 100644 --- a/Tests/MQTTnet.Core.Tests/Mockups/TestMqttCommunicationAdapter.cs +++ b/Tests/MQTTnet.Core.Tests/Mockups/TestMqttCommunicationAdapter.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Concurrent; +using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; using MQTTnet.Adapter; @@ -18,6 +19,8 @@ namespace MQTTnet.Tests.Mockups public bool IsSecureConnection { get; } = false; + public X509Certificate2 ClientCertificate { get; } + public MqttPacketFormatterAdapter PacketFormatterAdapter { get; } = new MqttPacketFormatterAdapter(MqttProtocolVersion.V311); public long BytesSent { get; } @@ -66,6 +69,10 @@ namespace MQTTnet.Tests.Mockups }, cancellationToken); } + public void ResetStatistics() + { + } + private void EnqueuePacketInternal(MqttBasePacket packet) { if (packet == null) throw new ArgumentNullException(nameof(packet)); diff --git a/Tests/MQTTnet.Core.Tests/MqttClient_Tests.cs b/Tests/MQTTnet.Core.Tests/MqttClient_Tests.cs index f146d17e..155b55e4 100644 --- a/Tests/MQTTnet.Core.Tests/MqttClient_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/MqttClient_Tests.cs @@ -20,6 +20,95 @@ namespace MQTTnet.Tests [TestClass] public class Client_Tests { + [TestMethod] + public async Task Send_Reply_In_Message_Handler_For_Same_Client() + { + using (var testEnvironment = new TestEnvironment()) + { + await testEnvironment.StartServerAsync(); + var client = await testEnvironment.ConnectClientAsync(); + + await client.SubscribeAsync("#"); + + var replyReceived = false; + + client.UseApplicationMessageReceivedHandler(c => + { + if (c.ApplicationMessage.Topic == "request") + { +#pragma warning disable 4014 + Task.Run(() => client.PublishAsync("reply", null, MqttQualityOfServiceLevel.AtLeastOnce)); +#pragma warning restore 4014 + } + else + { + replyReceived = true; + } + }); + + await client.PublishAsync("request", null, MqttQualityOfServiceLevel.AtLeastOnce); + + SpinWait.SpinUntil(() => replyReceived, TimeSpan.FromSeconds(10)); + + Assert.IsTrue(replyReceived); + } + } + + [TestMethod] + public async Task Send_Reply_In_Message_Handler() + { + using (var testEnvironment = new TestEnvironment()) + { + await testEnvironment.StartServerAsync(); + var client1 = await testEnvironment.ConnectClientAsync(); + var client2 = await testEnvironment.ConnectClientAsync(); + + await client1.SubscribeAsync("#"); + await client2.SubscribeAsync("#"); + + var replyReceived = false; + + client1.UseApplicationMessageReceivedHandler(c => + { + if (c.ApplicationMessage.Topic == "reply") + { + replyReceived = true; + } + }); + + client2.UseApplicationMessageReceivedHandler(async c =>{ await client2.PublishAsync("reply", null, MqttQualityOfServiceLevel.AtLeastOnce); }); + + await client1.PublishAsync("request", null, MqttQualityOfServiceLevel.AtLeastOnce); + + SpinWait.SpinUntil(() => replyReceived, TimeSpan.FromSeconds(10)); + + Assert.IsTrue(replyReceived); + } + } + + [TestMethod] + public async Task Reconnect() + { + using (var testEnvironment = new TestEnvironment()) + { + var server = await testEnvironment.StartServerAsync(); + var client = await testEnvironment.ConnectClientAsync(); + + await Task.Delay(500); + Assert.IsTrue(client.IsConnected); + + await server.StopAsync(); + await Task.Delay(500); + Assert.IsFalse(client.IsConnected); + + await server.StartAsync(new MqttServerOptionsBuilder().WithDefaultEndpointPort(testEnvironment.ServerPort).Build()); + await Task.Delay(500); + + await client.ConnectAsync(new MqttClientOptionsBuilder().WithTcpServer("127.0.0.1", testEnvironment.ServerPort).Build()); + Assert.IsTrue(client.IsConnected); + } + } + [TestMethod] public async Task PacketIdentifier_In_Publish_Result() { @@ -89,6 +178,8 @@ namespace MQTTnet.Tests { } + await Task.Delay(500); + Assert.IsNotNull(ex); Assert.IsInstanceOfType(ex, typeof(MqttCommunicationException)); Assert.IsInstanceOfType(ex.InnerException, typeof(SocketException)); diff --git a/Tests/MQTTnet.Core.Tests/MqttKeepAliveMonitor_Tests.cs b/Tests/MQTTnet.Core.Tests/MqttKeepAliveMonitor_Tests.cs index ea2ab0f2..adf9a2b1 100644 --- a/Tests/MQTTnet.Core.Tests/MqttKeepAliveMonitor_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/MqttKeepAliveMonitor_Tests.cs @@ -16,31 +16,43 @@ namespace MQTTnet.Tests [TestMethod] public void KeepAlive_Timeout() { - var clientSession = new TestClientSession(); - var monitor = new MqttClientKeepAliveMonitor(clientSession, new MqttNetLogger().CreateChildLogger()); + var counter = 0; - Assert.AreEqual(0, clientSession.StopCalledCount); + var monitor = new MqttClientKeepAliveMonitor("", () => + { + counter++; + return Task.CompletedTask; + }, + new MqttNetLogger().CreateChildLogger()); + + Assert.AreEqual(0, counter); monitor.Start(1, CancellationToken.None); - Assert.AreEqual(0, clientSession.StopCalledCount); + Assert.AreEqual(0, counter); Thread.Sleep(2000); // Internally the keep alive timeout is multiplied with 1.5 as per protocol specification. - Assert.AreEqual(1, clientSession.StopCalledCount); + Assert.AreEqual(1, counter); } [TestMethod] public void KeepAlive_NoTimeout() { - var clientSession = new TestClientSession(); - var monitor = new MqttClientKeepAliveMonitor(clientSession, new MqttNetLogger().CreateChildLogger()); + var counter = 0; - Assert.AreEqual(0, clientSession.StopCalledCount); + var monitor = new MqttClientKeepAliveMonitor("", () => + { + counter++; + return Task.CompletedTask; + }, + new MqttNetLogger().CreateChildLogger()); + + Assert.AreEqual(0, counter); monitor.Start(1, CancellationToken.None); - Assert.AreEqual(0, clientSession.StopCalledCount); + Assert.AreEqual(0, counter); // Simulate traffic. Thread.Sleep(1000); // Internally the keep alive timeout is multiplied with 1.5 as per protocol specification. @@ -49,11 +61,11 @@ namespace MQTTnet.Tests monitor.PacketReceived(); Thread.Sleep(1000); - Assert.AreEqual(0, clientSession.StopCalledCount); + Assert.AreEqual(0, counter); Thread.Sleep(2000); - Assert.AreEqual(1, clientSession.StopCalledCount); + Assert.AreEqual(1, counter); } private class TestClientSession : IMqttClientSession diff --git a/Tests/MQTTnet.Core.Tests/MqttPacketSerializer_Tests.cs b/Tests/MQTTnet.Core.Tests/MqttPacketSerializer_Tests.cs index 7f29b574..b67d2a27 100644 --- a/Tests/MQTTnet.Core.Tests/MqttPacketSerializer_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/MqttPacketSerializer_Tests.cs @@ -23,7 +23,7 @@ namespace MQTTnet.Tests var p = new MqttConnectPacket { ClientId = "XYZ", - Password = "PASS", + Password = Encoding.UTF8.GetBytes("PASS"), Username = "USER", KeepAlivePeriod = 123, CleanSession = true @@ -38,7 +38,7 @@ namespace MQTTnet.Tests var p = new MqttConnectPacket { ClientId = "XYZ", - Password = "PASS", + Password = Encoding.UTF8.GetBytes("PASS"), Username = "USER", KeepAlivePeriod = 123, CleanSession = true @@ -53,7 +53,7 @@ namespace MQTTnet.Tests var p = new MqttConnectPacket { ClientId = "XYZ", - Password = "PASS", + Password = Encoding.UTF8.GetBytes("PASS"), Username = "USER", KeepAlivePeriod = 123, CleanSession = true, @@ -75,7 +75,7 @@ namespace MQTTnet.Tests var p = new MqttConnectPacket { ClientId = "XYZ", - Password = "PASS", + Password = Encoding.UTF8.GetBytes("PASS"), Username = "USER", KeepAlivePeriod = 123, CleanSession = true @@ -90,7 +90,7 @@ namespace MQTTnet.Tests var p = new MqttConnectPacket { ClientId = "XYZ", - Password = "PASS", + Password = Encoding.UTF8.GetBytes("PASS"), Username = "USER", KeepAlivePeriod = 123, CleanSession = true, diff --git a/Tests/MQTTnet.Core.Tests/MqttSubscriptionsManager_Tests.cs b/Tests/MQTTnet.Core.Tests/MqttSubscriptionsManager_Tests.cs index 38fb99be..1c4ec84a 100644 --- a/Tests/MQTTnet.Core.Tests/MqttSubscriptionsManager_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/MqttSubscriptionsManager_Tests.cs @@ -2,6 +2,7 @@ using MQTTnet.Packets; using MQTTnet.Protocol; using MQTTnet.Server; +using MQTTnet.Tests.Mockups; namespace MQTTnet.Tests { @@ -11,7 +12,7 @@ namespace MQTTnet.Tests [TestMethod] public void MqttSubscriptionsManager_SubscribeSingleSuccess() { - var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(), new MqttServerOptions()); + var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(new TestLogger()), new MqttServerOptions()); var sp = new MqttSubscribePacket(); sp.TopicFilters.Add(new TopicFilterBuilder().WithTopic("A/B/C").Build()); @@ -26,7 +27,7 @@ namespace MQTTnet.Tests [TestMethod] public void MqttSubscriptionsManager_SubscribeDifferentQoSSuccess() { - var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(), new MqttServerOptions()); + var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(new TestLogger()), new MqttServerOptions()); var sp = new MqttSubscribePacket(); sp.TopicFilters.Add(new TopicFilter { Topic = "A/B/C", QualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce }); @@ -41,7 +42,7 @@ namespace MQTTnet.Tests [TestMethod] public void MqttSubscriptionsManager_SubscribeTwoTimesSuccess() { - var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(), new MqttServerOptions()); + var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(new TestLogger()), new MqttServerOptions()); var sp = new MqttSubscribePacket(); sp.TopicFilters.Add(new TopicFilter { Topic = "#", QualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce }); @@ -57,7 +58,7 @@ namespace MQTTnet.Tests [TestMethod] public void MqttSubscriptionsManager_SubscribeSingleNoSuccess() { - var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(), new MqttServerOptions()); + var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(new TestLogger()), new MqttServerOptions()); var sp = new MqttSubscribePacket(); sp.TopicFilters.Add(new TopicFilterBuilder().WithTopic("A/B/C").Build()); @@ -70,7 +71,7 @@ namespace MQTTnet.Tests [TestMethod] public void MqttSubscriptionsManager_SubscribeAndUnsubscribeSingle() { - var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(), new MqttServerOptions()); + var sm = new MqttClientSubscriptionsManager("", new MqttServerEventDispatcher(new TestLogger()), new MqttServerOptions()); var sp = new MqttSubscribePacket(); sp.TopicFilters.Add(new TopicFilterBuilder().WithTopic("A/B/C").Build()); diff --git a/Tests/MQTTnet.Core.Tests/MqttTcpChannel_Tests.cs b/Tests/MQTTnet.Core.Tests/MqttTcpChannel_Tests.cs index b2005ba1..436d2d10 100644 --- a/Tests/MQTTnet.Core.Tests/MqttTcpChannel_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/MqttTcpChannel_Tests.cs @@ -39,7 +39,7 @@ namespace MQTTnet.Tests await Task.Delay(100, ct.Token); - var tcpChannel = new MqttTcpChannel(new NetworkStream(clientSocket, true), "test"); + var tcpChannel = new MqttTcpChannel(new NetworkStream(clientSocket, true), "test", null); var buffer = new byte[1]; await tcpChannel.ReadAsync(buffer, 0, 1, ct.Token); diff --git a/Tests/MQTTnet.Core.Tests/Server_Tests.cs b/Tests/MQTTnet.Core.Tests/Server_Tests.cs index 7b78e340..31f08479 100644 --- a/Tests/MQTTnet.Core.Tests/Server_Tests.cs +++ b/Tests/MQTTnet.Core.Tests/Server_Tests.cs @@ -12,6 +12,7 @@ using MQTTnet.Client.Connecting; using MQTTnet.Client.Disconnecting; using MQTTnet.Client.Options; using MQTTnet.Client.Receiving; +using MQTTnet.Client.Subscribing; using MQTTnet.Protocol; using MQTTnet.Server; using MQTTnet.Tests.Mockups; @@ -120,6 +121,45 @@ namespace MQTTnet.Tests } } + [TestMethod] + public async Task Intercept_Subscription() + { + using (var testEnvironment = new TestEnvironment()) + { + await testEnvironment.StartServerAsync(new MqttServerOptionsBuilder().WithSubscriptionInterceptor( + c => + { + // Set the topic to "a" regards what the client wants to subscribe. + c.TopicFilter.Topic = "a"; + })); + + var topicAReceived = false; + var topicBReceived = false; + + var client = await testEnvironment.ConnectClientAsync(); + client.UseApplicationMessageReceivedHandler(c => + { + if (c.ApplicationMessage.Topic == "a") + { + topicAReceived = true; + } + else if (c.ApplicationMessage.Topic == "b") + { + topicBReceived = true; + } + }); + + await client.SubscribeAsync("b"); + + await client.PublishAsync("a"); + + await Task.Delay(500); + + Assert.IsTrue(topicAReceived); + Assert.IsFalse(topicBReceived); + } + } + [TestMethod] public async Task Subscribe_Unsubscribe() { @@ -155,7 +195,7 @@ namespace MQTTnet.Tests Assert.AreEqual(1, receivedMessagesCount); var unsubscribeEventCalled = false; - server.ClientUnsubscribedTopicHandler = new MqttServerClientUnsubscribedTopicHandlerDelegate(e => + server.ClientUnsubscribedTopicHandler = new MqttServerClientUnsubscribedTopicHandlerDelegate(e => { unsubscribeEventCalled = e.TopicFilter == "a" && e.ClientId == "c1"; }); @@ -174,6 +214,78 @@ namespace MQTTnet.Tests } } + [TestMethod] + public async Task Subscribe_Multiple_In_Single_Request() + { + using (var testEnvironment = new TestEnvironment()) + { + var receivedMessagesCount = 0; + + await testEnvironment.StartServerAsync(); + + var c1 = await testEnvironment.ConnectClientAsync(); + c1.UseApplicationMessageReceivedHandler(c => Interlocked.Increment(ref receivedMessagesCount)); + await c1.SubscribeAsync(new MqttClientSubscribeOptionsBuilder() + .WithTopicFilter("a") + .WithTopicFilter("b") + .WithTopicFilter("c") + .Build()); + + var c2 = await testEnvironment.ConnectClientAsync(); + + await c2.PublishAsync("a"); + await Task.Delay(100); + Assert.AreEqual(receivedMessagesCount, 1); + + await c2.PublishAsync("b"); + await Task.Delay(100); + Assert.AreEqual(receivedMessagesCount, 2); + + await c2.PublishAsync("c"); + await Task.Delay(100); + Assert.AreEqual(receivedMessagesCount, 3); + } + } + + [TestMethod] + public async Task Subscribe_Multiple_In_Multiple_Request() + { + using (var testEnvironment = new TestEnvironment()) + { + var receivedMessagesCount = 0; + + await testEnvironment.StartServerAsync(); + + var c1 = await testEnvironment.ConnectClientAsync(); + c1.UseApplicationMessageReceivedHandler(c => Interlocked.Increment(ref receivedMessagesCount)); + await c1.SubscribeAsync(new MqttClientSubscribeOptionsBuilder() + .WithTopicFilter("a") + .Build()); + + await c1.SubscribeAsync(new MqttClientSubscribeOptionsBuilder() + .WithTopicFilter("b") + .Build()); + + await c1.SubscribeAsync(new MqttClientSubscribeOptionsBuilder() + .WithTopicFilter("c") + .Build()); + + var c2 = await testEnvironment.ConnectClientAsync(); + + await c2.PublishAsync("a"); + await Task.Delay(100); + Assert.AreEqual(receivedMessagesCount, 1); + + await c2.PublishAsync("b"); + await Task.Delay(100); + Assert.AreEqual(receivedMessagesCount, 2); + + await c2.PublishAsync("c"); + await Task.Delay(100); + Assert.AreEqual(receivedMessagesCount, 3); + } + } + [TestMethod] public async Task Publish_From_Server() { @@ -303,7 +415,7 @@ namespace MQTTnet.Tests using (var testEnvironment = new TestEnvironment()) { var server = await testEnvironment.StartServerAsync(); - server.ClientConnectedHandler = new MqttServerClientConnectedHandlerDelegate(e => server.SubscribeAsync(e.ClientId, "topic1")); + server.ClientConnectedHandler = new MqttServerClientConnectedHandlerDelegate(e => server.SubscribeAsync(e.ClientId, "topic1")); var client = await testEnvironment.ConnectClientAsync(); var receivedMessages = new List(); @@ -616,7 +728,7 @@ namespace MQTTnet.Tests { await testEnvironment.StartServerAsync( new MqttServerOptionsBuilder().WithApplicationMessageInterceptor( - c => { c.ApplicationMessage = new MqttApplicationMessage {Topic = "new_topic" }; })); + c => { c.ApplicationMessage = new MqttApplicationMessage { Topic = "new_topic" }; })); string receivedTopic = null; var c1 = await testEnvironment.ConnectClientAsync(); @@ -793,7 +905,7 @@ namespace MQTTnet.Tests var events = new List(); - server.ClientConnectedHandler = new MqttServerClientConnectedHandlerDelegate(_ => + server.ClientConnectedHandler = new MqttServerClientConnectedHandlerDelegate(_ => { lock (events) { @@ -977,7 +1089,7 @@ namespace MQTTnet.Tests var client2 = await testEnvironment.ConnectClientAsync(); var buffer = new StringBuilder(); - + client2.UseApplicationMessageReceivedHandler(c => { lock (buffer) @@ -1009,7 +1121,7 @@ namespace MQTTnet.Tests var clientStatus = await server.GetClientStatusAsync(); Assert.AreEqual(0, clientStatus.Count); - + var client2 = await testEnvironment.ConnectClientAsync(new MqttClientOptionsBuilder().WithClientId("b")); await client2.PublishAsync("x", "1"); await client2.PublishAsync("x", "2"); diff --git a/Tests/MQTTnet.TestApp.NetCore/MQTTnet.TestApp.NetCore.csproj b/Tests/MQTTnet.TestApp.NetCore/MQTTnet.TestApp.NetCore.csproj index 1900203e..d60256ed 100644 --- a/Tests/MQTTnet.TestApp.NetCore/MQTTnet.TestApp.NetCore.csproj +++ b/Tests/MQTTnet.TestApp.NetCore/MQTTnet.TestApp.NetCore.csproj @@ -12,11 +12,12 @@ - + + diff --git a/Tests/MQTTnet.TestApp.NetCore/ManagedClientTest.cs b/Tests/MQTTnet.TestApp.NetCore/ManagedClientTest.cs index 0d4f8f9d..dc7d9250 100644 --- a/Tests/MQTTnet.TestApp.NetCore/ManagedClientTest.cs +++ b/Tests/MQTTnet.TestApp.NetCore/ManagedClientTest.cs @@ -62,7 +62,7 @@ namespace MQTTnet.TestApp.NetCore public class RandomPassword : IMqttClientCredentials { - public string Password => Guid.NewGuid().ToString(); + public byte[] Password => Guid.NewGuid().ToByteArray(); public string Username => "the_static_user"; } diff --git a/Tests/MQTTnet.TestApp.NetCore/PublicBrokerTest.cs b/Tests/MQTTnet.TestApp.NetCore/PublicBrokerTest.cs index ff4e3374..58c4ad10 100644 --- a/Tests/MQTTnet.TestApp.NetCore/PublicBrokerTest.cs +++ b/Tests/MQTTnet.TestApp.NetCore/PublicBrokerTest.cs @@ -1,10 +1,13 @@ using MQTTnet.Client; using System; using System.IO; +using System.Net; +using System.Security.Authentication; using System.Threading; using System.Threading.Tasks; using MQTTnet.Client.Options; using MQTTnet.Client.Receiving; +using MQTTnet.Extensions.WebSocket4Net; using MQTTnet.Formatter; using MQTTnet.Protocol; using Newtonsoft.Json; @@ -77,6 +80,7 @@ namespace MQTTnet.TestApp.NetCore { Write("Testing '" + name + "'... ", ConsoleColor.Gray); var factory = new MqttFactory(); + //factory.UseWebSocket4Net(); var client = factory.CreateMqttClient(); var topic = Guid.NewGuid().ToString(); diff --git a/Tests/MQTTnet.TestApp.UniversalWindows/MQTTnet.TestApp.UniversalWindows.csproj b/Tests/MQTTnet.TestApp.UniversalWindows/MQTTnet.TestApp.UniversalWindows.csproj index c13db930..243c9c56 100644 --- a/Tests/MQTTnet.TestApp.UniversalWindows/MQTTnet.TestApp.UniversalWindows.csproj +++ b/Tests/MQTTnet.TestApp.UniversalWindows/MQTTnet.TestApp.UniversalWindows.csproj @@ -135,6 +135,10 @@ {c444e9c8-95fa-430e-9126-274129de16cd} MQTTnet.Extensions.Rpc + + {2BD01D53-4CA5-4142-BE8D-313876395E3E} + MQTTnet.Extensions.WebSocket4Net + {3587e506-55a2-4eb3-99c7-dc01e42d25d2} MQTTnet diff --git a/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml b/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml index 210f0595..11e68c65 100644 --- a/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml +++ b/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml @@ -63,6 +63,7 @@ TCP WS + WS (WebSocket4Net) Use TLS diff --git a/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml.cs b/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml.cs index 226fcf23..94abc418 100644 --- a/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml.cs +++ b/Tests/MQTTnet.TestApp.UniversalWindows/MainPage.xaml.cs @@ -1,8 +1,6 @@ using System; using System.Collections.Concurrent; using System.Collections.ObjectModel; -using System.Net.Security; -using System.Security.Cryptography.X509Certificates; using System.Text; using System.Threading.Tasks; using Windows.Security.Cryptography.Certificates; @@ -23,6 +21,7 @@ using MQTTnet.Server; using MQTTnet.Server.Status; using MqttClientConnectedEventArgs = MQTTnet.Client.Connecting.MqttClientConnectedEventArgs; using MqttClientDisconnectedEventArgs = MQTTnet.Client.Disconnecting.MqttClientDisconnectedEventArgs; +using MQTTnet.Extensions.WebSocket4Net; namespace MQTTnet.TestApp.UniversalWindows { @@ -83,6 +82,8 @@ namespace MQTTnet.TestApp.UniversalWindows private async void Connect(object sender, RoutedEventArgs e) { + var mqttFactory = new MqttFactory(); + var tlsOptions = new MqttClientTlsOptions { UseTls = UseTls.IsChecked == true, @@ -116,6 +117,17 @@ namespace MQTTnet.TestApp.UniversalWindows }; } + if (UseWs4Net.IsChecked == true) + { + options.ChannelOptions = new MqttClientWebSocketOptions + { + Uri = Server.Text, + TlsOptions = tlsOptions + }; + + mqttFactory.UseWebSocket4Net(); + } + if (options.ChannelOptions == null) { throw new InvalidOperationException(); @@ -126,7 +138,7 @@ namespace MQTTnet.TestApp.UniversalWindows options.Credentials = new MqttClientCredentials { Username = User.Text, - Password = Password.Text + Password = Encoding.UTF8.GetBytes(Password.Text) }; } @@ -156,11 +168,9 @@ namespace MQTTnet.TestApp.UniversalWindows _mqttClient.DisconnectedHandler = new MqttClientDisconnectedHandlerDelegate(x => OnDisconnected(x)); } - var factory = new MqttFactory(); - if (UseManagedClient.IsChecked == true) { - _managedMqttClient = factory.CreateManagedMqttClient(); + _managedMqttClient = mqttFactory.CreateManagedMqttClient(); _managedMqttClient.UseApplicationMessageReceivedHandler(HandleReceivedApplicationMessage); _managedMqttClient.ConnectedHandler = new MqttClientConnectedHandlerDelegate(x => OnConnected(x)); _managedMqttClient.DisconnectedHandler = new MqttClientDisconnectedHandlerDelegate(x => OnDisconnected(x)); @@ -172,7 +182,7 @@ namespace MQTTnet.TestApp.UniversalWindows } else { - _mqttClient = factory.CreateMqttClient(); + _mqttClient = mqttFactory.CreateMqttClient(); _mqttClient.UseApplicationMessageReceivedHandler(HandleReceivedApplicationMessage); _mqttClient.ConnectedHandler = new MqttClientConnectedHandlerDelegate(x => OnConnected(x)); _mqttClient.DisconnectedHandler = new MqttClientDisconnectedHandlerDelegate(x => OnDisconnected(x)); @@ -204,7 +214,7 @@ namespace MQTTnet.TestApp.UniversalWindows private async Task HandleReceivedApplicationMessage(MqttApplicationMessageReceivedEventArgs eventArgs) { - var item = $"Timestamp: {DateTime.Now:O} | Topic: {eventArgs.ApplicationMessage.Topic} | Payload: {Encoding.UTF8.GetString(eventArgs.ApplicationMessage.Payload)} | QoS: {eventArgs.ApplicationMessage.QualityOfServiceLevel}"; + var item = $"Timestamp: {DateTime.Now:O} | Topic: {eventArgs.ApplicationMessage.Topic} | Payload: {eventArgs.ApplicationMessage.ConvertPayloadToString()} | QoS: {eventArgs.ApplicationMessage.QualityOfServiceLevel}"; await Dispatcher.RunAsync(CoreDispatcherPriority.Low, () => { @@ -524,6 +534,13 @@ namespace MQTTnet.TestApp.UniversalWindows Console.WriteLine(); }); + void Handler(MqttApplicationMessageReceivedEventArgs args) + { + //... + } + + client.UseApplicationMessageReceivedHandler(e => Handler(e)); + // Subscribe after connect client.UseConnectedHandler(async e => @@ -584,7 +601,7 @@ namespace MQTTnet.TestApp.UniversalWindows Credentials = new MqttClientCredentials { Username = "bud", - Password = "%spencer%" + Password = Encoding.UTF8.GetBytes("%spencer%") }, ChannelOptions = new MqttClientTcpOptions { @@ -716,6 +733,22 @@ namespace MQTTnet.TestApp.UniversalWindows var mqttServer = new MqttFactory().CreateMqttServer(); } + { + // Setup application message interceptor. + var options = new MqttServerOptionsBuilder() + .WithApplicationMessageInterceptor(context => + { + if (context.ApplicationMessage.Topic == "my/custom/topic") + { + context.ApplicationMessage.Payload = Encoding.UTF8.GetBytes("The server injected payload."); + } + + // It is also possible to read the payload and extend it. For example by adding a timestamp in a JSON document. + // This is useful when the IoT device has no own clock and the creation time of the message might be important. + }) + .Build(); + } + { // Setup subscription interceptor. var options = new MqttServerOptionsBuilder()