NdsForge.NdsReadOptions Class Reference

Controls resource limits applied while parsing an image. More...

Properties
static NdsReadOptions	Default = new() [get]
	Supplies conservative allocation and recursion ceilings suitable for untrusted retail-sized images.
int	MaximumFileNameTableBytes = 16 * 1024 * 1024 [get]
	Limits bytes allocated for the NitroFS FNT before any names or directory links are decoded.
int	MaximumFileAllocationTableBytes = 8 * 1024 * 1024 [get]
	Limits bytes allocated for the FAT, whose eight-byte records map file IDs to image regions.
int	MaximumDirectoryCount = 4096 [get]
	Caps reachable FNT directory records and may not exceed the format's 4,096-ID namespace.
int	MaximumDirectoryDepth = 128 [get]
	Bounds recursive FNT traversal so cyclic or adversarial directory trees cannot exhaust the call stack.
int	MaximumOverlayCount = 65_536 [get]
	Bounds entries decoded independently from each ARM9 or ARM7 overlay table.
int	MaximumBannerBytes = 0x23C0 [get]
	Bounds banner allocation before its version field selects a smaller, exact supported layout.

Detailed Description

Controls resource limits applied while parsing an image.

Definition at line 4 of file NdsReadOptions.cs.

Property Documentation

Default

NdsReadOptions NdsForge.NdsReadOptions.Default = new()

staticget

Supplies conservative allocation and recursion ceilings suitable for untrusted retail-sized images.

Definition at line 7 of file NdsReadOptions.cs.

MaximumBannerBytes

int NdsForge.NdsReadOptions.MaximumBannerBytes = 0x23C0

get

Bounds banner allocation before its version field selects a smaller, exact supported layout.

Definition at line 26 of file NdsReadOptions.cs.

MaximumDirectoryCount

int NdsForge.NdsReadOptions.MaximumDirectoryCount = 4096

get

Caps reachable FNT directory records and may not exceed the format's 4,096-ID namespace.

Definition at line 17 of file NdsReadOptions.cs.

MaximumDirectoryDepth

int NdsForge.NdsReadOptions.MaximumDirectoryDepth = 128

get

Bounds recursive FNT traversal so cyclic or adversarial directory trees cannot exhaust the call stack.

Definition at line 20 of file NdsReadOptions.cs.

MaximumFileAllocationTableBytes

int NdsForge.NdsReadOptions.MaximumFileAllocationTableBytes = 8 * 1024 * 1024

get

Limits bytes allocated for the FAT, whose eight-byte records map file IDs to image regions.

Definition at line 14 of file NdsReadOptions.cs.

MaximumFileNameTableBytes

int NdsForge.NdsReadOptions.MaximumFileNameTableBytes = 16 * 1024 * 1024

get

Limits bytes allocated for the NitroFS FNT before any names or directory links are decoded.

The 16 MiB default is intentionally far above normal retail tables while bounding hostile length fields.

Definition at line 11 of file NdsReadOptions.cs.

MaximumOverlayCount

int NdsForge.NdsReadOptions.MaximumOverlayCount = 65_536

get

Bounds entries decoded independently from each ARM9 or ARM7 overlay table.

Definition at line 23 of file NdsReadOptions.cs.

---

The documentation for this class was generated from the following file:

• src/NdsForge/NdsReadOptions.cs