From aa25a97f36c621ed6e64a0131f3cadc6aa0d0b2b Mon Sep 17 00:00:00 2001 From: Zeke Medley Date: Wed, 3 Jul 2019 11:40:34 -0700 Subject: [PATCH 1/6] Update README. --- README | 36 ------------------------------------ README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 1 - 3 files changed, 53 insertions(+), 37 deletions(-) delete mode 100644 README create mode 100644 README.md delete mode 120000 README.rst diff --git a/README b/README deleted file mode 100644 index 2c71e11c0b..0000000000 --- a/README +++ /dev/null @@ -1,36 +0,0 @@ -============================= -Zeek Network Security Monitor -============================= - -Zeek is a powerful framework for network analysis and security -monitoring. - -(Zeek is the new name for the long-established Bro system. Note that -parts of the system retain the "Bro" name, and it also often appears in -the documentation and distributions.) - -Please see the INSTALL file for installation instructions and pointers -for getting started. NEWS contains release notes for the current -version, and CHANGES has the complete history of changes. Please see -COPYING for licensing information. - -You can download source and binary releases on: - - https://www.zeek.org/download - -To get the current development version, clone our master git -repository: - - git clone --recursive https://github.com/zeek/zeek - -For more documentation, research publications, and community contact -information, please see the home page: - - https://www.zeek.org - -On behalf of the Zeek Development Team, - -Vern Paxson & Robin Sommer, -International Computer Science Institute & -Lawrence Berkeley National Laboratory -vern@icir.org / robin@icir.org diff --git a/README.md b/README.md new file mode 100644 index 0000000000..8b359547a6 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +

+
+ + The Zeek Logo + +

+ The Zeek Network Security Monitor +
+

+

A powerful framework for network analysis and security monitoring.

+

+ Key Features - + Documentation - + Getting Started - + Development - + License +

+ +## Key Features + +* Adaptable and Flexible + Zeek's domain-specific scripting language enables site-specific monitoring policies and means that it is not restricted to any particular detection approach. + +* In-depth Analysis + Zeek comes with analyzers for many protocols, enabling high-level semantic analysis at the application layer. + +* Efficient + Zeek targets high-performance networks and is used operationally at a variety of large sites. + +* Highly Stateful + Zeek keeps extensive application-layer state about the network it monitors and provides a high-level archive of a network's activity. + +## Getting Started +The best place to find information about getting started with Zeek is our [website](https://www.zeek.org/documentation/index.html). You can find downloads for stable relases, tutorials on getting Zeek set up, and many other useful resources there. You can also find release notes for the current version in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) has the complete history of changes + +To work on the development branch of Zeek, clone the master git repository. + +`git clone --recursive https://github.com/zeek/zeek ` + +Then, with its [dependencies](https://docs.zeek.org/en/stable/install/install.html#prerequisites) installed, build and install. + +`./configure && make && sudo make install` + + +## Development +Zeek was originally developed by Vern Paxson. Robin Sommer now leads the project, jointly with a core team of researchers and developers at the [International Computer Science Institute](http://www.icsi.berkeley.edu) in Berkeley, CA; and the [National Center for Supercomputing Applications](http://www.ncsa.illinois.edu) in Urbana-Champaign, IL. + +Zeek is developed on GitHub and we welcome contributions. Working on an open-source project like Zeek can be an incredibly rewarding experience. We actively collect feature requests and issues on GitHub [here](https://github.com/zeek/zeek/issues). If you're looking for a good first issue you might find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) useful. + +More information on Zeek's development can be found [here](https://www.zeek.org/development/index.html), and information about its community and mailing lists (which are fairly active) can be found [here](https://www.zeek.org/community/index.html). + +## License +Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can read it [here](https://github.com/zeek/zeek/blob/master/COPYING). diff --git a/README.rst b/README.rst deleted file mode 120000 index 100b93820a..0000000000 --- a/README.rst +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file From e9bab80c2a06eca599b3f6e486c3a8b791e712e7 Mon Sep 17 00:00:00 2001 From: Zeke Medley Date: Tue, 9 Jul 2019 11:24:49 -0700 Subject: [PATCH 2/6] Remove development paragraph. --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b359547a6..f515e75e84 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Zeek keeps extensive application-layer state about the network it monitors and provides a high-level archive of a network's activity. ## Getting Started -The best place to find information about getting started with Zeek is our [website](https://www.zeek.org/documentation/index.html). You can find downloads for stable relases, tutorials on getting Zeek set up, and many other useful resources there. You can also find release notes for the current version in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) has the complete history of changes +The best place to find information about getting started with Zeek is our [website](https://www.zeek.org/documentation/index.html). You can find downloads for stable relases, tutorials on getting Zeek set up, and many other useful resources there. You can also find release notes for the current version and a complete history of changes in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) respectvely. To work on the development branch of Zeek, clone the master git repository. @@ -43,11 +43,9 @@ Then, with its [dependencies](https://docs.zeek.org/en/stable/install/install.ht ## Development -Zeek was originally developed by Vern Paxson. Robin Sommer now leads the project, jointly with a core team of researchers and developers at the [International Computer Science Institute](http://www.icsi.berkeley.edu) in Berkeley, CA; and the [National Center for Supercomputing Applications](http://www.ncsa.illinois.edu) in Urbana-Champaign, IL. - Zeek is developed on GitHub and we welcome contributions. Working on an open-source project like Zeek can be an incredibly rewarding experience. We actively collect feature requests and issues on GitHub [here](https://github.com/zeek/zeek/issues). If you're looking for a good first issue you might find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) useful. -More information on Zeek's development can be found [here](https://www.zeek.org/development/index.html), and information about its community and mailing lists (which are fairly active) can be found [here](https://www.zeek.org/community/index.html). +More information on Zeek's development can be found [here](https://www.zeek.org/development/index.html), and information about its community and mailing lists (which are fairly active) can be found [here](https://www.zeek.org/community/index.html). ## License Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can read it [here](https://github.com/zeek/zeek/blob/master/COPYING). From 20e7a1911960a47effc9f1879dd82e2d37fa5a0b Mon Sep 17 00:00:00 2001 From: Zeke Medley Date: Fri, 12 Jul 2019 17:32:11 -0700 Subject: [PATCH 3/6] Tone down HTML and improve development section. --- README | 1 + README.md | 55 ++++++++++++++++++++++++++++++++++++------------------- cmake | 2 +- 3 files changed, 38 insertions(+), 20 deletions(-) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000000..42061c01a1 --- /dev/null +++ b/README @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/README.md b/README.md index f515e75e84..ea7cd17fe7 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@

-
- - The Zeek Logo - -

- The Zeek Network Security Monitor -
-

-

A powerful framework for network analysis and security monitoring.

-

- Key Features - - Documentation - - Getting Started - - Development - - License -

+ +[![Zeek Logo](https://www.zeek.org/images/bro-eyes.png)](https:://www.zeek.org) + +The Zeek Network Security Monitor + +

+ +A [powerful](https://www.zeek.org/why_choose_zeek.pdf) framework for network analysis and security monitoring + +[_Key Features_](#key-features) - +[_Documentation_](https://docs.zeek.org/en/stable/index.html) - +[_Getting Started_](#getting-started) - +[_Development_](#development) - +[_License_](#license) + +

## Key Features @@ -31,19 +31,36 @@ Zeek keeps extensive application-layer state about the network it monitors and provides a high-level archive of a network's activity. ## Getting Started -The best place to find information about getting started with Zeek is our [website](https://www.zeek.org/documentation/index.html). You can find downloads for stable relases, tutorials on getting Zeek set up, and many other useful resources there. You can also find release notes for the current version and a complete history of changes in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) respectvely. +The best place to find information about getting started with Zeek is our [website](https://www.zeek.org/documentation/index.html). You can find downloads for stable releases, tutorials on getting Zeek set up, and many other useful resources there. You can also find release notes for the current version and a complete history of changes in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) respectively. To work on the development branch of Zeek, clone the master git repository. `git clone --recursive https://github.com/zeek/zeek ` -Then, with its [dependencies](https://docs.zeek.org/en/stable/install/install.html#prerequisites) installed, build and install. +With its [dependencies](https://docs.zeek.org/en/stable/install/install.html#prerequisites) installed, build and install. `./configure && make && sudo make install` +Write your first Zeek script. +```zeek +// hello.zeek + +event zeek_init + { + print "Hello World!"; + } +``` +And run it. + +`zeek hello.zeek` + + ## Development -Zeek is developed on GitHub and we welcome contributions. Working on an open-source project like Zeek can be an incredibly rewarding experience. We actively collect feature requests and issues on GitHub [here](https://github.com/zeek/zeek/issues). If you're looking for a good first issue you might find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) useful. +Zeek is developed on GitHub by its community. Today, as a result countless contributions, it is is used operationally around the world by major companies and educational and scientific institutions alike for securing their cyber infrastructure. We welcome contributions. Working on an open source project like Zeek can be an incredibly rewarding experience and, packet by packet, makes the internet a little safer. + +If you're interested in getting involved, we actively collect feature requests and issues on GitHub [here](https://github.com/zeek/zeek/issues) and you might find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) to be a good place to get started. For learning more about the Zeek scripting language, try.zeek.org is a great place to get started. + More information on Zeek's development can be found [here](https://www.zeek.org/development/index.html), and information about its community and mailing lists (which are fairly active) can be found [here](https://www.zeek.org/community/index.html). diff --git a/cmake b/cmake index 58e4eebe3a..7bc1a726cb 160000 --- a/cmake +++ b/cmake @@ -1 +1 @@ -Subproject commit 58e4eebe3aebd0cf608e51046805a9ab1ffa6c1b +Subproject commit 7bc1a726cb294fc016e1286da80013d50ab1ae3f From 684dec945215c00400dfb3e3e0da62b650f5fdd2 Mon Sep 17 00:00:00 2001 From: Zeke Medley Date: Fri, 12 Jul 2019 18:00:58 -0700 Subject: [PATCH 4/6] Improve readability of plaintext. --- README.md | 72 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 52 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index ea7cd17fe7..a3d6966216 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ The Zeek Network Security Monitor

-A [powerful](https://www.zeek.org/why_choose_zeek.pdf) framework for network analysis and security monitoring +A [powerful](https://www.zeek.org/why_choose_zeek.pdf) framework for network +analysis and security monitoring [_Key Features_](#key-features) - [_Documentation_](https://docs.zeek.org/en/stable/index.html) - @@ -16,34 +17,48 @@ A [powerful](https://www.zeek.org/why_choose_zeek.pdf) framework for network ana

-## Key Features +Key Features +-------------- -* Adaptable and Flexible - Zeek's domain-specific scripting language enables site-specific monitoring policies and means that it is not restricted to any particular detection approach. +* __Adaptable and Flexible__ + Zeek's domain-specific scripting language enables site-specific monitoring + policies and means that it is not restricted to any particular detection + approach. -* In-depth Analysis - Zeek comes with analyzers for many protocols, enabling high-level semantic analysis at the application layer. +* __In-depth Analysis__ + Zeek comes with analyzers for many protocols, enabling high-level semantic + analysis at the application layer. -* Efficient - Zeek targets high-performance networks and is used operationally at a variety of large sites. +* __Efficient__ + Zeek targets high-performance networks and is used operationally at a variety + of large sites. -* Highly Stateful - Zeek keeps extensive application-layer state about the network it monitors and provides a high-level archive of a network's activity. +* __Highly Stateful__ + Zeek keeps extensive application-layer state about the network it monitors + and provides a high-level archive of a network's activity. -## Getting Started -The best place to find information about getting started with Zeek is our [website](https://www.zeek.org/documentation/index.html). You can find downloads for stable releases, tutorials on getting Zeek set up, and many other useful resources there. You can also find release notes for the current version and a complete history of changes in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) respectively. +Getting Started +--------------- + +The best place to find information about getting started with Zeek is our +[website](https://www.zeek.org/documentation/index.html). You can find downloads +for stable releases, tutorials on getting Zeek set up, and many other useful +resources there. You can also find release notes for the current version and a +complete history of changes in [NEWS](https://github.com/zeek/zeek/blob/master/NEWS), +and [CHANGES](https://github.com/zeek/zeek/blob/master/CHANGES) respectively. To work on the development branch of Zeek, clone the master git repository. `git clone --recursive https://github.com/zeek/zeek ` -With its [dependencies](https://docs.zeek.org/en/stable/install/install.html#prerequisites) installed, build and install. +With its [dependencies](https://docs.zeek.org/en/stable/install/install.html#prerequisites) +installed, build and install. `./configure && make && sudo make install` Write your first Zeek script. ```zeek -// hello.zeek +# hello.zeek event zeek_init { @@ -56,13 +71,30 @@ And run it. -## Development -Zeek is developed on GitHub by its community. Today, as a result countless contributions, it is is used operationally around the world by major companies and educational and scientific institutions alike for securing their cyber infrastructure. We welcome contributions. Working on an open source project like Zeek can be an incredibly rewarding experience and, packet by packet, makes the internet a little safer. +Development +----------- -If you're interested in getting involved, we actively collect feature requests and issues on GitHub [here](https://github.com/zeek/zeek/issues) and you might find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) to be a good place to get started. For learning more about the Zeek scripting language, try.zeek.org is a great place to get started. +Zeek is developed on GitHub by its community. Today, as a result countless +contributions, it is is used operationally around the world by major companies +and educational and scientific institutions alike for securing their cyber +infrastructure. We welcome contributions. Working on an open source project +like Zeek can be an incredibly rewarding experience and, packet by packet, +makes the internet a little safer. + +If you're interested in getting involved, we actively collect feature requests +and issues on GitHub [here](https://github.com/zeek/zeek/issues) and you might +find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) +to be a good place to get started. For learning more about the Zeek scripting +language, try.zeek.org is a great place to get started. -More information on Zeek's development can be found [here](https://www.zeek.org/development/index.html), and information about its community and mailing lists (which are fairly active) can be found [here](https://www.zeek.org/community/index.html). +More information on Zeek's development can be found +[here](https://www.zeek.org/development/index.html), and information about its +community and mailing lists (which are fairly active) can be found +[here](https://www.zeek.org/community/index.html). -## License -Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can read it [here](https://github.com/zeek/zeek/blob/master/COPYING). +License +----------- + +Zeek comes with a BSD license, allowing for free use with virtually no +restrictions. You can read it [here](https://github.com/zeek/zeek/blob/master/COPYING). From 14bd9ff923319348dfac58e702d0a3106b90a845 Mon Sep 17 00:00:00 2001 From: Zeke Medley Date: Fri, 12 Jul 2019 18:06:53 -0700 Subject: [PATCH 5/6] Fix try.zeek.org link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a3d6966216..0ce684b437 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ If you're interested in getting involved, we actively collect feature requests and issues on GitHub [here](https://github.com/zeek/zeek/issues) and you might find [these](https://github.com/zeek/zeek/issues?q=is%3Aissue+is%3Aopen+label%3A%22Difficulty%3A+Easy%22) to be a good place to get started. For learning more about the Zeek scripting -language, try.zeek.org is a great place to get started. +language, [try.zeek.org](http://try.zeek.org) is a great resource. More information on Zeek's development can be found From e8706a9c9f335ef2c5c7a7c61d62c78ffd5c35e2 Mon Sep 17 00:00:00 2001 From: Zeke Medley Date: Mon, 15 Jul 2019 09:15:29 -0700 Subject: [PATCH 6/6] Add plaintext README file. --- README | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- README.md | 4 +-- 2 files changed, 91 insertions(+), 3 deletions(-) diff --git a/README b/README index 42061c01a1..30491f0e5a 100644 --- a/README +++ b/README @@ -1 +1,89 @@ -README.md \ No newline at end of file +================================= +The Zeek Network Security Monitor +================================= + +Zeek is a powerful framework for network analysis and security +monitoring. + +Key Features +============ + +* **Adaptable & Flexible** + Zeek's domain specific scripting language enables site-specific + monitoring policies and means that it is not restricted to any + particular detection approach. + +* **In-depth Analysis** + Zeek ships with analyzers for many protocols, enabling + high-level semantic analysis at the application layer. + +* **Efficient** + Zeek targets high-performance networks and is used operationally + at a variety of large sites. + +* **Highly Stateful** + Zeek keeps extensive application-layer state about the network + it monitors and provides a high-level archive of a network's + activity. + +Getting Started +=============== + +The best place to find information about getting started with Zeek +is our website [1]. You can find downloads for stable releases, +tutorials on getting Zeek set up, and many other useful resources +there. You can also find release notes for the current version and a +complete history of changes in NEWS, and CHANGES respectively. + +To work on the development branch of Zeek, clone the master git +repository. + +> git clone --recursive https://github.com/zeek/zeek + +With its dependencies [2] installed, build and install. + +> ./configure && make && sudo make install + +Write your first Zeek script. + +``` +# hello.zeek + +event zeek_init + { + print "Hello World!"; + } +``` + +And run it. + +> zeek hello.zeek + +Development +=========== + +Zeek is developed on GitHub by its community. Today, as a result of +countless contributions, it is is used operationally around the world +by major companies and educational and scientific institutions alike +for securing their cyber infrastructure. We welcome contributions. +Working on an open source project like Zeek can be an incredibly +rewarding experience and, packet by packet, makes the internet a +little safer. + +If you're interested in getting involved, we actively collect feature +requests and issues on GitHub. For learning more about the Zeek +scripting language, https://try.zeek.org is a great resource. + +More information on Zeek's development can be found here [3], and +information about its community and mailing lists (which are fairly +active) can be found here [4]. + + + + +[1] https://www.zeek.org +[2] https://docs.zeek.org/en/stable/install/install.html +[3] https://www.zeek.org/development/index.html +[4] https://www.zeek.org/community/index.html + + diff --git a/README.md b/README.md index 0ce684b437..18a12b40ed 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Key Features approach. * __In-depth Analysis__ - Zeek comes with analyzers for many protocols, enabling high-level semantic + Zeek ships with analyzers for many protocols, enabling high-level semantic analysis at the application layer. * __Efficient__ @@ -74,7 +74,7 @@ And run it. Development ----------- -Zeek is developed on GitHub by its community. Today, as a result countless +Zeek is developed on GitHub by its community. Today, as a of result countless contributions, it is is used operationally around the world by major companies and educational and scientific institutions alike for securing their cyber infrastructure. We welcome contributions. Working on an open source project