├── .github └── workflows │ └── git_sync.yaml ├── LICENSE ├── README.rst ├── cortex.bat ├── cortex.command ├── cortex.sh ├── data ├── blogs │ └── using-csvtool │ │ ├── ingest.csv │ │ └── ingest.storm └── storm │ └── helloworld.storm └── docker-compose.yml /.github/workflows/git_sync.yaml: -------------------------------------------------------------------------------- 1 | name: GitSync 2 | 3 | on: 4 | - push 5 | - delete 6 | 7 | jobs: 8 | sync: 9 | runs-on: ubuntu-latest 10 | name: Git Repo Sync 11 | steps: 12 | - uses: actions/checkout@v2 13 | with: 14 | fetch-depth: 0 15 | - uses: vertexproject/git-repo-sync@v0.1.0 16 | with: 17 | target-url: https://${{ secrets.SYNC_TARGET_HOST }}/${{ github.repository }}.git 18 | target-username: ${{ secrets.SYNC_TARGET_USERNAME }} 19 | target-token: ${{ secrets.SYNC_TARGET_TOKEN }} -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Synapse Quickstart 2 | ################## 3 | 4 | Get started using Synapse Open-Source to start a `Cortex`_ and try it out! 5 | 6 | Installing Docker 7 | ================= 8 | 9 | To run the Docker containers included with this Quickstart, you will need to 10 | make sure you have installed Docker Desktop. Follow the instructions at `Get Docker`_ 11 | before trying to execute any of the following commands. 12 | 13 | Installing Synapse 14 | ================== 15 | 16 | Download the Quickstart ZIP file from `the github repo`_ and unzip it to your 17 | host filesystem. 18 | 19 | Starting a Cortex 20 | ================= 21 | 22 | **Windows** 23 | 24 | Double-click ``cortex.bat`` from your file explorer to initialize the Cortex and 25 | start up a shell that you can use to execute commands. 26 | 27 | **MacOS (Intel Chip or Apple Chip)** 28 | 29 | Double-click ``cortex.command`` from your file explorer to initialize the Cortex and 30 | start up a shell that you can use to execute commands. 31 | 32 | **Linux** 33 | 34 | Execute ``cortex.sh`` from your terminal to initialize the Cortex and start up 35 | a shell that you can use to execute commands. 36 | 37 | Check Your Work 38 | --------------- 39 | 40 | To make sure your ``Cortex`` is running, lets run the ``Storm`` CLI, manually 41 | add a node, and quit. 42 | 43 | Execute the storm CLI from the linux root shell:: 44 | 45 | root@77c281dcf338:/# python -m synapse.tools.storm cell:///vertex/storage 46 | 47 | Welcome to the Storm interpreter! 48 | 49 | Local interpreter (non-storm) commands may be executed with a ! prefix: 50 | Use !quit to exit. 51 | Use !help to see local interpreter commands. 52 | 53 | storm> 54 | 55 | Manually add an ``inet:user`` node:: 56 | 57 | storm> [ inet:user=visi ] 58 | .. 59 | inet:user=visi 60 | .created = 2021/08/25 15:06:29.227 61 | complete. 1 nodes in 22 ms (45/sec). 62 | storm> 63 | 64 | Quit the storm CLI:: 65 | 66 | storm> !quit 67 | o/ 68 | root@77c281dcf338:/# 69 | 70 | Using Synapse Tools 71 | =================== 72 | 73 | Once you have your Cortex started, you should be able to execute Synapse `Tools`_, such as ``storm`` or ``csvtool`` from the shell prompt. :: 74 | 75 | python -m synapse.tools.storm cell:///vertex/storage 76 | 77 | Any files present in the ``data`` directory will be mapped into the folder 78 | ``/data/`` within the shell and running Docker container. This will allow you 79 | to edit Storm scripts, import csv files, and have an easy way to map files from 80 | your host into the Docker container. 81 | 82 | Examples from our Blog 83 | ====================== 84 | 85 | Using Csvtool to Ingest Data 86 | ---------------------------- 87 | 88 | In `using csvtool`_, we demonstrate using ``csvtool`` to import and export data from a Cortex. The examples used in the Vertex Project blog shared here have been included in the ``/data/blogs/using-csvtool`` folder mapped into the running Docker container. 89 | 90 | :: 91 | 92 | cd /data/blogs/using-csvtool 93 | python -m synapse.tools.csvtool --csv-header --cortex cell:///vertex/storage ingest.storm ingest.csv 94 | 95 | Test your ingest 96 | ---------------- 97 | 98 | From the ``Storm`` CLI, you can now query the data to make sure the nodes were created. 99 | 100 | **Example #1** 101 | 102 | Use the following storm command to display the newly added ``inet:dns:a`` records:: 103 | 104 | storm> inet:dns:a 105 | 106 | Here's what you should see as a result:: 107 | 108 | inet:dns:a=('bbc-news.org', '207.180.214.158') 109 | .created = 2021/08/24 11:54:33.958 110 | .seen = ('2019/04/15 07:16:09.364', '2019/04/24 07:31:37.271') 111 | :fqdn = bbc-news.org 112 | :ipv4 = 207.180.214.158 113 | inet:dns:a=('theguardiannews.org', '12.131.129.89') 114 | .created = 2021/08/24 11:54:33.941 115 | .seen = ('2016/09/20 13:10:12.000', '2016/09/20 13:10:12.001') 116 | :fqdn = theguardiannews.org 117 | :ipv4 = 12.131.129.89 118 | inet:dns:a=('theguardiannews.org', '32.210.118.89') 119 | .created = 2021/08/24 11:54:33.954 120 | .seen = ('2015/12/17 00:00:00.000', '2015/12/17 18:17:55.000') 121 | :fqdn = theguardiannews.org 122 | :ipv4 = 32.210.118.89 123 | inet:dns:a=('bbc-news.org', '192.64.119.28') 124 | .created = 2021/08/24 11:54:33.960 125 | .seen = ('2019/04/18 19:04:01.000', '2019/04/19 07:31:27.360') 126 | :fqdn = bbc-news.org 127 | :ipv4 = 192.64.119.28 128 | inet:dns:a=('theguardiannews.org', '5.135.183.154') 129 | .created = 2021/08/24 11:54:33.951 130 | .seen = ('2015/12/11 10:57:12.000', '2015/12/14 10:59:15.000') 131 | :fqdn = theguardiannews.org 132 | :ipv4 = 5.135.183.154 133 | inet:dns:a=('bbc-news.org', '217.160.182.197') 134 | .created = 2021/08/24 11:54:33.961 135 | .seen = ('2015/05/03 10:31:14.000', '2015/05/03 10:31:14.001') 136 | :fqdn = bbc-news.org 137 | :ipv4 = 217.160.182.197 138 | inet:dns:a=('theguardiannews.org', '31.210.118.89') 139 | .created = 2021/08/24 11:54:33.953 140 | .seen = ('2015/12/18 09:25:42.000', '2016/12/09 10:59:08.000') 141 | :fqdn = theguardiannews.org 142 | :ipv4 = 31.210.118.89 143 | inet:dns:a=('nato-news.com', '185.82.202.174') 144 | .created = 2021/08/24 11:54:33.955 145 | .seen = ('2015/10/10 00:00:00.000', '2016/09/28 05:30:53.000') 146 | :fqdn = nato-news.com 147 | :ipv4 = 185.82.202.174 148 | complete. 8 nodes in 9 ms (888/sec). 149 | 150 | .. _Cortex: https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#cortex 151 | .. _the github repo: https://github.com/vertexproject/synapse-quickstart/archive/refs/heads/main.zip 152 | .. _Get Docker: https://docs.docker.com/get-docker/ 153 | .. _Tools: https://synapse.docs.vertex.link/en/latest/synapse/userguides/index_tools.html#tools 154 | .. _using csvtool: https://vertex.link/blogs/using-csvtool/ 155 | -------------------------------------------------------------------------------- /cortex.bat: -------------------------------------------------------------------------------- 1 | docker volume create --name=cortex00 2 | docker-compose pull 3 | docker-compose down 4 | docker-compose up -d 5 | docker-compose exec cortex /bin/bash 6 | -------------------------------------------------------------------------------- /cortex.command: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | cd "$(dirname "$0")" 3 | docker volume create --name=cortex00 4 | docker-compose pull 5 | docker-compose down 6 | docker-compose up -d 7 | docker-compose exec cortex /bin/bash 8 | -------------------------------------------------------------------------------- /cortex.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | cd "$(dirname "$0")" 3 | docker volume create --name=cortex00 4 | docker-compose pull 5 | docker-compose down 6 | docker-compose up -d 7 | docker-compose exec cortex /bin/bash 8 | -------------------------------------------------------------------------------- /data/blogs/using-csvtool/ingest.csv: -------------------------------------------------------------------------------- 1 | fqdn,ip,first-seen,last-seen 2 | theguardiannews.org,12.131.129.89,2016/09/20 13:10:12.000,2016/09/20 13:10:12.001 3 | theguardiannews.org,5.135.183.154,2015/12/11 10:57:12.000,2015/12/14 10:59:15.000 4 | theguardiannews.org,31.210.118.89,2015/12/18 09:25:42.000,2016/12/09 10:59:08.000 5 | theguardiannews.org,32.210.118.89,2015/12/17 00:00:00.000,2015/12/17 18:17:55.000 6 | nato-news.com,185.82.202.174,2015/10/10 00:00:00.000,2016/09/28 05:30:53.000 7 | bbc-news.org,207.180.214.158,2019/04/15 07:16:09.364,2019/04/24 07:31:37.271 8 | bbc-news.org,192.64.119.28,2019/04/18 19:04:01.000,2019/04/19 07:31:27.360 9 | bbc-news.org,217.160.182.197,2015/05/03 10:31:14.000,2015/05/03 10:31:14.001 10 | -------------------------------------------------------------------------------- /data/blogs/using-csvtool/ingest.storm: -------------------------------------------------------------------------------- 1 | // Loop over the $rows which are provided by csvtool 2 | for ($fqdn, $ipv4, $first, $last) in $rows { 3 | // Add an inet:dns:a node and update its .seen time window 4 | [ inet:dns:a = ( $fqdn, $ipv4 ) .seen=( $first, $last ) ] 5 | } 6 | -------------------------------------------------------------------------------- /data/storm/helloworld.storm: -------------------------------------------------------------------------------- 1 | $lib.print("hello world") 2 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | cortex: 4 | image: vertexproject/synapse-cortex:v2.x.x 5 | container_name: cortex00 6 | volumes: 7 | # Map in a persistent storage directory 8 | - cortex00:/vertex/storage 9 | - ./data:/data 10 | volumes: 11 | cortex00: 12 | external: true 13 | --------------------------------------------------------------------------------