├── docs ├── ONI-CCLA.docx ├── oni-guy.png ├── oni-logo.png ├── label-repos.bmp ├── oni-guy_big.png ├── label-tracking.bmp ├── oni-approach.png ├── label-discussion.bmp ├── label-issue-type.bmp ├── label-bug-enhancement.bmp └── labels-design-tracking.bmp ├── .gitmodules ├── ISSUES.md ├── README.md └── LICENSE /docs/ONI-CCLA.docx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/ONI-CCLA.docx -------------------------------------------------------------------------------- /docs/oni-guy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/oni-guy.png -------------------------------------------------------------------------------- /docs/oni-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/oni-logo.png -------------------------------------------------------------------------------- /docs/label-repos.bmp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/label-repos.bmp -------------------------------------------------------------------------------- /docs/oni-guy_big.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/oni-guy_big.png -------------------------------------------------------------------------------- /docs/label-tracking.bmp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/label-tracking.bmp -------------------------------------------------------------------------------- /docs/oni-approach.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/oni-approach.png -------------------------------------------------------------------------------- /docs/label-discussion.bmp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/label-discussion.bmp -------------------------------------------------------------------------------- /docs/label-issue-type.bmp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/label-issue-type.bmp -------------------------------------------------------------------------------- /docs/label-bug-enhancement.bmp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/label-bug-enhancement.bmp -------------------------------------------------------------------------------- /docs/labels-design-tracking.bmp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Open-Network-Insight/open-network-insight/HEAD/docs/labels-design-tracking.bmp -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "oni-ingest"] 2 | path = oni-ingest 3 | url = https://github.com/OpenNetworkInsight/oni-ingest 4 | [submodule "oni-setup"] 5 | path = oni-setup 6 | url = https://github.com/OpenNetworkInsight/oni-setup 7 | [submodule "oni-ml"] 8 | path = oni-ml 9 | url = https://github.com/OpenNetworkInsight/oni-ml 10 | [submodule "oni-oa"] 11 | path = oni-oa 12 | url = https://github.com/Open-Network-Insight/oni-oa 13 | [submodule "oni-nfdump"] 14 | path = oni-nfdump 15 | url = https://github.com/Open-Network-Insight/oni-nfdump 16 | -------------------------------------------------------------------------------- /ISSUES.md: -------------------------------------------------------------------------------- 1 | # **How to create an issue for ONI** 2 | 3 | Please help us to improve ONI! Create your issues found following the next steps: 4 | 5 | 6 | ## **Create an Issue** 7 | 8 | To create an issue please go to [ONI Issues](https://github.com/Open-Network-Insight/open-network-insight/issues), 9 | * Review current open issues for any matches. 10 | * If there is a match, please feel free to comment on the issue. 11 | * If you don't find a match, please continue creating your own issue. 12 | 13 | ## **Add issue type label** 14 | 15 | ![Issue type](docs/label-issue-type.bmp) 16 | 17 | * **Bug:** Something that is not working properly according the functional spec. 18 | * **Enhancement:** Add new functionality or improve existing functionality. 19 | * **Discussion:** Open a discussion related to any topic about ONI solution. 20 | 21 | ## **Add repo label** 22 | Once an issue is created, add a repo tag to identify the module that needs to be tracked. 23 | 24 | ![oni repos](docs/label-repos.bmp "ONI Repos") 25 | 26 | # **Context Labels (Added by ONI team)** 27 | 28 | ONI team will add a label that will be used to add context and status of the issue: 29 | 30 | ![oni Bugs/Enhancement](docs/label-tracking.bmp) 31 | 32 | * **Wontfix:** We won't fix this issue, as part of current release or roadmap. It will be a nice-to-have 33 | * **Tracked:** This issue is already part of our backlog and will be planned for future releases. 34 | * **Duplicated:** The issue already exists. 35 | * **Invalid:** Expected ONI functionality based in the functional spec. 36 | * **Help wanted:** More details are required to understand the reported issue. 37 | 38 | ![oni Design](docs/labels-design-tracking.bmp) 39 | 40 | * **Design Review:** After a Design Spec has been submitted, this label will be applied to notify the contributor this design is under review and pending approval. 41 | The Maintainers of ONI recommend submitting a Design Spec prior to coding feature enhancements or major changes to the code base. 42 | * **Code Review**: This label indicates the Design has been approved and we are ready to review a PR related to your Design Spec. 43 | * **Documentation Review**: After the code has been approved, The related documentation will need to be updated and approved. 44 | * **Ready to Merge**: Success! this has been tested and is now ready to be merged pending LGTM from the maintainers. 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # **Open Network Insight** _The business of network security - the "port perspective"_ 2 | 3 | Open Network Insight is open source software for leveraging insights from flow and packet analysis. It helps enterprises and service providers gain insight on their compute environments through transparency of service delivery and identification of potential security threats or attacks happening among resources operating at cloud scale. 4 | 5 | While current threat intelligence tools help, identifying unknown threats and attacks remains a challenge. Open Network Insight provides tools to accelerate companies’ ability to expose suspicious connections and previously unseen attacks using flow and packet analysis technologies. 6 |

7 | 8 | ![oni logo](docs/oni-guy.png "ONI")![](docs/oni-logo.png "ONI") 9 | 10 | ---- 11 | 12 | ## **Overview** 13 | ![oni approach](docs/oni-approach.png "ONI Approach") 14 | 15 | With the arrival of big data platforms, security organizations can now make data-driven decisions about how they protect their assets. Records of network traffic, captured as network flows, are often stored and analyzed for use in network management. An organization can use this same information to gain insight into what channels corporate information flows through. 16 | 17 | By taking into account additional context such as prevalent attacks and key protocols to the organization, the security team can develop a strategy that applies the right amount of per-channel risk mitigation based on the value of the data flowing through it. For an organization, we call this “the port perspective”. 18 | 19 | There are two vectors that all organizations should evaluate: 20 | 21 | * A “wide enough, deep enough” protection strategy that involves both edge prevention and sophisticated detection of unusual behavior 22 | 23 | * A deep inspection of key protocols using methods that can scale to the volume of data flowing across that channel 24 | 25 | While inspecting specific, unique flows of data that may be important for individual organizations, all organizations can realize significant risk reduction from analysis of network flows and DNS (domain name service) replies. 26 | 27 | **Open Network Insight** by leveraging strong technology in both Big Data and Scientific Computing disciplines is a solution intended to support this strategy by focusing on “hard security problems” detecting events such as lateral movement, side-channel data escapes, insider issues, or stealthy behavior in general. 28 | 29 | 30 | ### **Telemetry** 31 | * Flows. 32 | * DNS (pcaps). 33 | * Proxy. 34 | 35 | ### **Parallel Ingest Framework** 36 | * Open source decoders. 37 | * Load data in Hadoop. 38 | * Data transformation. 39 | 40 | 41 | ### **Machine Learning** 42 | * Filter billion of events to a few thousands. 43 | * Unsupervised learning. 44 | 45 | ### **Operational Analytics** 46 | * Visualization. 47 | * Attack heuristics. 48 | * Noise filter. 49 | 50 | ## Try the ONI UI with example data: 51 | 52 | *Running Demo on Docker* 53 | 54 | 1. [Install Docker](https://docs.docker.com/engine/installation/) for your platform 55 | 2. Run the container: `docker run -it -p 8889:8889 opennetworkinsight/oni-demo` 56 | 3. visit [http://localhost:8889/files/ui/flow/suspicious.html#date=2016-07-08](http://localhost:8889/files/ui/proxy/suspicious.html#date=2016-07-08) in your browser to get started 57 | 58 | For the full instructions visit the [opennetworkinsight](https://hub.docker.com/r/opennetworkinsight/oni-demo/) on Docker hub 59 | 60 | *Running the standalone demo* 61 | 62 | pull the code from [oni-demo repo](https://github.com/Open-Network-Insight/oni-demo) and install it yourself 63 | 64 | ## **Getting Started** 65 | 66 | ONI can be installed by following our installation manual. To get started, [check out the installation instructions in the documentation](https://github.com/Open-Network-Insight/open-network-insight/wiki). 67 | 68 | ## If you want all of the ONI code at once, just clone it! 69 | git clone --recursive https://github.com/Open-Network-Insight/open-network-insight.git 70 | 71 | ## **Roadmap** 72 | 73 | TBD 74 | 75 | ## **Documentation (Developer Guide)** 76 | 77 | ONI functionality is divided into different repositories, go to each repository for developer documentation: 78 | 79 | * [oni-ingest](https://github.com/Open-Network-Insight/oni-ingest) 80 | * [oni-ml](https://github.com/Open-Network-Insight/oni-ml) 81 | * [oni-oa](https://github.com/Open-Network-Insight/oni-oa) 82 | * [oni-setup](https://github.com/Open-Network-Insight/oni-setup) 83 | * [oni-nfdump](https://github.com/Open-Network-Insight/oni-nfdump) 84 | * [oni-lda-c](https://github.com/Open-Network-Insight/oni-lda-c) 85 | 86 | ## **Community Support** 87 | 88 | Our Central repository for our Open Network Insight solution is found here. If you find a bug, have question or something to discuss please contact us: 89 | 90 | * [Create an Issue](https://github.com/Open-Network-Insight/open-network-insight/issues). For issue creation guidelines and how to create an issue for ONI please go to: [How to create an Issue](ISSUES.md) 91 | * [Go to our Slack channel](https://opennetworkinsights.slack.com/messages/general/). 92 | 93 | ## **Contributing to ONI** 94 | 95 | Help us improve ONI! 96 | 97 | ONI is Apache 2.0 licensed and accepts contribuitions via GitHub pull requests. Please follow the next steps 98 | and join our comunity. 99 | 100 | ### **Contribuiting to ONI code** 101 | 102 | * Fork the repo of the module that you wish to commit to. 103 | * Create a Branch, we use [topic branches](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#Topic-Branches) for our commits. 104 | * Push your commit(s) to your repository. 105 | * Create a pull request to the original repo in ONI organization. 106 | * Sign [Contributor License Agreement](docs/ONI-CCLA.docx) and send it to *info@open-network-insight.org* 107 | 108 | ### **Commit Guidelines** 109 | 110 | * Bug fixes should be a single commit. 111 | * Please be clear with the commit messages about what you are fixing or adding to the code base. If you code is addressing an open issue please add the reference to the issue in the comments with: Fix: Issue's URL. 112 | 113 | 114 | ### **Merge approval** 115 | 116 | ONI maintainers use LGTM (Looks Good to Me) in a comments on the code review to indicate acceptance, 117 | at least 3 "LGTM" from maintainers are required to approve the merge. If you have any question or concern please feel free to add a comment in your pull request or branch and tag any of the maintainers. 118 | 119 | 120 | ## **Licensing** 121 | 122 | ONI is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text. 123 | 124 | * oni-nfdump [License](https://github.com/Open-Network-Insight/oni-nfdump/blob/master/BSD-license.txt) 125 | * oni-lda-c [License](https://github.com/Open-Network-Insight/oni-lda-c/blob/1.0.1/license.txt) 126 | 127 | ## **Maintainers** 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 |
@EverLoSa@EverLoSa@ledalima@ledalima@rabarona@rabarona@daortizh@daortizh
@natedogs911@natedogs911@NathanSegerlind @NathanSegerlind@moy8011@moy8011
142 | 143 | 144 | ## Thanks 145 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------