initial commit with setup

.gitignore

+/target

Cargo.lock

+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
+[[package]]
+name = "tenjin"
+version = "0.1.0"
+dependencies = [
+ "byteorder",
+]

Cargo.toml

+[package]
+name = "tenjin"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+name = "tenjin"
+path = "src/lib.rs"
+
+[[bin]]
+name = "tenjin"
+path = "src/main.rs"
+
+[dependencies]
+byteorder = "1.0.0"
\ No newline at end of file

LICENSE

+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

+# Tenjin SDN 
+
+## Goals
+
+To understand  The software-defined networking well, I trying to create a simple SDN with Rust language  to support Openflow 1.0 first and 1.3 later.
+
+## TODOs
+
+- [ ] design structure of code and working.
+- [ ] write more description in README.
\ No newline at end of file

src/lib.rs

+pub mod openflow;
\ No newline at end of file

src/main.rs

+use tenjin::openflow::{Controller, Msg, OfpHeader};
+use std::io::Read;
+use std::net::TcpListener;
+
+extern crate byteorder;
+
+fn main() -> Result<(), std::io::Error> {
+    let controller = Controller::new(Controller::OFP_1_0);
+
+    let listener = TcpListener::bind(("127.0.0.1", 6633)).unwrap();
+    let mut buf = vec![0u8; 8];
+    for stream in listener.incoming() {
+        println!("{:?}", stream);
+        match stream {
+            Ok(mut stream) => {
+                // std::thread::spawn(move || {
+                println!("=================== connection =======================");
+
+                // after tcp is connected, it will send hello message
+                controller.hello(&mut stream);
+
+                // loop for receive data
+                loop {
+                    // first receive with Openflow header 64 bit to buf
+                    match stream.read(&mut buf) {
+                        Ok(v) if v > 0 => {
+                            let packet = OfpHeader::parse(&buf);
+                            // length_payload is var to receive payload if the packet has
+                            // and assign size by length
+                            let length_payload = packet.size();
+                            let mut payload = vec![0u8; length_payload];
+                            stream.read(&mut payload)?;
+                            let message = Msg::parse(packet.message, &payload);
+
+                            match message {
+                                // 0 is Hello message
+                                Msg::Hello => {
+                                    // after get Hello, send fetureReq
+                                    controller.feture_req(packet.xid, &mut stream);
+                                    println!("Hello event");
+                                }
+                                Msg::PacketIn(b) => {
+                                    println!("PacketIn event");
+                                }
+                                _ => {
+                                    println!("others message");
+                                }
+                            }
+                        }
+                        Ok(_) | Err(_) => break,
+                    }
+                }
+                println!("======================================================");
+
+                // });
+            }
+            Err(_) => {
+                // connection failed
+                panic!("Connection failed")
+            }
+        }
+    }
+    Ok(())
+}

src/openflow/controller.rs

+use std::{io::Write, mem::size_of, net::TcpStream};
+
+use byteorder::{BigEndian, WriteBytesExt};
+
+use super::OfpHeader;
+
+pub struct Controller {
+    version: u8,
+}
+
+impl Controller {
+    pub const OFP_1_0: u8 = 1;
+    pub fn new(version: u8) -> Self {
+        Self { version }
+    }
+    pub fn hello(&self, stream: &mut TcpStream) {
+        let header = OfpHeader::new(self.version, 0, size_of::<OfpHeader>() as u16, 0);
+        let mut bytes: Vec<u8> = Vec::new();
+        header.marshal(&mut bytes);
+        stream.write_all(&bytes).unwrap();
+    }
+
+    pub fn feture_req(&self, xid: u32, stream: &mut TcpStream) {
+        let header = OfpHeader::new(self.version, 5, 8, xid);
+        let mut bytes: Vec<u8> = Vec::new();
+        header.marshal(&mut bytes);
+        stream.write_all(&bytes).unwrap();
+    }
+
+    pub fn send(&self, xid: u32, message: u8, payload: &Vec<u8>, stream: &mut TcpStream) {
+        let length = size_of::<OfpHeader>() + payload.len();
+        let header = OfpHeader::new(self.version, message, length as u16, xid);
+        let mut bytes: Vec<u8> = Vec::new();
+
+        header.marshal(&mut bytes);
+
+        stream.write_all(&bytes).unwrap();
+    }
+}

src/openflow/header.rs

+use std::{io::Cursor, mem::size_of};
+
+use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};
+
+pub struct OfpHeader {
+    pub version: u8,
+    pub message: u8,
+    pub length: u16,
+    pub xid: u32,
+}
+
+impl OfpHeader {
+    pub fn size(&self) -> usize {
+        return self.length as usize - size_of::<OfpHeader>();
+    }
+    pub fn new(version: u8, message: u8, length: u16, xid: u32) -> Self {
+        Self {
+            version,
+            message,
+            length,
+            xid,
+        }
+    }
+    pub fn parse(buf: &Vec<u8>) -> Self {
+        let mut buf_cursor = Cursor::new(buf);
+        // split data from header
+        let version = buf_cursor.read_u8().unwrap();
+        let message = buf_cursor.read_u8().unwrap();
+        // size is size of packet
+        let length = buf_cursor.read_u16::<BigEndian>().unwrap();
+        let xid = buf_cursor.read_u32::<BigEndian>().unwrap();
+        Self {
+            version,
+            message,
+            length,
+            xid,
+        }
+    }
+    pub fn marshal(&self, bytes: &mut Vec<u8>) {
+        bytes.write_u8(self.version).unwrap();
+        bytes.write_u8(self.message).unwrap();
+        bytes.write_u16::<BigEndian>(self.length).unwrap();
+        bytes.write_u32::<BigEndian>(self.xid).unwrap();
+    }
+}

src/openflow/message.rs

+pub enum Msg {
+    Hello,
+    PacketIn(Vec<u8>),
+    NotFound,
+}
+
+impl Msg {
+    pub fn parse(message_code: u8, payload: &Vec<u8>) -> Self {
+        match message_code {
+            0 => Msg::Hello,
+            8 => Msg::PacketIn(payload.clone()),
+            _ => Msg::NotFound,
+        }
+    }
+}

src/openflow/mod.rs

+pub mod header;
+pub use header::OfpHeader;
+
+pub mod message;
+pub use message::Msg;
+
+pub mod controller;
+pub use controller::Controller;