1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
use crate::blocks::{PcapBlock, PcapBlockOwned};
use crate::error::PcapError;
use crate::pcapng::*;
use crate::traits::PcapReaderIterator;
use circular::Buffer;
use nom::combinator::{complete, map};
use nom::multi::many1;
use nom::{IResult, Offset};
use std::fmt;
use std::io::Read;
/// Parsing iterator over pcap-ng data (streaming version)
///
/// ## Pcap-NG Reader
///
/// This reader is a streaming parser based on a circular buffer, which means memory
/// usage is constant, and that it can be used to parse huge files or infinite streams.
/// It creates an abstraction over any input providing the `Read` trait, and takes care
/// of managing the circular buffer to provide an iterator-like interface.
///
/// The first call to `next` should return the a Section Header Block (SHB), marking the start of a
/// new section.
/// For each section, calls to `next` will return blocks, some of them containing data (SPB, EPB),
/// and others containing information (IDB, NRB, etc.).
///
/// Some information must be stored (for ex. the data link type from the IDB) to be able to parse
/// following block contents. Usually, a list of interfaces must be stored, with the data link type
/// and capture length, for each section. These values are used when parsing Enhanced Packet Blocks
/// (which gives an interface ID - the index, starting from 0) and Simple Packet Blocks (which
/// assume an interface index of 0).
///
/// The size of the circular buffer has to be big enough for at least one complete block. Using a
/// larger value (at least 65k) is advised to avoid frequent reads and buffer shifts.
///
/// **There are precautions to take when reading multiple blocks before consuming data. See
/// [PcapReaderIterator](traits/trait.PcapReaderIterator.html) for details.**
///
/// ## Example
///
/// ```rust
/// use pcap_parser::*;
/// use pcap_parser::traits::PcapReaderIterator;
/// use std::fs::File;
///
/// # let path = "assets/test001-le.pcapng";
/// let file = File::open(path).unwrap();
/// let mut num_blocks = 0;
/// let mut reader = PcapNGReader::new(65536, file).expect("PcapNGReader");
/// let mut if_linktypes = Vec::new();
/// loop {
/// match reader.next() {
/// Ok((offset, block)) => {
/// println!("got new block");
/// num_blocks += 1;
/// match block {
/// PcapBlockOwned::NG(Block::SectionHeader(ref _shb)) => {
/// // starting a new section, clear known interfaces
/// if_linktypes = Vec::new();
/// },
/// PcapBlockOwned::NG(Block::InterfaceDescription(ref idb)) => {
/// if_linktypes.push(idb.linktype);
/// },
/// PcapBlockOwned::NG(Block::EnhancedPacket(ref epb)) => {
/// assert!((epb.if_id as usize) < if_linktypes.len());
/// let linktype = if_linktypes[epb.if_id as usize];
/// #[cfg(feature="data")]
/// let res = pcap_parser::data::get_packetdata(epb.data, linktype, epb.caplen as usize);
/// },
/// PcapBlockOwned::NG(Block::SimplePacket(ref spb)) => {
/// assert!(if_linktypes.len() > 0);
/// let linktype = if_linktypes[0];
/// let blen = (spb.block_len1 - 16) as usize;
/// #[cfg(feature="data")]
/// let res = pcap_parser::data::get_packetdata(spb.data, linktype, blen);
/// },
/// PcapBlockOwned::NG(_) => {
/// // can be statistics (ISB), name resolution (NRB), etc.
/// eprintln!("unsupported block");
/// },
/// PcapBlockOwned::Legacy(_)
/// | PcapBlockOwned::LegacyHeader(_) => unreachable!(),
/// }
/// reader.consume(offset);
/// },
/// Err(PcapError::Eof) => break,
/// Err(PcapError::Incomplete) => {
/// eprintln!("Could not read complete data block.");
/// eprintln!("Hint: the reader buffer size may be too small, or the input file nay be truncated.");
/// break;
/// },
/// Err(e) => panic!("error while reading: {:?}", e),
/// }
/// }
/// println!("num_blocks: {}", num_blocks);
/// ```
pub struct PcapNGReader<R>
where
R: Read,
{
info: CurrentSectionInfo,
reader: R,
buffer: Buffer,
consumed: usize,
reader_exhausted: bool,
}
impl<R> PcapNGReader<R>
where
R: Read,
{
/// Creates a new `PcapNGReader<R>` with the provided buffer capacity.
pub fn new(capacity: usize, reader: R) -> Result<PcapNGReader<R>, PcapError<&'static [u8]>> {
let buffer = Buffer::with_capacity(capacity);
Self::from_buffer(buffer, reader)
}
/// Creates a new `PcapNGReader<R>` using the provided `Buffer`.
pub fn from_buffer(
mut buffer: Buffer,
mut reader: R,
) -> Result<PcapNGReader<R>, PcapError<&'static [u8]>> {
let sz = reader.read(buffer.space()).or(Err(PcapError::ReadError))?;
buffer.fill(sz);
// just check that first block is a valid one
let (_rem, _shb) = match parse_sectionheaderblock(buffer.data()) {
Ok((r, h)) => Ok((r, h)),
Err(nom::Err::Error(e)) | Err(nom::Err::Failure(e)) => Err(e.to_owned_vec()),
Err(_) => Err(PcapError::Incomplete),
}?;
let info = CurrentSectionInfo::default();
// do not consume
Ok(PcapNGReader {
info,
reader,
buffer,
consumed: 0,
reader_exhausted: false,
})
}
}
impl<R> PcapReaderIterator for PcapNGReader<R>
where
R: Read,
{
fn next(&mut self) -> Result<(usize, PcapBlockOwned), PcapError<&[u8]>> {
// Return EOF if
// 1) all bytes have been read
// 2) no more data is available
if self.buffer.available_data() == 0
&& (self.buffer.position() == 0 || self.reader_exhausted)
{
return Err(PcapError::Eof);
}
let data = self.buffer.data();
let parse = if self.info.big_endian {
parse_block_be
} else {
parse_block_le
};
match parse(data) {
Ok((rem, b)) => {
let offset = data.offset(rem);
if let Block::SectionHeader(ref shb) = b {
self.info.big_endian = shb.big_endian();
}
Ok((offset, PcapBlockOwned::from(b)))
}
Err(nom::Err::Error(e)) | Err(nom::Err::Failure(e)) => Err(e),
Err(_) => Err(PcapError::Incomplete),
}
}
fn consume(&mut self, offset: usize) {
self.consumed += offset;
self.buffer.consume(offset);
}
fn consume_noshift(&mut self, offset: usize) {
self.consumed += offset;
self.buffer.consume_noshift(offset);
}
fn consumed(&self) -> usize {
self.consumed
}
fn refill(&mut self) -> Result<(), PcapError<&[u8]>> {
self.buffer.shift();
let space = self.buffer.space();
// check if available space is empty, so we can distinguish
// a read() returning 0 because of EOF or because we requested 0
if space.is_empty() {
return Ok(());
}
let sz = self.reader.read(space).or(Err(PcapError::ReadError))?;
self.reader_exhausted = sz == 0;
self.buffer.fill(sz);
Ok(())
}
fn position(&self) -> usize {
self.buffer.position()
}
fn grow(&mut self, new_size: usize) -> bool {
self.buffer.grow(new_size)
}
fn data(&self) -> &[u8] {
self.buffer.data()
}
fn reader_exhausted(&self) -> bool {
self.reader_exhausted
}
}
#[derive(Default)]
pub struct CurrentSectionInfo {
big_endian: bool,
}
/// Parsing iterator over pcap-ng data (requires data to be loaded into memory)
///
/// ```rust
/// use pcap_parser::*;
/// use std::fs::File;
/// use std::io::Read;
///
/// # let path = "assets/test001-le.pcapng";
/// let mut file = File::open(path).unwrap();
/// let mut buffer = Vec::new();
/// file.read_to_end(&mut buffer).unwrap();
/// let mut num_blocks = 0;
/// let capture = PcapNGSlice::from_slice(&buffer).expect("parse file");
/// for _block in capture {
/// num_blocks += 1;
/// }
pub struct PcapNGSlice<'a> {
info: CurrentSectionInfo,
// remaining (unparsed) data
rem: &'a [u8],
}
impl<'a> PcapNGSlice<'a> {
pub fn from_slice(i: &[u8]) -> Result<PcapNGSlice, nom::Err<PcapError<&[u8]>>> {
// just check that first block is a valid one
let (_rem, _shb) = parse_sectionheaderblock(i)?;
let info = CurrentSectionInfo::default();
let rem = i;
Ok(PcapNGSlice { info, rem })
}
}
/// Iterator for PcapNGSlice. Returns a result so parsing errors are not
/// silently ignored
impl<'a> Iterator for PcapNGSlice<'a> {
type Item = Result<PcapBlockOwned<'a>, nom::Err<PcapError<&'a [u8]>>>;
fn next(&mut self) -> Option<Self::Item> {
if self.rem.is_empty() {
return None;
}
let parse = if self.info.big_endian {
parse_block_be
} else {
parse_block_le
};
let r = parse(self.rem).map(|(rem, b)| {
self.rem = rem;
if let Block::SectionHeader(ref shb) = b {
self.info.big_endian = shb.big_endian();
}
PcapBlockOwned::from(b)
});
Some(r)
}
}
/// Generic interface for PCAPNG file access
pub struct PcapNGCapture<'a> {
pub sections: Vec<Section<'a>>,
}
impl<'a> fmt::Debug for PcapNGCapture<'a> {
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
writeln!(f, "PcapNGCapture:")
}
}
/// Iterator over `PcapNGCapture`
pub struct PcapNGCaptureIterator<'a> {
cap: &'a PcapNGCapture<'a>,
idx: usize,
}
impl<'a> Iterator for PcapNGCaptureIterator<'a> {
type Item = PcapBlock<'a>;
fn next(&mut self) -> Option<PcapBlock<'a>> {
if self.cap.sections.len() != 1 {
// XXX only one section supported
unimplemented!();
}
self.cap.sections[0].blocks.get(self.idx).map(|b| {
self.idx += 1;
PcapBlock::from(b)
})
}
}
impl<'a> PcapNGCapture<'a> {
pub fn from_file(i: &[u8]) -> Result<PcapNGCapture, PcapError<&[u8]>> {
// XXX change return type to just an IResult
match parse_pcapng(i) {
Ok((_, pcap)) => Ok(pcap),
Err(nom::Err::Error(e)) | Err(nom::Err::Failure(e)) => Err(e),
Err(_) => Err(PcapError::Incomplete),
}
}
pub fn iter(&'a self) -> PcapNGCaptureIterator<'a> {
PcapNGCaptureIterator { cap: self, idx: 0 }
}
}
/// Parse the entire file
///
/// Note: this requires the file to be fully loaded to memory.
pub fn parse_pcapng(i: &[u8]) -> IResult<&[u8], PcapNGCapture, PcapError<&[u8]>> {
map(many1(complete(parse_section)), |sections| PcapNGCapture {
sections,
})(i)
}