diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d46a9ea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Thanks for adding to the Monad Community repo. This guide covers contributing +**scripts** (the `scripts/` directory); for blog assets, just add files under +`blog/`. + +## Adding a script + +Every script lives in its own directory under `scripts//` and ships with a +`README.md` documenting **how to use it and its limitations**. A script without +that documentation will not be merged. + +1. **Scaffold from the template:** + ```bash + cp -r scripts/_template scripts/ + ``` + Use a short, descriptive `kebab-case` slug (e.g. `tls-cert-to-syslog-input`). + +2. **Add your script** to that directory (`.sh`, `.py`, etc.). Keep it + self-contained; put sample inputs/outputs under an `examples/` subfolder. + +3. **Fill in `scripts//README.md`** — every section of the template, + especially **Limitations & caveats**. Be honest about what the script does + *not* do, what permissions it needs, and any edge cases. + +4. **Register it** in the catalog table in [`scripts/README.md`](scripts/README.md) + (one row: script, purpose, language, Monad API surface, category, link). + +5. **Open a PR.** See the checklist below. + +## Conventions + +- **Secrets never get committed.** Read credentials from an environment variable + (e.g. `MONAD_API_KEY`), a secrets manager, or an interactive prompt — never a + literal in the script or examples. Keep API keys out of the process list where + practical (e.g. pass headers to `curl` via `--config`, not the command line). +- **Be portable and dependency-light.** Note the interpreter and required tools + (and versions) in the README. For Bash, target `bash` 3.2 (macOS default) where + feasible. +- **Offer a dry run** for anything that writes/changes Monad state, so users can + preview before committing. +- **Document the Monad API surface** the script touches (endpoints, MCP tools, or + connectors) and the API-key permissions required. +- **Commits** follow [Conventional Commits](https://www.conventionalcommits.org/): + `feat(scripts): add `, `fix(scripts): …`, `docs(scripts): …`. Branch names + mirror the type: `feat/`, `fix/`. + +## PR checklist + +- [ ] Script lives in `scripts//` with a populated `README.md`. +- [ ] **Limitations & caveats** section is filled in (not left as a placeholder). +- [ ] No secrets committed; credentials sourced from env/secret manager/prompt. +- [ ] Usage examples included; a dry-run path exists for state-changing scripts. +- [ ] Added a row to `scripts/README.md`. +- [ ] Conventional Commit message and matching branch name. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b0cd8e3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 2026 Monad, Inc. + + 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. diff --git a/README.md b/README.md index 79ee445..f823de7 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Welcome to the **Monad Community** repo, a central hub for all public-facing tec This repo contains a variety of public assets aimed at enhancing understanding and usability of data engineering concepts for cybersecurity. Key categories include: - **Log Samples**: Real-world before-and-after examples of log transformations, such as flattening, masking, and filtering. -- **Code Snippets**: Ready-to-use scripts and configurations to help you implement and optimize your data pipelines. +- **Code Snippets**: Ready-to-use scripts and configurations to help you implement and optimize your data pipelines. See [`scripts/`](scripts/). - **Transformation Examples**: JSON examples to showcase how data can be cleaned, normalized, and structured for better usability and actionability. - **Technical Assets**: Additional technical resources relevant to Monad’s security data platform and ecosystem. @@ -21,13 +21,26 @@ This repo contains a variety of public assets aimed at enhancing understanding a 2. **Download or Clone**: - Clone the repository locally using: ```bash - git clone https://github.com/monad-community/monad-community.git + git clone https://github.com/monad-inc/community.git ``` - Or download the specific files you’re interested in. 3. **Learn and Experiment**: Use the provided examples to improve your workflows, whether it’s optimizing log transformations, implementing cost-efficient data routing, or enhancing alert prioritization. --- +## 🧰 Scripts + +Utility scripts that interact with Monad (REST API, MCP tools, or connectors) +live under [`scripts/`](scripts/). Each script has its own directory with a +`README.md` documenting its usage and limitations, and the catalog in +[`scripts/README.md`](scripts/README.md) lists what's available. + +To add one, see [`CONTRIBUTING.md`](CONTRIBUTING.md) — copy `scripts/_template/`, +fill in the README (including its **Limitations** section), and register it in the +catalog. + +--- + ## 🚀 How This Can Help You The assets provided in this repository are tailored to support security teams in: diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..c8a01bb --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,39 @@ +# Scripts + +Utility scripts that interact with Monad (its REST API, MCP tools, or +connectors). Each script lives in its own directory with a `README.md` covering +its usage and limitations. + +## Catalog + +| Script | Purpose | Language | Monad API surface | Category | Docs | +|---|---|---|---|---|---| +| [`tls-cert-to-syslog-input`](tls-cert-to-syslog-input/) | Register device TLS-certificate SHA-256 fingerprints on a pipeline's Syslog input so SNI-less sources route correctly | Bash | `GET /v1/organizations`, `GET /v2/{org}/pipelines/{id}`, `GET /v1/{org}/inputs/{id}`, `PATCH /v2/{org}/inputs/{id}` | Inputs / routing | [README](tls-cert-to-syslog-input/README.md) | + +## Layout + +``` +scripts/ +├── README.md # this catalog +├── _template/ # copy this to start a new script +│ ├── README.md # per-script doc template (fill every section) +│ └── script.sh # script header/convention stub +└── / # one directory per script + ├── README.md # required: usage + limitations + ├──