src/safety/bounded_reader.zig

Página generada desde zkit@zkit-0.0.0-_fk2iAa4BQCqGFKJeeY9WvMQClX5kiZQ2iOZrVsxVyyN (src/root.zig). No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

zkit.safety.BoundedReader — cursor de lectura sobre bytes NO confiables.

Todo parser de wire o contenedor (MoQT, H3/QPACK, WebTransport, MP4, MKV, el codec de conduit y el de spire) hace lo mismo: lee enteros de ancho fijo, varints y campos con prefijo de longitud de un buffer que ha escrito un atacante. Los bugs se repiten: leer más allá del final, un len del wire que se usa sin comparar con lo que queda, un contador que reserva memoria proporcional a un número de 62 bits, un unreachable en la rama "no puede pasar" que el atacante hace pasar.

Contrato:

• Ninguna operación lee fuera de buf, ninguna hace pánico, ninguna reserva memoria. Todo fallo es un error del conjunto Error.
• El cursor no avanza si la lectura falla (una lectura es atómica): un parser que reintenta con más datos no ve un estado a medias.
• sub(len) da un lector hijo acotado a len bytes (estructuras anidadas: átomos MP4, elementos EBML, frames de control): el hijo no puede leer fuera de su padre por construcción.
• readCount(max) para contadores que dimensionan algo: por encima de max es error.LimitExceeded, antes de reservar nada.

safety.BoundedReaderCopiar enlace

type · línea 38

pub const BoundedReader = struct

Sin ///.

safety.BoundedReader.initCopiar enlace

fn · línea 42

pub fn init(buf: []const u8) BoundedReader

Sin ///.

safety.BoundedReader.remainingCopiar enlace

fn · línea 46

pub fn remaining(self: *const BoundedReader) usize

Sin ///.

safety.BoundedReader.isEmptyCopiar enlace

fn · línea 50

pub fn isEmpty(self: *const BoundedReader) bool

Sin ///.

safety.BoundedReader.restCopiar enlace

fn · línea 55

pub fn rest(self: *const BoundedReader) []const u8

Lo que queda sin consumir (préstamo, no copia).

safety.BoundedReader.expectEndCopiar enlace

fn · línea 60

pub fn expectEnd(self: *const BoundedReader) Error!void

error.TrailingBytes si queda algo.

safety.BoundedReader.readBytesCopiar enlace

fn · línea 65

pub fn readBytes(self: *BoundedReader, n: usize) Error![]const u8

n bytes prestados del buffer (sin copia).

safety.BoundedReader.readBytesLenCopiar enlace

fn · línea 72

pub fn readBytesLen(self: *BoundedReader, n: u64) Error![]const u8

Como readBytes con n de tipo del wire (u64), comprobado.

safety.BoundedReader.skipCopiar enlace

fn · línea 77

pub fn skip(self: *BoundedReader, n: u64) Error!void

Sin ///.

safety.BoundedReader.readByteCopiar enlace

fn · línea 81

pub fn readByte(self: *BoundedReader) Error!u8

Sin ///.

safety.BoundedReader.peekByteCopiar enlace

fn · línea 85

pub fn peekByte(self: *const BoundedReader) Error!u8

Sin ///.

safety.BoundedReader.readIntCopiar enlace

fn · línea 90

pub fn readInt(self: *BoundedReader, comptime T: type, endian: std.builtin.Endian) Error!T

Sin ///.

safety.BoundedReader.subCopiar enlace

fn · línea 97

pub fn sub(self: *BoundedReader, len: u64) Error!BoundedReader

Lector hijo sobre los siguientes len bytes; el padre avanza len.

safety.BoundedReader.limitCopiar enlace

fn · línea 102

pub fn limit(value: anytype, max: u64) Error!u64

Entero T del wire que dimensiona algo: LimitExceeded si > max.

safety.BoundedReader.readQuicVarintCopiar enlace

fn · línea 112

pub fn readQuicVarint(self: *BoundedReader) Error!u62

Varint de QUIC (RFC 9000 §16): 1/2/4/8 bytes según los dos bits altos, valor de hasta 62 bits. Base de MoQT, H3 y WebTransport.

safety.BoundedReader.readQuicVarintMinimalCopiar enlace

fn · línea 123

pub fn readQuicVarintMinimal(self: *BoundedReader) Error!u62

Como readQuicVarint pero rechaza codificaciones no mínimas (InvalidEncoding), para campos donde la especificación lo exige.

safety.BoundedReader.readQuicVarintMaxCopiar enlace

fn · línea 136

pub fn readQuicVarintMax(self: *BoundedReader, max: u64) Error!u64

Varint QUIC que dimensiona algo (longitud, contador): LimitExceeded si pasa de max, y el cursor no avanza.

safety.BoundedReader.readQuicLengthPrefixedCopiar enlace

fn · línea 147

pub fn readQuicLengthPrefixed(self: *BoundedReader, max: u64) Error![]const u8

Campo con prefijo de longitud varint QUIC, longitud <= max.

safety.BoundedReader.EbmlVintCopiar enlace

type · línea 156

pub const EbmlVint = struct

Sin ///.

safety.BoundedReader.readEbmlVintCopiar enlace

fn · línea 167

pub fn readEbmlVint(self: *BoundedReader, max_len: u4) Error!EbmlVint

VINT de EBML (RFC 8794 §4): la longitud (1..8) la da el primer bit a 1 del primer byte; el marcador se quita del valor. 0x00 como primer byte es ilegal (InvalidEncoding). max_len limita la longitud (4 para IDs de elemento, 8 para tamaños).

safety.bounded_reader.ErrorCopiar enlace

const · línea 25

pub const Error = error{ /// Faltan bytes: el mensaje está truncado (o llegará más tarde). EndOfStream, /// Un valor del wire no cabe en el tipo pedido. Overflow, /// Un contador/longitud supera el …

Sin ///.

safety.bounded_reader.BoundedReaderCopiar enlace

type · línea 38

pub const BoundedReader = struct

Sin ///.

safety.bounded_reader.BoundedReader.initCopiar enlace

fn · línea 42

pub fn init(buf: []const u8) BoundedReader

Sin ///.

safety.bounded_reader.BoundedReader.remainingCopiar enlace

fn · línea 46

pub fn remaining(self: *const BoundedReader) usize

Sin ///.

safety.bounded_reader.BoundedReader.isEmptyCopiar enlace

fn · línea 50

pub fn isEmpty(self: *const BoundedReader) bool

Sin ///.

safety.bounded_reader.BoundedReader.restCopiar enlace

fn · línea 55

pub fn rest(self: *const BoundedReader) []const u8

Lo que queda sin consumir (préstamo, no copia).

safety.bounded_reader.BoundedReader.expectEndCopiar enlace

fn · línea 60

pub fn expectEnd(self: *const BoundedReader) Error!void

error.TrailingBytes si queda algo.

safety.bounded_reader.BoundedReader.readBytesCopiar enlace

fn · línea 65

pub fn readBytes(self: *BoundedReader, n: usize) Error![]const u8

n bytes prestados del buffer (sin copia).

safety.bounded_reader.BoundedReader.readBytesLenCopiar enlace

fn · línea 72

pub fn readBytesLen(self: *BoundedReader, n: u64) Error![]const u8

Como readBytes con n de tipo del wire (u64), comprobado.

safety.bounded_reader.BoundedReader.skipCopiar enlace

fn · línea 77

pub fn skip(self: *BoundedReader, n: u64) Error!void

Sin ///.

safety.bounded_reader.BoundedReader.readByteCopiar enlace

fn · línea 81

pub fn readByte(self: *BoundedReader) Error!u8

Sin ///.

safety.bounded_reader.BoundedReader.peekByteCopiar enlace

fn · línea 85

pub fn peekByte(self: *const BoundedReader) Error!u8

Sin ///.

safety.bounded_reader.BoundedReader.readIntCopiar enlace

fn · línea 90

pub fn readInt(self: *BoundedReader, comptime T: type, endian: std.builtin.Endian) Error!T

Sin ///.

safety.bounded_reader.BoundedReader.subCopiar enlace

fn · línea 97

pub fn sub(self: *BoundedReader, len: u64) Error!BoundedReader

Lector hijo sobre los siguientes len bytes; el padre avanza len.

safety.bounded_reader.BoundedReader.limitCopiar enlace

fn · línea 102

pub fn limit(value: anytype, max: u64) Error!u64

Entero T del wire que dimensiona algo: LimitExceeded si > max.

safety.bounded_reader.BoundedReader.readQuicVarintCopiar enlace

fn · línea 112

pub fn readQuicVarint(self: *BoundedReader) Error!u62

Varint de QUIC (RFC 9000 §16): 1/2/4/8 bytes según los dos bits altos, valor de hasta 62 bits. Base de MoQT, H3 y WebTransport.

safety.bounded_reader.BoundedReader.readQuicVarintMinimalCopiar enlace

fn · línea 123

pub fn readQuicVarintMinimal(self: *BoundedReader) Error!u62

Como readQuicVarint pero rechaza codificaciones no mínimas (InvalidEncoding), para campos donde la especificación lo exige.

safety.bounded_reader.BoundedReader.readQuicVarintMaxCopiar enlace

fn · línea 136

pub fn readQuicVarintMax(self: *BoundedReader, max: u64) Error!u64

Varint QUIC que dimensiona algo (longitud, contador): LimitExceeded si pasa de max, y el cursor no avanza.

safety.bounded_reader.BoundedReader.readQuicLengthPrefixedCopiar enlace

fn · línea 147

pub fn readQuicLengthPrefixed(self: *BoundedReader, max: u64) Error![]const u8

Campo con prefijo de longitud varint QUIC, longitud <= max.

safety.bounded_reader.BoundedReader.EbmlVintCopiar enlace

type · línea 156

pub const EbmlVint = struct

Sin ///.

safety.bounded_reader.BoundedReader.readEbmlVintCopiar enlace

fn · línea 167

pub fn readEbmlVint(self: *BoundedReader, max_len: u4) Error!EbmlVint

VINT de EBML (RFC 8794 §4): la longitud (1..8) la da el primer bit a 1 del primer byte; el marcador se quita del valor. 0x00 como primer byte es ilegal (InvalidEncoding). max_len limita la longitud (4 para IDs de elemento, 8 para tamaños).

safety.bounded_reader.quicVarintLenCopiar enlace

fn · línea 182

pub fn quicVarintLen(v: u64) usize

Bytes mínimos para codificar v como varint QUIC.

safety.bounded_reader.writeQuicVarintCopiar enlace

fn · línea 190

pub fn writeQuicVarint(out: []u8, v: u62) error{NoSpaceLeft}!usize

Codifica v (<= 2^62-1) como varint QUIC mínimo en out.