diff --git a/.gitignore b/.gitignore index dfcfd56..9c06b60 100644 --- a/.gitignore +++ b/.gitignore @@ -348,3 +348,6 @@ MigrationBackup/ # Ionide (cross platform F# VS Code tools) working folder .ionide/ + +dumps +patched \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..f8f34cb --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,20 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "name": "UFiber.Configurator", + "type": "coreclr", + "request": "launch", + "preLaunchTask": "build", + "program": "${workspaceFolder}/src/UFiber.Configurator/bin/Debug/net5.0/UFiber.Configurator.dll", + "args": [ + "--host", + "192.168.200.2", + "--dry-run" + ], + "cwd": "${workspaceFolder}/src/UFiber.Configurator", + "console": "internalConsole", + "stopAtEntry": false + } + ] +} \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..a959562 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,42 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "build", + "command": "dotnet", + "type": "process", + "args": [ + "build", + "${workspaceFolder}/src/UFiber.Configurator/UFiber.Configurator.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + }, + { + "label": "publish", + "command": "dotnet", + "type": "process", + "args": [ + "publish", + "${workspaceFolder}/src/UFiber.Configurator/UFiber.Configurator.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + }, + { + "label": "watch", + "command": "dotnet", + "type": "process", + "args": [ + "watch", + "run", + "${workspaceFolder}/src/UFiber.Configurator/UFiber.Configurator.csproj", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + } + ] +} \ No newline at end of file diff --git a/UFiber.Configurator.sln b/UFiber.Configurator.sln new file mode 100644 index 0000000..2f7f3ee --- /dev/null +++ b/UFiber.Configurator.sln @@ -0,0 +1,39 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.6.30114.105 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{7D598BFE-5D3E-4E92-BEAC-492BBFD00B02}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UFiber.Configurator", "src\UFiber.Configurator\UFiber.Configurator.csproj", "{3D31C840-16B1-4F68-A886-4B8E49246B81}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 + Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + Release|x86 = Release|x86 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Debug|x64.ActiveCfg = Debug|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Debug|x64.Build.0 = Debug|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Debug|x86.ActiveCfg = Debug|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Debug|x86.Build.0 = Debug|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Release|Any CPU.Build.0 = Release|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Release|x64.ActiveCfg = Release|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Release|x64.Build.0 = Release|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Release|x86.ActiveCfg = Release|Any CPU + {3D31C840-16B1-4F68-A886-4B8E49246B81}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {3D31C840-16B1-4F68-A886-4B8E49246B81} = {7D598BFE-5D3E-4E92-BEAC-492BBFD00B02} + EndGlobalSection +EndGlobal diff --git a/src/UFiber.Configurator/NVRAMInfo.cs b/src/UFiber.Configurator/NVRAMInfo.cs new file mode 100644 index 0000000..079374c --- /dev/null +++ b/src/UFiber.Configurator/NVRAMInfo.cs @@ -0,0 +1,114 @@ +using System; +using System.Text; + +namespace UFiber.Configurator +{ + public class NVRAMInfo + { + private const int NVRAM_START = 1408; + private const int NVRAM_END = 2432; + private Memory _data; + public Memory NVR => _data.Slice(NVRAM_START, NVRAM_END); + + public int Version => BitConverter.ToInt32(this.NVR.Slice(0, 4).Span); + + public NVRAMInfo(Memory data) + { + this._data = data; + } + + public byte[] Patch() + { + // TODO: Apply patches to the original data and return it. + return _data.ToArray(); + } + + public override string ToString() + { + var sb = new StringBuilder(); + sb.AppendLine("--- NVRAM Information --"); + sb.AppendLine($"- NVRAM Version: {this.Version}"); + + return sb.ToString(); + } + + // var local_crc32_table = new uint[]{ + // 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, + // 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, + // 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, + // 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, + // 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, + // 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, + // 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, + // 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, + // 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, + // 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, + // 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, + // 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, + // 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, + // 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F, + // 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, + // 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, + // 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, + // 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433, + // 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, + // 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, + // 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, + // 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, + // 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, + // 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, + // 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, + // 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, + // 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, + // 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9, + // 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, + // 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, + // 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, + // 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, + // 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, + // 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683, + // 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, + // 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, + // 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, + // 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, + // 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, + // 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, + // 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, + // 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B, + // 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, + // 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79, + // 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, + // 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, + // 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, + // 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D, + // 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, + // 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, + // 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, + // 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, + // 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, + // 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, + // 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, + // 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, + // 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, + // 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB, + // 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, + // 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, + // 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, + // 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF, + // 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, + // 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D, + // }; + + // uint CalculateCRC(byte[] data) + // { + // uint crc = 0xFFFFFFFF; + + // foreach (var bit in data) + // { + // crc = (crc >> 8) ^ local_crc32_table[(crc ^ bit) & 0xFF]; + // } + + // return crc & 0xFFFFFFFF; + // } + } +} \ No newline at end of file diff --git a/src/UFiber.Configurator/Program.cs b/src/UFiber.Configurator/Program.cs new file mode 100644 index 0000000..4abd785 --- /dev/null +++ b/src/UFiber.Configurator/Program.cs @@ -0,0 +1,198 @@ +using System; +using System.IO; +using Renci.SshNet; +using UFiber.Configurator; +using System.CommandLine; +using System.CommandLine.Invocation; + +var rootCommand = new RootCommand("Apply configuration changes to UFiber devices") +{ + new Option( + "--host", + "IP or hostname of the target UFiber device.", ArgumentArity.ExactlyOne), + new Option( + "--user", + getDefaultValue: () => "ubnt", + "SSH user name."), + new Option( + "--pw", + getDefaultValue: () => "ubnt", + "SSH password."), + new Option( + "--port", + getDefaultValue: () => 22, + "SSH port of the target UFiber device."), + new Option( + "--dry-run", + "Don't apply the patched file to the target UFiber device. (i.e. dry-run)"), + new Option( + "--slid", + "The SLID (or PLOAM Password).", ArgumentArity.ZeroOrOne), + new Option( + "--vendor", + "4-digit Vendor Id (e.g. HWTC, MTSC, etc.). Combined with --serial, a GPON Serial Number is built.", ArgumentArity.ZeroOrOne), + new Option( + "--serial", + "8-digit serial number (e.g. 01234567). Combined with --vendor, a GPON Serial Number is built.", ArgumentArity.ZeroOrOne), + new Option( + "--mac", + "The desired MAC address to clone.", ArgumentArity.ZeroOrOne), +}; + +SshClient GetSSHClient(string userName, string password, string host, int port = 22) +{ + var client = new SshClient(host, port, userName, password); + client.Connect(); + return client; +} + +ScpClient GetSCPClient(string userName, string password, string host, int port = 22) +{ + var client = new ScpClient(host, port, userName, password); + client.Connect(); + return client; +} + +rootCommand.Handler = CommandHandler + .Create( + (host, user, pw, port, dryRun, slid, vendor, serial, mac) => + { + if (string.IsNullOrWhiteSpace(host)) + { + Console.Error.WriteLine("Host is a required parameter and can't be empty."); + Environment.ExitCode = -1; + return; + } + + SshClient ssh = default!; + ScpClient scp = default!; + + try + { + // Connect to SSH and SCP + ssh = GetSSHClient(user, pw, host, port); + scp = GetSCPClient(user, pw, host, port); + } + catch (Exception ex) + { + Console.Error.WriteLine($"Unable to connect to the target UFiber device. Please check the connection parameters and try again. Error: {ex.Message}"); + Environment.ExitCode = -1; + return; + } + + var imgName = $"fw-{DateTime.UtcNow.ToString("ddMMyyyy-hhmmss")}.bin"; + + // Dump the image file + var cmd = ssh.RunCommand($"cat /dev/mtdblock3 > /tmp/{imgName}"); + if (cmd.ExitStatus != 0) + { + Console.Error.WriteLine($"Failute to dump the image file. Error: {cmd.Error}"); + Environment.ExitCode = cmd.ExitStatus; + return; + } + + const string localDumps = "./dumps"; + + if (!Directory.Exists(localDumps)) + { + Directory.CreateDirectory(localDumps); + } + + // Download the dump + try + { + scp.Download($"/tmp/{imgName}", new DirectoryInfo(localDumps)); + ssh.RunCommand($"rm /tmp/{imgName}"); + } + catch (Exception ex) + { + Console.Error.WriteLine($"Failure downloading original image file from the UFiber device. Error: {ex.Message}."); + Environment.ExitCode = -1; + return; + } + + var nvramInfo = new NVRAMInfo(File.ReadAllBytes(Path.Combine(localDumps, imgName))); + Console.WriteLine("### Original Image ###"); + Console.WriteLine(nvramInfo); + + Console.WriteLine($"### Patching {imgName}..."); + + if ((string.IsNullOrWhiteSpace(vendor) && !string.IsNullOrWhiteSpace(serial)) || + (!string.IsNullOrWhiteSpace(vendor) && string.IsNullOrWhiteSpace(serial))) + { + Console.Error.WriteLine($"To set the GPON Serial Number, you must pass both --vendor and --serial"); + Environment.ExitCode = -1; + return; + } + else if (!string.IsNullOrWhiteSpace(vendor) && !string.IsNullOrWhiteSpace(serial)) + { + // TODO: Apply Serial to the nvram + } + + if (!string.IsNullOrWhiteSpace(mac)) + { + // TODO: Apply MAC to the nvram + } + + if (!string.IsNullOrWhiteSpace(slid)) + { + // TODO: Apply SLID to the nvram + } + + var patched = nvramInfo.Patch(); + + const string localPatched = "./patched"; + + if (!Directory.Exists(localPatched)) + { + Directory.CreateDirectory(localPatched); + } + + var patchedFileName = $"patched-{imgName}"; + File.WriteAllBytes(Path.Combine(localPatched, patchedFileName), patched); + Console.WriteLine($"### Patched {imgName}!"); + Console.WriteLine(nvramInfo); + + if (!dryRun) + { + Console.WriteLine("Uploading patched file to the target UFiber device..."); + try + { + scp.Upload(new FileInfo(Path.Combine(localPatched, patchedFileName)), $"/tmp/{patchedFileName}"); + } + catch (Exception ex) + { + Console.Error.WriteLine($"Failure uploading patched image file to the UFiber device. Error: {ex.Message}."); + Environment.ExitCode = -1; + return; + } + Console.WriteLine("Uploaded!"); + Console.WriteLine("### Applying patched file on the target UFiber device..."); + cmd = ssh.RunCommand($"dd if=/tmp/{patchedFileName} of=/dev/mtdblock3 && rm /tmp/{patchedFileName}"); + if (cmd.ExitStatus != 0) + { + Console.Error.WriteLine($"Failure to apply patched image file. Error: {cmd.Error}"); + Environment.ExitCode = cmd.ExitStatus; + return; + } + Console.WriteLine("### Applied patch! Please reboot your UFiber device to load the new image."); + } + else + { + Console.WriteLine($"### Dry-run completed. The patched file can be found at '{Path.Combine(localDumps, patchedFileName)}'."); + } + }); + +return rootCommand.Invoke(args); + + + + + + + + + + + + diff --git a/src/UFiber.Configurator/UFiber.Configurator.csproj b/src/UFiber.Configurator/UFiber.Configurator.csproj new file mode 100644 index 0000000..b79c694 --- /dev/null +++ b/src/UFiber.Configurator/UFiber.Configurator.csproj @@ -0,0 +1,14 @@ + + + + Exe + net5.0 + enable + + + + + + + +