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
40 changes: 40 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
#
# 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 NimBLE is a Bluetooth Low Energy (BLE) host + controller stack.
Before reporting a security issue, consult `THREAT_MODEL.md`: most BLE
traffic is unauthenticated by the Bluetooth specification (open
advertising, pre-encryption traffic, and "Just Works" pairing has no MITM
protection), and those spec-defined behaviours are not NimBLE defects. The
in-model surface is memory safety in the radio PDU parsers (LL / HCI /
L2CAP / ATT / SM) and the correctness of the Security Manager's pairing
cryptography. See the §11a known-non-findings list.
43 changes: 43 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!--
#
# 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 NimBLE's security threat model — its scope, trust boundaries (the
graduated radio-trust tiers), 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 point for triagers and scanners: a large part of BLE is unauthenticated
by the Bluetooth specification (open advertising, traffic before encryption
is established, and "Just Works" pairing, which provides no MITM
protection). Those are spec-defined, not NimBLE bugs. The in-model surface
is memory safety in the PDU parsers and the correctness of the Security
Manager's cryptography. See `THREAT_MODEL.md` §9 and §11a.
Loading
Loading