RS.Fritz.Manager.API 2.4.0-alpha0028

RS.Fritz.Manager

Allows FritzBox device detection, monitoring, configuring and packet capturing.

Available as a standalone Windows application (UI) and as a NuGet package (API).

For a list of implemented services check the Service implementation status

RS.Fritz.Manager.UI

A Windows .NET WPF application for x64 and ARM64.

• Releases

RS.Fritz.Manager.API

A NuGet package to manage FritzBox devices using pure WCF calls.

• NuGet
• GitHub

Usage Examples

using System.Net;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using RS.Fritz.Manager.API;

// Register the Fritz services in the dependency container using AddFritzApi()
using IHost host = Host.CreateDefaultBuilder(args)
    .ConfigureServices((_, services) => services.AddFritzApi())
    .Build();

using IServiceScope serviceScope = host.Services.CreateScope();

// Search for routers and take the first one
IDeviceSearchService deviceSearchService = serviceScope.ServiceProvider.GetRequiredService<IDeviceSearchService>();
InternetGatewayDevice device = (await deviceSearchService.GetDevicesAsync()).First();

// Show the device model from UPnP data
Console.WriteLine($"Device model: {device.UPnPDescription.Device.ModelDescription}");

// Initialize the device for TR-064, retrieves the security port and the users
await device.InitializeAsync();

// Provide the password for the last logged on user
string lastUsedUserName = device.Users.Single(q => q.LastUser).Name;
Console.WriteLine($"Enter password for {lastUsedUserName}:");
device.NetworkCredential = new NetworkCredential(lastUsedUserName, Console.ReadLine());

// TR-064 example; show the device uptime from the TR-064 DeviceInfo service
DeviceInfoGetInfoResponse deviceInfo = await device.DeviceInfoGetInfoAsync();
Console.WriteLine($"Device uptime: {TimeSpan.FromSeconds(deviceInfo.Uptime)}");

// Special services

// Retrieving the device users manually
IUsersService usersService = serviceScope.ServiceProvider.GetRequiredService<IUsersService>();
IEnumerable<User> users = await usersService.GetUsersAsync(device);
users.ToList().ForEach(q => Console.WriteLine($"User: {q.Name}"));

// Retrieving a list of device hosts in the network
IDeviceHostsService deviceHostsService = serviceScope.ServiceProvider.GetRequiredService<IDeviceHostsService>();
DeviceHostInfo deviceHostInfo = await deviceHostsService.GetDeviceHostsAsync(device);
deviceHostInfo.DeviceHosts.ToList().ForEach(q => Console.WriteLine($"Device host: {q.HostName}"));

// Retrieving a list of mesh hosts in the network
IDeviceMeshService deviceMeshService = serviceScope.ServiceProvider.GetRequiredService<IDeviceMeshService>();
DeviceMeshInfo deviceMeshInfo = await deviceMeshService.GetDeviceMeshAsync(device);
deviceMeshInfo.DeviceMesh.Nodes.ToList().ForEach(q => Console.WriteLine($"Mesh host: {q.DeviceName}"));

// Retrieving a list of WLAN devices in the network
IWlanDeviceService wlanDeviceService = serviceScope.ServiceProvider.GetRequiredService<IWlanDeviceService>();
WlanDeviceInfo wlanDeviceInfo = await wlanDeviceService.GetWlanDevicesAsync(device);
wlanDeviceInfo.WlanDeviceList.Items.ToList().ForEach(q => Console.WriteLine($"WLAN device: {q.AssociatedDeviceIpAddress}"));

// Retrieve a new session for use in the WebUI
IWebUiService webUiService = serviceScope.ServiceProvider.GetRequiredService<IWebUiService>();
WebUiSessionInfo webUiSessionInfo = await webUiService.LogonAsync(device);
Console.WriteLine($"Session: {webUiSessionInfo.Sid}");

// Capture live network traffic from router to file
ICaptureControlService captureControlService = serviceScope.ServiceProvider.GetRequiredService<ICaptureControlService>();
IEnumerable<CaptureInterfaceGroup>? interfaceGroups = await captureControlService.GetInterfacesAsync(device);
CaptureInterface captureInterface = interfaceGroups.First().CaptureInterfaces.First();
var fileInfo = new FileInfo(FormattableString.Invariant($"c:\\temp\\{captureInterface.Name}_{DateTime.Now.ToString("s").Replace(":", string.Empty)}.eth"));

Task.Run(() => StopCaptureAsync(device, captureInterface, TimeSpan.FromSeconds(10), captureControlService));

await captureControlService.StartCaptureAsync(device, fileInfo, captureInterface);
Console.WriteLine($"Network trace written to file: {fileInfo}");

await host.RunAsync();

static async Task StopCaptureAsync(InternetGatewayDevice device, CaptureInterface captureInterface, TimeSpan timeSpan, ICaptureControlService captureControlService)
{
    await Task.Delay(timeSpan);
    await captureControlService.StopCaptureAsync(device, captureInterface);
}

TR-064 Service implementation status

WAN

• 🔶 urn:dslforum-org:service:WANIPConnection
  • ✅ GetInfo
  • ✅ GetConnectionTypeInfo
  • ❌ SetConnectionType
  • ✅ GetStatusInfo
  • ✅ GetNATRSIPStatus
  • ❌ SetConnectionTrigger
  • ❌ ForceTermination
  • ❌ RequestConnection
  • ✅ X_GetDNSServers
  • ✅ GetPortMappingNumberOfEntries
  • ✅ GetGenericPortMappingEntry
  • ❌ GetSpecificPortMappingEntry
  • ❌ AddPortMapping
  • ❌ DeletePortMapping
  • ✅ GetExternalIPAddress
  • ❌ SetRouteProtocolRx
  • ❌ SetIdleDisconnectTime
• 🔶 urn:dslforum-org:service:WANPPPConnection
  • ✅ GetInfo
  • ✅ GetConnectionTypeInfo
  • ❌ SetConnectionType
  • ✅ GetStatusInfo
  • ✅ GetLinkLayerMaxBitRates
  • ✅ GetUserName
  • ❌ SetUserName
  • ❌ SetPassword
  • ✅ GetNATRSIPStatus
  • ❌ SetConnectionTrigger
  • ❌ ForceTermination
  • ❌ RequestConnection
  • ✅ X_GetDNSServers
  • ✅ GetPortMappingNumberOfEntries
  • ✅ GetGenericPortMappingEntry
  • ❌ GetSpecificPortMappingEntry
  • ❌ AddPortMapping
  • ❌ DeletePortMapping
  • ✅ GetExternalIPAddress
  • ❌ SetRouteProtocolRx
  • ❌ SetIdleDisconnectTime
  • ✅ X_AVM-DE_GetAutoDisconnectTimeSpan
  • ❌ X_AVM-DE_SetAutoDisconnectTimeSpan
• ✅ urn:dslforum-org:service:WANCommonInterfaceConfig
  • ✅ GetCommonLinkProperties
  • ✅ GetTotalBytesSent
  • ✅ GetTotalBytesReceived
  • ✅ GetTotalPacketsSent
  • ✅ GetTotalPacketsReceived
  • ✅ X_AVM-DE_SetWANAccessType
  • ✅ X_AVM-DE_GetOnlineMonitor
• ✅ urn:dslforum-org:service:WANEthernetLinkConfig
  • ✅ GetEthernetLinkStatus
• ✅ urn:dslforum-org:service:WANDSLInterfaceConfig
  • ✅ GetInfo
  • ✅ GetStatisticsTotal
  • ✅ X_AVM-DE_GetDSLDiagnoseInfo
  • ✅ X_AVM-DE_GetDSLInfo
• 🔶 urn:dslforum-org:service:WANDSLLinkConfig
  • ✅ GetInfo
  • ❌ SetEnable
  • ❌ SetDSLLinkType
  • ✅ GetDSLLinkInfo
  • ❌ SetDestinationAddress
  • ✅ GetDestinationAddress
  • ❌ SetATMEncapsulation
  • ✅ GetATMEncapsulation
  • ✅ GetAutoConfig
  • ✅ GetStatistics
• ❌ urn:dslforum-org:service:X_AVM-DE_WANMobileConnection
• 🔶 urn:dslforum-org:service:X_AVM-DE_Speedtest
  • ✅ GetInfo
  • ❌ SetConfig
  • ✅ GetStatistics
  • ❌ ResetStatistics
• ❌ urn:dslforum-org:service:X_AVM-DE_RemoteAccess
• ❌ urn:dslforum-org:service:X_AVM-DE_MyFritz
• ❌ urn:dslforum-org:service:X_AVM-DE_HostFilter
• 🔶 urn:dslforum-org:service:Layer3Forwarding
  • ❌ SetDefaultConnectionService
  • ✅ GetDefaultConnectionService
  • ✅ GetForwardNumberOfEntries
  • ❌ AddForwardingEntry
  • ❌ DeleteForwardingEntry
  • ❌ GetSpecificForwardingEntry
  • ✅ GetGenericForwardingEntry
  • ❌ SetForwardingEntryEnable

Telephony

• ❌ urn:dslforum-org:service:X_AVM-DE_OnTel
• ❌ urn:dslforum-org:service:X_AVM-DE_TAM
• ❌ urn:dslforum-org:service:X_VoIP

Home network

• 🔶 urn:dslforum-org:service:Hosts
  • ✅ GetHostNumberOfEntries
  • ❌ GetSpecificHostEntry
  • ✅ GetGenericHostEntry
  • ✅ X_AVM-DE_GetInfo
  • ✅ X_AVM-DE_GetChangeCounter
  • ❌ X_AVM-DE_GetAutoWakeOnLANByMACAddress
  • ❌ X_AVM-DE_SetAutoWakeOnLANByMACAddress
  • ❌ X_AVM-DE_SetHostNameByMACAddress
  • ❌ X_AVM-DE_WakeOnLANByMACAddress
  • ❌ X_AVM-DE_GetSpecificHostEntryByIp
  • ✅ X_AVM-DE_HostsCheckUpdate
  • ❌ X_AVM-DE_HostDoUpdate
  • ❌ X_AVM-DE_SetPrioritizationByIP
  • ✅ X_AVM-DE_GetHostListPath
  • ✅ X_AVM-DE_GetMeshListPath
  • ✅ X_AVM-DE_GetFriendlyName
  • ❌ X_AVM-DE_SetFriendlyName
  • ❌ X_AVM-DE_SetFriendlyNameByIP
  • ❌ X_AVM-DE_SetFriendlyNameByMAC
• 🔶 urn:dslforum-org:service:WLANConfiguration
  • ❌ SetEnable
  • ✅ GetInfo
  • ❌ SetConfig
  • ❌ SetSecurityKeys
  • ❌ GetSecurityKeys
  • ❌ SetBasBeaconSecurityProperties
  • ✅ GetBasBeaconSecurityProperties
  • ✅ GetBSSID
  • ✅ GetSSID
  • ❌ SetSSID
  • ✅ GetBeaconType
  • ❌ SetBeaconType
  • ✅ GetChannelInfo
  • ❌ SetChannel
  • ✅ GetBeaconAdvertisement
  • ❌ SetBeaconAdvertisement
  • ✅ GetTotalAssociations
  • ❌ GetGenericAssociatedDeviceInfo
  • ❌ GetSpecificAssociatedDeviceInfo
  • ❌ X_AVM-DE_GetSpecificAssociatedDeviceInfoByIp
  • ✅ X_AVM-DE_GetWLANDeviceListPath
  • ❌ X_AVM-DE_SetStickSurfEnable
  • ✅ X_AVM-DE_GetIPTVOptimized
  • ❌ X_AVM-DE_SetIPTVOptimized
  • ✅ GetStatistics
  • ✅ GetPacketStatistics
  • ✅ X_AVM-DE_GetNightControl
  • ❌ X_SetHighFrequencyBand
  • ✅ X_AVM-DE_GetWLANHybridMode
  • ❌ X_AVM-DE_SetWLANHybridMode
  • ✅ X_AVM-DE_GetWLANExtInfo
  • ❌ X_AVM-DE_SetWLANGlobalEnable
  • ✅ X_AVM-DE_GetWPSInfo
  • ❌ X_AVM-DE_SetWPSConfig
  • ❌ X_AVM-DE_SetWPSEnable
  • ✅ X_AVM-DE_GetWLANConnectionInfo
• 🔶 urn:dslforum-org:service:LANHostConfigManagement
  • ✅ GetInfo
  • ❌ SetDHCPServerEnable
  • ❌ SetSubnetMask
  • ✅ GetSubnetMask
  • ❌ SetIPRouter
  • ✅ GetIPRoutersList
  • ❌ SetIPInterface
  • ✅ GetAddressRange
  • ❌ SetAddressRange
  • ✅ GetIPInterfaceNumberOfEntries
  • ✅ GetDNSServers
• 🔶 urn:dslforum-org:service:LANEthernetInterfaceConfig
  • ❌ SetEnable
  • ✅ GetInfo
  • ✅ GetStatistics
• ❌ urn:dslforum-org:service:X_AVM-DE_Dect
• ❌ urn:dslforum-org:service:X_AVM-DE_Media
• ❌ urn:dslforum-org:service:X_AVM-DE_Homeauto
• ❌ urn:dslforum-org:service:X_AVM-DE_Homeplug

Storage/NAS

• ❌ urn:dslforum-org:service:X_AVM-DE_Storage
• ❌ urn:dslforum-org:service:X_AVM-DE_UPnP
• ❌ urn:dslforum-org:service:X_AVM-DE_WebDAVClient
• ❌ urn:dslforum-org:service:X_AVM-DE_Filelinks

System

• ✅ urn:dslforum-org:service:DeviceInfo
  • ✅ GetInfo
  • ✅ SetProvisioningCode
  • ✅ GetDeviceLog
  • ✅ GetSecurityPort
• 🔶 urn:dslforum-org:service:DeviceConfig
  • ✅ GetPersistentData
  • ❌ SetPersistentData
  • ❌ ConfigurationStarted
  • ❌ ConfigurationFinished
  • ❌ FactoryReset
  • ❌ Reboot
  • ✅ X_GenerateUUID
  • ❌ X_AVM-DE_GetConfigFile
  • ❌ X_AVM-DE_SetConfigFile
  • ✅ X_AVM-DE_CreateUrlSID
  • ✅ X_AVM-DE_GetSupportDataInfo
  • ❌ X_AVM-DE_SendSupportData
  • ❌ X_AVM-DE_GetSupportDataEnable
  • ❌ X_AVM-DE_SetSupportDataEnable
• ✅ urn:dslforum-org:service:LANConfigSecurity
  • ✅ GetInfo
  • ✅ X_AVM-DE_GetAnonymousLogin
  • ✅ X_AVM-DE_GetCurrentUser
  • ✅ SetConfigPassword
  • ✅ X_AVM-DE_GetUserList
• ❌ urn:dslforum-org:service:X_AVM-DE_AppSetup
• ✅ urn:dslforum-org:service:ManagementServer
  • ✅ GetInfo
  • ✅ SetManagementServerURL
  • ✅ SetManagementServerUsername
  • ✅ SetManagementServerPassword
  • ✅ SetPeriodicInform
  • ✅ SetConnectionRequestAuthentication
  • ✅ SetUpgradeManagement
  • ✅ X_SetTR069Enable
  • ✅ X_AVM-DE_GetTR069FirmwareDownloadEnabled
  • ✅ X_AVM-DE_SetTR069FirmwareDownloadEnabled
• ❌ urn:dslforum-org:service:X_AVM-DE_USPController
• ❌ urn:dslforum-org:service:X_AVM-DE_Auth
• ✅ urn:dslforum-org:service:Time
  • ✅ GetInfo
  • ✅ SetNTPServers
• ✅ urn:dslforum-org:service:UserInterface
  • ✅ GetInfo
  • ✅ X_AVM-DE_CheckUpdate
  • ✅ X_AVM-DE_DoPrepareCGI
  • ✅ X_AVM-DE_DoUpdate
  • ✅ X_AVM-DE_DoManualUpdate
  • ✅ X_AVM-DE_GetInternationalConfig
  • ✅ X_AVM-DE_SetInternationalConfig
  • ✅ X_AVM-DE_GetInfo
  • ✅ X_AVM-DE_SetConfig