mirror of
https://github.com/meshcore-dev/MeshCore.git
synced 2026-07-15 23:29:10 +00:00
Compare commits
14 Commits
dev
...
revert-2915-main
| Author | SHA1 | Date | |
|---|---|---|---|
| d9cd3ea03a | |||
| a517f9c24f | |||
| 754fcb1fae | |||
| bbb58cceb8 | |||
| 54234b5837 | |||
| 57563ab8f9 | |||
| e8d3c53ba1 | |||
| d3444e6b0b | |||
| 06130dce29 | |||
| 55ad7689d5 | |||
| 3b39925399 | |||
| c94ed29ca3 | |||
| 5a342c7a20 | |||
| dea5ed790f |
@@ -25,5 +25,14 @@ runs:
|
|||||||
- name: Extract Version from Git Tag
|
- name: Extract Version from Git Tag
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
GIT_TAG_NAME="${GITHUB_REF#refs/tags/}"
|
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
|
||||||
echo "GIT_TAG_VERSION=${GIT_TAG_NAME##*-}" >> $GITHUB_ENV
|
# triggered by a tag push (e.g: refs/tags/companion-v1.2.3)
|
||||||
|
GIT_TAG_NAME="${GITHUB_REF#refs/tags/}"
|
||||||
|
VERSION_STRING="${GIT_TAG_NAME##*-}"
|
||||||
|
else
|
||||||
|
# triggered by a workflow dispatch (e.g: refs/heads/main)
|
||||||
|
# strip "refs/heads/" prefix and replace any remaining "/" with "-" to protect file paths
|
||||||
|
BRANCH_NAME="${GITHUB_REF#refs/heads/}"
|
||||||
|
VERSION_STRING=$(echo "$BRANCH_NAME" | tr '/' '-')
|
||||||
|
fi
|
||||||
|
echo "GIT_TAG_VERSION=${VERSION_STRING}" >> $GITHUB_ENV
|
||||||
|
|||||||
@@ -10,33 +10,8 @@ on:
|
|||||||
- 'companion-*'
|
- 'companion-*'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
build-companion-firmwares:
|
||||||
build:
|
uses: ./.github/workflows/firmware-builder.yml
|
||||||
runs-on: ubuntu-latest
|
with:
|
||||||
steps:
|
firmware_type: 'companion'
|
||||||
|
release_title_prefix: 'Companion Firmware'
|
||||||
- name: Clone Repo
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Setup Build Environment
|
|
||||||
uses: ./.github/actions/setup-build-environment
|
|
||||||
|
|
||||||
- name: Build Firmwares
|
|
||||||
env:
|
|
||||||
FIRMWARE_VERSION: ${{ env.GIT_TAG_VERSION }}
|
|
||||||
run: /usr/bin/env bash build.sh build-companion-firmwares
|
|
||||||
|
|
||||||
- name: Upload Workflow Artifacts
|
|
||||||
uses: actions/upload-artifact@v7
|
|
||||||
with:
|
|
||||||
name: companion-firmwares
|
|
||||||
path: out
|
|
||||||
|
|
||||||
- name: Create Release
|
|
||||||
uses: softprops/action-gh-release@v3
|
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
|
||||||
with:
|
|
||||||
name: Companion Firmware ${{ env.GIT_TAG_VERSION }}
|
|
||||||
body: ""
|
|
||||||
draft: true
|
|
||||||
files: out/*
|
|
||||||
|
|||||||
@@ -10,33 +10,8 @@ on:
|
|||||||
- 'repeater-*'
|
- 'repeater-*'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
build-repeater-firmwares:
|
||||||
build:
|
uses: ./.github/workflows/firmware-builder.yml
|
||||||
runs-on: ubuntu-latest
|
with:
|
||||||
steps:
|
firmware_type: 'repeater'
|
||||||
|
release_title_prefix: 'Repeater Firmware'
|
||||||
- name: Clone Repo
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Setup Build Environment
|
|
||||||
uses: ./.github/actions/setup-build-environment
|
|
||||||
|
|
||||||
- name: Build Firmwares
|
|
||||||
env:
|
|
||||||
FIRMWARE_VERSION: ${{ env.GIT_TAG_VERSION }}
|
|
||||||
run: /usr/bin/env bash build.sh build-repeater-firmwares
|
|
||||||
|
|
||||||
- name: Upload Workflow Artifacts
|
|
||||||
uses: actions/upload-artifact@v7
|
|
||||||
with:
|
|
||||||
name: repeater-firmwares
|
|
||||||
path: out
|
|
||||||
|
|
||||||
- name: Create Release
|
|
||||||
uses: softprops/action-gh-release@v3
|
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
|
||||||
with:
|
|
||||||
name: Repeater Firmware ${{ env.GIT_TAG_VERSION }}
|
|
||||||
body: ""
|
|
||||||
draft: true
|
|
||||||
files: out/*
|
|
||||||
|
|||||||
@@ -10,33 +10,8 @@ on:
|
|||||||
- 'room-server-*'
|
- 'room-server-*'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
build-room-server-firmwares:
|
||||||
build:
|
uses: ./.github/workflows/firmware-builder.yml
|
||||||
runs-on: ubuntu-latest
|
with:
|
||||||
steps:
|
firmware_type: 'room-server'
|
||||||
|
release_title_prefix: 'Room Server Firmware'
|
||||||
- name: Clone Repo
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Setup Build Environment
|
|
||||||
uses: ./.github/actions/setup-build-environment
|
|
||||||
|
|
||||||
- name: Build Firmwares
|
|
||||||
env:
|
|
||||||
FIRMWARE_VERSION: ${{ env.GIT_TAG_VERSION }}
|
|
||||||
run: /usr/bin/env bash build.sh build-room-server-firmwares
|
|
||||||
|
|
||||||
- name: Upload Workflow Artifacts
|
|
||||||
uses: actions/upload-artifact@v7
|
|
||||||
with:
|
|
||||||
name: room-server-firmwares
|
|
||||||
path: out
|
|
||||||
|
|
||||||
- name: Create Release
|
|
||||||
uses: softprops/action-gh-release@v3
|
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
|
||||||
with:
|
|
||||||
name: Room Server Firmware ${{ env.GIT_TAG_VERSION }}
|
|
||||||
body: ""
|
|
||||||
draft: true
|
|
||||||
files: out/*
|
|
||||||
|
|||||||
@@ -0,0 +1,90 @@
|
|||||||
|
name: Firmware Builder
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_call:
|
||||||
|
inputs:
|
||||||
|
firmware_type:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
release_title_prefix:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
|
||||||
|
generate-build-matrix:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
targets: ${{ steps.get-build-targets.outputs.targets }}
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- name: Clone Repo
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Setup Build Environment
|
||||||
|
uses: ./.github/actions/setup-build-environment
|
||||||
|
|
||||||
|
- name: Get Build Targets
|
||||||
|
id: get-build-targets
|
||||||
|
run: |
|
||||||
|
# get list of firmwares to build
|
||||||
|
TARGET_LIST=$(/usr/bin/env bash build.sh get-${{ inputs.firmware_type }}-firmwares-to-build)
|
||||||
|
|
||||||
|
# convert targets separated by new line into a json array string
|
||||||
|
JSON_ARRAY=$(echo "$TARGET_LIST" | jq -R -s -c 'split("\n") | map(select(length > 0))')
|
||||||
|
|
||||||
|
# use json array as targets result
|
||||||
|
echo "targets=$JSON_ARRAY" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
build:
|
||||||
|
needs: generate-build-matrix
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true # don't fail entire build if one board fails to build
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
target: ${{ fromJson(needs.generate-build-matrix.outputs.targets) }}
|
||||||
|
fail-fast: false # don't cancel other builds if one board fails to build
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- name: Clone Repo
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Setup Build Environment
|
||||||
|
uses: ./.github/actions/setup-build-environment
|
||||||
|
|
||||||
|
- name: Build Firmware
|
||||||
|
env:
|
||||||
|
FIRMWARE_VERSION: ${{ env.GIT_TAG_VERSION }}
|
||||||
|
run: /usr/bin/env bash build.sh build-firmware ${{ matrix.target }}
|
||||||
|
|
||||||
|
- name: Upload Workflow Artifacts
|
||||||
|
uses: actions/upload-artifact@v7
|
||||||
|
with:
|
||||||
|
name: "${{ matrix.target }}"
|
||||||
|
path: out
|
||||||
|
|
||||||
|
create-release:
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: startsWith(github.ref, 'refs/tags/') # only create release for tagged builds
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- name: Clone Repo
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Setup Build Environment
|
||||||
|
uses: ./.github/actions/setup-build-environment
|
||||||
|
|
||||||
|
- name: Download All Artifacts
|
||||||
|
uses: actions/download-artifact@v8
|
||||||
|
with:
|
||||||
|
merge-multiple: true
|
||||||
|
path: out
|
||||||
|
|
||||||
|
- name: Create Release
|
||||||
|
uses: softprops/action-gh-release@v3
|
||||||
|
with:
|
||||||
|
name: "${{ inputs.release_title_prefix }} ${{ env.GIT_TAG_VERSION }}"
|
||||||
|
body: ""
|
||||||
|
draft: true
|
||||||
|
files: out/*
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
name: 'Run Stale Bot'
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: '30 1 * * *' # daily at 1:30am
|
||||||
|
workflow_dispatch: {}
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
actions: write
|
||||||
|
issues: write
|
||||||
|
pull-requests: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
close-issues:
|
||||||
|
# only run on main repo, not forks
|
||||||
|
if: github.repository == 'meshcore-dev/MeshCore'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Close Stale Issues
|
||||||
|
uses: actions/stale@v10
|
||||||
|
with:
|
||||||
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
# auto close issues
|
||||||
|
days-before-issue-stale: 60
|
||||||
|
days-before-issue-close: 7
|
||||||
|
exempt-issue-labels: "keep-open"
|
||||||
|
stale-issue-label: "stale"
|
||||||
|
stale-issue-message: "This issue is stale because it has been open for 60 days with no activity. Remove the stale label or add a comment if this issue is still relevant, otherwise this issue will automatically close in 7 days."
|
||||||
|
close-issue-message: "This issue was closed because it has been inactive for 7 days since being marked as stale."
|
||||||
|
# don't auto close prs
|
||||||
|
days-before-pr-stale: -1
|
||||||
|
days-before-pr-close: -1
|
||||||
|
|
||||||
+57
@@ -0,0 +1,57 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
Security fixes are applied to the latest release only. We do not backport
|
||||||
|
fixes to older versions.
|
||||||
|
|
||||||
|
| Version | Supported |
|
||||||
|
|---------|-----------|
|
||||||
|
| 1.15+ | ✅ |
|
||||||
|
| <1.15 | ❌ |
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
**Please do not report security vulnerabilities through public GitHub issues.**
|
||||||
|
|
||||||
|
Use GitHub's private vulnerability reporting instead:
|
||||||
|
1. Go to the **Security** tab of this repository
|
||||||
|
2. Click **Report a vulnerability**
|
||||||
|
3. Fill in the details and submit
|
||||||
|
|
||||||
|
### What to include
|
||||||
|
|
||||||
|
A useful report tells us:
|
||||||
|
- Which component or file is affected
|
||||||
|
- What an attacker can do (impact) and under what conditions
|
||||||
|
- A minimal reproduction case or proof-of-concept if you have one
|
||||||
|
- Whether you believe it is remotely exploitable
|
||||||
|
|
||||||
|
You do not need a working exploit to report. An incomplete report is better
|
||||||
|
than no report.
|
||||||
|
|
||||||
|
## What to expect
|
||||||
|
|
||||||
|
This is a volunteer-maintained open-source project. We will do our best to
|
||||||
|
respond in a reasonable timeframe, but cannot commit to specific deadlines.
|
||||||
|
|
||||||
|
We ask that you give us a fair opportunity to investigate and address the
|
||||||
|
issue before any public disclosure. If you have not heard back after
|
||||||
|
**90 days**, feel free to follow up or proceed with disclosure at your
|
||||||
|
discretion.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
In scope:
|
||||||
|
- Remote code execution, memory corruption, or denial-of-service via crafted
|
||||||
|
radio packets
|
||||||
|
- Authentication or encryption bypasses
|
||||||
|
- Vulnerabilities in the packet routing or path handling logic
|
||||||
|
|
||||||
|
Out of scope:
|
||||||
|
- Physical access attacks (e.g., JTAG, UART extraction of keys)
|
||||||
|
- Regulatory compliance (duty cycle, frequency restrictions)
|
||||||
|
- Jamming or other physical-layer radio interference
|
||||||
|
- Issues in third-party libraries (RadioLib, Crypto, etc.) — report those
|
||||||
|
upstream
|
||||||
|
- "Best practice" suggestions without a demonstrated attack path
|
||||||
@@ -1,5 +1,8 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# exit when any command fails
|
||||||
|
set -e
|
||||||
|
|
||||||
global_usage() {
|
global_usage() {
|
||||||
cat - <<EOF
|
cat - <<EOF
|
||||||
Usage:
|
Usage:
|
||||||
@@ -275,4 +278,11 @@ elif [[ $1 == "build-repeater-firmwares" ]]; then
|
|||||||
build_repeater_firmwares
|
build_repeater_firmwares
|
||||||
elif [[ $1 == "build-room-server-firmwares" ]]; then
|
elif [[ $1 == "build-room-server-firmwares" ]]; then
|
||||||
build_room_server_firmwares
|
build_room_server_firmwares
|
||||||
|
elif [[ $1 == "get-companion-firmwares-to-build" ]]; then
|
||||||
|
get_pio_envs_ending_with_string "_companion_radio_usb"
|
||||||
|
get_pio_envs_ending_with_string "_companion_radio_ble"
|
||||||
|
elif [[ $1 == "get-repeater-firmwares-to-build" ]]; then
|
||||||
|
get_pio_envs_ending_with_string "_repeater"
|
||||||
|
elif [[ $1 == "get-room-server-firmwares-to-build" ]]; then
|
||||||
|
get_pio_envs_ending_with_string "_room_server"
|
||||||
fi
|
fi
|
||||||
|
|||||||
+25
-1
@@ -28,12 +28,25 @@ This document provides an overview of CLI commands that can be sent to MeshCore
|
|||||||
**Usage:**
|
**Usage:**
|
||||||
- `reboot`
|
- `reboot`
|
||||||
|
|
||||||
|
**Note:** No reply is sent.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Power-off the node
|
||||||
|
**Usage:**
|
||||||
|
- `poweroff`, or
|
||||||
|
- `shutdown`
|
||||||
|
|
||||||
|
**Note:** No reply is sent.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Reset the clock and reboot
|
### Reset the clock and reboot
|
||||||
**Usage:**
|
**Usage:**
|
||||||
- `clkreboot`
|
- `clkreboot`
|
||||||
|
|
||||||
|
**Note:** No reply is sent.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Sync the clock with the remote device
|
### Sync the clock with the remote device
|
||||||
@@ -632,10 +645,21 @@ This document provides an overview of CLI commands that can be sent to MeshCore
|
|||||||
**Parameters:**
|
**Parameters:**
|
||||||
- `value`: Maximum flood hop count (0-64) for a packet without a scope (no region set)
|
- `value`: Maximum flood hop count (0-64) for a packet without a scope (no region set)
|
||||||
|
|
||||||
**Default:** `0xFF` - indicates it hasn't been set, will track flood.max until it is.
|
**Default:** `64` - (`0xFF` indicates it hasn't been set, will track flood.max until it is.)
|
||||||
|
|
||||||
**Note:** An alternative to `region denyf *`, setting `flood.max.unscoped` to a lower value such as `3` would allow for local unscoped messages to propagate, while preventing noisy neighbors from flooding a local region.
|
**Note:** An alternative to `region denyf *`, setting `flood.max.unscoped` to a lower value such as `3` would allow for local unscoped messages to propagate, while preventing noisy neighbors from flooding a local region.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Limit the number of hops for an advert flood message
|
||||||
|
**Usage:**
|
||||||
|
- `get flood.max.advert`
|
||||||
|
- `set flood.max.advert <value>`
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
- `value`: Maximum flood hop count (0-64) for an advert packet
|
||||||
|
|
||||||
|
**Default:** `8`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+3
-1
@@ -12,8 +12,10 @@ meshcore://channel/add?name=Public&secret=8b3387e9c5cdea6ac9e5edbaa115cd72
|
|||||||
|
|
||||||
**Parameters**:
|
**Parameters**:
|
||||||
|
|
||||||
- `name`: Channel name (URL-encoded if needed)
|
- `name`: Channel name (URL-encoded)
|
||||||
- `secret`: 16-byte secret represented as 32 hex characters
|
- `secret`: 16-byte secret represented as 32 hex characters
|
||||||
|
- `region_scope`: Region Scope (optional, URL-encoded if provided)
|
||||||
|
- Supported by MeshCore App v1.47.0+
|
||||||
|
|
||||||
## Add Contact
|
## Add Contact
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user