FirmwareKit.NTPi 1.0.0

FirmwareKit.NTPi

A .NET library for parsing, extracting, and creating Nothing Technology Package Image (NTPI) firmware files. Supports AES-256-CBC decryption, LZMA2 decompression, and SHA-256 integrity verification.

Features

• Read NTPI firmware package metadata (version, regions, file entries)
• Unpack NTPI firmware packages to disk with parallel file extraction
• Parse NTPI firmware packages into memory for programmatic access
• Pack files into NTPI firmware packages with parallel compression and encryption
• AOT compatible — fully compatible with Native AOT publishing
• Cross-platform — targets .NET 10/8, .NET Standard 2.1/2.0

Installation

dotnet add package FirmwareKit.NTPi

Quick Start

Reading firmware info

using FirmwareKit.NTPi;
using FirmwareKit.NTPi.Compression;
using FirmwareKit.NTPi.Crypto;

using var reader = new NtpiReader(new AesCbcCryptoProvider(), new Lzma2Compressor());
NtpiFileInfo info = reader.ReadInfo("firmware.ntpi");

Console.WriteLine($"Version: {info.MajorVersion}.{info.MinorVersion}.{info.PatchVersion}");
Console.WriteLine($"Files: {info.FileEntries.Count}");
foreach (var entry in info.FileEntries)
{
    Console.WriteLine($"  {entry.Name} ({entry.OriginalLength} bytes)");
}

Unpacking firmware

using var reader = new NtpiReader(new AesCbcCryptoProvider(), new Lzma2Compressor());

// Sequential extraction
reader.Unpack("firmware.ntpi", @"C:\output");

// Parallel extraction with progress reporting
var progress = new Progress<NtpiExtractionProgress>(p =>
    Console.WriteLine($"[{p.CompletedFiles}/{p.TotalFiles}] {p.CurrentFileName}"));
reader.Unpack("firmware.ntpi", @"C:\output", progress, maxDegreeOfParallelism: 4);

// Async with cancellation
await reader.UnpackAsync("firmware.ntpi", @"C:\output",
    cancellationToken: cancellationToken);

Parsing firmware into memory

using var reader = new NtpiReader(new AesCbcCryptoProvider(), new Lzma2Compressor());
NtpiParsedFile parsed = reader.Parse("firmware.ntpi");

foreach (var (name, data) in parsed.ExtractedFiles)
{
    Console.WriteLine($"{name}: {data.Length} bytes");
}

Packing firmware

using var writer = new NtpiWriter(new AesCbcCryptoProvider(), new Lzma2Compressor());

// Pack from directory
writer.Pack(@"C:\firmware_files", "output.ntpi", major: 1, minor: 3, patch: 0);

// Pack from pre-defined entries
var entries = new List<FileEntry> { new FileEntry { Name = "boot.img" } };
var fileData = new Dictionary<string, byte[]> { ["boot.img"] = File.ReadAllBytes("boot.img") };
writer.PackFromEntries(entries, fileData, "output.ntpi");

// Async with progress
var progress = new Progress<NtpiPackProgress>(p =>
    Console.WriteLine($"[{p.Phase}] {p.CompletedFiles}/{p.TotalFiles} {p.CurrentFileName}"));
await writer.PackAsync(@"C:\firmware_files", "output.ntpi", progress: progress);

Registering custom version keys

using FirmwareKit.NTPi.Models;

var keys = new Dictionary<int, NtpiVersionKey>
{
    [1] = new NtpiVersionKey(keyBytes1, ivBytes1),
    [2] = new NtpiVersionKey(keyBytes2, ivBytes2),
    [3] = new NtpiVersionKey(keyBytes3, ivBytes3),
    [4] = new NtpiVersionKey(keyBytes4, ivBytes4),
    [5] = new NtpiVersionKey(keyBytes5, ivBytes5)
};
NtpiVersionRegistry.RegisterVersion(1, 5, 0, keys);

Architecture

The library uses dependency injection for crypto and compression services:

• ICryptoProvider — AES-256-CBC encryption/decryption abstraction
• ILzma2Compressor — LZMA2 compression/decompression abstraction

Default implementations (AesCbcCryptoProvider, Lzma2Compressor) are provided.

Supported Frameworks

License

MIT