Struct aya::programs::SkSkb

pub struct SkSkb { /* private fields */ }

A program used to intercept ingress socket buffers.

SkSkb programs are attached to socket maps, and can be used to inspect, redirect or filter incoming packet. See also SockMap and SockHash.

Minimum kernel version

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

Examples

use std::convert::{TryFrom, TryInto};
use aya::maps::SockMap;
use aya::programs::SkSkb;

let intercept_ingress = SockMap::try_from(bpf.map_mut("INTERCEPT_INGRESS")?)?;
let prog: &mut SkSkb = bpf.program_mut("intercept_ingress_packet").unwrap().try_into()?;
prog.load()?;
prog.attach(&intercept_ingress)?;

Implementations

impl SkSkb

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

Loads the program inside the kernel.

pub fn attach(
    &mut self,
    map: &dyn SocketMap
) -> Result<SkSkbLinkId, ProgramError>

Attaches the program to the given socket map.

The returned value can be used to detach, see SkSkb::detach.

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

Detaches the program.

See SkSkb::attach.

pub fn take_link(
    &mut self,
    link_id: SkSkbLinkId
) -> Result<OwnedLink<SkSkbLink>, 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 SkSkb

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 SkSkb

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

Formats the value using the given formatter.

impl ProgramFd for SkSkb

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

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

impl ProgramFd for &mut SkSkb

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 SkSkb

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.