netbox-ot 0.3.0__tar.gz

netbox_ot-0.3.0/LICENSE

@@ -0,0 +1,178 @@
+
+                                 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
+

netbox_ot-0.3.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: netbox-ot
+Version: 0.3.0
+Summary: IEC 62443 zones, conduits and flows, Purdue levels, an access map and a zone register for NetBox
+Author: Packetflow
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Packetflow-be/netbox-ot
+Project-URL: Documentation, https://github.com/Packetflow-be/netbox-ot/blob/main/docs/README.md
+Project-URL: Discussions, https://github.com/Packetflow-be/netbox-ot/discussions
+Project-URL: Issues, https://github.com/Packetflow-be/netbox-ot/issues
+Project-URL: Changelog, https://github.com/Packetflow-be/netbox-ot/blob/main/CHANGELOG.md
+Keywords: netbox,netbox-plugin,iec62443,ot,ics,scada,purdue,zeek,icsnpp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+<img src="https://raw.githubusercontent.com/Packetflow-be/netbox-ot/main/docs/icon.svg" alt="" width="96" align="right">
+
+# netbox-ot
+
+**An OT asset and security register in NetBox: IEC 62443 zones, conduits and flows, who can reach your PLCs and
+who decided that is allowed.**
+
+*Formerly **netbox-iec62443**: 0.3.0 takes an existing installation over in place, see
+[Upgrading from netbox-iec62443](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/installation.md#from-netbox-iec62443).*
+
+[![PyPI](https://img.shields.io/pypi/v/netbox-ot)](https://pypi.org/project/netbox-ot/)
+[![CI](https://github.com/Packetflow-be/netbox-ot/actions/workflows/ci.yml/badge.svg)](https://github.com/Packetflow-be/netbox-ot/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/netbox-ot)](https://github.com/Packetflow-be/netbox-ot/blob/main/LICENSE)
+
+A NetBox plugin for OT networks. It models **IEC 62443 zones and conduits**, the **flows** that run through
+them, and **Purdue levels** on devices and virtual machines. On top of that it builds an **access map**: every
+known flow into the controller zones, each with an "allowed?" verdict and who decided it.
+
+It is meant for the people who run production networks: plant and maintenance engineers, OT/IT teams and the
+integrators who work for them. Keep zones, conduits and industrial protocols in the same NetBox as the rest of
+your inventory. See at a glance who can reach the PLCs, including supplier remote access over 4G routers,
+TeamViewer, VPN or an MSP's jump host, and decide per flow whether that is allowed. Then hand an auditor the
+zone register.
+
+![The demo plant: the access map, a flow with its verdict and path, a zone with its security levels, and the zone register](https://raw.githubusercontent.com/Packetflow-be/netbox-ot/main/docs/demo.gif)
+
+## Features
+
+- **Zones and conduits** per IEC 62443-3-2: zone types (OT, safety/SIS, DMZ, enterprise, supplier), Purdue
+  levels, SL-T and SL-A vectors over the seven foundational requirements, accountable people, sub-zones, the
+  devices that enforce a conduit, and risk assessments. [Data model](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/data-model.md)
+- **Flows**: what actually runs from one zone into another (protocol, ports, read/write/control/program access,
+  remote access, the path of hops it takes) with a verdict: allowed yes/no/unknown, decided by whom, review
+  and expiry dates.
+- **Access map** per site: the flows into the controller zones, worst first, with what needs attention and a
+  diagram. [Access map](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/access-map.md)
+- **Consistency checks** and a printable **zone register** (CSV, JSON) for the audit, also as an API and a
+  command with an exit code for CI. [Checks and register](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/checks-and-register.md)
+- **Industrial services and fieldbuses**: Modbus, S7comm, PROFINET, EtherNet/IP, OPC UA, DNP3, IEC 61850 and
+  more, linked to NetBox application services. [Industrial systems](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/industrial.md)
+- **Importer** for passive captures: Zeek logs (with or without CISA ICSNPP) or a documented JSON format, with
+  a list of the hosts NetBox does not know yet. [Importer](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/importer.md)
+- **Vendor-neutral firewall rules** from the allowed flows. [Firewall rules](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/firewall-rules.md)
+- **Lifecycle**: end of support per device from netbox-lifecycle (device type and modules), checks for
+  unsupported devices in secure zones, and a firmware version field on devices and modules.
+  [Companion plugins](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/companions.md)
+- REST API, GraphQL, filters, bulk import/edit, change log and permissions like any NetBox object.
+  [API](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/api.md)
+
+## Compatibility
+
+| Plugin | NetBox | Python |
+|---|---|---|
+| 0.3.x (netbox-ot) | 4.7.0 and later 4.7 releases; 4.8 allowed | 3.12, 3.13 |
+| 0.2.x, 0.1.x (as netbox-iec62443) | 4.7.0 and later 4.7 releases; 4.8 allowed | 3.12, 3.13 |
+
+CI runs the full test suite on NetBox 4.7.0, on the newest 4.7 release, and every week on NetBox's
+development branch for the next release, so a NetBox change that breaks the plugin shows up before it ships.
+`max_version` admits 4.8 on the strength of that weekly run; it is lowered again if the next release breaks
+the plugin.
+
+## Dependencies
+
+None: no other NetBox plugins, Python packages, external software or services. The importer reads files that
+other tools wrote; to import from network captures you need [Zeek](https://zeek.org/) (optionally with the
+[CISA ICSNPP](https://github.com/cisagov/ICSNPP) parsers, or [Malcolm](https://github.com/cisagov/Malcolm),
+which bundles both) somewhere, not on the NetBox server.
+
+**Works with** [netbox-lifecycle](https://github.com/DanSheps/netbox-lifecycle) (end of support per device,
+checks for unsupported devices in secure zones) and [netbox-inventory](https://github.com/ArnesSI/netbox-inventory)
+(spares and purchases), tested together in CI; both optional. See
+[Companion plugins](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/companions.md).
+
+## Installation
+
+For a NetBox installed from source in `/opt/netbox`:
+
+```bash
+cd /opt/netbox
+echo "netbox-ot" | sudo tee -a local_requirements.txt
+sudo venv/bin/pip install netbox-ot
+```
+
+Add the plugin to `/opt/netbox/netbox/netbox/configuration.py` (if `PLUGINS` already exists, add it to the
+list):
+
+```python
+PLUGINS = ["netbox_ot"]
+```
+
+Create its tables and restart:
+
+```bash
+sudo venv/bin/python netbox/manage.py migrate
+sudo venv/bin/python netbox/manage.py collectstatic --no-input
+sudo systemctl restart netbox netbox-rq
+```
+
+An *IEC 62443* menu appears. To see it populated within minutes, create the fictional demo plant and open the
+site *IEC 62443 demo plant* (`--delete` removes it again):
+
+```bash
+sudo venv/bin/python netbox/manage.py ot_demo
+```
+
+[netbox-docker](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/installation.md#netbox-docker), the settings, permissions, upgrading and removing are in
+[docs/installation.md](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/installation.md).
+
+## Documentation
+
+The full documentation is in [docs/](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/README.md); release notes are in [CHANGELOG.md](https://github.com/Packetflow-be/netbox-ot/blob/main/CHANGELOG.md).
+
+## Getting help and contributing
+
+- **Questions and how-to**: [GitHub Discussions](https://github.com/Packetflow-be/netbox-ot/discussions).
+- **Bugs and feature requests**: [GitHub issues](https://github.com/Packetflow-be/netbox-ot/issues). Please
+  include the NetBox and plugin versions.
+- **Security issues**: privately, as described in [SECURITY.md](https://github.com/Packetflow-be/netbox-ot/blob/main/SECURITY.md), not in a public issue.
+- **Code, documentation and translations**: see [CONTRIBUTING.md](https://github.com/Packetflow-be/netbox-ot/blob/main/CONTRIBUTING.md).
+
+The plugin is maintained by [Packetflow](https://packetflow.be), a small company in Belgium, and is in alpha:
+the data model may still change, and every breaking change comes with a migration and a **Breaking Changes**
+note in the changelog.
+
+## License
+
+Code: Apache License 2.0, see [LICENSE](https://github.com/Packetflow-be/netbox-ot/blob/main/LICENSE). The icon (`docs/icon.svg`) is licensed under
+[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).

netbox_ot-0.3.0/README.md

@@ -0,0 +1,128 @@
+<img src="https://raw.githubusercontent.com/Packetflow-be/netbox-ot/main/docs/icon.svg" alt="" width="96" align="right">
+
+# netbox-ot
+
+**An OT asset and security register in NetBox: IEC 62443 zones, conduits and flows, who can reach your PLCs and
+who decided that is allowed.**
+
+*Formerly **netbox-iec62443**: 0.3.0 takes an existing installation over in place, see
+[Upgrading from netbox-iec62443](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/installation.md#from-netbox-iec62443).*
+
+[![PyPI](https://img.shields.io/pypi/v/netbox-ot)](https://pypi.org/project/netbox-ot/)
+[![CI](https://github.com/Packetflow-be/netbox-ot/actions/workflows/ci.yml/badge.svg)](https://github.com/Packetflow-be/netbox-ot/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/netbox-ot)](https://github.com/Packetflow-be/netbox-ot/blob/main/LICENSE)
+
+A NetBox plugin for OT networks. It models **IEC 62443 zones and conduits**, the **flows** that run through
+them, and **Purdue levels** on devices and virtual machines. On top of that it builds an **access map**: every
+known flow into the controller zones, each with an "allowed?" verdict and who decided it.
+
+It is meant for the people who run production networks: plant and maintenance engineers, OT/IT teams and the
+integrators who work for them. Keep zones, conduits and industrial protocols in the same NetBox as the rest of
+your inventory. See at a glance who can reach the PLCs, including supplier remote access over 4G routers,
+TeamViewer, VPN or an MSP's jump host, and decide per flow whether that is allowed. Then hand an auditor the
+zone register.
+
+![The demo plant: the access map, a flow with its verdict and path, a zone with its security levels, and the zone register](https://raw.githubusercontent.com/Packetflow-be/netbox-ot/main/docs/demo.gif)
+
+## Features
+
+- **Zones and conduits** per IEC 62443-3-2: zone types (OT, safety/SIS, DMZ, enterprise, supplier), Purdue
+  levels, SL-T and SL-A vectors over the seven foundational requirements, accountable people, sub-zones, the
+  devices that enforce a conduit, and risk assessments. [Data model](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/data-model.md)
+- **Flows**: what actually runs from one zone into another (protocol, ports, read/write/control/program access,
+  remote access, the path of hops it takes) with a verdict: allowed yes/no/unknown, decided by whom, review
+  and expiry dates.
+- **Access map** per site: the flows into the controller zones, worst first, with what needs attention and a
+  diagram. [Access map](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/access-map.md)
+- **Consistency checks** and a printable **zone register** (CSV, JSON) for the audit, also as an API and a
+  command with an exit code for CI. [Checks and register](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/checks-and-register.md)
+- **Industrial services and fieldbuses**: Modbus, S7comm, PROFINET, EtherNet/IP, OPC UA, DNP3, IEC 61850 and
+  more, linked to NetBox application services. [Industrial systems](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/industrial.md)
+- **Importer** for passive captures: Zeek logs (with or without CISA ICSNPP) or a documented JSON format, with
+  a list of the hosts NetBox does not know yet. [Importer](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/importer.md)
+- **Vendor-neutral firewall rules** from the allowed flows. [Firewall rules](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/firewall-rules.md)
+- **Lifecycle**: end of support per device from netbox-lifecycle (device type and modules), checks for
+  unsupported devices in secure zones, and a firmware version field on devices and modules.
+  [Companion plugins](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/companions.md)
+- REST API, GraphQL, filters, bulk import/edit, change log and permissions like any NetBox object.
+  [API](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/api.md)
+
+## Compatibility
+
+| Plugin | NetBox | Python |
+|---|---|---|
+| 0.3.x (netbox-ot) | 4.7.0 and later 4.7 releases; 4.8 allowed | 3.12, 3.13 |
+| 0.2.x, 0.1.x (as netbox-iec62443) | 4.7.0 and later 4.7 releases; 4.8 allowed | 3.12, 3.13 |
+
+CI runs the full test suite on NetBox 4.7.0, on the newest 4.7 release, and every week on NetBox's
+development branch for the next release, so a NetBox change that breaks the plugin shows up before it ships.
+`max_version` admits 4.8 on the strength of that weekly run; it is lowered again if the next release breaks
+the plugin.
+
+## Dependencies
+
+None: no other NetBox plugins, Python packages, external software or services. The importer reads files that
+other tools wrote; to import from network captures you need [Zeek](https://zeek.org/) (optionally with the
+[CISA ICSNPP](https://github.com/cisagov/ICSNPP) parsers, or [Malcolm](https://github.com/cisagov/Malcolm),
+which bundles both) somewhere, not on the NetBox server.
+
+**Works with** [netbox-lifecycle](https://github.com/DanSheps/netbox-lifecycle) (end of support per device,
+checks for unsupported devices in secure zones) and [netbox-inventory](https://github.com/ArnesSI/netbox-inventory)
+(spares and purchases), tested together in CI; both optional. See
+[Companion plugins](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/companions.md).
+
+## Installation
+
+For a NetBox installed from source in `/opt/netbox`:
+
+```bash
+cd /opt/netbox
+echo "netbox-ot" | sudo tee -a local_requirements.txt
+sudo venv/bin/pip install netbox-ot
+```
+
+Add the plugin to `/opt/netbox/netbox/netbox/configuration.py` (if `PLUGINS` already exists, add it to the
+list):
+
+```python
+PLUGINS = ["netbox_ot"]
+```
+
+Create its tables and restart:
+
+```bash
+sudo venv/bin/python netbox/manage.py migrate
+sudo venv/bin/python netbox/manage.py collectstatic --no-input
+sudo systemctl restart netbox netbox-rq
+```
+
+An *IEC 62443* menu appears. To see it populated within minutes, create the fictional demo plant and open the
+site *IEC 62443 demo plant* (`--delete` removes it again):
+
+```bash
+sudo venv/bin/python netbox/manage.py ot_demo
+```
+
+[netbox-docker](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/installation.md#netbox-docker), the settings, permissions, upgrading and removing are in
+[docs/installation.md](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/installation.md).
+
+## Documentation
+
+The full documentation is in [docs/](https://github.com/Packetflow-be/netbox-ot/blob/main/docs/README.md); release notes are in [CHANGELOG.md](https://github.com/Packetflow-be/netbox-ot/blob/main/CHANGELOG.md).
+
+## Getting help and contributing
+
+- **Questions and how-to**: [GitHub Discussions](https://github.com/Packetflow-be/netbox-ot/discussions).
+- **Bugs and feature requests**: [GitHub issues](https://github.com/Packetflow-be/netbox-ot/issues). Please
+  include the NetBox and plugin versions.
+- **Security issues**: privately, as described in [SECURITY.md](https://github.com/Packetflow-be/netbox-ot/blob/main/SECURITY.md), not in a public issue.
+- **Code, documentation and translations**: see [CONTRIBUTING.md](https://github.com/Packetflow-be/netbox-ot/blob/main/CONTRIBUTING.md).
+
+The plugin is maintained by [Packetflow](https://packetflow.be), a small company in Belgium, and is in alpha:
+the data model may still change, and every breaking change comes with a migration and a **Breaking Changes**
+note in the changelog.
+
+## License
+
+Code: Apache License 2.0, see [LICENSE](https://github.com/Packetflow-be/netbox-ot/blob/main/LICENSE). The icon (`docs/icon.svg`) is licensed under
+[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).

netbox_ot-0.3.0/netbox_ot/__init__.py

@@ -0,0 +1,47 @@
+from netbox.plugins import PluginConfig
+
+__version__ = '0.3.0'
+
+
+class NetBoxOTConfig(PluginConfig):
+    name = 'netbox_ot'
+    verbose_name = 'OT'
+    description = (
+        'OT asset and security register: IEC 62443 zones, conduits and flows, Purdue levels, an access map, '
+        'a zone register and lifecycle checks'
+    )
+    version = __version__
+    author = 'Packetflow'
+    base_url = 'ot'
+    # Tested in CI on 4.7.0, the newest 4.7 release and NetBox's development branch for the next release (weekly)
+    min_version = '4.7.0'
+    max_version = '4.8.99'
+    default_settings = {
+        # Create the "Purdue level" custom field on devices and virtual machines after migrate.
+        'create_custom_fields': True,
+        # The access map lists flows into zones at this Purdue level or below.
+        'access_map_max_level': '2',
+        # A flow not seen for this many days needs attention.
+        'stale_after_days': 90,
+    }
+
+    def ready(self):
+        from django.conf import settings
+        from django.core.exceptions import ImproperlyConfigured
+
+        if 'netbox_iec62443' in settings.PLUGINS:
+            # netbox-ot takes the old plugin's tables over on migrate (adopt.py); both at once would break both
+            raise ImproperlyConfigured(
+                'netbox-ot replaces netbox-iec62443: remove netbox_iec62443 from PLUGINS (and its PLUGINS_CONFIG '
+                'entry; move the settings to netbox_ot), then run migrate.'
+            )
+        super().ready()
+        from django.db.models.signals import post_migrate
+
+        from .customfields import ensure_custom_fields
+        from .upgrade import after_upgrade
+        post_migrate.connect(ensure_custom_fields, sender=self)
+        post_migrate.connect(after_upgrade, sender=self)
+
+
+config = NetBoxOTConfig