aboutsummaryrefslogtreecommitdiffstats
path: root/src/wireguard/mod.rs
diff options
context:
space:
mode:
authorMathias Hall-Andersen <mathias@hall-andersen.dk>2019-12-21 00:17:31 +0100
committerMathias Hall-Andersen <mathias@hall-andersen.dk>2019-12-21 00:17:31 +0100
commitaabefa50436af8d614520bb219d675953eeba6eb (patch)
tree9186ef07b94f12e75040d5163477ef1e549cee14 /src/wireguard/mod.rs
parentConstant renamed to be consistent with kernel WG (diff)
downloadwireguard-rs-aabefa50436af8d614520bb219d675953eeba6eb.tar.xz
wireguard-rs-aabefa50436af8d614520bb219d675953eeba6eb.zip
Remove unused test code.
- make naming consistent with the kernel module. - better distribution of functionality from src/wireguard.rs - more consistent "import pattern" throughout the project. - remove unused test code.
Diffstat (limited to 'src/wireguard/mod.rs')
-rw-r--r--src/wireguard/mod.rs19
1 files changed, 15 insertions, 4 deletions
diff --git a/src/wireguard/mod.rs b/src/wireguard/mod.rs
index ac7d9be..5310e96 100644
--- a/src/wireguard/mod.rs
+++ b/src/wireguard/mod.rs
@@ -1,17 +1,29 @@
+/* The wireguard sub-module represents a full, pure, WireGuard implementation:
+ *
+ * The WireGuard device described here does not depend on particular IO implementations
+ * or UAPI, and can be instantiated in unit-tests with the dummy IO implementation.
+ *
+ * The code at this level serves to "glue" the handshake state-machine
+ * and the crypto-key router code together,
+ * e.g. every WireGuard peer consists of a handshake and router peer.
+ */
mod constants;
-mod timers;
-mod wireguard;
-
mod handshake;
mod peer;
mod queue;
mod router;
+mod timers;
mod types;
+mod wireguard;
+mod workers;
#[cfg(test)]
mod tests;
+// represents a peer
pub use peer::Peer;
+
+// represents a WireGuard interface
pub use wireguard::Wireguard;
#[cfg(test)]
@@ -21,5 +33,4 @@ pub use types::dummy_keypair;
use super::platform::dummy;
use super::platform::{tun, udp, Endpoint};
-use peer::PeerInner;
use types::KeyPair;