Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
-->

# Agent guidance

This file is read by automated agents (security scanners, code analyzers,
AI assistants) operating on this repository. It points them at the
human-authored references they should consult before producing output.

## Security

Security model: [SECURITY.md](./SECURITY.md), which links to the project's
threat model at [THREAT_MODEL.md](./THREAT_MODEL.md).

Apache Mynewt is a real-time operating system for constrained 32-bit
devices. Before reporting a security issue, consult `THREAT_MODEL.md`:
Mynewt runs in a single address space with no inter-component isolation, so
the in-model surface is memory safety in the externally-reachable parsers
(`net/`, `mgmt/`, `fs/`, `encoding/`) and kernel objects reachable from
input. Out of model: vendored Mbed-TLS internal CVEs (upstream's),
protocol-spec weaknesses, the no-authentication management surface (modelled
in `apache/mynewt-mcumgr`), and firmware-image authenticity (the
bootloader's). The BLE radio surface is modelled in `apache/mynewt-nimble`.
See the §11a known-non-findings list.
46 changes: 46 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
-->

# Security Policy

## Reporting a Vulnerability

Please report suspected security vulnerabilities privately to the Apache
Security Team at <security@apache.org>, following the ASF process at
<https://www.apache.org/security/>. Do not open public GitHub issues or
pull requests for security reports.

## Threat Model

Apache Mynewt's security threat model — its scope, trust boundaries, the
security properties it does and does not provide, the adversary model, and a
list of recurring non-findings — is documented in
[THREAT_MODEL.md](./THREAT_MODEL.md).

Key points for triagers and scanners: Mynewt runs in a single address space
with no inter-component isolation, so the in-model surface is memory safety
in the externally-reachable parsers (`net/`, `mgmt/`, `fs/`, `encoding/`)
and kernel objects. Out of model are vendored Mbed-TLS internal CVEs
(tracked via upstream), protocol-specification weaknesses, the
no-authentication management surface (see the `apache/mynewt-mcumgr` model),
and firmware-image authenticity (enforced by the signature-verifying
bootloader). The BLE radio surface is modelled in `apache/mynewt-nimble`.
See `THREAT_MODEL.md` §9 and §11a.
Loading
Loading