qubes-mirage-firewall/router.mli

(* Copyright (C) 2015, Thomas Leonard <thomas.leonard@unikernel.com>
   See the README file for details. *)

(** Routing packets to the right network interface. *)

open Utils

type t
(** A routing table. *)

val create :
  client_eth:Client_eth.t ->
  default_gateway:interface ->
  t
(** [create ~client_eth ~default_gateway] is a new routing table that routes packets outside
    of [client_eth] to [default_gateway]. *)

val client_eth : t -> Client_eth.t

val target : t -> Cstruct.t -> interface option
(** [target t packet] is the interface to which [packet] (an IP packet) should be routed. *)

val add_client : t -> client_link -> unit
(** [add_client t iface] adds a rule for routing packets addressed to [iface].
    The client's IP address must be within the [client_eth] passed to [create]. *)

val remove_client : t -> client_link -> unit

val forward_ipv4 : t -> Cstruct.t -> unit Lwt.t
(** [forward_ipv4 t packet] sends the packet to [target t packet]. *)