Struct aya::programs::SocketFilter

pub struct SocketFilter { /* private fields */ }

A program used to inspect and filter incoming packets on a socket.

SocketFilter programs are attached on sockets and can be used to inspect and filter incoming packets.

Minimum kernel version

The minimum kernel version required to use this feature is 4.0.

Examples

use std::convert::TryInto;
use std::net::TcpStream;
use std::os::unix::io::AsRawFd;
use aya::programs::SocketFilter;

let mut client = TcpStream::connect("127.0.0.1:1234")?;
let prog: &mut SocketFilter = bpf.program_mut("filter_packets").unwrap().try_into()?;
prog.load()?;
prog.attach(client.as_raw_fd())?;

Implementations

impl SocketFilter

pub fn load(&mut self) -> Result<(), ProgramError>

Loads the program inside the kernel.

pub fn attach<T: AsRawFd>(
    &mut self,
    socket: T
) -> Result<SocketFilterLinkId, ProgramError>

Attaches the filter on the given socket.

The returned value can be used to detach from the socket, see SocketFilter::detach.

pub fn detach(
    &mut self,
    link_id: SocketFilterLinkId
) -> Result<(), ProgramError>

Detaches the program.

See SocketFilter::attach.

pub fn take_link(
    &mut self,
    link_id: SocketFilterLinkId
) -> Result<OwnedLink<SocketFilterLink>, ProgramError>

Takes ownership of the link referenced by the provided link_id.

The link will be detached on Drop and the caller is now responsible for managing its lifetime.

impl SocketFilter

pub fn unload(&mut self) -> Result<(), ProgramError>

Unloads the program from the kernel.

Links will be detached before unloading the program. Note that owned links obtained using take_link() will not be detached.

Trait Implementations

impl Debug for SocketFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ProgramFd for SocketFilter

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl ProgramFd for &mut SocketFilter

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl<'a> TryFrom<&'a Program> for &'a SocketFilter

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(program: &'a Program) -> Result<&'a SocketFilter, ProgramError>

Performs the conversion.

impl<'a> TryFrom<&'a mut Program> for &'a mut SocketFilter

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(
    program: &'a mut Program
) -> Result<&'a mut SocketFilter, ProgramError>

Performs the conversion.