diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..f45567b --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,217 @@ +name: Build and test + +on: + push: + branches: [main] + tags: ["agent-v*"] + pull_request: + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: build-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ !startsWith(github.ref, 'refs/tags/agent-v') }} + +jobs: + quality: + name: Tests and license checks + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 + with: + go-version-file: go.mod + cache: true + - uses: actions/setup-node@v4 + with: + node-version: 22 + - run: go test ./... + - run: go vet ./... + - run: npm run check:web + - name: Verify license copies and package metadata + shell: bash + run: | + set -euo pipefail + cmp LICENSES/AGPL-3.0-only.txt web/licenses/AGPL-3.0-only.txt + for file in \ + agent/LICENSE \ + agent/package/rmm-agent/LICENSE \ + agent/package/rmm-agent-go/LICENSE \ + agent/package/rmm-agent-go-production/LICENSE \ + agent/package/luci-app-rmm-agent/LICENSE \ + web/licenses/MIT.txt; do + cmp LICENSES/MIT.txt "$file" + done + missing_license="$(grep -L 'PKG_LICENSE:=MIT' agent/package/*/Makefile || true)" + missing_file="$(grep -L 'PKG_LICENSE_FILES:=LICENSE' agent/package/*/Makefile || true)" + test -z "$missing_license" + test -z "$missing_file" + + openwrt-packages: + name: OpenWrt ${{ matrix.release }} · ${{ matrix.label }} + if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/agent-v') + needs: quality + runs-on: ubuntu-24.04 + timeout-minutes: 90 + strategy: + fail-fast: false + max-parallel: 4 + matrix: + include: + # The matrix covers the common CPU families: amd64, mipsel, mips, + # ARMv7 and ARM64. Add a target/subtarget row when another device + # family needs an architecture-specific package. + - { release: "21.02.7", target: x86, subtarget: "64", label: x86-64, goarch: amd64 } + - { release: "21.02.7", target: ramips, subtarget: mt7621, label: ramips-mt7621, goarch: mipsle, gomips: softfloat } + - { release: "21.02.7", target: ath79, subtarget: generic, label: ath79-generic, goarch: mips, gomips: softfloat } + - { release: "21.02.7", target: ipq40xx, subtarget: generic, label: ipq40xx-generic, goarch: arm, goarm: "7" } + - { release: "21.02.7", target: bcm27xx, subtarget: bcm2711, label: bcm27xx-bcm2711, goarch: arm64 } + + - { release: "22.03.7", target: x86, subtarget: "64", label: x86-64, goarch: amd64 } + - { release: "22.03.7", target: ramips, subtarget: mt7621, label: ramips-mt7621, goarch: mipsle, gomips: softfloat } + - { release: "22.03.7", target: ath79, subtarget: generic, label: ath79-generic, goarch: mips, gomips: softfloat } + - { release: "22.03.7", target: ipq40xx, subtarget: generic, label: ipq40xx-generic, goarch: arm, goarm: "7" } + - { release: "22.03.7", target: bcm27xx, subtarget: bcm2711, label: bcm27xx-bcm2711, goarch: arm64 } + + - { release: "23.05.5", target: x86, subtarget: "64", label: x86-64, goarch: amd64 } + - { release: "23.05.5", target: ramips, subtarget: mt7621, label: ramips-mt7621, goarch: mipsle, gomips: softfloat } + - { release: "23.05.5", target: ath79, subtarget: generic, label: ath79-generic, goarch: mips, gomips: softfloat } + - { release: "23.05.5", target: ipq40xx, subtarget: generic, label: ipq40xx-generic, goarch: arm, goarm: "7" } + - { release: "23.05.5", target: bcm27xx, subtarget: bcm2711, label: bcm27xx-bcm2711, goarch: arm64 } + - { release: "23.05.5", target: mediatek, subtarget: filogic, label: mediatek-filogic, goarch: arm64 } + + - { release: "24.10.7", target: x86, subtarget: "64", label: x86-64, goarch: amd64 } + - { release: "24.10.7", target: ramips, subtarget: mt7621, label: ramips-mt7621, goarch: mipsle, gomips: softfloat } + - { release: "24.10.7", target: ath79, subtarget: generic, label: ath79-generic, goarch: mips, gomips: softfloat } + - { release: "24.10.7", target: ipq40xx, subtarget: generic, label: ipq40xx-generic, goarch: arm, goarm: "7" } + - { release: "24.10.7", target: bcm27xx, subtarget: bcm2711, label: bcm27xx-bcm2711, goarch: arm64 } + - { release: "24.10.7", target: mediatek, subtarget: filogic, label: mediatek-filogic, goarch: arm64 } + + - { release: "25.12.4", target: x86, subtarget: "64", label: x86-64, goarch: amd64 } + - { release: "25.12.4", target: ramips, subtarget: mt7621, label: ramips-mt7621, goarch: mipsle, gomips: softfloat } + - { release: "25.12.4", target: ath79, subtarget: generic, label: ath79-generic, goarch: mips, gomips: softfloat } + - { release: "25.12.4", target: ipq40xx, subtarget: generic, label: ipq40xx-generic, goarch: arm, goarm: "7" } + - { release: "25.12.4", target: bcm27xx, subtarget: bcm2711, label: bcm27xx-bcm2711, goarch: arm64 } + - { release: "25.12.4", target: mediatek, subtarget: filogic, label: mediatek-filogic, goarch: arm64 } + + steps: + - uses: actions/checkout@v4 + + - name: Verify agent release version + if: startsWith(github.ref, 'refs/tags/agent-v') + shell: bash + run: | + set -euo pipefail + expected="${GITHUB_REF_NAME#agent-v}" + source_version="$(sed -n 's/^const agentVersion = "\([^"]*\)"/\1/p' agent/go/cmd/rmm-agent/main.go)" + package_version="$(sed -n 's/^PKG_VERSION:=//p' agent/package/rmm-agent-go-production/Makefile)" + test "$source_version" = "$expected" + test "$package_version" = "$expected" + + - name: Resolve official OpenWrt SDK + id: sdk + shell: bash + env: + RELEASE: ${{ matrix.release }} + TARGET: ${{ matrix.target }} + SUBTARGET: ${{ matrix.subtarget }} + run: | + set -euo pipefail + relative="releases/${RELEASE}/targets/${TARGET}/${SUBTARGET}" + record="" + base_url="" + for mirror in https://downloads.openwrt.org https://archive.openwrt.org; do + candidate="${mirror}/${relative}" + if sums="$(curl --fail --location --silent --show-error "${candidate}/sha256sums" 2>/dev/null)"; then + record="$(printf '%s\n' "$sums" | awk ' + $2 ~ /^\*?openwrt-sdk-.*\.Linux-x86_64\.tar\.(xz|zst)$/ { + sub(/^\*/, "", $2); print $1 " " $2; exit + }')" + if [ -n "$record" ]; then + base_url="$candidate" + break + fi + fi + done + if [ -z "$record" ]; then + echo "No SDK found for OpenWrt ${RELEASE} ${TARGET}/${SUBTARGET}" >&2 + exit 1 + fi + read -r sha256 filename <<<"$record" + echo "url=${base_url}/${filename}" >> "$GITHUB_OUTPUT" + echo "sha256=${sha256}" >> "$GITHUB_OUTPUT" + echo "Using ${base_url}/${filename}" + + - uses: docker/setup-buildx-action@v3 + + - name: Build agent and LuCI packages + uses: docker/build-push-action@v6 + with: + context: . + file: deploy/luci-builder/Dockerfile + target: artifacts + push: false + outputs: type=local,dest=artifacts + build-args: | + OPENWRT_SDK_URL=${{ steps.sdk.outputs.url }} + OPENWRT_SDK_SHA256=${{ steps.sdk.outputs.sha256 }} + RMM_GOARCH=${{ matrix.goarch }} + RMM_GOARM=${{ matrix.goarm || '7' }} + RMM_GOMIPS=${{ matrix.gomips || 'softfloat' }} + RMM_GOAMD64=v1 + cache-from: type=gha,scope=openwrt-${{ matrix.release }}-${{ matrix.label }} + cache-to: type=gha,mode=max,scope=openwrt-${{ matrix.release }}-${{ matrix.label }} + + - name: Verify package artifacts + shell: bash + run: | + set -euo pipefail + find artifacts -maxdepth 1 -type f -print + test -f artifacts/SHA256SUMS + (cd artifacts && sha256sum --check SHA256SUMS) + find artifacts -maxdepth 1 -type f \( -name '*.ipk' -o -name '*.apk' \) -print -quit | grep -q . + + - uses: actions/upload-artifact@v4 + with: + name: openwrt-${{ matrix.release }}-${{ matrix.label }} + path: artifacts/* + if-no-files-found: error + retention-days: 30 + + release: + name: Publish agent GitHub release assets + if: startsWith(github.ref, 'refs/tags/agent-v') + needs: openwrt-packages + runs-on: ubuntu-24.04 + permissions: + contents: write + steps: + - uses: actions/download-artifact@v4 + with: + pattern: openwrt-* + path: release-assets + - name: Create release and upload packages + env: + GH_TOKEN: ${{ github.token }} + shell: bash + run: | + set -euo pipefail + mkdir publish + while IFS= read -r file; do + artifact="$(basename "$(dirname "$file")")" + cp "$file" "publish/${artifact}-$(basename "$file")" + done < <(find release-assets -type f \( -name '*.ipk' -o -name '*.apk' \) -print | sort) + (cd publish && sha256sum ./* > SHA256SUMS) + mapfile -t files < <(find publish -type f -print | sort) + if gh release view "${GITHUB_REF_NAME}" --repo "${GITHUB_REPOSITORY}" >/dev/null 2>&1; then + gh release upload "${GITHUB_REF_NAME}" "${files[@]}" \ + --repo "${GITHUB_REPOSITORY}" \ + --clobber + else + gh release create "${GITHUB_REF_NAME}" "${files[@]}" \ + --repo "${GITHUB_REPOSITORY}" \ + --generate-notes \ + --title "OpenWrt RMM Agent ${GITHUB_REF_NAME#agent-v}" + fi diff --git a/.github/workflows/release-server.yml b/.github/workflows/release-server.yml new file mode 100644 index 0000000..b9c1481 --- /dev/null +++ b/.github/workflows/release-server.yml @@ -0,0 +1,85 @@ +name: Release server + +on: + push: + tags: ["server-v*"] + workflow_dispatch: + +permissions: + contents: write + packages: write + +concurrency: + group: server-release-${{ github.ref }} + cancel-in-progress: false + +jobs: + server: + name: Test and build server image + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version-file: go.mod + cache: true + + - name: Test server + run: | + go test ./server/... + go vet ./server/... + + - name: Resolve image version + id: version + shell: bash + run: | + set -euo pipefail + if [[ "$GITHUB_REF" == refs/tags/server-v* ]]; then + version="${GITHUB_REF_NAME#server-v}" + else + version="sha-${GITHUB_SHA::12}" + fi + echo "value=${version}" >> "$GITHUB_OUTPUT" + + - uses: docker/setup-buildx-action@v3 + + - name: Log in to GitHub Container Registry + if: startsWith(github.ref, 'refs/tags/server-v') + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build and optionally publish server image + uses: docker/build-push-action@v6 + with: + context: . + file: Dockerfile + push: ${{ startsWith(github.ref, 'refs/tags/server-v') }} + tags: | + ghcr.io/benya9669/openwrt-rmm-server:${{ steps.version.outputs.value }} + ghcr.io/benya9669/openwrt-rmm-server:latest + labels: | + org.opencontainers.image.title=OpenWrt RMM Server + org.opencontainers.image.source=https://github.com/Benya9669/openwrt-rmm + org.opencontainers.image.revision=${{ github.sha }} + org.opencontainers.image.version=${{ steps.version.outputs.value }} + org.opencontainers.image.licenses=AGPL-3.0-only + cache-from: type=gha,scope=rmm-server + cache-to: type=gha,mode=max,scope=rmm-server + + - name: Create GitHub release + if: startsWith(github.ref, 'refs/tags/server-v') + env: + GH_TOKEN: ${{ github.token }} + shell: bash + run: | + set -euo pipefail + if ! gh release view "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1; then + gh release create "$GITHUB_REF_NAME" \ + --repo "$GITHUB_REPOSITORY" \ + --generate-notes \ + --title "OpenWrt RMM Server ${GITHUB_REF_NAME#server-v}" + fi diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..395a6fc --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,24 @@ +# OpenWrt RMM licensing + +Copyright (c) 2026 Benya. + +This repository uses separate licenses for the cloud application and the OpenWrt +components: + +- `server/` and `web/` are licensed under the GNU Affero General Public License, + version 3 only (`AGPL-3.0-only`). The canonical license text is in + `LICENSES/AGPL-3.0-only.txt`. +- `agent/`, including the Go agent, shell compatibility agent, LuCI application, + OpenWrt package recipes and their configuration files, is licensed under the MIT + License. The license text is in `LICENSES/MIT.txt` and `agent/LICENSE`. +- Documentation outside those directories is licensed under `AGPL-3.0-only`, unless a + file states otherwise. + +Third-party dependencies retain their own licenses. Partner names, logos and other +third-party brand assets under `web/assets/partners/` are not licensed as part of the +software. See `NOTICE.md`. + +Commercial licensing may be available from the copyright holder for organizations that +cannot use the server and web application under AGPL-3.0-only. + +SPDX-License-Identifier: AGPL-3.0-only AND MIT diff --git a/LICENSES/AGPL-3.0-only.txt b/LICENSES/AGPL-3.0-only.txt new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSES/AGPL-3.0-only.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..2498e30 --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Benya + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 0000000..88078f0 --- /dev/null +++ b/NOTICE.md @@ -0,0 +1,21 @@ +# Notices + +Copyright (c) 2026 Benya. + +## Partner assets + +Files under `web/assets/partners/` contain names, logos or other identifying marks of +third parties. They are displayed for identification of project partners only. They are +not covered by the AGPL-3.0-only or MIT grants in this repository, and no trademark +license or endorsement is implied. Permission from the relevant rights holder may be +required before redistribution or reuse. + +## Third-party software + +OpenWrt RMM uses third-party Go modules and operating-system packages. Those components +remain subject to their respective license notices. `go.mod`, `go.sum`, the container +base images and OpenWrt package metadata identify the versions used to build a release. +Redistributors are responsible for preserving applicable third-party notices. + +OpenWrt and LuCI are names of their respective projects. This project is not presented as +an official OpenWrt or LuCI distribution. diff --git a/RELEASES.md b/RELEASES.md new file mode 100644 index 0000000..fd867eb --- /dev/null +++ b/RELEASES.md @@ -0,0 +1,59 @@ +# Release policy + +OpenWrt RMM versions the cloud application and router bundle independently with Semantic +Versioning. + +## Server releases + +Tags use `server-vMAJOR.MINOR.PATCH`, for example `server-v0.8.0`. + +A server release contains the Go API, web interface, database migrations and deployment +files. The GitHub Actions server workflow tests the server and publishes: + +```text +ghcr.io/benya9669/openwrt-rmm-server:0.8.0 +ghcr.io/benya9669/openwrt-rmm-server:latest +``` + +Increment `MAJOR` for incompatible API or migration requirements, `MINOR` for compatible +features, and `PATCH` for compatible fixes. Database backups remain mandatory before a +production upgrade even when the release is marked compatible. + +## Agent releases + +Tags use `agent-vMAJOR.MINOR.PATCH`, for example `agent-v0.6.2`. + +An agent release contains the Go runtime, LuCI application and OpenWrt IPK/APK packages. +Before tagging, the tag version must match `agentVersion` in the Go source and +`PKG_VERSION` in the production Go package. CI rejects a mismatched release tag. + +The LuCI application is shipped as part of the router bundle. It can retain its own package +version for package-manager upgrades, but it does not require a separate GitHub release +line unless it later becomes an independent product. + +## Protocol compatibility + +Server and agent versions do not need to match. Compatibility is determined by the agent +API protocol, currently `v1`. Within the same protocol major version: + +- a newer server should continue to accept supported older agents; +- a newer agent should tolerate unknown response fields and optional server features; +- required capabilities must be negotiated or reported explicitly rather than inferred + only from the package version. + +An intentional incompatible protocol change requires a new API version and a documented +transition period; it should not silently reuse `v1`. + +## Release commands + +```sh +git tag -a server-v0.8.0 -m "OpenWrt RMM Server 0.8.0" +git push origin server-v0.8.0 + +git tag -a agent-v0.6.2 -m "OpenWrt RMM Agent 0.6.2" +git push origin agent-v0.6.2 +``` + +Pushing a server tag publishes the container image and creates a GitHub Release. Pushing +an agent tag builds the full OpenWrt matrix and creates a GitHub Release with packages and +checksums. `workflow_dispatch` can test either workflow without creating a release. diff --git a/agent/LICENSE b/agent/LICENSE new file mode 100644 index 0000000..2498e30 --- /dev/null +++ b/agent/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Benya + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/agent/README.md b/agent/README.md index 33b077c..cd2b4da 100644 --- a/agent/README.md +++ b/agent/README.md @@ -5,6 +5,10 @@ and the last heartbeat transport error after connectivity is restored. Production Go agent for OpenWrt, with the shell implementation retained as a fallback runtime. +The agent, LuCI application and OpenWrt packaging under `agent/` are licensed under the +MIT License. Binary OpenWrt packages install a copy of the license under +`/usr/share/licenses//LICENSE`. + The agent uses outbound HTTP polling: 1. Enrolls with the server using an enrollment token. diff --git a/agent/package/luci-app-rmm-agent/LICENSE b/agent/package/luci-app-rmm-agent/LICENSE new file mode 100644 index 0000000..2498e30 --- /dev/null +++ b/agent/package/luci-app-rmm-agent/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Benya + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/agent/package/luci-app-rmm-agent/Makefile b/agent/package/luci-app-rmm-agent/Makefile index fbd0494..7ef3dcb 100644 --- a/agent/package/luci-app-rmm-agent/Makefile +++ b/agent/package/luci-app-rmm-agent/Makefile @@ -1,11 +1,13 @@ +# SPDX-License-Identifier: MIT include $(TOPDIR)/rules.mk PKG_NAME:=luci-app-rmm-agent PKG_VERSION:=0.2.1 -PKG_RELEASE:=1 +PKG_RELEASE:=2 PKG_MAINTAINER:=RMM OpenWrt PKG_LICENSE:=MIT +PKG_LICENSE_FILES:=LICENSE include $(INCLUDE_DIR)/package.mk @@ -35,6 +37,8 @@ define Package/luci-app-rmm-agent/install $(INSTALL_DIR) $(1)/usr/share/rpcd/acl.d $(INSTALL_DATA) ./root/usr/share/rpcd/acl.d/luci-app-rmm-agent.json \ $(1)/usr/share/rpcd/acl.d/luci-app-rmm-agent.json + $(INSTALL_DIR) $(1)/usr/share/licenses/luci-app-rmm-agent + $(INSTALL_DATA) ./LICENSE $(1)/usr/share/licenses/luci-app-rmm-agent/LICENSE endef $(eval $(call BuildPackage,luci-app-rmm-agent)) diff --git a/agent/package/luci-app-rmm-agent/README.md b/agent/package/luci-app-rmm-agent/README.md index 9fe13c8..dce041c 100644 --- a/agent/package/luci-app-rmm-agent/README.md +++ b/agent/package/luci-app-rmm-agent/README.md @@ -67,8 +67,8 @@ application to the router. Do not copy or install the shell runtime at the same cd dist/rmm-openwrt-25.12.4-ramips-mt7621 sha256sum -c SHA256SUMS scp \ - rmm-agent-go-production-0.6.1-r1.apk \ - luci-app-rmm-agent-0.2.1-r1.apk \ + rmm-agent-go-production-0.6.1-r2.apk \ + luci-app-rmm-agent-0.2.1-r2.apk \ root@ROUTER_IP:/tmp/ ``` @@ -76,8 +76,8 @@ Then install the locally built, unsigned packages over SSH: ```sh apk add --allow-untrusted \ - /tmp/rmm-agent-go-production-0.6.1-r1.apk \ - /tmp/luci-app-rmm-agent-0.2.1-r1.apk + /tmp/rmm-agent-go-production-0.6.1-r2.apk \ + /tmp/luci-app-rmm-agent-0.2.1-r2.apk /etc/init.d/rpcd restart /etc/init.d/uhttpd restart ``` diff --git a/agent/package/rmm-agent-go-production/LICENSE b/agent/package/rmm-agent-go-production/LICENSE new file mode 100644 index 0000000..2498e30 --- /dev/null +++ b/agent/package/rmm-agent-go-production/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Benya + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/agent/package/rmm-agent-go-production/Makefile b/agent/package/rmm-agent-go-production/Makefile index 51bd7aa..4a5cff9 100644 --- a/agent/package/rmm-agent-go-production/Makefile +++ b/agent/package/rmm-agent-go-production/Makefile @@ -1,11 +1,13 @@ +# SPDX-License-Identifier: MIT include $(TOPDIR)/rules.mk PKG_NAME:=rmm-agent-go-production PKG_VERSION:=0.6.1 -PKG_RELEASE:=1 +PKG_RELEASE:=2 PKG_MAINTAINER:=RMM OpenWrt PKG_LICENSE:=MIT +PKG_LICENSE_FILES:=LICENSE include $(INCLUDE_DIR)/package.mk @@ -42,6 +44,8 @@ define Package/rmm-agent-go-production/install $(INSTALL_CONF) ./files/etc/config/rmm-agent $(1)/etc/config/rmm-agent $(INSTALL_DIR) $(1)/usr/libexec $(INSTALL_BIN) ./files/usr/libexec/rmm-agent-uci-sync $(1)/usr/libexec/rmm-agent-uci-sync + $(INSTALL_DIR) $(1)/usr/share/licenses/rmm-agent-go-production + $(INSTALL_DATA) ./LICENSE $(1)/usr/share/licenses/rmm-agent-go-production/LICENSE endef $(eval $(call BuildPackage,rmm-agent-go-production)) diff --git a/agent/package/rmm-agent-go/LICENSE b/agent/package/rmm-agent-go/LICENSE new file mode 100644 index 0000000..2498e30 --- /dev/null +++ b/agent/package/rmm-agent-go/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Benya + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/agent/package/rmm-agent-go/Makefile b/agent/package/rmm-agent-go/Makefile index 8b82e62..74d9c70 100644 --- a/agent/package/rmm-agent-go/Makefile +++ b/agent/package/rmm-agent-go/Makefile @@ -1,11 +1,13 @@ +# SPDX-License-Identifier: MIT include $(TOPDIR)/rules.mk PKG_NAME:=rmm-agent-go PKG_VERSION:=0.6.1 -PKG_RELEASE:=1 +PKG_RELEASE:=2 PKG_MAINTAINER:=RMM OpenWrt PKG_LICENSE:=MIT +PKG_LICENSE_FILES:=LICENSE include $(INCLUDE_DIR)/package.mk @@ -35,6 +37,8 @@ define Package/rmm-agent-go/install $(INSTALL_BIN) ./files/etc/init.d/rmm-agent-go $(1)/etc/init.d/rmm-agent-go $(INSTALL_DIR) $(1)/etc $(INSTALL_CONF) ./files/etc/rmm-agent-go.conf $(1)/etc/rmm-agent-go.conf + $(INSTALL_DIR) $(1)/usr/share/licenses/rmm-agent-go + $(INSTALL_DATA) ./LICENSE $(1)/usr/share/licenses/rmm-agent-go/LICENSE endef $(eval $(call BuildPackage,rmm-agent-go)) diff --git a/agent/package/rmm-agent/LICENSE b/agent/package/rmm-agent/LICENSE new file mode 100644 index 0000000..2498e30 --- /dev/null +++ b/agent/package/rmm-agent/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Benya + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/agent/package/rmm-agent/Makefile b/agent/package/rmm-agent/Makefile index 679f434..b18e28f 100644 --- a/agent/package/rmm-agent/Makefile +++ b/agent/package/rmm-agent/Makefile @@ -1,11 +1,13 @@ +# SPDX-License-Identifier: MIT include $(TOPDIR)/rules.mk PKG_NAME:=rmm-agent PKG_VERSION:=0.1.1 -PKG_RELEASE:=2 +PKG_RELEASE:=3 PKG_MAINTAINER:=RMM OpenWrt PKG_LICENSE:=MIT +PKG_LICENSE_FILES:=LICENSE include $(INCLUDE_DIR)/package.mk @@ -41,6 +43,8 @@ define Package/rmm-agent/install $(INSTALL_CONF) ./files/etc/config/rmm-agent $(1)/etc/config/rmm-agent $(INSTALL_DIR) $(1)/usr/libexec $(INSTALL_BIN) ./files/usr/libexec/rmm-agent-uci-sync $(1)/usr/libexec/rmm-agent-uci-sync + $(INSTALL_DIR) $(1)/usr/share/licenses/rmm-agent + $(INSTALL_DATA) ./LICENSE $(1)/usr/share/licenses/rmm-agent/LICENSE endef $(eval $(call BuildPackage,rmm-agent)) diff --git a/deploy/luci-builder/Dockerfile b/deploy/luci-builder/Dockerfile index d737e17..1696b12 100644 --- a/deploy/luci-builder/Dockerfile +++ b/deploy/luci-builder/Dockerfile @@ -22,7 +22,7 @@ RUN export CGO_ENABLED=0 GOOS=linux GOARCH="${RMM_GOARCH}" \ && go build -trimpath -ldflags="-s -w" \ -o /out/rmm-agent ./agent/go/cmd/rmm-agent -FROM debian:bookworm-slim AS builder +FROM debian:bookworm-slim AS sdk ARG OPENWRT_SDK_URL="https://downloads.openwrt.org/releases/25.12.4/targets/ramips/mt7621/openwrt-sdk-25.12.4-ramips-mt7621_gcc-14.3.0_musl.Linux-x86_64.tar.zst" ARG OPENWRT_SDK_SHA256="03f4766fcfbae86a814cbbf194226fa7e9ec66be2d4273bc1a0927a72a43a333" @@ -50,12 +50,23 @@ RUN apt-get update \ USER builder WORKDIR /home/builder -RUN curl --fail --location --show-error --silent \ - --output openwrt-sdk.tar.zst "${OPENWRT_SDK_URL}" \ - && echo "${OPENWRT_SDK_SHA256} openwrt-sdk.tar.zst" | sha256sum --check --strict \ +RUN case "${OPENWRT_SDK_URL}" in \ + *.tar.xz) sdk_archive="openwrt-sdk.tar.xz" ;; \ + *.tar.zst) sdk_archive="openwrt-sdk.tar.zst" ;; \ + *) echo "unsupported OpenWrt SDK URL: ${OPENWRT_SDK_URL}" >&2; exit 1 ;; \ + esac \ + && curl --fail --location --show-error --silent \ + --output "${sdk_archive}" "${OPENWRT_SDK_URL}" \ + && echo "${OPENWRT_SDK_SHA256} ${sdk_archive}" | sha256sum --check --strict \ && mkdir sdk \ - && tar --zstd --extract --file openwrt-sdk.tar.zst --strip-components=1 --directory sdk \ - && rm openwrt-sdk.tar.zst + && case "${sdk_archive}" in \ + *.tar.xz) tar --extract --xz --file "${sdk_archive}" --strip-components=1 --directory sdk ;; \ + *.tar.zst) tar --extract --zstd --file "${sdk_archive}" --strip-components=1 --directory sdk ;; \ + *) echo "unsupported OpenWrt SDK archive: ${sdk_archive}" >&2; exit 1 ;; \ + esac \ + && rm "${sdk_archive}" + +FROM sdk AS builder USER root @@ -112,8 +123,7 @@ RUN printf '%s\n' \ >> .config \ && make defconfig -RUN grep -E '^CONFIG_PACKAGE_(libmbedtls|libustream-mbedtls)=' .config \ - && make -j"$(nproc)" package/feeds/base/mbedtls/compile \ +RUN make -j"$(nproc)" package/feeds/base/mbedtls/compile \ && make -j"$(nproc)" package/feeds/base/ustream-ssl/compile RUN make -j"$(nproc)" \ diff --git a/docs/openwrt.md b/docs/openwrt.md index 8808cde..dd48186 100644 --- a/docs/openwrt.md +++ b/docs/openwrt.md @@ -126,3 +126,29 @@ The production agent should either: - be rewritten in Go; - include a tiny JSON parser strategy; - keep a stable shell-oriented command polling endpoint. + +## GitHub Actions package matrix + +`.github/workflows/build.yml` runs Go, web and license checks on every push and pull +request. A manual workflow run or a tag matching `agent-v*` additionally builds installable +OpenWrt packages through the official SDKs. + +The release matrix covers OpenWrt `21.02.7`, `22.03.7`, `23.05.5`, `24.10.7` and +`25.12.4`, and these common CPU/target families where the target exists: + +- x86-64 (`x86/64`, `amd64`); +- MediaTek MT7621 (`ramips/mt7621`, `mipsle`); +- Atheros (`ath79/generic`, `mips`); +- Qualcomm IPQ40xx (`ipq40xx/generic`, ARMv7); +- Raspberry Pi 4 (`bcm27xx/bcm2711`, ARM64); +- MediaTek Filogic (`mediatek/filogic`, ARM64) on supported releases. + +The workflow resolves each SDK filename and SHA256 from the official OpenWrt mirror, +falling back to the OpenWrt archive for end-of-life branches. Releases through `24.10` +produce `.ipk`; `25.12` produces `.apk`. Manual runs retain each target as a workflow +artifact for 30 days. An `agent-v*` tag also creates a GitHub Release containing all packages and +a combined `SHA256SUMS`. + +This matrix represents common CPU families, not every OpenWrt target. Add an explicit +matrix row for another target/subtarget and select the matching Go architecture rather +than assuming binaries from a different CPU family are compatible. diff --git a/server/README.md b/server/README.md index 7959493..ad4dab8 100644 --- a/server/README.md +++ b/server/README.md @@ -1,5 +1,10 @@ # RMM OpenWrt Server +The server and bundled web application are licensed under `AGPL-3.0-only`. A deployed +modified version must keep a working offer of its corresponding source available to remote +users. The default legal page links to the project repository; downstream deployments must +update that link if their corresponding source is hosted elsewhere. + MVP backend for OpenWrt RMM. ## Run diff --git a/web/README.md b/web/README.md index cd64459..ad9c938 100644 --- a/web/README.md +++ b/web/README.md @@ -14,12 +14,17 @@ Then open: http://127.0.0.1:8080/ public landing page http://127.0.0.1:8080/login sign in and password recovery http://127.0.0.1:8080/app authenticated RMM cabinet +http://127.0.0.1:8080/legal.html license notices and source offer ``` The UI uses a revocable HttpOnly server-side session. It does not store operator tokens in browser storage. Normal users see only their own routers and can create one-time enrollment grants; administrators can create user accounts. +The server and web interface are licensed under `AGPL-3.0-only`. Keep the source-code +link on `legal.html` available to users of a deployed modified version and point it to the +corresponding source for that deployment. + Current MVP features: - device list and detail; diff --git a/web/index.html b/web/index.html index 2eda661..ad11253 100644 --- a/web/index.html +++ b/web/index.html @@ -11,7 +11,7 @@ - +
@@ -90,7 +90,10 @@ -
OpenWrt RMMБезопасное управление вашей сетью
+