diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fdd8ef8..a2c845e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,15 +13,27 @@ Describe the FAT/SAT, commissioning, interoperability, troubleshooting, or repos - [ ] `dotnet test .\ProcessBusSuite.sln -c Release --no-build` - [ ] `pwsh .\scripts\repository-health.ps1` - [ ] Runtime smoke test on Windows, when runtime behavior changed -- [ ] Documentation/screenshots updated when user-visible behavior changed +- [ ] Documentation/screenshots updated when user-visible behavior or claims changed +- [ ] Portable package verification completed when packaging or legal content changed -## Safety and evidence +## Product, claim, and evidence boundary - [ ] Receive-only product boundary is preserved - [ ] Timing language matches timestamp-source confidence -- [ ] No customer, site, device, MAC/IP, capture, SCL, or project-sensitive data is included +- [ ] Expected configuration, observed traffic, software interpretation, and external-device behavior remain distinct +- [ ] No claim implies formal conformance, calibration, deterministic timing, functional safety, cybersecurity approval, universal interoperability, switching authority, or IED acceptance proof +- [ ] No customer, employer, station, device, credential, MAC/IP, capture, SCL, or project-sensitive data is included +- [ ] Any fixture or screenshot is synthetic, contributor-owned, or documented as authorized and sanitized +- [ ] No unrelated proprietary code, tests, wording, screenshot, report, asset, or UI design was copied or mechanically translated - [ ] No `bin`, `obj`, `artifacts`, logs, captures, or local settings are committed +## Contribution licensing + +- [ ] I have read and affirmatively accept `CONTRIBUTOR-LICENSE-AGREEMENT.md` +- [ ] I have the legal right and any required employer or organizational authorization to submit this contribution +- [ ] Every commit includes `Signed-off-by: Name ` under the DCO +- [ ] Any third-party material is identified with its license and provenance + ## Compatibility / migration notes -None, or describe them here. +None, or describe them here. \ No newline at end of file diff --git a/.github/workflows/candidate-package.yml b/.github/workflows/candidate-package.yml index 7b53bf4..a6bb8ef 100644 --- a/.github/workflows/candidate-package.yml +++ b/.github/workflows/candidate-package.yml @@ -5,6 +5,13 @@ on: branches: [main] paths: - "Directory.Build.props" + - "LICENSE" + - "NOTICE" + - "COMMERCIAL-LICENSE.md" + - "COPYRIGHT.md" + - "TRADEMARK.md" + - "THIRD_PARTY_NOTICES.md" + - "docs/LICENSING.md" - "src/**" - "tests/**" - "scripts/publish-windows-portable.ps1" @@ -29,7 +36,7 @@ env: jobs: candidate: name: Build verified Windows x64 candidate - if: github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'stabilization/') || startsWith(github.head_ref, 'architecture/') + if: github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'stabilization/') || startsWith(github.head_ref, 'architecture/') || startsWith(github.head_ref, 'legal/') runs-on: windows-latest timeout-minutes: 35 @@ -52,12 +59,10 @@ jobs: $prefixNode = $props.SelectSingleNode('/Project/PropertyGroup/VersionPrefix') $suffixNode = $props.SelectSingleNode('/Project/PropertyGroup/VersionSuffix') if ($null -eq $prefixNode) { throw 'VersionPrefix is missing.' } - $prefix = $prefixNode.InnerText.Trim() $suffix = if ($null -eq $suffixNode) { '' } else { $suffixNode.InnerText.Trim() } $version = if ([string]::IsNullOrWhiteSpace($suffix)) { $prefix } else { "$prefix-$suffix" } if ([string]::IsNullOrWhiteSpace($version)) { throw 'Unable to resolve repository version.' } - "value=$version" | Out-File -FilePath $env:GITHUB_OUTPUT -Append -Encoding utf8 Write-Host "Candidate version: $version" @@ -95,6 +100,8 @@ jobs: sourceRef = '${{ github.head_ref || github.ref_name }}' runtime = 'win-x64' framework = 'net8.0-windows' + communityLicense = 'GPL-3.0-or-later' + historicalBoundary = '85d43a0fe58a5888a9e8008c168ab76d2333ea87' timestampUtc = (Get-Date).ToUniversalTime().ToString('o') } $manifest | ConvertTo-Json | Set-Content .\artifacts\release\candidate-manifest.json -Encoding utf8 diff --git a/.github/workflows/release-package.yml b/.github/workflows/release-package.yml index ebe60a6..fbf40fe 100644 --- a/.github/workflows/release-package.yml +++ b/.github/workflows/release-package.yml @@ -4,9 +4,9 @@ on: workflow_dispatch: inputs: version: - description: Version label, for example 1.4.0-beta.1 + description: Version label, for example 1.4.0-beta.2 required: true - default: 1.4.0-beta.1 + default: 1.4.0-beta.2 publish_release: description: Create or update a GitHub Release required: true @@ -18,14 +18,14 @@ on: default: true type: boolean draft: - description: Create GitHub Release as draft + description: Create a draft release required: true default: false type: boolean release_notes_file: description: Markdown file used as release body required: true - default: docs/RELEASE_NOTES_v1.4.0-beta.1.md + default: docs/RELEASE_NOTES_v1.4.0-beta.2.md push: tags: - "v*" @@ -102,6 +102,8 @@ jobs: commit = '${{ github.sha }}' runtime = 'win-x64' framework = 'net8.0-windows' + communityLicense = 'GPL-3.0-or-later' + historicalBoundary = '85d43a0fe58a5888a9e8008c168ab76d2333ea87' timestampUtc = (Get-Date).ToUniversalTime().ToString('o') } $manifest | ConvertTo-Json | Set-Content .\artifacts\release\release-manifest.json -Encoding utf8 @@ -130,7 +132,7 @@ jobs: $sha = "artifacts/release/SHA256SUMS.txt" $manifest = "artifacts/release/release-manifest.json" $notesFile = '${{ github.event.inputs.release_notes_file }}' - if ([string]::IsNullOrWhiteSpace($notesFile)) { $notesFile = 'docs/RELEASE_NOTES_v1.4.0-beta.1.md' } + if ([string]::IsNullOrWhiteSpace($notesFile)) { $notesFile = 'docs/RELEASE_NOTES_v1.4.0-beta.2.md' } if (-not (Test-Path $notesFile)) { throw "Release notes file not found: $notesFile" } $releaseArgs = @('release', 'create', $tag, $zip, $sha, $manifest, '--title', "Process Bus Insight $tag", '--notes-file', $notesFile, '--target', '${{ github.sha }}') diff --git a/AGENTS.md b/AGENTS.md index 94dee91..16f7939 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -33,9 +33,25 @@ This file defines permanent rules for human and AI contributors. Historical phas - Duplicate APPID alone is a design warning; hard conflict requires stronger identity collision evidence. - Preserve raw evidence when semantic mapping is uncertain. -## Timing language +## Timing and claim language -Use wording such as `arrival timing`, `software timestamp`, `screening`, and `capture-path confidence`. Do not use `certified`, `measurement-grade`, or equivalent claims without validated hardware evidence. +Use wording such as `arrival timing`, `software timestamp`, `screening`, and `capture-path confidence`. Do not use `certified`, `measurement-grade`, `conformant`, `deterministic`, `safe`, `secure`, or universal interoperability claims without the exact evidence and authority required. + +The software does not establish functional safety, cybersecurity approval, calibrated measurement, equipment isolation, switching authority, or proof that an IED accepted or acted on observed traffic. + +## External-material boundary + +External software may be used only as a lawfully licensed black-box interoperability or packet-observation endpoint. Do not use unrelated external source, generated bindings, API composition, internal structure, tests, wording, screenshots, icons, report layouts, UI composition, binaries, or extracted resources as implementation design material without documented rights. + +Use synthetic or contributor-owned fixtures. Real SCL, PCAP, screenshots, logs, and diagnostics require documented authorization and sanitization. + +## Licensing boundary + +- Current community revisions and current packages are `GPL-3.0-or-later` only. +- Historical Apache-2.0 revisions end at `85d43a0fe58a5888a9e8008c168ab76d2333ea87` and remain on `archive/apache-2.0-final`. +- Commercial rights require a separate negotiated and executed agreement. +- The commercial notice grants no additional rights by itself. +- Third-party components retain their own licenses and notices. ## Repository quality gate @@ -48,11 +64,11 @@ dotnet build .\ProcessBusSuite.sln -c Release --no-restore dotnet test .\ProcessBusSuite.sln -c Release --no-build ``` -Update tests and documentation whenever runtime behavior, user-visible wording, screenshots, versioning, or release packaging changes. +Update tests and documentation whenever runtime behavior, user-visible wording, screenshots, versioning, licensing, or release packaging changes. ## Version and release - `Directory.Build.props` is the repository version source. - README package examples, landing-page structured data, release workflow defaults, and release notes must match it. -- Release artifacts must include checksum and release manifest. -- Do not tag a stable release while selected-stream updates, timebase behavior, or waveform/phasor/RMS coherence remain nondeterministic. +- Release artifacts must include checksum, release manifest, current GPL text, commercial notice, copyright, trademark, third-party notices, and licensing summary. +- Do not tag a stable release while selected-stream updates, timebase behavior, or waveform/phasor/RMS coherence remain nondeterministic. \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 1988bce..2147cc1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,18 +6,42 @@ All notable changes are documented here. The project follows Semantic Versioning ### Planned -- Sanitized golden PCAP/PCAPNG replay corpus with broader multi-vendor scenarios +- Sanitized golden PCAP/PCAPNG replay corpus with broader interoperability scenarios - Further decomposition of the analyzer runtime and WPF workspace -- Expanded SCL multi-vendor validation +- Expanded SCL validation - Evidence export for FAT/SAT reports +## [1.4.0-beta.2] - 2026-07-15 + +### Added + +- GPL-3.0-or-later current community licensing model +- Separate negotiated commercial licensing path +- Historical Apache-2.0 preservation branch at `archive/apache-2.0-final` +- Copyright, trademark, CLA, DCO, transition, provenance, and public-claim records +- GPL and package legal-content verification in the repository-health gate +- Candidate-package validation for `legal/*` branches + +### Changed + +- Version advanced to `1.4.0-beta.2` so post-transition packages are not confused with historical Apache-licensed v1.4.0-beta.1 artifacts +- README, landing-page structured data, FAQ, manifest, contribution guidance, package scripts, release workflow, and release documentation now reflect GPL and commercial boundaries +- Current portable packages include GPL, commercial, copyright, trademark, third-party, and licensing-summary documents +- Release manifests record the community license and historical boundary + +### Security and provenance + +- External implementation material is limited to lawful black-box interoperability use unless documented incorporation rights exist +- Real captures, SCL, screenshots, and diagnostics require documented authorization and sanitization +- Public wording separates configured expectations, observed traffic, software interpretation, and external-device behavior + ## [1.4.0-beta.1] - 2026-07-11 ### Added - Immutable selected-stream runtime generations with copied waveform, analog, identity, and diagnostic evidence - Atomic runtime snapshot publisher for coherent consumer reads -- Classic Ethernet PCAP replay through the same raw decoder/analyzer path used by live Npcap capture +- Classic PCAP replay through the same raw decoder/analyzer path used by live Npcap capture - Microsecond and nanosecond PCAP timestamp variants in little-endian and big-endian formats - Bounded rejection for unsupported link types, invalid headers, oversized records, and truncated captures - Deterministic runtime-architecture tests covering replay timing, snapshot immutability, and three-stream isolation @@ -27,8 +51,8 @@ All notable changes are documented here. The project follows Semantic Versioning ### Changed - Release and documentation versioning use `1.4.0-beta.1` -- Runtime architecture now exposes a coherent publication boundary instead of requiring consumers to retain mutable analyzer display models -- Offline replay is explicitly treated as a reproducibility path, not a separate decoder or a traffic publisher +- Runtime architecture exposes a coherent publication boundary instead of requiring consumers to retain mutable analyzer display models +- Offline replay is treated as a reproducibility path, not a separate decoder or traffic publisher ### Limitations @@ -51,8 +75,7 @@ All notable changes are documented here. The project follows Semantic Versioning ### Changed - Release and documentation versioning use `1.3.0-beta.2` -- Runtime validation now separates deterministic automated stress evidence from maintained 30–60 minute live/replay soak evidence -- Public documentation exposes a dedicated Runtime Stability workflow and test filter +- Runtime validation separates deterministic automated stress evidence from maintained live/replay soak evidence ## [1.3.0-beta.1] - 2026-07-10 @@ -67,12 +90,9 @@ All notable changes are documented here. The project follows Semantic Versioning ### Changed -- SCL candidates with a valid primary identity anchor remain eligible when transport or configuration fields mismatch, preserving a precise `MISMATCH` result instead of splitting evidence into `MISSING` and `UNEXPECTED` rows -- Dependency Review uses the current Node 24 action generation and retries while dependency snapshots are still being submitted +- SCL candidates with a valid primary identity anchor remain eligible when transport or configuration fields mismatch - SV explorer prioritizes live streams and sorts by SV name -- Live streams use `LIVE` state with health color rather than ambiguous warning-only labels -- Metering and waveform layouts reduce repeated status/noise text -- Release and documentation versioning use `1.3.0-beta.1` +- Metering and waveform layouts reduce repeated status text ### Security @@ -82,7 +102,8 @@ All notable changes are documented here. The project follows Semantic Versioning - Hardened BER parsing, Npcap lifecycle, release version propagation, and public-repository packaging. -[Unreleased]: https://github.com/masarray/DigSubAnalyzer/compare/v1.4.0-beta.1...HEAD +[Unreleased]: https://github.com/masarray/DigSubAnalyzer/compare/v1.4.0-beta.2...HEAD +[1.4.0-beta.2]: https://github.com/masarray/DigSubAnalyzer/compare/v1.4.0-beta.1...v1.4.0-beta.2 [1.4.0-beta.1]: https://github.com/masarray/DigSubAnalyzer/compare/v1.3.0-beta.2...v1.4.0-beta.1 [1.3.0-beta.2]: https://github.com/masarray/DigSubAnalyzer/compare/v1.3.0-beta.1...v1.3.0-beta.2 [1.3.0-beta.1]: https://github.com/masarray/DigSubAnalyzer/releases/tag/v1.3.0-beta.1 diff --git a/COMMERCIAL-LICENSE.md b/COMMERCIAL-LICENSE.md new file mode 100644 index 0000000..a730130 --- /dev/null +++ b/COMMERCIAL-LICENSE.md @@ -0,0 +1,26 @@ +# Commercial Licensing + +Process Bus Insight / DigSubAnalyzer is available as a community edition under `GPL-3.0-or-later`. + +Organizations that cannot use or redistribute the software under the GNU GPL may contact the project owner to discuss a separate commercial agreement for rights controlled by that owner, including: + +- proprietary or closed-source integration; +- OEM or white-label distribution; +- redistribution without the GPL source-distribution model; +- private product branches and organization-specific features; +- contractual maintenance, priority support, training, warranty, or engineering services. + +## Important legal boundary + +This document is an invitation to negotiate. It is **not itself a commercial license**, does not create a contract, and **grants no additional rights** beyond the licenses that already apply. + +Commercial terms become effective only through a separately negotiated and executed agreement. Such an agreement can cover only copyrights and other rights controlled by the granting party. It does not replace or remove: + +- third-party license obligations; +- contributor-owned rights not covered by an applicable agreement; +- historical open-source grants; +- standards-access restrictions; +- trademark rules; or +- operational authorization, validation, safety, or regulatory requirements. + +For a confidential commercial discussion, contact the project owner through the `masarray` GitHub profile. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 585728f..8e69987 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,28 @@ Thank you for helping improve a receive-only IEC 61850 Process Bus engineering tool. +## Licensing and acceptance + +The current community edition is `GPL-3.0-or-later` and the project maintains a separate commercial licensing path. + +Before merge, contributors must: + +1. read and affirmatively accept `CONTRIBUTOR-LICENSE-AGREEMENT.md`; +2. add a Developer Certificate of Origin sign-off to every commit; +3. have the legal right and any required employer or organizational authorization to submit the contribution; and +4. identify any third-party material together with its provenance and license. + +Sign commits with: + +```text +Signed-off-by: Full Name +``` + +The CLA grants rights needed for GPL-compatible publication and a separate commercial path. It does not transfer ownership of the contributor's work. + ## Start here -1. Read [`AGENTS.md`](AGENTS.md) for permanent engineering invariants. +1. Read `AGENTS.md` for permanent engineering invariants. 2. Search existing issues and pull requests. 3. Use a focused branch and keep changes reviewable. 4. Remove customer, site, device, capture, SCL, MAC/IP, and project-sensitive information from all evidence. @@ -28,18 +47,22 @@ dotnet test .\ProcessBusSuite.sln -c Release - UI clarity that reduces visual noise without hiding evidence - Release automation, documentation, and field-validation scenarios -## Product boundaries +## Independent-development and data boundary + +External software may be used only as a lawfully licensed black-box interoperability or packet-observation endpoint. Do not copy or mechanically translate unrelated source, API composition, tests, documentation wording, screenshots, icons, reports, UI layouts, binaries, or extracted resources unless the project has documented incorporation and relicensing rights. + +Use synthetic or contributor-owned fixtures whenever practical. Real SCL, PCAP, screenshots, logs, and diagnostics require documented sharing rights and sanitization. -Do not add: +Do not submit: -- IEC 61850 operate/control workflows -- protection-action or publisher behavior -- timing claims beyond the validated timestamp source -- restricted third-party binaries -- unsanitized customer/project evidence +- IEC 61850 operate/control, publisher, or protection-action workflows; +- timing or measurement claims beyond the validated evidence source; +- restricted third-party binaries or proprietary material; +- confidential customer, employer, station, credential, or network data; or +- production captures and project files without explicit redistribution authority. ## Pull-request expectations -A pull request should explain the engineering problem, source of truth, validation method, compatibility impact, and any remaining uncertainty. Runtime changes should include automated regression coverage where practical and a Windows smoke test. +A pull request should explain the engineering problem, source of truth, validation method, compatibility impact, operational and data-handling impact, public wording changes, and remaining uncertainty. Runtime changes should include automated regression coverage where practical and a Windows smoke test. -The pull-request template is the minimum checklist, not a substitute for engineering evidence. +The pull-request template is the minimum checklist, not a substitute for engineering evidence. \ No newline at end of file diff --git a/CONTRIBUTOR-LICENSE-AGREEMENT.md b/CONTRIBUTOR-LICENSE-AGREEMENT.md new file mode 100644 index 0000000..eb4f6c1 --- /dev/null +++ b/CONTRIBUTOR-LICENSE-AGREEMENT.md @@ -0,0 +1,39 @@ +# Contributor License Agreement + +By submitting a contribution to Process Bus Insight / DigSubAnalyzer, you agree to the terms below. “Contribution” means code, documentation, tests, designs, data, or other material intentionally submitted for inclusion in the project. + +## 1. Ownership + +You retain ownership of your Contribution. + +## 2. Copyright license + +You grant the project owner and recipients of the project a perpetual, worldwide, non-exclusive, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute your Contribution as part of the project. + +This grant includes permission to distribute the Contribution: + +- under `GPL-3.0-or-later` and compatible later community licensing; +- under a separately negotiated commercial, OEM, white-label, proprietary-integration, support, or services agreement; and +- as part of historical, archival, source, binary, documentation, test, and release materials. + +## 3. Patent license + +To the extent you control patent claims necessarily infringed by your Contribution alone or in combination with the project, you grant a perpetual, worldwide, non-exclusive, royalty-free, irrevocable patent license to make, use, sell, offer for sale, import, and otherwise transfer the Contribution as part of the project. + +## 4. Authority and provenance + +You represent that: + +- you have the legal right to submit the Contribution and grant these rights; +- the Contribution is your original work or you have clearly identified and documented all third-party material; +- you have obtained any required employer, client, educational institution, sponsor, or organizational permission; +- the Contribution does not knowingly include confidential, restricted, customer, station, credential, or unlawfully obtained material; and +- any SCL, PCAP, screenshot, report, test fixture, or diagnostic evidence is synthetic, contributor-owned, or documented as authorized and sanitized. + +## 5. No obligation + +The project is not required to accept, use, maintain, support, or distribute any Contribution. Unless separately agreed in writing, Contributions are provided without warranty. + +## Acceptance + +A pull request must affirm acceptance of this agreement. Every commit must also include a Developer Certificate of Origin sign-off as described in `DCO.txt`. \ No newline at end of file diff --git a/COPYRIGHT.md b/COPYRIGHT.md new file mode 100644 index 0000000..0bb13f3 --- /dev/null +++ b/COPYRIGHT.md @@ -0,0 +1,11 @@ +# Copyright + +Copyright © 2026 Ari Sulistiono and Process Bus Insight contributors. + +Current community revisions are distributed under `GPL-3.0-or-later`. Earlier revisions through commit `85d43a0fe58a5888a9e8008c168ab76d2333ea87` retain the Apache-2.0 grant under which they were released. + +Each contributor retains ownership of copyright in their contribution unless a separate written agreement states otherwise. Contribution acceptance is governed by the Contributor License Agreement and Developer Certificate of Origin in this repository. + +Third-party components, generated runtime files, standards, documentation sources, and external assets retain their own applicable rights and notices. + +No repository statement determines ownership created by employment, invention-assignment, confidentiality, customer, education, sponsorship, or other private agreements. Contributors are responsible for obtaining any authorization required before submission. \ No newline at end of file diff --git a/DCO.txt b/DCO.txt new file mode 100644 index 0000000..a7c0539 --- /dev/null +++ b/DCO.txt @@ -0,0 +1,22 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or + +(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or + +(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. + +(d) I understand and agree that this project and the contribution are public and that a record of the contribution, including all personal information I submit with it, is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. + +Contributors sign off commits with: + +Signed-off-by: Full Name \ No newline at end of file diff --git a/Directory.Build.props b/Directory.Build.props index a667847..a690d91 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,9 +1,9 @@ - Process Bus Insight Contributors - Process Bus Insight Contributors - Copyright 2026 Process Bus Insight Contributors - Apache-2.0 + Ari Sulistiono; Process Bus Insight Contributors + Process Bus Insight + Copyright 2026 Ari Sulistiono and Process Bus Insight Contributors + GPL-3.0-or-later git https://github.com/masarray/DigSubAnalyzer https://masarray.github.io/DigSubAnalyzer/ @@ -11,7 +11,7 @@ 1.4.0 - beta.1 + beta.2 $(VersionPrefix)-$(VersionSuffix) $(Version) $(VersionPrefix).0 @@ -23,7 +23,6 @@ true latest-recommended - true all high diff --git a/LICENSE b/LICENSE index 080561b..e72bfdd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,674 @@ -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 Process Bus Insight Contributors - -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. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/NOTICE b/NOTICE index 746c340..9206742 100644 --- a/NOTICE +++ b/NOTICE @@ -1,6 +1,16 @@ Process Bus Insight / DigSubAnalyzer -Copyright 2026 Process Bus Insight Contributors +Copyright 2026 Ari Sulistiono and Process Bus Insight Contributors -This product includes source code licensed under the Apache License, Version 2.0. +Current community revisions and current public release packages are licensed under GPL-3.0-or-later. -Npcap is a runtime prerequisite for raw packet capture on Windows. Npcap is not vendored in this repository and must be installed separately by the user. +The final active Apache-2.0 revision is commit: +85d43a0fe58a5888a9e8008c168ab76d2333ea87 + +That historical revision is preserved on: +archive/apache-2.0-final + +Historical Apache-2.0 grants remain effective for the revisions to which they applied. They are not a current alternative license for later revisions or current binaries. + +A separate commercial licensing path is described in COMMERCIAL-LICENSE.md. That notice is not itself a license and grants no additional rights. + +Npcap is a separately installed runtime prerequisite for raw packet capture on Windows and is not vendored or silently bundled. Third-party components retain their applicable licenses and notices. \ No newline at end of file diff --git a/README.md b/README.md index 5418475..dc0617b 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ [![GitHub Pages](https://github.com/masarray/DigSubAnalyzer/actions/workflows/pages.yml/badge.svg)](https://github.com/masarray/DigSubAnalyzer/actions/workflows/pages.yml) [![Release Package](https://github.com/masarray/DigSubAnalyzer/actions/workflows/release-package.yml/badge.svg)](https://github.com/masarray/DigSubAnalyzer/actions/workflows/release-package.yml) [![Latest Release](https://img.shields.io/github/v/release/masarray/DigSubAnalyzer?include_prereleases&label=release)](https://github.com/masarray/DigSubAnalyzer/releases) -[![License](https://img.shields.io/github/license/masarray/DigSubAnalyzer)](LICENSE) +[![License: GPL-3.0-or-later](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](LICENSE) [![Platform](https://img.shields.io/badge/platform-Windows%2010%2F11-0078d4)](#download-and-run) [![.NET](https://img.shields.io/badge/.NET-8.0-512BD4)](#build-from-source) -**Process Bus Insight** is a free, open-source, receive-only **IEC 61850 Process Bus analyzer for Windows**. It provides engineering visibility into **Sampled Values (SV)**, **GOOSE**, **PTPv2 timing context**, and **SCL expected-vs-observed validation** for FAT, SAT, commissioning, interoperability checks, and troubleshooting. +**Process Bus Insight** is a free, open-source, receive-only **IEC 61850 Process Bus analyzer for Windows**. It provides engineering visibility into **Sampled Values (SV)**, **GOOSE**, **PTPv2 timing context**, and **SCL expected-vs-observed validation** for authorized FAT, SAT, commissioning-support, interoperability, laboratory, and troubleshooting workflows. -The project is currently released as a **public beta**. Its design goal is field clarity without overstating measurement confidence: identify live publishers, inspect protocol evidence, isolate unhealthy streams, reproduce captured traffic offline, compare observed traffic against SCL, and capture defensible findings. +The project is currently a **public beta**. Its purpose is to identify live publishers, inspect protocol evidence, isolate unhealthy streams, reproduce sanitized captures offline, compare observed traffic against SCL, and preserve defensible findings without overstating measurement confidence. > **Timing confidence:** normal Windows/Npcap timestamps and replayed capture timestamps are software evidence. Arrival timing is useful for screening and troubleshooting, but is not certification-grade jitter evidence unless the capture path is validated with appropriate hardware timestamping, TAP, or trusted timing equipment. @@ -23,47 +23,45 @@ The project is currently released as a **public beta**. Its design goal is field Process Bus Insight is intentionally receive-only. It does not send IEC 61850 commands, operate breakers, publish SV/GOOSE, or act as a protection/control client. -Current capabilities include: - | Area | Capability | | --- | --- | -| SV analyzer | Multi-stream discovery, APPID/svID/MAC/VLAN/confRev evidence, selected-stream workspace, raw decoded sample waveform, RMS, phasor, sequence diagnostics, shape/distortion indication, and selectable scope windows. | +| SV analyzer | Multi-stream discovery, APPID/svID/MAC/VLAN/confRev evidence, selected-stream workspace, decoded waveform, RMS, phasor, sequence diagnostics, shape/distortion indication, and selectable scope windows. | | Runtime snapshots | Immutable selected-stream generations containing copied identity, waveform, analog, phasor, shape, and diagnostic evidence for coherent consumer reads. | -| PCAP replay | Bounded classic Ethernet PCAP replay through the same raw decoder/analyzer entry point used by live Npcap capture. | +| PCAP replay | Bounded classic Ethernet PCAP replay through the same decoder/analyzer entry point used by live Npcap capture. | | GOOSE inspector | Publisher discovery, stNum/sqNum tracking, event timeline, typed `allData` decoding, change summaries, and SCL-assisted semantic context. | -| PTP visibility | Passive PTPv2 message context, grandmaster/domain evidence where available, freshness wording, and timestamp-confidence boundaries. | +| PTP visibility | Passive PTPv2 context, grandmaster/domain evidence where available, freshness wording, and timestamp-confidence boundaries. | | SCL validation | Load SCD/ICD/CID files and compare expected publishers/streams against observed APPID, destination MAC, VLAN, svID, confRev, and related evidence. | | Evidence workflow | Copyable engineering evidence, cautious timing language, target-aware diagnostics, and screenshot-friendly workspaces. | -## Why this exists +## Evidence boundary -Wireshark remains an essential packet-analysis tool. Process Bus Insight focuses on the questions commissioning engineers repeatedly need answered quickly: +The application can record what was configured in SCL, what the selected capture or replay point observed, and how the software decoded or calculated that evidence. It does **not** establish: -- Which SV streams and GOOSE publishers are live now? -- Is the observed APPID, MAC, VLAN, svID, or confRev consistent with the SCL design? -- Is the problem owned by the stream, publisher, timing source, adapter, or capture path? -- Are waveform, RMS, and phasor values coming from the same selected stream? -- Can a sanitized capture reproduce the same decoder and runtime behavior away from site? -- What evidence can be copied into a FAT/SAT finding without overclaiming timing accuracy? +- formal IEC 61850 conformance or certification; +- calibrated measurement or deterministic real-time timing; +- functional-safety or cybersecurity approval; +- universal interoperability; +- equipment isolation, switching authority, or site authorization; or +- proof that an IED received, accepted, trusted, or acted on observed traffic. ## Download and run -1. Install **Npcap** on the Windows capture machine. +1. Install **Npcap** on the Windows capture machine when live raw Ethernet capture is required. 2. Download the latest portable ZIP from [GitHub Releases](https://github.com/masarray/DigSubAnalyzer/releases). 3. Extract it to a local folder such as `C:\Tools\ProcessBusInsight`. 4. Run `ProcessBusInsight.exe`. -5. Select a physical Ethernet adapter connected to a TAP, mirror port, or isolated test network. +5. Select a physical Ethernet adapter connected through an authorized TAP, mirror port, or isolated engineering test network. 6. Start capture and select the SV/GOOSE/PTP target to inspect. -Current public-beta package naming: +Current post-transition package naming: ```text -ProcessBusInsight-v1.4.0-beta.1-win-x64-portable.zip +ProcessBusInsight-v1.4.0-beta.2-win-x64-portable.zip SHA256SUMS.txt release-manifest.json ``` -A separate .NET runtime is not required for the self-contained portable package. Npcap remains a separate runtime prerequisite and is not redistributed by this repository. +A separate .NET runtime is not required for the self-contained package. Npcap remains separately installed and is not redistributed by this repository. See [`docs/QUICK_START.md`](docs/QUICK_START.md) for the field checklist. @@ -79,18 +77,13 @@ Classic Ethernet PCAP ───────────> bounded replay reader WPF / tests / future export ``` -The selected SV stream is the source of truth for waveform, RMS, phasor, and stream details. Per-stream state must remain isolated; consumers must never combine values from different publishers. The v1.4 runtime snapshot boundary copies mutable analyzer collections before atomic publication. See [`docs/architecture/STREAM_RUNTIME.md`](docs/architecture/STREAM_RUNTIME.md) and [`docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md`](docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md). +The selected SV stream is the source of truth for waveform, RMS, phasor, and stream details. Per-stream state remains isolated; consumers must not combine values from different publishers. See [`docs/architecture/STREAM_RUNTIME.md`](docs/architecture/STREAM_RUNTIME.md) and [`docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md`](docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md). The first replay reader supports classic PCAP 2.4 with Ethernet link type 1 in little/big-endian microsecond or nanosecond variants. PCAPNG is not yet claimed. ## Build from source -Requirements: - -- Windows 10/11 x64 -- .NET 8 SDK -- Visual Studio with the .NET desktop workload, or the .NET CLI -- Npcap for live capture tests +Requirements: Windows 10/11 x64, .NET 8 SDK, Visual Studio with the .NET desktop workload or the .NET CLI, and Npcap for authorized live-capture testing. ```powershell git clone https://github.com/masarray/DigSubAnalyzer.git @@ -98,19 +91,14 @@ cd DigSubAnalyzer dotnet restore .\ProcessBusSuite.sln dotnet build .\ProcessBusSuite.sln -c Release dotnet test .\ProcessBusSuite.sln -c Release -``` - -Run the application: - -```powershell dotnet run --project .\src\ProcessBus.App.Wpf\ProcessBus.App.Wpf.csproj -c Release ``` Create and verify a portable package: ```powershell -.\scripts\publish-windows-portable.ps1 -Version "1.4.0-beta.1" -.\scripts\verify-release-package.ps1 -PackageZip ".\artifacts\release\ProcessBusInsight-v1.4.0-beta.1-win-x64-portable.zip" +.\scripts\publish-windows-portable.ps1 -Version "1.4.0-beta.2" +.\scripts\verify-release-package.ps1 -PackageZip ".\artifacts\release\ProcessBusInsight-v1.4.0-beta.2-win-x64-portable.zip" ``` Run the repository-quality gate: @@ -119,23 +107,18 @@ Run the repository-quality gate: .\scripts\repository-health.ps1 ``` -Run only the deterministic runtime-stability suite: +Focused deterministic suites: ```powershell dotnet test .\tests\ProcessBus.Tests\ProcessBus.Tests.csproj -c Release --filter "Category=RuntimeStability" -``` - -Run only the immutable snapshot and PCAP replay suite: - -```powershell dotnet test .\tests\ProcessBus.Tests\ProcessBus.Tests.csproj -c Release --filter "Category=RuntimeArchitecture" ``` ## Validation status -The repository includes parser and regression tests, repeated deterministic multi-stream stability evidence, immutable runtime/replay evidence, CI build/test evidence, CodeQL analysis, dependency review, release-package verification, and explicit repository-hygiene checks. Public-beta status does **not** imply vendor certification or measurement-grade timing validation. +The repository includes parser and regression tests, repeated multi-stream stability evidence, immutable runtime/replay evidence, CI build/test evidence, CodeQL analysis, dependency review, release-package verification, and repository-hygiene checks. Public-beta status does not imply certification or measurement-grade timing validation. -Before interpreting results, review: +Review: - [`docs/validation/TESTED_CONFIGURATIONS.md`](docs/validation/TESTED_CONFIGURATIONS.md) - [`docs/validation/V1.3.0_BETA2_FIELD_EVIDENCE.md`](docs/validation/V1.3.0_BETA2_FIELD_EVIDENCE.md) @@ -148,21 +131,23 @@ Before interpreting results, review: - [`docs/QUICK_START.md`](docs/QUICK_START.md) — first-run and field checklist - [`docs/USER_MANUAL.md`](docs/USER_MANUAL.md) — user workflow - [`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md) — capture and interpretation issues -- [`docs/architecture/STREAM_RUNTIME.md`](docs/architecture/STREAM_RUNTIME.md) — selected-stream and snapshot invariants -- [`docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md`](docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md) — immutable generation and PCAP replay design -- [`docs/validation/TESTED_CONFIGURATIONS.md`](docs/validation/TESTED_CONFIGURATIONS.md) — explicitly tested environments -- [`docs/validation/V1.3.0_BETA2_FIELD_EVIDENCE.md`](docs/validation/V1.3.0_BETA2_FIELD_EVIDENCE.md) — maintained 60-minute live stability evidence +- [`docs/LICENSING.md`](docs/LICENSING.md) — current GPL, historical Apache boundary, and commercial path +- [`docs/architecture/STREAM_RUNTIME.md`](docs/architecture/STREAM_RUNTIME.md) — selected-stream invariants +- [`docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md`](docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md) — immutable generation and PCAP replay - [`docs/RELEASE_PACKAGING.md`](docs/RELEASE_PACKAGING.md) — portable packaging design -- [`ROADMAP.md`](ROADMAP.md) — product direction -- [`SECURITY.md`](SECURITY.md) — vulnerability reporting and data-handling policy -- [`SUPPORT.md`](SUPPORT.md) — support boundaries and issue evidence +- [`SECURITY.md`](SECURITY.md) — vulnerability reporting +- [`SUPPORT.md`](SUPPORT.md) — community and commercial support boundaries ## Contributing -Contributions are welcome when they preserve the receive-only boundary, selected-stream isolation, evidence-focused wording, and honest timing confidence. Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and [`AGENTS.md`](AGENTS.md) before changing runtime or UI behavior. +Contributions are welcome when they preserve the receive-only boundary, selected-stream isolation, evidence-focused wording, legal provenance, and honest timing confidence. Read [`CONTRIBUTING.md`](CONTRIBUTING.md), [`CONTRIBUTOR-LICENSE-AGREEMENT.md`](CONTRIBUTOR-LICENSE-AGREEMENT.md), [`DCO.txt`](DCO.txt), and [`AGENTS.md`](AGENTS.md). + +## Licensing + +Revisions after commit `85d43a0fe58a5888a9e8008c168ab76d2333ea87` on `main`, and release packages built from those revisions, are licensed **only** under [`GPL-3.0-or-later`](LICENSE). -## License and third-party software +The boundary commit and earlier revisions—including historical `v1.4.0-beta.1` artifacts built from that line—retain their Apache-2.0 grants and are preserved on `archive/apache-2.0-final`. Historical rights remain effective; this is not a current Apache-or-GPL dual-license offer. -Source code is licensed under **Apache-2.0**. See [`LICENSE`](LICENSE) and [`NOTICE`](NOTICE). +A separate negotiated commercial path is available for proprietary integration, OEM/white-label distribution, closed-source redistribution, private branches, and contractual support or engineering services. [`COMMERCIAL-LICENSE.md`](COMMERCIAL-LICENSE.md) is an invitation to discuss terms and grants no additional rights by itself. -Npcap is a runtime prerequisite and is not vendored. Self-contained .NET/WPF runtime files may be present in generated release artifacts. See [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md). +Third-party software retains its own terms. See [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md), [`COPYRIGHT.md`](COPYRIGHT.md), and [`TRADEMARK.md`](TRADEMARK.md). \ No newline at end of file diff --git a/SUPPORT.md b/SUPPORT.md index 54c81af..aca999f 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,26 +1,32 @@ # Support -Process Bus Insight is an open-source public-beta engineering tool. Support is community and maintainer based; no response-time or field-service SLA is implied. +Process Bus Insight is a GPL-3.0-or-later public-beta engineering tool. Community support is maintainer based and best effort; no response-time, warranty, field-service, validation, or acceptance SLA is implied. ## Before opening an issue -- Confirm the latest public beta or current `main` build. +- Confirm the latest post-transition public beta or current `main` build. - Read `docs/QUICK_START.md` and `docs/TROUBLESHOOTING.md`. - Reproduce with a known source and a supported Windows/Npcap capture path. -- Separate application behavior from publisher behavior by checking raw sample values or a sanitized capture where possible. +- Separate application behavior from publisher or external-device behavior by checking raw values or a sanitized capture where possible. ## Include this evidence -- Application version or commit SHA -- Windows and Npcap versions -- Adapter type and capture path -- Selected SV/GOOSE/PTP target -- Expected and actual behavior -- Minimal, sanitized steps -- Sanitized screenshot, SCL excerpt, log, or capture when legally shareable +- application version or commit SHA; +- Windows and Npcap versions; +- adapter type and capture/replay path; +- selected SV/GOOSE/PTP target; +- expected and observed behavior; +- evidence source: automated test, replay, loopback, isolated laboratory equipment, or authorized commissioning environment; and +- the smallest legally shareable sanitized screenshot, SCL excerpt, log, or capture. ## Never post publicly -Customer/site names, real project files, credentials, private IP/MAC inventories, confidential captures, or unsanitized SCL/device data. +Customer, employer, station, project, credential, private address inventory, confidential capture, unsanitized SCL/device data, proprietary manual, support response, screenshot, report, binary, or extracted third-party material. Security issues must use a private security advisory, not the public issue tracker. + +## Scope boundary + +Community support does not establish formal conformance, calibrated timing, deterministic real-time behavior, functional safety, cybersecurity approval, switching authority, site authorization, universal interoperability, or proof that an IED accepted or acted on observed traffic. + +For proprietary integration, OEM or white-label distribution, private branches, contractual response times, warranty, training, or engineering services, review `COMMERCIAL-LICENSE.md` and contact the project owner privately through the `masarray` GitHub profile. The notice grants no additional rights by itself. \ No newline at end of file diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 819cf42..d98e31b 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -1,17 +1,19 @@ # Third-Party Notices -Process Bus Insight is built with Microsoft .NET and WPF for Windows desktop use. +Process Bus Insight / DigSubAnalyzer project material covered by the current community license is distributed under `GPL-3.0-or-later`. Third-party components retain their own licenses and are not relicensed merely because they are used, restored, bundled, or documented by this project. -## Runtime prerequisite +## Microsoft .NET and WPF -Npcap is required on the target Windows machine for raw packet capture. Npcap is not vendored in this repository and is not bundled by the source tree. +Process Bus Insight is built with Microsoft .NET and WPF for Windows desktop use. Self-contained packages created with `dotnet publish` may contain applicable .NET runtime and WPF files generated by the .NET SDK. Their Microsoft license terms and notices remain applicable. -Users should install Npcap from its official distribution source and follow the applicable license terms for their environment. +## Npcap -## Published artifacts +Npcap is required on the target Windows machine for live raw Ethernet capture. It is not vendored in this repository and is not silently bundled by the portable package. Users install it separately and are responsible for the applicable license and deployment terms. -Self-contained Windows packages created with `dotnet publish` may include Microsoft .NET runtime and WPF files generated by the .NET SDK. Redistribution terms are governed by the applicable Microsoft .NET license terms. +## Managed dependencies -## Project source license +The exact direct and transitive NuGet dependency graph is defined by the project files and resolved during restore. Dependencies, test tools, GitHub Actions, build services, fonts, and other external resources retain their applicable licenses and notices. -Process Bus Insight source code is licensed under Apache-2.0. See `LICENSE`. +## Commercial licensing boundary + +A separate Process Bus Insight commercial agreement can cover only rights controlled by the relevant copyright holder. It does not replace, remove, or expand third-party license rights or obligations. \ No newline at end of file diff --git a/TRADEMARK.md b/TRADEMARK.md new file mode 100644 index 0000000..0c8831a --- /dev/null +++ b/TRADEMARK.md @@ -0,0 +1,24 @@ +# Trademark and Branding Policy + +The names **Process Bus Insight**, **DigSubAnalyzer**, associated logos, icons, visual identity, and project branding are not granted for unrestricted use by the software license. + +The GNU GPL governs copyright permissions for covered software. It does not grant trademark rights or permission to imply endorsement, certification, origin, or affiliation. + +## Allowed without separate permission + +- truthful nominative references to the original project; +- unmodified redistribution that preserves the original name and clearly identifies the source; +- statements such as “based on Process Bus Insight” that do not imply endorsement; and +- links to the official repository or project website. + +## Permission required + +Separate written permission is required for: + +- using the project name or logo as the primary identity of a materially modified product; +- OEM or white-label branding; +- claiming an official, certified, approved, sponsored, or endorsed relationship; +- using branding in a way likely to confuse users about origin or maintenance; or +- registering confusingly similar product names, domains, accounts, or marks. + +Modified distributions should use a distinct name and clearly state that they are modified and independently maintained. Commercial branding rights may be included only in a separately negotiated agreement. \ No newline at end of file diff --git a/docs/EXTERNAL_IP_AND_PROVENANCE_REVIEW_2026-07-15.md b/docs/EXTERNAL_IP_AND_PROVENANCE_REVIEW_2026-07-15.md new file mode 100644 index 0000000..4f06ff2 --- /dev/null +++ b/docs/EXTERNAL_IP_AND_PROVENANCE_REVIEW_2026-07-15.md @@ -0,0 +1,44 @@ +# External IP and Provenance Review — 2026-07-15 + +## Scope + +This review covers the current tracked repository, public documentation, release packaging, and visible contribution history for Process Bus Insight / DigSubAnalyzer. + +## Observed repository boundary + +- The project is a receive-only IEC 61850 Process Bus analyzer implemented in the repository's own source tree. +- Visible merged pull requests reviewed for the current line were submitted from the maintainer account. +- Runtime dependencies and separately installed prerequisites are identified in `THIRD_PARTY_NOTICES.md`. +- Public examples are expected to be synthetic, contributor-owned, or documented as authorized and sanitized. + +## Independent-development rule + +External software may be used only as a lawfully licensed black-box interoperability or packet-observation endpoint within the applicable authorization and license boundary. + +Do not use unrelated external source, generated bindings, API composition, internal structures, tests, documentation wording, screenshots, icons, report layouts, UI composition, binaries, extracted resources, or confidential support material as implementation design material unless the project has documented rights to incorporate and relicense it. + +## Data and fixture rule + +Do not commit customer, employer, station, credential, restricted network, or production evidence. Real SCL, PCAP, screenshots, logs, or diagnostics require documented sharing rights and sanitization. Prefer synthetic fixtures that reproduce only the engineering condition under test. + +## Findings + +No external human code contributor was identified in the visible pull-request evidence reviewed for this migration. That supports, but does not conclusively prove, maintainer control over the current repository line. + +Repository inspection cannot determine: + +- employment or invention-assignment obligations; +- confidentiality or customer restrictions; +- rights in private or deleted artifacts; +- whether every historical input was independently created; +- trademark priority outside the repository; or +- rights required for a specific commercial deliverable. + +## Required ongoing controls + +- CLA affirmation and DCO sign-off for new contributions; +- provenance disclosure for third-party material; +- synthetic or documented authorized fixtures; +- required third-party notices and SBOM/dependency evidence where available; +- no external product affiliation or imitation claims; and +- transaction-specific legal review before a significant OEM or proprietary agreement. \ No newline at end of file diff --git a/docs/LICENSE_TRANSITION_RECORD_2026-07-15.md b/docs/LICENSE_TRANSITION_RECORD_2026-07-15.md new file mode 100644 index 0000000..edff3aa --- /dev/null +++ b/docs/LICENSE_TRANSITION_RECORD_2026-07-15.md @@ -0,0 +1,40 @@ +# License Transition Record — 2026-07-15 + +## Preserved historical line + +The final active Apache-2.0 revision is: + +```text +85d43a0fe58a5888a9e8008c168ab76d2333ea87 +``` + +The exact revision is preserved on: + +```text +archive/apache-2.0-final +``` + +Historical grants remain effective for that revision and earlier revisions. + +## Current line + +Revisions after the boundary on `main` are released as the Process Bus Insight / DigSubAnalyzer community edition under `GPL-3.0-or-later`. + +Current release packages contain the GNU GPL version 3 text and current notices. They must not present the historical Apache license as a current alternative. + +## Separate commercial path + +Additional proprietary, OEM, white-label, closed-source redistribution, private-branch, support, training, warranty, or engineering rights require a separately negotiated and executed agreement. The repository commercial notice grants no rights by itself. + +## Controls introduced + +- current GPL package metadata; +- historical-boundary documentation and archive branch; +- commercial, copyright, trademark, CLA, DCO, and provenance records; +- README and landing-page licensing updates; +- package-content and license-text validation; and +- repository-health enforcement for licensing and public wording. + +## Limitation + +This record documents repository actions. It does not resolve employment, invention-assignment, confidentiality, customer, educational, sponsorship, trademark, or off-repository ownership questions. \ No newline at end of file diff --git a/docs/LICENSING.md b/docs/LICENSING.md new file mode 100644 index 0000000..d099917 --- /dev/null +++ b/docs/LICENSING.md @@ -0,0 +1,64 @@ +# Licensing + +## Current community edition + +Current revisions on `main` and current public release packages are licensed **only** under: + +```text +GPL-3.0-or-later +``` + +The GNU General Public License gives users permission to run, study, modify, and redistribute covered software subject to its terms, including source-availability obligations when conveying object code. + +## Historical Apache-2.0 boundary + +The final revision released under Apache-2.0 as the active project license is: + +```text +85d43a0fe58a5888a9e8008c168ab76d2333ea87 +``` + +It is preserved on: + +```text +archive/apache-2.0-final +``` + +Revisions at or before that boundary retain the Apache-2.0 rights already granted. Those historical rights are not revoked. Later revisions and current binaries are not offered as an Apache-or-GPL choice. + +## Commercial path + +Organizations requiring proprietary integration, OEM or white-label distribution, closed-source redistribution, private branches, contractual support, training, warranty, or engineering services may discuss a separate commercial agreement. + +`COMMERCIAL-LICENSE.md` is an invitation to negotiate. It is not itself an executed license and grants no additional rights. + +Commercial rights can cover only material and rights controlled by the relevant granting party. Third-party components, contributor-owned material, standards, and historical grants remain subject to their own terms. + +## Contributions + +New contributions require: + +- affirmative acceptance of `CONTRIBUTOR-LICENSE-AGREEMENT.md`; +- a Developer Certificate of Origin sign-off on every commit; +- authority to submit the material, including any required employer or organizational approval; and +- documented provenance for any third-party or non-synthetic fixture. + +## Packages + +Current portable packages must include: + +```text +LICENSE.txt +NOTICE.txt +COMMERCIAL-LICENSE.md +COPYRIGHT.md +TRADEMARK.md +THIRD_PARTY_NOTICES.md +Licensing.md +``` + +`LICENSE.txt` must contain GNU GPL version 3. A historical Apache license file must not be included in a current package in a way that suggests Apache-2.0 applies to the current binary. + +## Scope limitation + +Repository records document licensing intent and public release boundaries. They do not by themselves establish employer ownership, resolve invention-assignment or confidentiality duties, or determine rights in off-repository material. Significant commercial transactions should review the exact contributors, contracts, dependencies, trademarks, fixtures, and deliverables involved. \ No newline at end of file diff --git a/docs/RELEASE_NOTES_v1.4.0-beta.2.md b/docs/RELEASE_NOTES_v1.4.0-beta.2.md new file mode 100644 index 0000000..0959a8a --- /dev/null +++ b/docs/RELEASE_NOTES_v1.4.0-beta.2.md @@ -0,0 +1,34 @@ +# Process Bus Insight v1.4.0-beta.2 + +This beta establishes the post-transition licensing, provenance, package, and public-claim boundary for Process Bus Insight while preserving the receive-only runtime architecture introduced in v1.4.0-beta.1. + +## Licensing + +- Current source and this release are `GPL-3.0-or-later`. +- The final active Apache-2.0 revision is `85d43a0fe58a5888a9e8008c168ab76d2333ea87`, preserved on `archive/apache-2.0-final`. +- Historical v1.4.0-beta.1 and earlier grants remain effective for the revisions and artifacts to which they applied. +- Proprietary integration, OEM or white-label distribution, closed-source redistribution, private branches, and contractual services require a separate negotiated agreement. +- `COMMERCIAL-LICENSE.md` is an invitation to negotiate and grants no additional rights by itself. + +## Repository and package hardening + +- Added copyright, trademark, CLA, DCO, licensing-transition, provenance, and public-wording records. +- Added automated GPL and commercial-license boundary checks to the repository-health gate. +- Current portable packages include GPL, NOTICE, commercial licensing, copyright, trademark, third-party, and licensing-summary documents. +- Package verification rejects a stale Apache license presented as the current package license. +- Candidate packaging now runs for licensing branches. +- Release manifests identify the community license and historical boundary. + +## Engineering scope retained + +- Receive-only SV, GOOSE, PTP, SCL, and PCAP analysis. +- Immutable selected-stream runtime generations. +- Classic Ethernet PCAP replay through the same raw decoder/analyzer path used by live capture. +- No SV/GOOSE publishing and no IEC 61850 control-command path. + +## Important limitations + +- This remains a public beta, not a certified protection, conformance, timing, calibration, functional-safety, or cybersecurity platform. +- Windows/Npcap and replay timestamps remain engineering screening evidence unless the capture path is independently validated. +- Observed traffic and software interpretation do not prove that an external IED received, accepted, trusted, or acted on the traffic. +- Npcap is installed separately for live capture. \ No newline at end of file diff --git a/docs/RELEASE_PACKAGING.md b/docs/RELEASE_PACKAGING.md index 592cda7..8a7da08 100644 --- a/docs/RELEASE_PACKAGING.md +++ b/docs/RELEASE_PACKAGING.md @@ -19,14 +19,26 @@ User Manual.pdf README.txt LICENSE.txt NOTICE.txt +COMMERCIAL-LICENSE.md +COPYRIGHT.md +TRADEMARK.md THIRD_PARTY_NOTICES.md +Licensing.md ``` -Npcap is required on the target Windows machine and is not bundled. +Npcap is required on the target Windows machine for live raw Ethernet capture and is not bundled. + +## License boundary + +Packages built from post-transition revisions are `GPL-3.0-or-later`. `LICENSE.txt` must contain GNU GPL version 3. A historical Apache license file must not be included as a current package license. + +The final active Apache-2.0 revision is commit `85d43a0fe58a5888a9e8008c168ab76d2333ea87`, preserved on `archive/apache-2.0-final`. Historical packages retain the grants under which they were distributed. + +`COMMERCIAL-LICENSE.md` is an invitation to negotiate separate proprietary or OEM terms and grants no additional rights by itself. ## Version source -`Directory.Build.props` defines the default public-beta version. The README package example, landing-page structured data, release workflow default, release notes, and package script must remain synchronized. The repository health script checks this contract. +`Directory.Build.props` defines the default public-beta version. README package examples, landing-page structured data, release workflow defaults, release notes, and the package script must remain synchronized. The repository-health script checks this contract. ## Required documentation @@ -39,25 +51,17 @@ git add -f docs/QUICK_START.pdf docs/USER_MANUAL.pdf ## Local packaging ```powershell -.\scripts\repository-health.ps1 -ExpectedVersion "1.4.0-beta.1" -.\scripts\publish-windows-portable.ps1 -Version "1.4.0-beta.1" -.\scripts\verify-release-package.ps1 -PackageZip ".\artifacts\release\ProcessBusInsight-v1.4.0-beta.1-win-x64-portable.zip" +.\scripts\repository-health.ps1 -ExpectedVersion "1.4.0-beta.2" +.\scripts\publish-windows-portable.ps1 -Version "1.4.0-beta.2" +.\scripts\verify-release-package.ps1 -PackageZip ".\artifacts\release\ProcessBusInsight-v1.4.0-beta.2-win-x64-portable.zip" ``` ## GitHub workflows -The candidate workflow runs for `stabilization/*` and `architecture/*` pull requests. It restores, builds, tests, packages, verifies the ZIP, creates a candidate manifest, and uploads the candidate without publishing a public release. - -The release workflow runs manually or for tags matching `v*`. It restores, builds, tests, packages, verifies the ZIP, produces a checksum and release manifest, uploads workflow evidence, and optionally creates or updates a GitHub Release. - -Manual release inputs: +The candidate workflow runs for `stabilization/*`, `architecture/*`, and `legal/*` pull requests when relevant files change. It restores, builds, tests, packages, verifies the ZIP and legal documents, creates a candidate manifest, and uploads the candidate without publishing a public release. -- `version` — semantic version label -- `publish_release` — create/update the GitHub Release -- `prerelease` — mark the release as prerelease -- `draft` — create a draft release -- `release_notes_file` — Markdown release body +The release workflow runs manually or for tags matching `v*`. It restores, builds, tests, packages, verifies the ZIP, produces a checksum and release manifest, uploads workflow evidence, and optionally creates a GitHub Release. ## Packaging design notes -The publish script performs a runtime-specific restore and then publishes with `--no-restore`. It splits prerelease versions into numeric assembly/file version and informational/package version so a label such as `1.4.0-beta.1` remains valid while Windows assembly versions stay numeric. +The publish script performs a runtime-specific restore and then publishes with `--no-restore`. It splits prerelease versions into numeric assembly/file version and informational/package version. Package verification also checks the current GPL text, commercial notice boundary, historical-license documentation, single-root-EXE rule, required PDFs, and absence of a historical Apache license presented as current. \ No newline at end of file diff --git a/docs/WORDING_AND_CLAIM_REVIEW_2026-07-15.md b/docs/WORDING_AND_CLAIM_REVIEW_2026-07-15.md new file mode 100644 index 0000000..a1c5b31 --- /dev/null +++ b/docs/WORDING_AND_CLAIM_REVIEW_2026-07-15.md @@ -0,0 +1,41 @@ +# Public Wording and Claim Review — 2026-07-15 + +## Product description + +Process Bus Insight / DigSubAnalyzer is described as receive-only engineering software for observing, decoding, replaying, visualizing, and comparing IEC 61850 Process Bus evidence on Windows. + +## Evidence boundaries + +Public wording must distinguish: + +- SCL-configured expectations; +- frames observed at the selected capture or replay point; +- software decoding, calculations, and diagnostics; and +- external device reception, acceptance, time quality, or process action. + +## Claims not established by the software + +Do not claim or imply: + +- formal IEC 61850 conformance or certification; +- calibrated or certification-grade timing and measurement; +- deterministic real-time operation; +- functional-safety or cybersecurity approval; +- universal interoperability; +- switching authority, equipment isolation, or site authorization; +- proof that an IED received, accepted, trusted, or acted on observed traffic; or +- equivalence to an approved test set, protection test system, or conformance platform. + +Use scoped evidence terms such as implemented, observed, replayed, decoded, tested in the stated environment, provisional, unsupported, or not yet verified. + +## Operational wording + +The application is receive-only and does not publish SV or GOOSE or send IEC 61850 control commands. Nevertheless, capture must use an authorized TAP, mirror port, engineering switch, or other approved observation path. Software instructions cannot establish the safety or authorization of an external network. + +## Licensing wording + +Current community revisions and releases are `GPL-3.0-or-later` only. Historical Apache-2.0 references must identify the exact preserved boundary and must not imply a current dual-license choice. The commercial notice is an invitation to negotiate and grants no additional rights by itself. + +## Review result + +README, landing-page structured data, visible FAQ, package documentation, contribution guidance, and automated repository checks are updated by the migration to apply these boundaries. \ No newline at end of file diff --git a/docs/development/RELEASE_CHECKLIST.md b/docs/development/RELEASE_CHECKLIST.md index 555bd31..29ee5fb 100644 --- a/docs/development/RELEASE_CHECKLIST.md +++ b/docs/development/RELEASE_CHECKLIST.md @@ -1,11 +1,16 @@ # Release Checklist -## Source and repository +## Source, licensing, and repository - [ ] `main` is clean and protected by pull-request review where practical - [ ] Repository health script passes +- [ ] Root `LICENSE` is GNU GPL version 3 and project metadata declares `GPL-3.0-or-later` +- [ ] Current source and package wording do not present Apache-2.0 as an active alternative license +- [ ] Historical boundary commit `85d43a0fe58a5888a9e8008c168ab76d2333ea87` and `archive/apache-2.0-final` are documented +- [ ] Commercial notice states that it is not itself a license and grants no additional rights +- [ ] Copyright, trademark, CLA, DCO, third-party, provenance, and public-claim documents are current - [ ] No nested repo, RnD solution, build output, logs, captures, or local settings are tracked -- [ ] Version matches `Directory.Build.props`, README, landing page, release workflow, and release notes +- [ ] Version matches `Directory.Build.props`, README, landing page, release workflow, release notes, and package script - [ ] Changelog, architecture notes, and tested-configuration notes are updated ## Automated validation @@ -14,9 +19,7 @@ - [ ] Release build succeeds - [ ] All tests pass - [ ] Runtime Stability workflow passes all repeated `Category=RuntimeStability` iterations -- [ ] Runtime Stability TRX artifact is retained with the release evidence - [ ] Runtime Architecture workflow passes all repeated `Category=RuntimeArchitecture` iterations -- [ ] Runtime Architecture TRX artifact is retained with the release evidence - [ ] Classic PCAP little/big-endian and micro/nanosecond variants pass - [ ] Truncated, unsupported-link-type, invalid-timestamp, and oversized-record cases are rejected - [ ] CodeQL completes @@ -26,7 +29,7 @@ ## Runtime smoke test -- [ ] Application starts without Npcap crash handling regressions +- [ ] Application starts without Npcap crash-handling regressions - [ ] Physical/known adapter can start and stop cleanly - [ ] Multiple SV streams remain isolated - [ ] Initial selected stream updates without user click @@ -37,7 +40,6 @@ - [ ] Duplicate, forward-gap, and publisher-restart behavior is exercised - [ ] GOOSE, PTP, and SCL workspaces open and update - [ ] 30–60 minute soak test shows no material memory growth or UI freeze -- [ ] Maintained live evidence remains available in `docs/validation/V1.3.0_BETA2_FIELD_EVIDENCE.md` ## Replay and immutable snapshot checks @@ -49,19 +51,29 @@ - [ ] Replay is file-input only and does not open a transmit path - [ ] PCAPNG is listed as unsupported until implemented and validated -## Claims and evidence +## Claims, data, and provenance - [ ] Timing wording remains screening-level unless hardware evidence exists - [ ] Replay is not described as recreating NIC, switch, or hardware timestamp behavior -- [ ] Automated deterministic stress is not described as a replacement for live/replay soak validation -- [ ] Full internal analyzer decomposition is not claimed before it is complete +- [ ] Expected configuration, observed traffic, software interpretation, and external-device behavior remain distinct +- [ ] No formal conformance, calibration, deterministic timing, functional-safety, cybersecurity, universal interoperability, switching-authority, or IED-acceptance claim is implied - [ ] Screenshots match the released UI -- [ ] No customer or project-sensitive evidence is included +- [ ] No customer, employer, station, credential, project-sensitive, or unlawfully shared evidence is included +- [ ] Every non-synthetic fixture has documented authorization, sanitization, and provenance - [ ] Known limitations are listed in release notes +## Package legal content + +- [ ] ZIP contains `LICENSE.txt`, `NOTICE.txt`, `COMMERCIAL-LICENSE.md`, `COPYRIGHT.md`, `TRADEMARK.md`, `THIRD_PARTY_NOTICES.md`, and `Licensing.md` +- [ ] `LICENSE.txt` contains GNU GPL version 3 +- [ ] No historical Apache license file is presented as the current package license +- [ ] Commercial notice non-grant wording is intact +- [ ] Release manifest identifies `GPL-3.0-or-later` and the historical boundary + ## Release - [ ] Create signed/verified tag where available - [ ] Publish portable ZIP, `SHA256SUMS.txt`, and `release-manifest.json` - [ ] Mark beta releases as prerelease - [ ] Confirm GitHub Pages and download links +- [ ] Do not replace a historical Apache release asset with a post-transition GPL binary under the same tag; use the new version `v1.4.0-beta.2` or later \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 69003ae..65580e8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,37 +3,31 @@ - Process Bus Insight - IEC 61850 SV, GOOSE, PTP and SCL Analyzer for Windows - - - - + Process Bus Insight — IEC 61850 SV, GOOSE, PTP and SCL Analyzer + + + - - - - + + - - + - - + + - - - - - -
- -
-
- - - - Process Bus Insight - IEC 61850 analyzer - - - - - -
- - code - GitHub - - - download - Download - -
-
-
+
+
+ Process Bus InsightIEC 61850 analyzer + +
codeGitHubdownloadDownload
+
-
- verified Free open-source Windows tool -

IEC 61850 Process Bus visibility for engineers who need answers fast.

-

Analyze live Sampled Values, GOOSE, PTP timing context, and SCL expected-vs-observed evidence, then reproduce sanitized classic PCAP captures through the same decoder path. Built for FAT, SAT, commissioning, and real digital substation troubleshooting.

- -
- - download_for_offline - Download portable ZIP - - - menu_book - User manual - -
- -
- desktop_windows Windows 10/11 - replay PCAP replay - visibility Receive-only -
-
- -
-
-
-
-
hub Process Bus Insight
-
Analyzer ready
-
-
- Process Bus Insight IEC 61850 analyzer dashboard showing waveform, phasor, metering, and stream diagnostics - fullscreen Preview -
-
timeline SV stream view
-
sync PTP context
-
fact_check SCL validation
-
-
+
visibility GPL-3.0-or-later · Receive-only · Windows

IEC 61850 Process Bus visibility for engineers who need defensible answers.

Analyze live Sampled Values, GOOSE, PTP timing context, and SCL expected-vs-observed evidence. Reproduce sanitized classic PCAP captures through the same decoder path while keeping timing and evidence limitations visible.

download_for_offlineDownload portable ZIPmenu_bookUser manual
desktop_windows Windows 10/11replay PCAP replayshield No transmit path
+
hub Process Bus Insight
Analyzer ready
Process Bus Insight dashboard with waveform, phasor, metering, and stream diagnosticsfullscreen Preview
-
-
- download Download and run -

Try the Windows portable package without opening Visual Studio.

-

Get the latest release, extract the ZIP, install Npcap if raw capture is needed, then run the single EXE from the portable folder.

-
-
- - archive - 1. Download ZIP -

Use the latest Windows x64 portable package from GitHub Releases.

- - - rocket_launch - 2. Read Quick Start -

Use the PDF checklist to launch the app and select the correct capture adapter.

- - - support_agent - 3. Troubleshoot safely -

Check adapter, Npcap, mirror port, traffic visibility, and timing limitations.

- -
-
- -
-
- auto_awesome Product capabilities -

Focused features for substation automation engineers.

-

The interface shortens the path from packet capture to usable engineering evidence. It keeps capture limitations visible and avoids pretending that Windows software capture is certified metrology.

-
+
download Download and run

Portable engineering software with current legal notices included.

Use an authorized observation path. Npcap is installed separately only when live raw Ethernet capture is required.

archive1. Download

Portable EXE, checksum, and manifest.

rocket_launch2. Prepare

Review adapter and timing boundaries.

gavel3. Review rights

GPL, history, and commercial path.

-
-
- monitoring -

Sampled Values visibility

-

View SV stream identity, APPID, svID, VLAN, source MAC, continuity state, phasor, waveform, and metering context.

-
-
- lan -

GOOSE inspection

-

Inspect publishers, state changes, stNum, sqNum, typed dataset values, and event history in a cleaner engineering view.

-
-
- schedule -

PTP context

-

Confirm timing traffic presence, transport context, and confidence wording while keeping software timestamp limits explicit.

-
-
- account_tree -

SCL expected-vs-observed

-

Load SCD, ICD, or CID files to compare APPID, VLAN, MAC, DataSet, confRev, and stream identity against live traffic.

-
-
- replay -

Reproducible PCAP replay

-

Feed sanitized classic Ethernet PCAP frames through the same raw analyzer path used by live capture for repeatable regression and troubleshooting.

-
-
- shield -

Receive-only boundary

-

The application listens, decodes, and replays files internally. It does not publish GOOSE/SV traffic and does not send control commands.

-
-
-
- -
-
- route Field workflow -

A practical path from network traffic to engineering conclusion.

-
-
-
-
- 01 - Connect through a safe capture path -

Use a TAP, mirror port, or controlled test switch. Avoid inserting unknown tools into protection-critical paths.

-
-
- 02 - Observe live SV, GOOSE, and PTP -

Identify what is alive first: publisher, VLAN, APPID, stream identity, timing traffic, and basic behaviour.

-
-
- 03 - Load SCL or replay sanitized evidence -

Compare traffic with engineering expectations or reproduce the same decoder/runtime behavior away from site.

-
-
- 04 - Document the finding -

Use clear wording for what was expected, what was observed, and which object needs attention.

-
-
-
- SCL binding workspace showing IEC 61850 expected versus observed traffic - fullscreen Preview -
-
-
+
auto_awesome Capabilities

From packet observation to scoped engineering evidence.

The application shortens the path from traffic to a reviewable finding without treating software capture as certified metrology.

+
monitoring

Sampled Values

Stream identity, APPID, svID, VLAN, continuity, waveform, RMS, phasor, and sequence context.

+
lan

GOOSE inspection

Publisher state, stNum, sqNum, dataset values, and event changes.

+
schedule

PTP context

Timing traffic and freshness with explicit timestamp-source limits.

+
account_tree

SCL comparison

Compare observed traffic with SCD, ICD, or CID expectations.

+
replay

PCAP replay

Reproduce sanitized classic Ethernet captures through the live decoder path.

+
shield

Receive-only

No SV or GOOSE publishing and no IEC 61850 control-command path.

+
-
-
- dashboard Application preview -

Readable screens for real troubleshooting sessions.

-

Click any screenshot to preview it fullscreen with a calm blurred backdrop.

-
-
-
- Validation dashboard for IEC 61850 Process Bus validation - fullscreen Preview -
Validation dashboardExpected-vs-observed validation for engineering review.
-
-
- Diagnostics health workspace - fullscreen Preview -
Diagnostics healthTraffic and timing confidence in one readable workspace.
-
-
- GOOSE inspector workspace - fullscreen Preview -
GOOSE inspectorPublisher state and dataset inspection for troubleshooting.
-
-
- Advanced evidence workspace - fullscreen Preview -
Evidence workspaceBetter discussion material for FAT and commissioning teams.
-
-
-
+
route Engineering workflow

Keep expected, observed, interpreted, and externally proven behavior separate.

01Use an authorized capture path

TAP, mirror port, or controlled engineering switch.

02Observe evidence

Identify stream, publisher, VLAN, APPID, timing context, and capture health.

03Compare or replay

Load SCL expectations or reproduce sanitized traffic offline.

04Record a scoped finding

State what was expected, observed, decoded, and not proven.

SCL expected versus observed workspacefullscreen Preview
-
-
- play_circle Product trailer -

See the engineering problem and product direction in motion.

-
-
-
- -
-
- smart_display - Why Engineers Struggle with IEC 61850 -

The trailer helps first-time users understand the pain point before downloading: packet noise is not enough; engineers need readable, defensible visibility.

- Open on YouTube arrow_outward -
-
-
+
gavel Licensing

GPL community edition with a separate negotiated commercial path.

Post-transition source and packages are GPL-3.0-or-later only. Historical Apache-2.0 grants remain attached to the revisions and artifacts to which they originally applied.

code

Community edition

Use, study, modify, and redistribute under GPL-3.0-or-later and its conditions.

Read GPL

history

Historical boundary

Apache-2.0 ends at 85d43a0fe58a5888a9e8008c168ab76d2333ea87, preserved on archive/apache-2.0-final. Historical v1.4.0-beta.1 artifacts remain historical; this is not a current dual-license offer.

business_center

Commercial discussion

Proprietary integration, OEM/white-label, closed-source redistribution, private branches, or contractual services require a separate commercial agreement. The notice grants no additional rights by itself.

Commercial notice

-
-
- help FAQ for engineers trying the app -

What users usually need to know before download.

-
-
-
- computer What do I need before running it? -

A Windows 10 or Windows 11 PC, a safe network capture path, and Npcap when raw Ethernet capture is required. For real Process Bus testing, use a TAP, mirror port, or controlled test switch.

-
-
- science Can I use it during FAT, SAT, or commissioning? -

Yes. It is designed for visibility, troubleshooting, reproducible capture analysis, and engineering evidence during lab validation, FAT, SAT, and commissioning.

-
-
- security Does it control relays, merging units, or bay controllers? -

No. It is receive-only and raw-passive. It does not publish GOOSE, publish Sampled Values, or send IEC 61850 control commands.

-
-
- description Do I need an SCL file? -

No for live visibility. Yes for deeper expected-vs-observed validation. Loading SCD, ICD, or CID files allows the app to compare live traffic against engineering configuration.

-
-
- replay Which capture files can be replayed? -

v1.4.0-beta.1 supports classic PCAP 2.4 with Ethernet link type 1. PCAPNG and non-Ethernet link types are not yet claimed.

-
-
- timer Can it prove certified timing performance? -

No. Windows software and replay timestamps are useful for screening and troubleshooting, but certification-grade timing proof needs validated test equipment and hardware timestamping.

-
-
- workspace_premium Is it free for professional use? -

Yes. Process Bus Insight is free and open source under Apache-2.0. There is no subscription, license key, or trial limit.

-
-
-
+
help Boundaries

Important questions before field use.

security Does it control equipment?

No. It is receive-only and does not publish SV/GOOSE or send IEC 61850 control commands.

timer Can it prove certified timing?

No. Ordinary Windows/Npcap and replay timestamps are screening evidence, not calibrated timing proof.

verified Does a matching screen prove IED acceptance?

No. External IED reception, trust, and process action require separate evidence.

workspace_premium Can a company obtain proprietary rights?

A separate commercial agreement may be negotiated for rights controlled by the project owner. The repository notice is not itself a commercial license.

- - - - + + diff --git a/docs/site.webmanifest b/docs/site.webmanifest index 6d5868c..c803441 100644 --- a/docs/site.webmanifest +++ b/docs/site.webmanifest @@ -1,22 +1,14 @@ { "name": "Process Bus Insight", "short_name": "Process Bus", - "description": "Free Windows IEC 61850 Process Bus analyzer for SV, GOOSE, PTP timing context, and SCL validation.", + "description": "GPL-3.0-or-later receive-only Windows IEC 61850 Process Bus analyzer for SV, GOOSE, PTP timing context, SCL validation, and PCAP replay.", "start_url": "/DigSubAnalyzer/", "scope": "/DigSubAnalyzer/", "display": "standalone", "background_color": "#f6f8fb", "theme_color": "#f7f9fc", "icons": [ - { - "src": "assets/branding/icon-192.png", - "sizes": "192x192", - "type": "image/png" - }, - { - "src": "assets/branding/icon-512.png", - "sizes": "512x512", - "type": "image/png" - } + {"src": "assets/branding/icon-192.png", "sizes": "192x192", "type": "image/png"}, + {"src": "assets/branding/icon-512.png", "sizes": "512x512", "type": "image/png"} ] } diff --git a/scripts/publish-windows-portable.ps1 b/scripts/publish-windows-portable.ps1 index db6972d..6be03e7 100644 --- a/scripts/publish-windows-portable.ps1 +++ b/scripts/publish-windows-portable.ps1 @@ -1,5 +1,5 @@ param( - [string]$Version = "1.3.0-beta.1", + [string]$Version = "1.4.0-beta.2", [string]$Configuration = "Release", [string]$Runtime = "win-x64", [string]$AppName = "ProcessBusInsight", @@ -10,25 +10,25 @@ param( ) $ErrorActionPreference = "Stop" - $repoRoot = Resolve-Path (Join-Path $PSScriptRoot "..") Set-Location $repoRoot - -if ([string]::IsNullOrWhiteSpace($Version)) { - throw "Version cannot be empty." -} - +if ([string]::IsNullOrWhiteSpace($Version)) { throw "Version cannot be empty." } $requiredReleaseDocs = @( - "docs/QUICK_START.pdf", - "docs/USER_MANUAL.pdf" + "docs/QUICK_START.pdf", "docs/USER_MANUAL.pdf", "LICENSE", "NOTICE", + "COMMERCIAL-LICENSE.md", "COPYRIGHT.md", "TRADEMARK.md", + "THIRD_PARTY_NOTICES.md", "docs/LICENSING.md" ) - foreach ($doc in $requiredReleaseDocs) { - $docPath = Join-Path $repoRoot $doc - if (-not (Test-Path $docPath)) { - throw "Release documentation is missing: $doc. These PDF files must be committed to the repository before running the release workflow. If you just copied the repo upgrade files locally, run: git add -f docs/QUICK_START.pdf docs/USER_MANUAL.pdf" - } + if (-not (Test-Path (Join-Path $repoRoot $doc))) { throw "Required release document is missing: $doc" } +} + +$licenseText = Get-Content (Join-Path $repoRoot "LICENSE") -Raw +if ($licenseText -notmatch 'GNU GENERAL PUBLIC LICENSE' -or $licenseText -notmatch 'Version 3, 29 June 2007') { + throw "Current root LICENSE is not GNU GPL version 3." +} +if (Test-Path (Join-Path $repoRoot "LICENSE-APACHE-2.0")) { + throw "Historical Apache license must not be staged as a current release license." } $portableName = "$AppName-v$Version-$Runtime-portable" @@ -41,133 +41,93 @@ $selfContained = -not $FrameworkDependent.IsPresent $singleFile = -not $MultiFile.IsPresent Write-Host "Publishing $AppName $Version for $Runtime" -Write-Host "Self-contained: $selfContained" -Write-Host "Single-file EXE: $singleFile" - +Write-Host "Community license: GPL-3.0-or-later" Remove-Item -LiteralPath $publishDir -Recurse -Force -ErrorAction SilentlyContinue Remove-Item -LiteralPath $stageDir -Recurse -Force -ErrorAction SilentlyContinue New-Item -ItemType Directory -Path $publishDir, $stageDir, $releaseDir | Out-Null $resolvedProjectPath = (Resolve-Path $ProjectPath).Path +dotnet restore $resolvedProjectPath -r $Runtime /p:ContinuousIntegrationBuild=true +if ($LASTEXITCODE -ne 0) { throw "Runtime-specific restore failed." } -# Runtime-specific restore is done explicitly, then publish runs with --no-restore. -# Do not pass /p:AssemblyName from the command line. MSBuild global properties flow -# into project references too and can trigger NuGet ambiguous project-name errors. -$restoreArgs = @( - "restore", $resolvedProjectPath, - "-r", $Runtime, - "/p:ContinuousIntegrationBuild=true" -) - -dotnet @restoreArgs - -# Split a stable or prerelease label into a numeric prefix (for AssemblyVersion, -# which must be four numeric parts) and an optional suffix. $versionParts = $Version.Split('-', 2) $versionPrefix = $versionParts[0] $versionSuffix = if ($versionParts.Length -gt 1) { $versionParts[1] } else { '' } - $publishArgs = @( - "publish", $resolvedProjectPath, - "--no-restore", - "-c", $Configuration, - "-r", $Runtime, - "-o", $publishDir, - "/p:Version=$Version", - "/p:VersionPrefix=$versionPrefix", - "/p:VersionSuffix=$versionSuffix", - "/p:PackageVersion=$Version", - "/p:AssemblyVersion=$versionPrefix.0", - "/p:FileVersion=$versionPrefix.0", - "/p:InformationalVersion=$Version", + "publish", $resolvedProjectPath, "--no-restore", "-c", $Configuration, + "-r", $Runtime, "-o", $publishDir, + "/p:Version=$Version", "/p:VersionPrefix=$versionPrefix", "/p:VersionSuffix=$versionSuffix", + "/p:PackageVersion=$Version", "/p:AssemblyVersion=$versionPrefix.0", + "/p:FileVersion=$versionPrefix.0", "/p:InformationalVersion=$Version", "/p:PublishSingleFile=$($singleFile.ToString().ToLowerInvariant())", - "/p:IncludeNativeLibrariesForSelfExtract=true", - "/p:EnableCompressionInSingleFile=true", - "/p:PublishTrimmed=false", - "/p:DebugType=None", - "/p:DebugSymbols=false", - "/p:ErrorOnDuplicatePublishOutputFiles=true" + "/p:IncludeNativeLibrariesForSelfExtract=true", "/p:EnableCompressionInSingleFile=true", + "/p:PublishTrimmed=false", "/p:DebugType=None", "/p:DebugSymbols=false", + "/p:ErrorOnDuplicatePublishOutputFiles=true", "--self-contained", $selfContained.ToString().ToLowerInvariant() ) - -if ($selfContained) { - $publishArgs += "--self-contained" - $publishArgs += "true" -} -else { - $publishArgs += "--self-contained" - $publishArgs += "false" -} - dotnet @publishArgs +if ($LASTEXITCODE -ne 0) { throw "Publish failed." } $publishedExe = Join-Path $publishDir "$AppName.exe" if (-not (Test-Path $publishedExe)) { $fallbackExe = Get-ChildItem -Path $publishDir -Filter "*.exe" -File | Select-Object -First 1 - if ($fallbackExe) { - $publishedExe = $fallbackExe.FullName - } + if ($fallbackExe) { $publishedExe = $fallbackExe.FullName } } - if ($singleFile) { - if (-not (Test-Path $publishedExe)) { - throw "Single-file publish did not produce an executable in: $publishDir" - } - Copy-Item -Path $publishedExe -Destination (Join-Path $stageDir "$AppName.exe") -Force -} -else { + if (-not (Test-Path $publishedExe)) { throw "Single-file publish did not produce an executable in: $publishDir" } + Copy-Item $publishedExe (Join-Path $stageDir "$AppName.exe") -Force +} else { $appStageDir = Join-Path $stageDir "app" New-Item -ItemType Directory -Path $appStageDir | Out-Null - Copy-Item -Path (Join-Path $publishDir "*") -Destination $appStageDir -Recurse -Force + Copy-Item (Join-Path $publishDir "*") $appStageDir -Recurse -Force } $packageReadme = @" Process Bus Insight / DigSubAnalyzer Windows portable package Version: $Version +Community license: GPL-3.0-or-later -How to run: -1. Install Npcap on the Windows machine that will capture IEC 61850 Process Bus traffic. -2. Extract this ZIP to a local folder, for example C:\Tools\ProcessBusInsight. +1. Install Npcap separately when live raw Ethernet capture is required. +2. Extract this ZIP to a local folder. 3. Run $AppName.exe. -4. Select a real physical Ethernet adapter connected to a TAP, mirror port, or isolated test network. -5. Start capture and review SV, GOOSE, PTP, diagnostics, and SCL binding views. +4. Use an authorized TAP, mirror port, or isolated engineering test network. -Included documents: -- Quick Start.pdf -- User Manual.pdf +Included legal documents: +LICENSE.txt, NOTICE.txt, COMMERCIAL-LICENSE.md, COPYRIGHT.md, TRADEMARK.md, +THIRD_PARTY_NOTICES.md, and Licensing.md. -Timing note: -Normal Windows/Npcap timestamps are software based. Use timing findings as screening evidence unless the capture path is validated with hardware timestamping, TAP, or trusted timing equipment. +Proprietary, OEM, white-label, closed-source redistribution, private-branch, or contractual service rights require a separate negotiated agreement. The commercial notice grants no additional rights by itself. + +Windows/Npcap timestamps are screening evidence unless independently validated. The software does not prove external IED acceptance or process action. -Project page: https://github.com/masarray/DigSubAnalyzer "@ -Set-Content -Path (Join-Path $stageDir "README.txt") -Value $packageReadme -Encoding UTF8 +Set-Content (Join-Path $stageDir "README.txt") $packageReadme -Encoding UTF8 $copyMap = @( - @{ Source = "LICENSE"; Destination = "LICENSE.txt"; Required = $true }, - @{ Source = "NOTICE"; Destination = "NOTICE.txt"; Required = $false }, - @{ Source = "THIRD_PARTY_NOTICES.md"; Destination = "THIRD_PARTY_NOTICES.md"; Required = $false }, - @{ Source = "docs/QUICK_START.pdf"; Destination = "Quick Start.pdf"; Required = $true }, - @{ Source = "docs/USER_MANUAL.pdf"; Destination = "User Manual.pdf"; Required = $true } + @{ Source = "LICENSE"; Destination = "LICENSE.txt" }, + @{ Source = "NOTICE"; Destination = "NOTICE.txt" }, + @{ Source = "COMMERCIAL-LICENSE.md"; Destination = "COMMERCIAL-LICENSE.md" }, + @{ Source = "COPYRIGHT.md"; Destination = "COPYRIGHT.md" }, + @{ Source = "TRADEMARK.md"; Destination = "TRADEMARK.md" }, + @{ Source = "THIRD_PARTY_NOTICES.md"; Destination = "THIRD_PARTY_NOTICES.md" }, + @{ Source = "docs/LICENSING.md"; Destination = "Licensing.md" }, + @{ Source = "docs/QUICK_START.pdf"; Destination = "Quick Start.pdf" }, + @{ Source = "docs/USER_MANUAL.pdf"; Destination = "User Manual.pdf" } ) - foreach ($item in $copyMap) { $source = Join-Path $repoRoot $item.Source - if (Test-Path $source) { - Copy-Item $source -Destination (Join-Path $stageDir $item.Destination) -Force - } - elseif ($item.Required) { - throw "Required package file missing: $($item.Source). For release documentation PDFs, make sure they are committed with: git add -f docs/QUICK_START.pdf docs/USER_MANUAL.pdf" - } + if (-not (Test-Path $source)) { throw "Required package file missing: $($item.Source)" } + Copy-Item $source (Join-Path $stageDir $item.Destination) -Force } -Remove-Item -LiteralPath $zipPath -Force -ErrorAction SilentlyContinue -Compress-Archive -Path (Join-Path $stageDir "*") -DestinationPath $zipPath -Force - -$hash = Get-FileHash -Path $zipPath -Algorithm SHA256 -$shaLine = "$($hash.Hash.ToLowerInvariant()) $(Split-Path $zipPath -Leaf)" -Set-Content -Path $shaPath -Value $shaLine -Encoding ASCII +if (Test-Path (Join-Path $stageDir "LICENSE-APACHE-2.0")) { + throw "Historical Apache license must not appear in a current GPL package." +} +Remove-Item $zipPath -Force -ErrorAction SilentlyContinue +Compress-Archive -Path (Join-Path $stageDir "*") -DestinationPath $zipPath -Force +$hash = Get-FileHash $zipPath -Algorithm SHA256 +Set-Content $shaPath "$($hash.Hash.ToLowerInvariant()) $(Split-Path $zipPath -Leaf)" -Encoding ASCII Write-Host "Created: $zipPath" Write-Host "Created: $shaPath" diff --git a/scripts/repository-health.ps1 b/scripts/repository-health.ps1 index 68af748..857a724 100644 --- a/scripts/repository-health.ps1 +++ b/scripts/repository-health.ps1 @@ -12,11 +12,22 @@ function Assert-Path([string]$Path) { } } +function Read-RepoText([string]$Path) { + return Get-Content -LiteralPath (Join-Path $repoRoot $Path) -Raw +} + $required = @( "ProcessBusSuite.sln", "Directory.Build.props", "README.md", "LICENSE", + "NOTICE", + "COMMERCIAL-LICENSE.md", + "COPYRIGHT.md", + "TRADEMARK.md", + "CONTRIBUTOR-LICENSE-AGREEMENT.md", + "DCO.txt", + "THIRD_PARTY_NOTICES.md", "SECURITY.md", "CONTRIBUTING.md", "CODE_OF_CONDUCT.md", @@ -26,6 +37,7 @@ $required = @( ".gitattributes", ".gitignore", ".github/CODEOWNERS", + ".github/pull_request_template.md", ".github/workflows/ci.yml", ".github/workflows/runtime-stability.yml", ".github/workflows/runtime-architecture.yml", @@ -34,6 +46,10 @@ $required = @( ".github/workflows/dependency-review.yml", ".github/workflows/pages.yml", ".github/workflows/release-package.yml", + "docs/LICENSING.md", + "docs/LICENSE_TRANSITION_RECORD_2026-07-15.md", + "docs/EXTERNAL_IP_AND_PROVENANCE_REVIEW_2026-07-15.md", + "docs/WORDING_AND_CLAIM_REVIEW_2026-07-15.md", "docs/architecture/STREAM_RUNTIME.md", "docs/architecture/RUNTIME_SNAPSHOT_AND_REPLAY.md", "docs/validation/TESTED_CONFIGURATIONS.md", @@ -50,6 +66,10 @@ $required = @( ) $required | ForEach-Object { Assert-Path $_ } +if (Test-Path (Join-Path $repoRoot "LICENSE-APACHE-2.0")) { + throw "Historical Apache license must not be present as an active root license on the current GPL branch." +} + $forbiddenPatterns = @( '(^|/)(bin|obj|artifacts|TestResults|captures|logs|temp|tmp)(/|$)', '(^|/)ProcessBusAnalyzer\.RnD\.sln$', @@ -64,10 +84,6 @@ $forbiddenPatterns = @( $paths = @() if (Test-Path (Join-Path $repoRoot ".git")) { - # Inspect the repository state that actually exists on disk. Plain - # `git ls-files` also returns tracked files that have just been deleted - # by the synchronization step, and it omits newly added untracked files. - # Both behaviours produce false hygiene results during a clean upgrade. $paths = @(git ls-files --cached --others --exclude-standard | Where-Object { if ([string]::IsNullOrWhiteSpace($_)) { return $false } Test-Path -LiteralPath (Join-Path $repoRoot $_) @@ -88,14 +104,60 @@ foreach ($path in $paths) { } } -[xml]$props = Get-Content -LiteralPath (Join-Path $repoRoot "Directory.Build.props") -Raw +$license = Read-RepoText "LICENSE" +if ($license -notmatch 'GNU GENERAL PUBLIC LICENSE' -or $license -notmatch 'Version 3, 29 June 2007') { + throw "LICENSE is not the GNU General Public License version 3 text." +} +if ($license -match 'Apache License') { + throw "Current root LICENSE contains stale Apache license wording." +} + +[xml]$props = Read-RepoText "Directory.Build.props" +$licenseExpression = $props.SelectSingleNode("/Project/PropertyGroup/PackageLicenseExpression") +if ($null -eq $licenseExpression -or $licenseExpression.InnerText.Trim() -ne 'GPL-3.0-or-later') { + throw "Directory.Build.props must declare GPL-3.0-or-later." +} + +$commercial = Read-RepoText "COMMERCIAL-LICENSE.md" +if ($commercial -notmatch 'not itself a commercial license' -or $commercial -notmatch 'grants no additional rights') { + throw "Commercial notice must state that it is not itself a license and grants no additional rights." +} + +$licensing = Read-RepoText "docs/LICENSING.md" +foreach ($marker in @( + 'GPL-3.0-or-later', + '85d43a0fe58a5888a9e8008c168ab76d2333ea87', + 'archive/apache-2.0-final' +)) { + if ($licensing -notmatch [regex]::Escape($marker)) { + throw "docs/LICENSING.md is missing required marker: $marker" + } +} + +$readme = Read-RepoText "README.md" +if ($readme -notmatch 'GPL-3.0-or-later' -or $readme -notmatch 'COMMERCIAL-LICENSE\.md') { + throw "README does not clearly state the GPL community and commercial licensing model." +} +if ($readme -match 'Source code is licensed under \*\*Apache-2\.0\*\*') { + throw "README still presents Apache-2.0 as the current license." +} + +$site = Read-RepoText "docs/index.html" +if ($site -notmatch 'https://spdx\.org/licenses/GPL-3\.0-or-later\.html') { + throw "Landing-page structured data does not declare GPL-3.0-or-later." +} +if ($site -match 'https://www\.apache\.org/licenses/LICENSE-2\.0') { + throw "Landing page still declares Apache-2.0 as the active structured license." +} +if ($site -notmatch 'commercial agreement' -or $site -notmatch 'grants no additional rights') { + throw "Landing page does not explain the separate commercial path." +} + $prefixNode = $props.SelectSingleNode("/Project/PropertyGroup/VersionPrefix") $suffixNode = $props.SelectSingleNode("/Project/PropertyGroup/VersionSuffix") - if ($null -eq $prefixNode) { throw "VersionPrefix is missing." } $prefix = $prefixNode.InnerText.Trim() $suffix = if ($null -eq $suffixNode) { "" } else { $suffixNode.InnerText.Trim() } - if ([string]::IsNullOrWhiteSpace($prefix)) { throw "VersionPrefix is empty." } $version = if ([string]::IsNullOrWhiteSpace($suffix)) { $prefix } else { "$prefix-$suffix" } Write-Host "Resolved repository version: $version" @@ -104,17 +166,13 @@ if (-not [string]::IsNullOrWhiteSpace($ExpectedVersion) -and $ExpectedVersion -n throw "Version mismatch. Repository=$version, requested=$ExpectedVersion" } -$releaseWorkflow = Get-Content (Join-Path $repoRoot ".github/workflows/release-package.yml") -Raw +$releaseWorkflow = Read-RepoText ".github/workflows/release-package.yml" if ($releaseWorkflow -notmatch [regex]::Escape($version)) { throw "Release workflow does not reference repository version $version." } - -$site = Get-Content (Join-Path $repoRoot "docs/index.html") -Raw if ($site -notmatch ('"softwareVersion"\s*:\s*"' + [regex]::Escape($version) + '"')) { throw "docs/index.html softwareVersion is not $version." } - -$readme = Get-Content (Join-Path $repoRoot "README.md") -Raw if ($readme -notmatch [regex]::Escape("ProcessBusInsight-v$version-win-x64-portable.zip")) { throw "README package example is not synchronized with version $version." } @@ -125,11 +183,13 @@ if ($readme -notmatch 'Category=RuntimeArchitecture') { $releaseNotesPath = "docs/RELEASE_NOTES_v$version.md" Assert-Path $releaseNotesPath -$solution = Get-Content (Join-Path $repoRoot "ProcessBusSuite.sln") -Raw +$solution = Read-RepoText "ProcessBusSuite.sln" if ($solution -notmatch 'ProcessBus.Tests') { throw "ProcessBus.Tests is not included in ProcessBusSuite.sln." } Write-Host "Repository health: PASS" -ForegroundColor Green Write-Host "Version: $version" +Write-Host "Current community license: GPL-3.0-or-later" +Write-Host "Historical Apache boundary: 85d43a0fe58a5888a9e8008c168ab76d2333ea87" Write-Host "Tracked/inspected files: $($paths.Count)" diff --git a/scripts/verify-release-package.ps1 b/scripts/verify-release-package.ps1 index 2a8ee76..6398a04 100644 --- a/scripts/verify-release-package.ps1 +++ b/scripts/verify-release-package.ps1 @@ -5,10 +5,7 @@ param( ) $ErrorActionPreference = "Stop" - -if (-not (Test-Path $PackageZip)) { - throw "Package ZIP not found: $PackageZip" -} +if (-not (Test-Path $PackageZip)) { throw "Package ZIP not found: $PackageZip" } $temp = Join-Path ([System.IO.Path]::GetTempPath()) ("ProcessBusInsightVerify_" + [Guid]::NewGuid().ToString("N")) New-Item -ItemType Directory -Path $temp | Out-Null @@ -21,20 +18,48 @@ try { "Quick Start.pdf", "User Manual.pdf", "README.txt", - "LICENSE.txt" + "LICENSE.txt", + "NOTICE.txt", + "COMMERCIAL-LICENSE.md", + "COPYRIGHT.md", + "TRADEMARK.md", + "THIRD_PARTY_NOTICES.md", + "Licensing.md" ) - foreach ($relative in $required) { - $path = Join-Path $temp $relative - if (-not (Test-Path $path)) { + if (-not (Test-Path (Join-Path $temp $relative))) { throw "Package verification failed. Missing: $relative" } } + if (Test-Path (Join-Path $temp "LICENSE-APACHE-2.0")) { + throw "Package verification failed. Historical Apache license is presented as a current package license." + } + + $license = Get-Content (Join-Path $temp "LICENSE.txt") -Raw + if ($license -notmatch 'GNU GENERAL PUBLIC LICENSE' -or $license -notmatch 'Version 3, 29 June 2007') { + throw "Package verification failed. LICENSE.txt is not GNU GPL version 3." + } + if ($license -match 'Apache License') { + throw "Package verification failed. LICENSE.txt contains stale Apache wording." + } + + $commercial = Get-Content (Join-Path $temp "COMMERCIAL-LICENSE.md") -Raw + if ($commercial -notmatch 'not itself a commercial license' -or $commercial -notmatch 'grants no additional rights') { + throw "Package verification failed. Commercial notice does not state its non-grant boundary." + } + + $licensing = Get-Content (Join-Path $temp "Licensing.md") -Raw + foreach ($marker in @('GPL-3.0-or-later', '85d43a0fe58a5888a9e8008c168ab76d2333ea87', 'archive/apache-2.0-final')) { + if ($licensing -notmatch [regex]::Escape($marker)) { + throw "Package verification failed. Licensing.md is missing: $marker" + } + } + $batFiles = Get-ChildItem -Path $temp -Recurse -File -Filter "*.bat" if ($batFiles.Count -gt 0) { $names = ($batFiles | ForEach-Object { $_.FullName.Substring($temp.Length + 1) }) -join ', ' - throw "Package verification failed. Batch files are not allowed in the portable package: $names" + throw "Package verification failed. Batch files are not allowed: $names" } $exeFiles = Get-ChildItem -Path $temp -File -Filter "*.exe" @@ -44,18 +69,16 @@ try { } $size = (Get-Item (Join-Path $temp "$AppName.exe")).Length - if ($size -lt 1024) { - throw "Package verification failed. Executable looks too small: $size bytes" - } + if ($size -lt 1024) { throw "Package verification failed. Executable looks too small: $size bytes" } foreach ($pdfName in @("Quick Start.pdf", "User Manual.pdf")) { - $pdfPath = Join-Path $temp $pdfName - if ((Get-Item $pdfPath).Length -lt 2048) { + if ((Get-Item (Join-Path $temp $pdfName)).Length -lt 2048) { throw "Package verification failed. PDF document looks too small: $pdfName" } } Write-Host "Package verification passed: $PackageZip" + Write-Host "Community license: GPL-3.0-or-later" } finally { Remove-Item -LiteralPath $temp -Recurse -Force -ErrorAction SilentlyContinue