NetworkHandshakeCheck 0.5.0

dotnet add package NetworkHandshakeCheck --version 0.5.0                
NuGet\Install-Package NetworkHandshakeCheck -Version 0.5.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NetworkHandshakeCheck" Version="0.5.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NetworkHandshakeCheck --version 0.5.0                
#r "nuget: NetworkHandshakeCheck, 0.5.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NetworkHandshakeCheck as a Cake Addin
#addin nuget:?package=NetworkHandshakeCheck&version=0.5.0

// Install NetworkHandshakeCheck as a Cake Tool
#tool nuget:?package=NetworkHandshakeCheck&version=0.5.0                

NetworkHandshakeCheck

A framework that helps you communicate with servers over arbitrary network protocols, including well-known ones, and check the status of their responses.

How to use

Initializes an instance of a class containing specifications for the protocol and calls the TestTcpHandshakeAsync extension method.

// HTTP
var http = new HttpHandshakeProtocol();
var result = await http.TestTcpHandshakeAsync("www.example.com");
Assert.NotNull(result);

// HTTPS
var https = new HttpsHandshakeProtocol();
var result = await https.TestTcpHandshakeAsync("www.microsoft.com");
Assert.NotNull(result);

// RDP
var rdp = new SshHandshakeProtocol();
var result = await rdp.TestTcpHandshakeAsync("test.rebex.net");
Assert.NotNull(result);

How to implement custom protocol support

Send first protocol

If the protocol requires sending a message to the server as soon as the client connects, implement it as follows.

public sealed class VncHandshakeProtocol : ITcpSendFirstProtocol
{
    public string ProtocolName => "VNC";

    public int DefaultPort => 5900;

    public bool RequireSsl => false;

    public byte[] GetInitialSendData() => new byte[]
    {
        // RFB
        0x52, 0x46, 0x42,

        // [ ]
        0x20,

        // 003
        0x30, 0x30, 0x33,

        // .
        0x2E,

        // 008
        0x30, 0x30, 0x38,

        // \n
        0x0A,
    };
}

Receive first protocol

If the server sends a banner message or confirmation message after confirming the client's connection, implement it as follows.

public sealed class SshHandshakeProtocol : ITcpReceiveFirstProtocol
{
    public string ProtocolName => "SSH";

    public int DefaultPort => 22;

    public bool RequireSsl => false;

    public byte[] GetExpectedInitialReceiveData() =>
        new byte[] { 0x53, 0x53, 0x48, 0x2d, };
}

Handling SSL connection

If the SSL protocol handshake must be performed immediately after connection, such as HTTPS, SSL processing will be performed automatically if the RequireSsl property is returned as true.

public sealed class HttpsHandshakeProtocol : ITcpSendFirstProtocol
{
    public string ProtocolName => "HTTPS";

    public int DefaultPort => 443;

    public bool RequireSsl => true;

    public byte[] GetInitialSendData() =>
        new byte[] { 0x47, 0x45, 0x54, 0x20, 0x2F, 0x20, 0x48, 0x54, 0x54, 0x50, 0x2F, 0x31, 0x2E, 0x31, 0x0D, 0x0A, 0x0D, 0x0A, };
}

License

This library follows Apache-2.0 license. See LICENSE file for more information.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.5.0 174 8/19/2024