Telnet 0.10.2
See the version list below for details.
dotnet add package Telnet --version 0.10.2
NuGet\Install-Package Telnet -Version 0.10.2
<PackageReference Include="Telnet" Version="0.10.2" />
paket add Telnet --version 0.10.2
#r "nuget: Telnet, 0.10.2"
// Install Telnet as a Cake Addin #addin nuget:?package=Telnet&version=0.10.2 // Install Telnet as a Cake Tool #tool nuget:?package=Telnet&version=0.10.2
Telnet
We needed to issue simple commands to (and monitor) a router remotely and that's what we've been able to achieve with this little library. It's usage is simple, it doesn't do anything particularly fancy but if all you're wanting to do is interact with a telnet server by issuing commands, parsing text responses and having the opportunity to respond in code accordingly then hopefully having taken the time to wrap this up in a simple NuGet package will make your life easier!
FWIW I'm happy to take merge requests if they meet incumbent standards, don't break anything and accomodate the code file sharing so all versions work (and likely receive the same change). I'm no TCPIP/Telnet expert but if I can help out with bugs or feature requests I'll do what I can, outside my day job ofc!
v0.9 introduced a significant bump to Net versions and some potentially breaking code changes. Changes to your consuming code should be minimal, but be prepared to test thoroughly. Please raise an Issue if you encounter any problems; in part it'll help others with the same problems and we'll see what we can do to accomodate your use cases.
Usage:
//Sync Example
namespace PrimS.Telnet.CiTests
{
using FluentAssertions;
using Xunit;
using System;
using System.Text.RegularExpressions;
[TestClass]
public class ReadMeExampleFixture
{
private const int TimeoutMs = 5000;
[Fact]
public void ReadMeExample()
{
using (TelnetServer server = new TelnetServer())
{
using (Client client = new Client(server.IPAddress.ToString(), server.Port, new System.Threading.CancellationToken()))
{
client.IsConnected.Should().Be(true);
Client.IsWriteConsole = true;
client.TryLogin("username", "password", TimeoutMs).Should().Be(true);
client.WriteLine("show statistic wan2");
string s = client.TerminatedRead(">", TimeSpan.FromMilliseconds(TimeoutMs));
s.Should().Contain(">");
s.Should().Contain("WAN2");
Regex regEx = new Regex("(?!WAN2 total TX: )([0-9.]*)(?! GB ,RX: )([0-9.]*)(?= GB)");
regEx.IsMatch(s).Should().Be(true);
MatchCollection matches = regEx.Matches(s);
decimal tx = decimal.Parse(matches[0].Value);
decimal rx = decimal.Parse(matches[1].Value);
(tx + rx).Should().BeGreaterThan(0);
(tx + rx).Should().BeLessThan(50);
}
}
}
}
}
// Async Example
namespace PrimS.Telnet.CiTests
{
using System;
using FluentAssertions;
using System.Threading.Tasks;
using System.Text.RegularExpressions;
using Xunit;
public class ReadMeExampleFixture
{
public const string Pattern = "(?:WAN2 total TX: )([0-9.]*) ((?:[KMG]B)|(?:Bytes))(?:[, ]*RX: )([0-9.]*) ((?:[KMG]B)|(?:Bytes))";
private const int TimeoutMs = 5000;
[Fact]
public async Task ReadMeExample()
{
using (var server = new DummyTelnetServer())
{
using (var client = new Client(server.IPAddress.ToString(), server.Port, new System.Threading.CancellationToken()))
{
client.IsConnected.Should().Be(true);
Client.IsWriteConsole = false;
(await client.TryLoginAsync("username", "password", TimeoutMs)).Should().Be(true);
await client.WriteLineAsync("show statistic wan2");
string s = await client.TerminatedReadAsync(">", TimeSpan.FromMilliseconds(TimeoutMs));
s.Should().Contain(">");
s.Should().Contain("WAN2");
var regEx = new Regex(Pattern);
regEx.IsMatch(s).Should().Be(true);
MatchCollection matches = regEx.Matches(s);
matches.Count.Should().Be(1);
matches[0].Captures.Count.Should().Be(1);
matches[0].Groups.Count.Should().Be(5);
matches[0].Groups[0].Value.Should().Be("WAN2 total TX: 6.3 GB ,RX: 6.9 GB");
matches[0].Groups[1].Value.Should().Be("6.3");
matches[0].Groups[2].Value.Should().Be("GB");
matches[0].Groups[3].Value.Should().Be("6.9");
matches[0].Groups[4].Value.Should().Be("GB");
}
}
}
}
}
// VB.NET Example
Private Async Function RunRemoteScript(commandLine As String) As Task(Of Boolean)
Using telnet = New Client("HostName", 23, _cancellationSource.Token)
If Not telnet.IsConnected Then Return False
Dim loggedOn = Await telnet.TryLoginAsync("username", "password", SocketTimeout, "#"))
If Not loggedOn Then Return False
Await telnet.WriteLine(commandLine)
Dim serverResponse = Await telnet.TerminatedReadAsync("#", TimeSpan.FromMilliseconds(SocketTimeout))
Debug.Print(serverResponse)
Await telnet.WriteLine("exit")
Dim logoutMessage = Await telnet.ReadAsync(New TimeSpan(100))
Debug.Print(logoutMessage)
End Using
Return True ' If we got this far; celebrate
End Function
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. 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 is compatible. |
.NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 is compatible. 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. |
-
.NETFramework 4.6.2
- No dependencies.
-
.NETFramework 4.7.2
- No dependencies.
-
.NETFramework 4.8
- No dependencies.
-
.NETStandard 2.0
- No dependencies.
-
.NETStandard 2.1
- No dependencies.
-
net6.0
- No dependencies.
NuGet packages (4)
Showing the top 4 NuGet packages that depend on Telnet:
Package | Downloads |
---|---|
TeamSpeak3.Metrics
Collect metrics from your TeamSpeak 3 Server |
|
Rosystec.Scan.Lib
sensor aggregator |
|
DreamNucleus.Heos
A .Net HEOS CLI client using Reactive Extensions |
|
Simple.K.Socket
Package Description |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Telnet:
Repository | Stars |
---|---|
Kudayasu/Artifice
Xbox One Developer Mode Privilege Escalation
|
Version | Downloads | Last updated |
---|---|---|
0.13.0 | 7,743 | 7/8/2024 |
0.12.0 | 7,418 | 4/17/2024 |
0.11.3 | 146,055 | 9/17/2022 |
0.11.2 | 3,764 | 9/3/2022 |
0.11.1 | 1,471 | 9/2/2022 |
0.11.0 | 1,518 | 9/2/2022 |
0.10.2 | 2,711 | 8/22/2022 |
0.10.1 | 1,487 | 8/21/2022 |
0.10.0 | 1,174 | 8/20/2022 |
0.9.1 | 4,253 | 8/18/2022 |
0.9.0-beta0001 | 8,251 | 5/16/2018 |
0.8.6 | 261,051 | 9/3/2020 |
0.8.6-beta0001 | 407 | 9/2/2020 |
0.8.4 | 50,193 | 10/9/2019 |
0.8.3 | 25,273 | 3/7/2019 |
0.8.2 | 3,409 | 1/30/2019 |
0.8.1 | 132,576 | 5/8/2018 |
0.8.0 | 30,354 | 3/12/2017 |
0.7.0 | 10,715 | 9/6/2016 |
0.6.1 | 53,244 | 2/25/2016 |
0.6.0 | 1,564 | 1/27/2016 |
0.5.0 | 1,571 | 12/8/2015 |
0.4.0 | 3,357 | 10/27/2015 |
0.3.2 | 1,525 | 9/15/2015 |
0.3.1 | 2,458 | 6/20/2015 |
0.2.5 | 81,293 | 12/15/2014 |
0.2.0 | 1,320 | 11/27/2014 |
0.1.0 | 1,598 | 11/26/2014 |
Building on 0.9.1 which introduced potentially breaking changes and dropped unsupported Net
versions Std1.6, 3.5, 4.0, 4.5.1 (all sync) while adding 4.6.2 (sync), NetStandard 4.7.2,
4.8 and Std2.1 (all async) this release additionally adds Net6.
Note the constructor Client(IByteStream byteStream, TimeSpan timeout, CancellationToken token)
has been reordered to comply with best practice standards.
Lots of rework was needed on the async chains to properly integrate 0.9.1 changes, and the
equivalent functionality introduced has now been replicated on the sync paths as well. Test
coverage has been extended to cover both; which actually revealed some unintended code... that
has been rectified in this release.