From 023d6f0fda7c2cfa8c89bfbcfa3e4a4de93be973 Mon Sep 17 00:00:00 2001 From: "Donald F. Coffin" Date: Sat, 14 Nov 2026 12:26:32 -0500 Subject: [PATCH] docs: mark the repo pre-release; add SECURITY.md and root LICENSE - README: pre-release warning banner pointing vulnerability reports to SECURITY.md; the module table no longer claims "Production" and now lists openespi-handoff and the real per-module status (#232, #89, deferred writes). The deployment section describes the current Spring Boot JARs, actuator health and build-image (no WAR, no Helm charts exist), and the documentation links point at files that exist. - SECURITY.md: private reporting through GitHub security advisories, what to expect, scope. - LICENSE: the Apache-2.0 text already shipped in each module, at the root, so GitHub detects the licence (it reported none) and README's ./LICENSE link resolves. Co-Authored-By: Claude Opus 5.5 --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 70 ++++++++++-------- SECURITY.md | 43 +++++++++++ 3 files changed, 283 insertions(+), 31 deletions(-) create mode 100644 LICENSE create mode 100644 SECURITY.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 179d424e6..b0c1cd8ef 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # OpenESPI GreenButton Java -Complete monorepo implementation of the NAESB Energy Services Provider Interface (ESPI) 4.0 specification for Green Button energy data standards. +> [!WARNING] +> **Pre-release: not for production use.** This repository is under active development and has +> not had its first release. The customer authorization flow is incomplete, and known security +> issues are being fixed under private advisories. Do not deploy it with real customer data. To +> report a vulnerability, see [SECURITY.md](./SECURITY.md); please do not open a public issue. + +Monorepo implementation of the NAESB Energy Services Provider Interface (ESPI) specification (REQ.21 v4.1) for Green Button energy data standards. ## 🚀 Quick Start @@ -12,19 +18,23 @@ cd OpenESPI-GreenButton-Java # Build all modules (Java 25 + Jakarta EE throughout) mvn clean install -# Run Spring Boot 3.5 modules +# Run the Spring Boot applications (H2, no external database: add -Dspring-boot.run.profiles=local) cd openespi-datacustodian && mvn spring-boot:run cd openespi-authserver && mvn spring-boot:run ``` ## 📦 Modules -| Module | Description | Java | Jakarta EE | Spring Boot | Status | -|--------|-------------|------|------------|-------------|--------| -| **openespi-common** | Shared domain models, services | 25 ✅ | 11 ✅ | 4.0.1 ✅ | **Production** | -| **openespi-datacustodian** | OAuth2 resource server | 25 ✅ | 11 ✅ | 4.0.1 ✅ | **Production** | -| **openespi-authserver** | OAuth2 authorization server | 25 ✅ | 11 ✅ | 4.0.1 ✅ | **Production** | -| **openespi-thirdparty** | Client application | 25 ✅ | ✅ | 4.0.1 ⚠️ | **Partial Migration** | +All modules build with Java 25, Jakarta EE 11 and Spring Boot 4.1. Status is tracked in the +[CANONICAL BUILD PLAN epic (#119)](https://github.com/GreenButtonAlliance/OpenESPI-GreenButton-Java/issues/119). + +| Module | Description | Status | +|--------|-------------|--------| +| **openespi-handoff** | Signed AS↔DC customer-flow handoff codec | Pre-release | +| **openespi-common** | Shared ESPI domain model, DTOs, mappers, services | Pre-release | +| **openespi-datacustodian** | ESPI resource server (opaque-token introspection) | Pre-release: GET API only; write endpoints deferred | +| **openespi-authserver** | OAuth2 authorization server | Pre-release: delegated customer flow incomplete (#232) | +| **openespi-thirdparty** | ESPI third-party client | Pre-release: data import not implemented (#89) | ## 🏗️ Architecture @@ -44,9 +54,10 @@ cd openespi-authserver && mvn spring-boot:run ``` **Module Dependencies:** +- **openespi-handoff**: Infrastructure-only handoff codec (no ESPI domain types) - **openespi-common**: Foundation library (no dependencies on other modules) -- **openespi-datacustodian**: Depends on openespi-common -- **openespi-authserver**: **Independent** (no dependency on openespi-common) +- **openespi-datacustodian**: Depends on openespi-common and openespi-handoff +- **openespi-authserver**: Depends on openespi-handoff only (**no** dependency on openespi-common) - **openespi-thirdparty**: Depends on openespi-common ## ✨ Migration Achievements @@ -236,28 +247,22 @@ mvn flyway:info -pl openespi-common ## 🚀 Deployment -Each module has independent deployment capabilities: -- **Common**: Maven Central library (shared dependency) -- **DataCustodian**: Kubernetes/Docker deployment (Spring Boot 3.5 JAR) -- **AuthServer**: Kubernetes/Docker deployment (Spring Boot 3.5 JAR) -- **ThirdParty**: WAR deployment to Tomcat/Jetty ⚠️ **Temporary** - awaiting Spring Boot 3.5 migration for containerization - -**Note on ThirdParty Deployment:** -ThirdParty currently uses legacy WAR packaging because it runs on Spring Framework (not Spring Boot) with JSP/JSTL views. Once the Spring Boot 3.5 migration completes, it will switch to executable JAR packaging with embedded server and Docker/Kubernetes deployment like the other modules. +There is no release yet; see the warning at the top. The three applications are executable +Spring Boot JARs (Thymeleaf views, embedded Tomcat). Each exposes `/actuator/health` (with +`liveness` and `readiness` groups) for orchestrators; other actuator endpoints require an admin +access token. -### Docker Build +### Container images ```bash -# Build individual service images -cd openespi-datacustodian && docker build -t openespi-datacustodian . +# OCI image via Cloud Native Buildpacks (what the release workflow uses for the Data Custodian) +mvn spring-boot:build-image -DskipTests -pl openespi-datacustodian + +# The Authorization Server also has a Dockerfile cd openespi-authserver && docker build -t openespi-authserver . ``` -### Kubernetes Deployment -```bash -# Deploy with Helm -helm install openespi-datacustodian ./helm/datacustodian -helm install openespi-authserver ./helm/authserver -``` +Releasing is described in [RELEASING.md](./RELEASING.md) and CI in +[.github/CI_CD_SETUP.md](./.github/CI_CD_SETUP.md). ## 🌿 Branch Structure @@ -273,10 +278,13 @@ All original commit history has been preserved using git subtree. ## 📚 Documentation -- [Migration Status](./MIGRATION_STATUS.md) - Detailed migration information -- [Development Guide](./docs/DEVELOPMENT.md) - Development workflow -- [Deployment Guide](./docs/DEPLOYMENT.md) - Production deployment -- [API Documentation](./docs/API.md) - REST API reference +- [CANONICAL BUILD PLAN (#119)](https://github.com/GreenButtonAlliance/OpenESPI-GreenButton-Java/issues/119) - status and roadmap +- [CI/CD setup](./.github/CI_CD_SETUP.md) and [Releasing](./RELEASING.md) +- [openespi-handoff](./openespi-handoff/README.md) - AS↔DC signed-handoff contract +- [Authorization Server deployment guide](./openespi-authserver/DEPLOYMENT_GUIDE.md) +- [Contributing guidelines](./openespi-common/CONTRIBUTING.md) +- [Green Button API documentation](https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/) +- [Security policy](./SECURITY.md) ## 🤝 Contributing diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..e44c4b10a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,43 @@ +# Security Policy + +## Supported versions + +OpenESPI-GreenButton-Java is **pre-release**: there is no released version yet, and nothing in +this repository should be deployed with real customer data. Security fixes are made on `main`. + +| Version | Supported | +|---|---| +| `main` (4.0.0-SNAPSHOT) | Yes: fixes land here | +| Any earlier tag or fork | No | + +## Reporting a vulnerability + +**Please do not report security vulnerabilities in public GitHub issues, discussions or pull +requests.** + +Report them privately through GitHub: + +1. Open the repository's **Security** tab. +2. Choose **Report a vulnerability** + ([direct link](https://github.com/GreenButtonAlliance/OpenESPI-GreenButton-Java/security/advisories/new)). +3. Describe the issue, the affected module (`openespi-authserver`, `openespi-datacustodian`, + `openespi-thirdparty`, `openespi-common` or `openespi-handoff`), the steps to reproduce it, + and its impact. + +Your report is visible only to you and the maintainers. + +## What to expect + +- We aim to acknowledge a report within **5 business days**. +- We will confirm or rule out the issue, and keep you informed while we work on a fix. +- Fixes are developed in a private advisory fork. The advisory is published, with a CVE where + appropriate, once a fix is on `main`. +- We are happy to credit reporters in the advisory. Tell us if you prefer to stay anonymous. + +## Scope + +In scope: the code in this repository, including its OAuth2 flows (authorization server, +resource server, third-party client), ESPI XML handling and the build and CI configuration. + +Out of scope: vulnerabilities in third-party dependencies that are already publicly known +(Dependabot tracks these), and deployments of this code operated by others.