diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..4dda4814 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: 🐛 Bug Report +about: If something isn't working as expected 🤔. +--- + +## Bug Report + +### Current behavior + + + + + +### Expected behavior + + + +### Environment + +- Updater version: +- OS and platform: + +### Additional context + + diff --git a/.github/workflows/check-certificates.yml b/.github/workflows/check-certificates.yml new file mode 100644 index 00000000..976df471 --- /dev/null +++ b/.github/workflows/check-certificates.yml @@ -0,0 +1,99 @@ +name: Check for issues with signing certificates + +on: + schedule: + # run every 10 hours + - cron: "0 */10 * * *" + # workflow_dispatch event allows the workflow to be triggered manually. + # This could be used to run an immediate check after updating certificate secrets. + # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + +env: + # Begin notifications when there are less than this many days remaining before expiration + EXPIRATION_WARNING_PERIOD: 30 + +jobs: + get-certificates-list: + # This workflow would fail in forks that don't have the certificate secrets defined + if: github.repository == 'arduino/FirmwareUpdater' + runs-on: ubuntu-latest + outputs: + certificates: ${{ steps.get-files.outputs.certificates }} + + steps: + - name: checkout + uses: actions/checkout@v2 + + - name: Set certificates path environment variable + run: | + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + echo "FILES=\"$(ls ${{ github.workspace }}/certs/* | xargs | sed 's/ /","/g')\"" >> $GITHUB_ENV + + - name: Get files list + id: get-files + run: | + JSON=$(echo '[${{ join(env.FILES) }}]' | jq -c '{"cert_file": .}') + echo "::set-output name=certificates::$JSON" + + check-certificates: + # This workflow would fail in forks that don't have the certificate secrets defined + if: github.repository == 'arduino/FirmwareUpdater' + runs-on: ubuntu-latest + needs: get-certificates-list + + strategy: + fail-fast: false + matrix: ${{fromJSON(needs.get-certificates-list.outputs.certificates)}} + + steps: + - name: checkout + uses: actions/checkout@v2 + + - name: Get days remaining before certificate expiration date + id: get-days-before-expiration + run: | + EXPIRATION_DATE="$( + ( + openssl x509 \ + -inform der \ + -in ${{ matrix.cert_file }} \ + -enddate -noout + ) | ( + grep \ + --max-count=1 \ + --only-matching \ + --perl-regexp \ + 'notAfter=(\K.*)' + ) + )" + + DAYS_BEFORE_EXPIRATION="$((($(date --utc --date="$EXPIRATION_DATE" +%s) - $(date --utc +%s)) / 60 / 60 / 24))" + + # Display the expiration information in the log + echo "Certificate expiration date: $EXPIRATION_DATE" + echo "Days remaining before expiration: $DAYS_BEFORE_EXPIRATION" + + echo "::set-output name=days::$DAYS_BEFORE_EXPIRATION" + + - name: Check if expiration notification period has been reached + id: check-expiration + run: | + DAYS=${{ steps.get-days-before-expiration.outputs.days }} + if [[ $DAYS -lt ${{ env.EXPIRATION_WARNING_PERIOD }} ]]; then + echo "::error::${{ matrix.cert_file }} will expire in $DAYS days!!!" + exit 1 + fi + + - name: Slack notification of pending certificate expiration + # Don't send spurious expiration notification if verification fails + if: failure() && steps.check-expiration.outcome == 'failure' + uses: rtCamp/action-slack-notify@v2.1.0 + env: + SLACK_WEBHOOK: ${{ secrets.TEAM_TOOLING_CHANNEL_SLACK_WEBHOOK }} + SLACK_MESSAGE: | + :warning::warning::warning::warning: + WARNING: ${{ github.repository }} ${{ matrix.cert_file }} will expire in ${{ steps.get-days-before-expiration.outputs.days }} days!!! + :warning::warning::warning::warning: + SLACK_COLOR: danger + MSG_MINIMAL: true diff --git a/.github/workflows/check-notarization-certificates.yml b/.github/workflows/check-notarization-certificates.yml new file mode 100644 index 00000000..b9f2f26d --- /dev/null +++ b/.github/workflows/check-notarization-certificates.yml @@ -0,0 +1,121 @@ +name: Check for issues with notarization certificates + +on: + schedule: + # run every 10 hours + - cron: "0 */10 * * *" + # workflow_dispatch event allows the workflow to be triggered manually. + # This could be used to run an immediate check after updating certificate secrets. + # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + +env: + # Begin notifications when there are less than this many days remaining before expiration + EXPIRATION_WARNING_PERIOD: 30 + +jobs: + check-certificates: + # This workflow would fail in forks that don't have the certificate secrets defined + if: github.repository == 'arduino/FirmwareUpdater' + runs-on: ubuntu-latest + + strategy: + fail-fast: false + + matrix: + certificate: + - identifier: macOS signing certificate # Text used to identify the certificate in notifications + certificate-secret: INSTALLER_CERT_MAC_P12 # The name of the secret that contains the certificate + password-secret: INSTALLER_CERT_MAC_PASSWORD # The name of the secret that contains the certificate password + + steps: + - name: Set certificate path environment variable + run: | + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + echo "CERTIFICATE_PATH=${{ runner.temp }}/certificate.p12" >> "$GITHUB_ENV" + + - name: Decode certificate + env: + CERTIFICATE: ${{ secrets[matrix.certificate.certificate-secret] }} + run: | + echo "${{ env.CERTIFICATE }}" | base64 --decode > "${{ env.CERTIFICATE_PATH }}" + + - name: Verify certificate + env: + CERTIFICATE_PASSWORD: ${{ secrets[matrix.certificate.password-secret] }} + run: | + ( + openssl pkcs12 \ + -in "${{ env.CERTIFICATE_PATH }}" \ + -noout -passin env:CERTIFICATE_PASSWORD + ) || ( + echo "::error::Verification of ${{ matrix.certificate.identifier }} failed!!!" + exit 1 + ) + + # See: https://github.com/rtCamp/action-slack-notify + - name: Slack notification of certificate verification failure + if: failure() + uses: rtCamp/action-slack-notify@v2.1.0 + env: + SLACK_WEBHOOK: ${{ secrets.TEAM_TOOLING_CHANNEL_SLACK_WEBHOOK }} + SLACK_MESSAGE: | + :warning::warning::warning::warning: + WARNING: ${{ github.repository }} ${{ matrix.certificate.identifier }} verification failed!!! + :warning::warning::warning::warning: + SLACK_COLOR: danger + MSG_MINIMAL: true + + - name: Get days remaining before certificate expiration date + env: + CERTIFICATE_PASSWORD: ${{ secrets[matrix.certificate.password-secret] }} + id: get-days-before-expiration + run: | + EXPIRATION_DATE="$( + ( + openssl pkcs12 \ + -in "${{ env.CERTIFICATE_PATH }}" \ + -clcerts \ + -nodes \ + -passin env:CERTIFICATE_PASSWORD + ) | ( + openssl x509 \ + -noout \ + -enddate + ) | ( + grep \ + --max-count=1 \ + --only-matching \ + --perl-regexp \ + 'notAfter=(\K.*)' + ) + )" + + DAYS_BEFORE_EXPIRATION="$((($(date --utc --date="$EXPIRATION_DATE" +%s) - $(date --utc +%s)) / 60 / 60 / 24))" + + # Display the expiration information in the log + echo "Certificate expiration date: $EXPIRATION_DATE" + echo "Days remaining before expiration: $DAYS_BEFORE_EXPIRATION" + + echo "::set-output name=days::$DAYS_BEFORE_EXPIRATION" + + - name: Check if expiration notification period has been reached + id: check-expiration + run: | + if [[ ${{ steps.get-days-before-expiration.outputs.days }} -lt ${{ env.EXPIRATION_WARNING_PERIOD }} ]]; then + echo "::error::${{ matrix.certificate.identifier }} will expire in ${{ steps.get-days-before-expiration.outputs.days }} days!!!" + exit 1 + fi + + - name: Slack notification of pending certificate expiration + # Don't send spurious expiration notification if verification fails + if: failure() && steps.check-expiration.outcome == 'failure' + uses: rtCamp/action-slack-notify@v2.1.0 + env: + SLACK_WEBHOOK: ${{ secrets.TEAM_TOOLING_CHANNEL_SLACK_WEBHOOK }} + SLACK_MESSAGE: | + :warning::warning::warning::warning: + WARNING: ${{ github.repository }} ${{ matrix.certificate.identifier }} will expire in ${{ steps.get-days-before-expiration.outputs.days }} days!!! + :warning::warning::warning::warning: + SLACK_COLOR: danger + MSG_MINIMAL: true diff --git a/.github/workflows/link-validation.yml b/.github/workflows/link-validation.yml new file mode 100644 index 00000000..ef9ea353 --- /dev/null +++ b/.github/workflows/link-validation.yml @@ -0,0 +1,24 @@ +name: Verifies documentation links + +on: + push: + pull_request: + schedule: + - cron: "0 3 * * 1" # Every Monday at 03:00 + +jobs: + verify-links: + # Don't trigger on schedule event when in a fork + if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository == 'arduino/FirmwareUpdater') + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Install Taskfile + uses: arduino/actions/setup-taskfile@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + version: 3.x + + - name: Verify links + run: task docs:check-links diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 00000000..bd2cab18 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,144 @@ +name: release + +on: + push: + tags: + - "[0-9]+.[0-9]+.[0-9]+*" + +jobs: + create-release-artifacts: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Create changelog + uses: arduino/create-changelog@v1 + with: + tag-regex: '^[0-9]+\.[0-9]+\.[0-9]+$' + filter-regex: '^\[(skip|changelog)[ ,-](skip|changelog)\].*' + case-insensitive-regex: true + changelog-file-path: "dist/CHANGELOG.md" + + - name: Install Taskfile + uses: arduino/actions/setup-taskfile@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + version: 3.x + + - uses: actions/setup-go@v2 + with: + go-version: "^1.16.2" + + - name: Build + run: task dist:all + + - name: Upload artifacts + uses: actions/upload-artifact@v2 + with: + name: dist + path: dist + + notarize-macos: + runs-on: macos-latest + needs: create-release-artifacts + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Download artifacts + uses: actions/download-artifact@v2 + with: + name: dist + # to ensure compatibility with v1 + # https://github.com/actions/download-artifact#compatibility-between-v1-and-v2 + path: dist + + - name: Import Code-Signing Certificates + env: + KEYCHAIN: "sign.keychain" + INSTALLER_CERT_MAC_PATH: "/tmp/ArduinoCerts2020.p12" + KEYCHAIN_PASSWORD: keychainpassword # Arbitrary password for a keychain that exists only for the duration of the job, so not secret + run: | + echo "${{ secrets.INSTALLER_CERT_MAC_P12 }}" | base64 --decode > ${{ env.INSTALLER_CERT_MAC_PATH }} + security create-keychain -p ${{ env.KEYCHAIN_PASSWORD }} ${{ env.KEYCHAIN }} + security default-keychain -s ${{ env.KEYCHAIN }} + security unlock-keychain -p ${{ env.KEYCHAIN_PASSWORD }} ${{ env.KEYCHAIN }} + security import ${{ env.INSTALLER_CERT_MAC_PATH }} -k ${{ env.KEYCHAIN }} -f pkcs12 -A -T /usr/bin/codesign -P "${{ secrets.INSTALLER_CERT_MAC_PASSWORD }}" + security set-key-partition-list -S apple-tool:,apple: -s -k ${{ env.KEYCHAIN_PASSWORD }} ${{ env.KEYCHAIN }} + + - name: Install gon for code signing and app notarization + run: | + wget -q https://github.com/mitchellh/gon/releases/download/v0.2.3/gon_macos.zip + unzip gon_macos.zip -d /usr/local/bin + + - name: Sign and notarize binary + env: + AC_USERNAME: ${{ secrets.AC_USERNAME }} + AC_PASSWORD: ${{ secrets.AC_PASSWORD }} + run: | + gon gon.config.hcl + + - name: Re-package binary and update checksum + # Repackage the signed binary replaced in place by Gon (ignoring the output zip file) + run: | + TAG=${GITHUB_REF/refs\/tags\//} + tar cjf dist/FirmwareUpdater_${TAG}_macOS_64bit.tar.bz2 \ + firmwares \ + LICENSE.txt \ + -C dist/macos64/ FirmwareUpdater + + - name: Upload artifacts + uses: actions/upload-artifact@v2 + with: + name: dist + path: dist + + create-release: + runs-on: ubuntu-latest + needs: notarize-macos + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Download artifact + uses: actions/download-artifact@v2 + with: + name: dist + # to ensure compatibility with v1 + # https://github.com/actions/download-artifact#compatibility-between-v1-and-v2 + path: dist + + - name: Install Taskfile + uses: arduino/actions/setup-taskfile@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + version: 3.x + + - name: Build + # This must be done after OS X notarization or the wrong checksum + # would be calculated since the binary is modified during notarization + run: task dist:generate-index-data + + - name: Identify Prerelease + # This is a workaround while waiting for create-release action + # to implement auto pre-release based on tag + id: prerelease + run: | + wget -q -P /tmp https://github.com/fsaintjacques/semver-tool/archive/3.0.0.zip + unzip -p /tmp/3.0.0.zip semver-tool-3.0.0/src/semver >/tmp/semver && chmod +x /tmp/semver + if [[ $(/tmp/semver get prerel ${GITHUB_REF/refs\/tags\//}) ]]; then echo "::set-output name=IS_PRE::true"; fi + + - name: Create Github Release and upload artifacts + uses: ncipollo/release-action@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} + bodyFile: "dist/CHANGELOG.md" + draft: false + prerelease: ${{ steps.prerelease.outputs.IS_PRE }} + artifacts: dist/FirmwareUpdater*,dist/package_index.json diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 00000000..93cf10a9 --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,113 @@ +name: stale-bot + +on: + schedule: + # run every day at midnight + - cron: "0 0 * * *" + issue_comment: + types: ["created"] + +env: + # Name of the label that makes issues subject to the stale bot. + STALE_ENABLE_LABEL: "status: waiting for information" + # Name of the label used to mark issues as stale. + STALE_LABEL: "status: stale" + +jobs: + stale-bot: + runs-on: ubuntu-latest + steps: + - name: Mark stale + if: github.event_name == 'schedule' + uses: actions/github-script@v3 + with: + github-token: ${{github.token}} + script: | + // Get a list of all open issues labeled as waiting for feedback + const opts = github.issues.listForRepo.endpoint.merge({ + ...context.repo, + state: 'open', + labels: ['${{ env.STALE_ENABLE_LABEL }}'], + }); + const issues = await github.paginate(opts); + + // Set this value to whatever makes sense for the repo. + let elapsedDays = 30 + + let elapsed = elapsedDays * 24 * 60 * 60 * 1000; + let now = new Date().getTime(); + for (const issue of issues) { + // If an issue was active in the past 15 days, leave it alone. + if (now - new Date(issue.updated_at).getTime() < elapsed) { + continue; + } + + // If we're here, we've been waiting for feedback for more than + // 15 days, mark as stale. + github.issues.addLabels({ + ...context.repo, + issue_number: issue.number, + labels: ['${{ env.STALE_LABEL }}'] + }); + } + + - name: Mark active + if: github.event_name == 'issue_comment' + uses: actions/github-script@v3 + with: + github-token: ${{github.token}} + script: | + // Every time a comment is added to an issue, close it if it contains + // the stale label. + + // Load issue's labels. + const opts = github.issues.listLabelsOnIssue.endpoint.merge({ + ...context.repo, + issue_number: context.issue.number + }); + const labels = await github.paginate(opts); + + // Search for stale label. + for (const label of labels) { + if (label.name === '${{ env.STALE_LABEL }}') { + await github.issues.removeLabel({ + ...context.repo, + issue_number: context.issue.number, + name: '${{ env.STALE_LABEL }}' + }) + return; + } + } + + - name: Close stale + if: github.event_name == 'schedule' + uses: actions/github-script@v3 + with: + github-token: ${{github.token}} + script: | + // Load all the stale issues + const opts = github.issues.listForRepo.endpoint.merge({ + ...context.repo, + state: 'open', + labels: ['${{ env.STALE_LABEL }}'], + }); + const issues = await github.paginate(opts); + + // Set this value to whatever makes sense for the repo. + let elapsedDays = 15; + + let elapsed = elapsedDays * 24 * 60 * 60 * 1000; + let now = new Date().getTime(); + for (const issue of issues) { + // If an issue was stale for less than elapsed time, leave it alone. + if (now - new Date(issue.updated_at).getTime() < elapsed) { + continue; + } + + // Close the stale issue. + await github.issues.update({ + ...context.repo, + issue_number: issue.number, + state: 'closed' + }); + } diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index d202736f..935078aa 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -1,35 +1,52 @@ -name: test +name: Run tests on: push: branches: - - master + - main pull_request: jobs: native-os-build: strategy: matrix: - os: [ubuntu-latest, windows-latest, macOS-latest] + os: [ubuntu-latest, windows-latest, macos-latest] runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v1 - - uses: actions/setup-go@v1 + - name: Disable EOL conversions + run: git config --global core.autocrlf false + + - name: Checkout + uses: actions/checkout@v2 + + - name: Install Go + uses: actions/setup-go@v2 with: go-version: "1.15" + + - name: Install Taskfile + uses: arduino/actions/setup-taskfile@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + version: 3.x + - name: Build native - run: go build -v ./... - shell: bash - - name: Run unit tests - run: go test -v -race ./... shell: bash + run: task build + - name: Cross-build for 386 - if: matrix.os != 'macOS-latest' - run: GOARCH=386 go build -v ./... - shell: bash + if: matrix.os != 'macos-latest' + env: + GOARCH: "386" + run: task build + - name: Cross-build for arm - if: matrix.os != 'macOS-latest' - run: GOARCH=arm go build -v ./... - shell: bash + if: matrix.os != 'macos-latest' + env: + GOARCH: "arm" + run: task build + + - name: Run unit tests + run: task test diff --git a/.github/workflows/verify-formatting.yml b/.github/workflows/verify-formatting.yml new file mode 100644 index 00000000..df0edbdf --- /dev/null +++ b/.github/workflows/verify-formatting.yml @@ -0,0 +1,34 @@ +name: "Verify files formatting" + +on: + push: + paths: + - "**/*.md" + - "**/*.yml" + - "**/*.yaml" + - ".prettierrc" + - ".prettierignore" + pull_request: + paths: + - "**/*.md" + - "**/*.yml" + - "**/*.yaml" + - ".prettierrc" + - ".prettierignore" + +jobs: + verify-formatting: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Install Taskfile + uses: arduino/actions/setup-taskfile@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + version: 3.x + + - name: Verify formatting of all files + run: task docs:check config:check diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..acf9be21 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +/debug +/FirmwareUpdater* +/.vscode/ +.idea +coverage_*.txt +/dist + +# Misc. +.DS_Store diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000..6260782e --- /dev/null +++ b/.prettierignore @@ -0,0 +1,5 @@ +# IDE files +.idea/ +.vscode/ +.vs/ +.ionide/ diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000..2703167c --- /dev/null +++ b/.prettierrc @@ -0,0 +1,12 @@ +{ + "semi": false, + "printWidth": 120, + "overrides": [ + { + "files": "*.md", + "options": { + "proseWrap": "always" + } + } + ] +} diff --git a/DistTasks.yml b/DistTasks.yml new file mode 100644 index 00000000..84fb7504 --- /dev/null +++ b/DistTasks.yml @@ -0,0 +1,167 @@ +version: "3" + +tasks: + all: + desc: Build for distribution for all platforms + cmds: + - task: Windows_32bit + - task: Windows_64bit + - task: Linux_32bit + - task: Linux_64bit + - task: Linux_ARM + - task: Linux_ARM64 + - task: macOS_64bit + + Windows_32bit: + desc: Builds Windows 32 bit binaries + env: + GOOS: "windows" + GOARCH: "386" + GO386: "softfloat" + cmds: + - | + go build -o {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }}.exe + zip {{ .DIST_DIR}}/{{ .PACKAGE_NAME }} {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }}.exe -j + zip {{ .DIST_DIR}}/{{ .PACKAGE_NAME }} firmwares LICENSE.txt -r + vars: + PLATFORM_DIR: "windows32" + PACKAGE_PLATFORM: "Windows_32bit" + PACKAGE_NAME: "{{ .PROJECT_NAME }}_{{ .VERSION }}_{{ .PACKAGE_PLATFORM }}.zip" + + Windows_64bit: + desc: Builds Windows 64 bit binaries + env: + GOOS: "windows" + GOARCH: "amd64" + cmds: + - | + go build -o {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }}.exe + zip {{ .DIST_DIR}}/{{ .PACKAGE_NAME }} {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }}.exe -j + zip {{ .DIST_DIR}}/{{ .PACKAGE_NAME }} firmwares LICENSE.txt -r + vars: + PLATFORM_DIR: "windows64" + PACKAGE_PLATFORM: "Windows_64bit" + PACKAGE_NAME: "{{ .PROJECT_NAME }}_{{ .VERSION }}_{{ .PACKAGE_PLATFORM }}.zip" + + Linux_32bit: + desc: Builds Linux 32 bit binaries + env: + GOOS: "linux" + GOARCH: "386" + GO386: "softfloat" + cmds: + - | + go build -o {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }} + tar cj firmwares LICENSE.txt -C {{ .DIST_DIR}}/{{ .PLATFORM_DIR }} {{ .PROJECT_NAME }} -f {{ .DIST_DIR }}/{{ .PACKAGE_NAME }} + vars: + PLATFORM_DIR: "linux32" + PACKAGE_PLATFORM: "Linux_32bit" + PACKAGE_NAME: "{{ .PROJECT_NAME }}_{{ .VERSION }}_{{ .PACKAGE_PLATFORM }}.tar.bz2" + + Linux_64bit: + desc: Builds Linux 64 bit binaries + env: + GOOS: "linux" + GOARCH: "amd64" + cmds: + - | + go build -o {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }} + tar cj firmwares LICENSE.txt -C {{ .DIST_DIR}}/{{ .PLATFORM_DIR }} {{ .PROJECT_NAME }} -f {{ .DIST_DIR }}/{{ .PACKAGE_NAME }} + vars: + PLATFORM_DIR: "linux64" + PACKAGE_PLATFORM: "Linux_64bit" + PACKAGE_NAME: "{{ .PROJECT_NAME }}_{{ .VERSION }}_{{ .PACKAGE_PLATFORM }}.tar.bz2" + + Linux_ARM: + desc: Builds Linux ARM binaries + env: + GOOS: "linux" + GOARCH: "arm" + cmds: + - | + go build -o {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }} + tar cj firmwares LICENSE.txt -C {{ .DIST_DIR}}/{{ .PLATFORM_DIR }} {{ .PROJECT_NAME }} -f {{ .DIST_DIR }}/{{ .PACKAGE_NAME }} + vars: + PLATFORM_DIR: "linuxarm" + PACKAGE_PLATFORM: "Linux_ARM" + PACKAGE_NAME: "{{ .PROJECT_NAME }}_{{ .VERSION }}_{{ .PACKAGE_PLATFORM }}.tar.bz2" + + Linux_ARM64: + desc: Builds Linux ARM64 binaries + env: + GOOS: "linux" + GOARCH: "arm64" + cmds: + - | + go build -o {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }} + tar cj firmwares LICENSE.txt -C {{ .DIST_DIR}}/{{ .PLATFORM_DIR }} {{ .PROJECT_NAME }} -f {{ .DIST_DIR }}/{{ .PACKAGE_NAME }} + vars: + PLATFORM_DIR: "linuxarm64" + PACKAGE_PLATFORM: "Linux_ARM64" + PACKAGE_NAME: "{{ .PROJECT_NAME }}_{{ .VERSION }}_{{ .PACKAGE_PLATFORM }}.tar.bz2" + + macOS_64bit: + desc: Builds Mac OS X 64 bit binaries + env: + GOOS: "darwin" + GOARCH: "amd64" + cmds: + - | + go build -o {{ .DIST_DIR}}/{{ .PLATFORM_DIR }}/{{ .PROJECT_NAME }} + tar cj firmwares LICENSE.txt -C {{ .DIST_DIR}}/{{ .PLATFORM_DIR }} {{ .PROJECT_NAME }} -f {{ .DIST_DIR }}/{{ .PACKAGE_NAME }} + vars: + PLATFORM_DIR: "macos64" + PACKAGE_PLATFORM: "macOS_64bit" + PACKAGE_NAME: "{{ .PROJECT_NAME }}_{{ .VERSION }}_{{ .PACKAGE_PLATFORM }}.tar.bz2" + + generate-index-data: + desc: Generates json for platform index + vars: + WINDOWS32_SHA: + sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_32bit.zip | cut -f1 -d " " + WINDOWS64_SHA: + sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_64bit.zip | cut -f1 -d " " + LINUX32_SHA: + sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_32bit.tar.bz2 | cut -f1 -d " " + LINUX64_SHA: + sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_64bit.tar.bz2 | cut -f1 -d " " + LINUXARM_SHA: + sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARM.tar.bz2 | cut -f1 -d " " + LINUXARM64_SHA: + sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARM64.tar.bz2 | cut -f1 -d " " + OSX_SHA: + sh: sha256sum {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_macOS_64bit.tar.bz2 | cut -f1 -d " " + LINUX64_SIZE: + sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_32bit.zip | cut -f5 -d " " + LINUX32_SIZE: + sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Windows_64bit.zip | cut -f5 -d " " + LINUXARM_SIZE: + sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_32bit.tar.bz2 | cut -f5 -d " " + LINUXARM64_SIZE: + sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_64bit.tar.bz2 | cut -f5 -d " " + OSX_SIZE: + sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARM.tar.bz2 | cut -f5 -d " " + WINDOWS32_SIZE: + sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_Linux_ARM64.tar.bz2 | cut -f5 -d " " + WINDOWS64_SIZE: + sh: ls -la {{ .DIST_DIR }}/{{ .PROJECT_NAME }}_{{ .VERSION }}_macOS_64bit.tar.bz2 | cut -f5 -d " " + cmds: + - | + cat extras/package_index.json.template | + sed "s/%%VERSION%%/{{ .VERSION }}/" | + sed "s/%%FILENAME%%/{{ .PROJECT_NAME }}/" | + sed "s/%%LINUX64_SHA%%/{{ .LINUX64_SHA }}/" | + sed "s/%%LINUX64_SIZE%%/{{ .LINUX64_SIZE }}/" | + sed "s/%%LINUX32_SHA%%/{{ .LINUX32_SHA }}/" | + sed "s/%%LINUX32_SIZE%%/{{ .LINUX32_SIZE }}/" | + sed "s/%%LINUXARM_SHA%%/{{ .LINUXARM_SHA }}/" | + sed "s/%%LINUXARM_SIZE%%/{{ .LINUXARM_SIZE }}/" | + sed "s/%%LINUXARM64_SHA%%/{{ .LINUXARM64_SHA }}/" | + sed "s/%%LINUXARM64_SIZE%%/{{ .LINUXARM64_SIZE }}/" | + sed "s/%%OSX_SHA%%/{{ .OSX_SHA }}/" | + sed "s/%%OSX_SIZE%%/{{ .OSX_SIZE }}/" | + sed "s/%%WINDOWS32_SHA%%/{{ .WINDOWS32_SHA }}/" | + sed "s/%%WINDOWS32_SIZE%%/{{ .WINDOWS32_SIZE }}/" | + sed "s/%%WINDOWS64_SHA%%/{{ .WINDOWS64_SHA }}/" | + sed "s/%%WINDOWS64_SIZE%%/{{ .WINDOWS64_SIZE }}/" \ + > {{ .DIST_DIR }}/package_index.json diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..95da58be --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,420 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + Preamble + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + a) The modified work must itself be a software library. + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + NO WARRANTY + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + END OF TERMS AND CONDITIONS + How to Apply These Terms to Your New Libraries + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + This library 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 + Lesser General Public License for more details. + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA +Also add information on how to contact you by electronic and paper mail. +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + , 1 April 1990 + Ty Coon, President of Vice +That's all there is to it! diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 11be7584..00000000 --- a/README.adoc +++ /dev/null @@ -1,82 +0,0 @@ -= Firmware/Certificates updater for WINC and NINA Wifi module = - -Use this tool to update the firmware and/or add SSL certificates for any WINC, NINA or SARA module - -== Install == - -You can download the Firmware/Certificates updater here: - -https://github.com/arduino/FirmwareUpdater/releases/latest - -== Usage == - -Extract the zip file and run (for example, NINA -> WiFi1010) - - ./$your_os/updater -flasher firmwares/NINA/FirmwareUpdater.mkrwifi1010.ino.bin -firmware firmwares/NINA/1.2.1/NINA_W102.bin -port /dev/ttyACM0 -address arduino.cc:443 -restore_binary /tmp/arduino_build_619137/WiFiSSLClient.ino.bin -programmer {runtime.tools.bossac}/bossac - -To flash a MKR1000: - - ./$your_os/updater -flasher firmwares/WINC1500/FirmwareUpdater.mkr1000.ino.bin -firmware firmwares/WINC1500/19.5.4/m2m_aio_3a0.bin -port /dev/ttyACM0 -address arduino.cc:443 -restore_binary /tmp/arduino_build_619137/WiFiSSLClient.ino.bin -programmer {runtime.tools.bossac}/bossac - -To update a MKRNB1500: - - ./$your_os/updater -flasher firmwares/SARA/SerialSARAPassthrough.ino.bin -firmware firmwares/SARA/5.6A2.00-to-5.6A2.01.pkg -port /dev/ttyACM0 -restore_binary firmwares/SARA/SerialSARAPassthrough.ino.bin -programmer {runtime.tools.bossac}/bossac - -=== Command line options === - -The full list of command line options can be obtained with the `-h` option: `./updater -h` - - Usage of ./distrib/linux64/updater: - -address value - address (host:port) to fetch and flash root certificate for, multiple values allowed - -certs string - root certificate directory - -firmware string - firmware file to flash - -flasher string - firmware upload binary (precompiled for the right target) -> if not provided it will expect FirmwareUpdater sketch to be already flashed on the board - -model string - module model (winc or nina) - -port string - serial port to use for flashing - -programmer string - path of programmer in use (avrdude/bossac) - -read - read all firmware and output to stdout - -restore_binary string - firmware upload binary (precompiled for the right target) -> if not provided it will try to restore the original firmware - -== How to build the tools from source file == - -From the sources root directory run: - - go build -o updater - -This will create the `updater` executable. - -== Security == - -If you think you found a vulnerability or other security-related bug in this project, please read our -https://github.com/arduino/FirmwareUpdater/security/policy[security policy] and report the bug to our Security Team 🛡️ -Thank you! - -e-mail contact: security@arduino.cc - -== License == - -Copyright (c) 2015-2016 Arduino LLC. All right reserved. - -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library 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 -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - diff --git a/README.md b/README.md new file mode 100644 index 00000000..48860406 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# Firmware/Certificates updater for WINC and NINA Wifi module + +Use this tool to update the firmware and/or add SSL certificates for any WINC, NINA or SARA module. + +## Install + +You can download the Firmware/Certificates updater here: + +https://github.com/arduino/FirmwareUpdater/releases/latest + +## Usage + +Extract the zip file and run (for example, NINA -> WiFi1010) + +``` +./$your_os/updater -flasher firmwares/NINA/FirmwareUpdater.mkrwifi1010.ino.bin -firmware firmwares/NINA/1.2.1/NINA_W102.bin -port /dev/ttyACM0 -address arduino.cc:443 -restore_binary /tmp/arduino_build_619137/WiFiSSLClient.ino.bin -programmer {runtime.tools.bossac}/bossac +``` + +To flash a MKR1000: + +``` +./$your_os/updater -flasher firmwares/WINC1500/FirmwareUpdater.mkr1000.ino.bin -firmware firmwares/WINC1500/19.5.4/m2m_aio_3a0.bin -port /dev/ttyACM0 -address arduino.cc:443 -restore_binary /tmp/arduino_build_619137/WiFiSSLClient.ino.bin -programmer {runtime.tools.bossac}/bossac +``` + +To update a MKRNB1500: + +``` +./$your_os/updater -flasher firmwares/SARA/SerialSARAPassthrough.ino.bin -firmware firmwares/SARA/5.6A2.00-to-5.6A2.01.pkg -port /dev/ttyACM0 -restore_binary firmwares/SARA/SerialSARAPassthrough.ino.bin -programmer {runtime.tools.bossac}/bossac +``` + +### Command line options + +The full list of command line options can be obtained with the `-h` option: `./updater -h` + +``` +Usage of ./distrib/linux64/updater: + -address value + address (host:port) to fetch and flash root certificate for, multiple values allowed + -certs string + root certificate directory + -firmware string + firmware file to flash + -flasher string + firmware upload binary (precompiled for the right target) -> if not provided it will expect FirmwareUpdater sketch to be already flashed on the board + -model string + module model (winc or nina) + -port string + serial port to use for flashing + -programmer string + path of programmer in use (avrdude/bossac) + -read + read all firmware and output to stdout + -restore_binary string + firmware upload binary (precompiled for the right target) -> if not provided it will try to restore the original firmware +``` + +## How to build the tools from source file + +From the sources root directory run: + +``` +go build -o updater +``` + +This will create the `updater` executable. + +## Security + +If you think you found a vulnerability or other security-related bug in this project, please read our [security +policy][security-policy] and report the bug to our Security Team 🛡️ Thank you! + +e-mail contact: security@arduino.cc + +## License + +Copyright (c) 2015-2021 Arduino LLC. All right reserved. + +This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later +version. + +This library 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 Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the +Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +[security-policy]: https://github.com/arduino/FirmwareUpdater/security/policy diff --git a/Taskfile.yml b/Taskfile.yml new file mode 100755 index 00000000..cf3e5cd2 --- /dev/null +++ b/Taskfile.yml @@ -0,0 +1,93 @@ +version: "3" + +includes: + dist: ./DistTasks.yml + +tasks: + docs:check: + desc: Run documentation linting + cmds: + - npx {{ .PRETTIER }} --check "**/*.md" + + docs:check-links: + desc: Verifies there are no dead links in documentation + cmds: + - | + npx -p markdown-link-check -c ' + STATUS=0 + for file in $(find -name "*.md"); do + markdown-link-check -c markdown-link-check-config.json -q "$file" + STATUS=$(( $STATUS + $? )) + done + exit $STATUS' + + docs:format: + desc: Automatically formats documentation + cmds: + - npx {{ .PRETTIER }} --write "**/*.md" + + build: + desc: Build the project + cmds: + - go build -v {{.LDFLAGS}} + + test: + desc: Run tests + cmds: + - go test -short -race -run '.*' {{ default "-v" .GOFLAGS }} -coverprofile=coverage_unit.txt ./... {{.TEST_LDFLAGS}} + + check: + desc: Check fmt and lint + cmds: + - test -z $(go fmt ./...) + - go vet ./... + - "'{{.GOLINTBIN}}' {{.GOLINTFLAGS}} ./..." + - task: docs:check + - task: config:check + + config:check: + desc: Check linting of configuration and supporting files + cmds: + - npx {{ .PRETTIER }} --check "**/*.{yml,yaml}" + + config:format: + desc: Automatically formats configuration and supporting files + cmds: + - npx {{ .PRETTIER }} --write "**/*.{yml,yaml}" + +vars: + PROJECT_NAME: "FirmwareUpdater" + DIST_DIR: "dist" + # build vars + COMMIT: + sh: echo "$(git log -n 1 --format=%h)" + TIMESTAMP: + sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")" + TIMESTAMP_SHORT: + sh: echo "{{now | date "20060102"}}" + TAG: + sh: echo "`git tag --points-at=HEAD 2> /dev/null | head -n1`" + VERSION: "{{ if .NIGHTLY }}nightly-{{ .TIMESTAMP_SHORT }}{{ else if .TAG }}{{ .TAG }}{{ else }}{{ .PACKAGE_NAME_PREFIX }}git-snapshot{{ end }}" + LDFLAGS: > + -ldflags + ' + -X github.com/arduino/FirmwareUpdater/version.versionString={{.VERSION}} + -X github.com/arduino/FirmwareUpdater/version.commit={{ .COMMIT }} + -X github.com/arduino/FirmwareUpdater/version.date={{.TIMESTAMP}} + ' + # test vars + GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic" + TEST_VERSION: "0.0.0-test.preview" + TEST_COMMIT: "deadbeef" + TEST_LDFLAGS: > + -ldflags + ' + -X github.com/arduino/FirmwareUpdater/version.versionString={{.TEST_VERSION}} + -X github.com/arduino/FirmwareUpdater/version.commit={{.TEST_COMMIT}} + -X github.com/arduino/FirmwareUpdater/version.date={{.TIMESTAMP}} + ' + # check-lint vars + GOLINTBIN: + sh: go list -f {{"{{"}}".Target{{"}}"}}" golang.org/x/lint/golint + GOLINTFLAGS: "-min_confidence 0.8 -set_exit_status" + PRETTIER: prettier@2.0.5 diff --git a/distrib.sh b/distrib.sh deleted file mode 100755 index c626af8f..00000000 --- a/distrib.sh +++ /dev/null @@ -1,88 +0,0 @@ -#!/bin/bash -ex - -VERSION=`git describe --tags` -FILENAME="FirmwareUploader" - -rm -rf distrib -mkdir -p distrib/linux64 -mkdir -p distrib/linux32 -mkdir -p distrib/linuxarm -mkdir -p distrib/linuxarm64 -mkdir -p distrib/osx -mkdir -p distrib/windows32 -mkdir -p distrib/windows64 - -export CGO_ENABLED=0 - -GOOS=linux GOARCH=amd64 go build -o distrib/linux64/${FILENAME} -GOOS=linux GOARCH=386 GO386=387 go build -o distrib/linux32/${FILENAME} -GOOS=linux GOARCH=arm go build -o distrib/linuxarm/${FILENAME} -GOOS=linux GOARCH=arm64 go build -o distrib/linuxarm64/${FILENAME} -GOOS=windows GOARCH=386 GO386=387 go build -o distrib/windows32/${FILENAME}.exe -GOOS=windows GOARCH=amd64 go build -o distrib/windows64/${FILENAME}.exe - -#export CGO_ENABLED=1 -# need osxcross in path -GOOS=darwin GOARCH=amd64 go build -o distrib/osx/${FILENAME} - -cp -r firmwares distrib/linux64 -cp -r firmwares distrib/linux32 -cp -r firmwares distrib/linuxarm -cp -r firmwares distrib/linuxarm64 -cp -r firmwares distrib/windows32 -cp -r firmwares distrib/windows64 -cp -r firmwares distrib/osx - -cd distrib/linux64 && tar cjf ../${FILENAME}_${VERSION}_Linux_64bit.tar.bz2 * && cd - -LINUX64_SHA=`sha256sum distrib/${FILENAME}_${VERSION}_Linux_64bit.tar.bz2 | cut -f1 -d " "` -LINUX64_SIZE=`ls -la distrib/${FILENAME}_${VERSION}_Linux_64bit.tar.bz2 | cut -f5 -d " "` - -cd distrib/linux32 && tar cjf ../${FILENAME}_${VERSION}_Linux_32bit.tar.bz2 * && cd - -LINUX32_SHA=`sha256sum distrib/${FILENAME}_${VERSION}_Linux_32bit.tar.bz2 | cut -f1 -d " "` -LINUX32_SIZE=`ls -la distrib/${FILENAME}_${VERSION}_Linux_32bit.tar.bz2 | cut -f5 -d " "` - -cd distrib/linuxarm && tar cjf ../${FILENAME}_${VERSION}_Linux_ARM.tar.bz2 * && cd - -LINUXARM_SHA=`sha256sum distrib/${FILENAME}_${VERSION}_Linux_ARM.tar.bz2 | cut -f1 -d " "` -LINUXARM_SIZE=`ls -la distrib/${FILENAME}_${VERSION}_Linux_ARM.tar.bz2 | cut -f5 -d " "` - -cd distrib/linuxarm64 && tar cjf ../${FILENAME}_${VERSION}_Linux_ARM64.tar.bz2 * && cd - -LINUXARM64_SHA=`sha256sum distrib/${FILENAME}_${VERSION}_Linux_ARM64.tar.bz2 | cut -f1 -d " "` -LINUXARM64_SIZE=`ls -la distrib/${FILENAME}_${VERSION}_Linux_ARM64.tar.bz2 | cut -f5 -d " "` - -cd distrib/osx && tar cjf ../${FILENAME}_${VERSION}_macOS_64bit.tar.bz2 * && cd - -OSX_SHA=`sha256sum distrib/${FILENAME}_${VERSION}_macOS_64bit.tar.bz2 | cut -f1 -d " "` -OSX_SIZE=`ls -la distrib/${FILENAME}_${VERSION}_macOS_64bit.tar.bz2 | cut -f5 -d " "` - -cd distrib/windows32 && zip -r ../${FILENAME}_${VERSION}_Windows_32bit.zip * && cd - -WINDOWS32_SHA=`sha256sum distrib/${FILENAME}_${VERSION}_Windows_32bit.zip | cut -f1 -d " "` -WINDOWS32_SIZE=`ls -la distrib/${FILENAME}_${VERSION}_Windows_32bit.zip | cut -f5 -d " "` - -cd distrib/windows64 && zip -r ../${FILENAME}_${VERSION}_Windows_64bit.zip * && cd - -WINDOWS64_SHA=`sha256sum distrib/${FILENAME}_${VERSION}_Windows_64bit.zip | cut -f1 -d " "` -WINDOWS64_SIZE=`ls -la distrib/${FILENAME}_${VERSION}_Windows_64bit.zip | cut -f5 -d " "` - - -echo "==============================" -echo "BOARD MANAGER SNIPPET" -echo "==============================" - -cat extras/package_index.json.template | -sed "s/%%VERSION%%/${VERSION}/" | -sed "s/%%FILENAME%%/${FILENAME}/" | -sed "s/%%LINUX64_SHA%%/${LINUX64_SHA}/" | -sed "s/%%LINUX64_SIZE%%/${LINUX64_SIZE}/" | -sed "s/%%LINUX32_SHA%%/${LINUX32_SHA}/" | -sed "s/%%LINUX32_SIZE%%/${LINUX32_SIZE}/" | -sed "s/%%LINUXARM_SHA%%/${LINUXARM_SHA}/" | -sed "s/%%LINUXARM_SIZE%%/${LINUXARM_SIZE}/" | -sed "s/%%LINUXARM64_SHA%%/${LINUXARM64_SHA}/" | -sed "s/%%LINUXARM64_SIZE%%/${LINUXARM64_SIZE}/" | -sed "s/%%OSX_SHA%%/${OSX_SHA}/" | -sed "s/%%OSX_SIZE%%/${OSX_SIZE}/" | -sed "s/%%WINDOWS32_SHA%%/${WINDOWS32_SHA}/" | -sed "s/%%WINDOWS32_SIZE%%/${WINDOWS32_SIZE}/" | -sed "s/%%WINDOWS64_SHA%%/${WINDOWS64_SHA}/" | -sed "s/%%WINDOWS64_SIZE%%/${WINDOWS64_SIZE}/" - -# call the tool with something like -# ./linux64/updater -flasher firmwares/NINA/FirmwareUpdater.mkrwifi1010.ino.bin -firmware firmwares/NINA/1.2.1/NINA_W102.bin -port /dev/ttyACM0 -address arduino.cc:443 -restore_binary /tmp/arduino_build_619137/WiFiSSLClient.ino.bin -programmer {runtime.tools.bossac}/bossac diff --git a/go.sum b/go.sum index 78f25a4f..0d29c754 100644 --- a/go.sum +++ b/go.sum @@ -246,6 +246,7 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= +golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3 h1:XQyxROzUlZH+WIQwySDgnISgOivlhjIEwaQaJEJrrN0= golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/net v0.0.0-20180406214816-61147c48b25b/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= diff --git a/gon.config.hcl b/gon.config.hcl new file mode 100644 index 00000000..685cc8bd --- /dev/null +++ b/gon.config.hcl @@ -0,0 +1,12 @@ +source = ["dist/macos64/FirmwareUpdater"] +bundle_id = "cc.arduino.FirmwareUpdater" + +sign { + application_identity = "Developer ID Application: ARDUINO SA (7KT7ZWMCJT)" +} + +# Ask Gon for zip output to force notarization process to take place. +# The CI will ignore the zip output, using the signed binary only. +zip { + output_path = "FirmwareUpdater.zip" +} \ No newline at end of file diff --git a/markdown-link-check-config.json b/markdown-link-check-config.json new file mode 100644 index 00000000..25027703 --- /dev/null +++ b/markdown-link-check-config.json @@ -0,0 +1,13 @@ +{ + "ignorePatterns": [ + { + "pattern": "https?://localhost:\\d*/" + }, + { + "pattern": "https?://(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?):\\d*" + } + ], + "aliveStatusCodes": [200, 206], + "retryCount": 3, + "retryOn429": true +}