| Version | Supported | End of Support |
|---|---|---|
| 1.0.x | ✅ | Current |
| < 1.0.0 | ❌ | Not supported |
OSynaptic-TX is a TX-only encoder — it does not accept or parse any external input. The attack surface is therefore minimal. However, integrators should be aware of:
- Value scaling: the
scaledparameter is a signed 32-bit integer. Ensure sensor readings are range-checked before passing toostx_sensor_pack()/ostx_static_pack()/ostx_stream_pack(). - Agent ID confidentiality: the
aidfield is transmitted in plaintext. Do not use cryptographic keys or sensitive identifiers as agent IDs. - Transport security: OSynaptic-TX produces unencrypted frames. If confidentiality is required, encrypt at the transport layer (e.g., TLS over TCP, DTLS over UDP).
- Replay protection: frames include a transaction ID (
tid) and timestamp (ts), but the library does not enforce monotonicity at the sender side — that responsibility lies with the receiving server.
- Timestamp source: use a reliable time source for
ts. Bogus timestamps can confuse the server-side deduplication logic. - Buffer sizes:
OSTX_PACKET_MAX(default 96) must be large enough for your longest sensor ID + unit + encoded value. Adjust inostx_config.hif needed. - Thread safety: the library has no internal locking. If used from multiple tasks (e.g., FreeRTOS), guard calls with a mutex at the application level.
Please do not publicly disclose security vulnerabilities. Instead:
-
Open a GitHub Security Advisory in the repository (preferred), or
email the maintainers with:- Description of the vulnerability
- Affected components and versions
- Proof of concept (without exposing a full working exploit)
- Suggested remediation if available
- Your name and contact information (for credit)
-
Response timeline:
- Acknowledgment: within 48 hours
- Initial assessment: within 1 week
- Fix preparation: within 2 weeks (severity dependent)
-
We will coordinate a disclosure timeline with you and credit responsible reporters in the release notes.
Published via:
- GitHub Security Advisories (when a CVE is assigned)
- Release notes and version tags on GitHub
Subscribe to release notifications to stay informed of security updates.