Metadata-Version: 2.4
Name: evocode
Version: 0.2.1
Summary: Read, decode, sign and write BMW NBT EVO (QNX) coding over ENET/HSFZ — pure stdlib.
Author: Igor Titov
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2026 Igor Titov
        
           Licensed 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.
        
Project-URL: Homepage, https://github.com/FreZZZeR/evocode
Project-URL: Source, https://github.com/FreZZZeR/evocode
Keywords: bmw,nbt-evo,coding,hsfz,uds,enet,idrive,qnx
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Provides-Extra: crypto
Requires-Dist: cryptography>=41; extra == "crypto"
Provides-Extra: ssh
Requires-Dist: paramiko<5,>=3; extra == "ssh"
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Dynamic: license-file

# nbt-evo-coding (`evocode`)

> **Language:** English · [Русский](README.ru.md) — see [TRANSLATING.md](TRANSLATING.md) to add one.

Read, decode, sign and write the **coding** of a BMW **NBT EVO** head unit over ENET/HSFZ —
a small, dependency-free Python library and CLI.

> 🤖 **Driven by an AI agent or a technical operator at the car — not a self-serve consumer app.**
> Each command assumes someone who can read a UDS negative-response code, connect ENET and judge
> whether a change behaved on the unit. Start at **[AGENTS.md](AGENTS.md)**: the operating model, the
> two access planes (why coding and FSC need **no SSH**), and the risk map.

> **Scope: NBT EVO (QNX) only** — iDrive **ID4 / ID5 / ID6**. This is **not** for MGU / **ID7+**
> (BMW OS 7/8, Linux); that is a different head unit and a different platform. See
> [docs/scope.md](docs/scope.md).

> ⚠️ **Writing coding can brick or degrade your head unit.** Reads are safe; writes are gated,
> default to a dry run, and refuse unless the connected car's VIN matches the one you own. Always
> back up first, verify offline, and keep the backup as your revert. Use only on a car you own.

## Status

Early (0.1), but validated against real BMW data — not just internally:

- **Transport, `BMWSigVerify` signature, read, verify, sign** — the signer reproduces a real car's
  own NCD signature byte-for-byte ([examples/a4a.md](examples/a4a.md)).
- **Write** — full choreography, **dry-run by default**, gated on your VIN.
- **`recover-key`** — recovers your own NCD/L3 signing key from your own PSdZData; reproduces the
  reference key exactly (needs the `crypto` extra).
- **`decode`** — reads a backup against a per-CAFD catalog.
- **`build-catalog`** — decrypts your own `.caf` (CMS + gzip) and writes a full coordinate skeleton
  (1469 coordinates for CAFD `00001EF6`; A4A/CarPlay verified). Parameter **names** are a community
  overlay (BMW strips them); no pre-derived BMW data is shipped — the catalog in `catalogs/` is the
  named starter (A4A, CarPlay today), while the full 1469-coordinate skeleton is what `build-catalog`
  emits from your own data. Needs the `crypto` extra + an `openssl` binary.

## Install

```bash
pip install -e .          # pure stdlib; no runtime dependencies
```

## Quickstart

```bash
export NBTEVO_OWN_VIN=<your VIN>      # the VIN of the car you own

# 1. Identify the unit (reads the SVK: BTLD + CAFD + VIN). Never assume these.
evocode identify --host 169.254.199.99

# 2. Back up the live coding to an NCD (do this every time — it is also your revert).
evocode read --host 169.254.199.99 -o backup.ncd

# See what your coding currently says, against a catalog.
evocode decode --ncd backup.ncd --catalog catalogs/cafd_00001ef6.json

# 3. Recover YOUR coding signing key from YOUR PSdZData (one time), then prove the signer
#    reproduces the car's own signature byte-for-byte.
evocode recover-key --btld 00001FFD --psdzdata /path/to/psdzdata -o key.json
evocode verify --ncd backup.ncd --key key.json

# 4. Edit a coding byte and re-sign offline (verified locally before anything goes to the car).
evocode sign backup.ncd modified.ncd --key key.json --set 0x3000,107,1,0x80,7

# 5. Write it (DRY RUN unless --commit; --commit re-checks VIN and the signature first).
evocode write --host 169.254.199.99 --ncd modified.ncd --key key.json --l3-key l3.json --commit

# 6. Confirm: read back and diff, and watch the HMI come up. Revert = write backup.ncd.
evocode read --host 169.254.199.99 -o after.ncd
```

## How it works (one paragraph)

The NBT EVO re-verifies a cryptographic signature over its coding **at every boot**. A raw byte
edit reverts unless you also recompute that signature with the key the bootloader (BTLD) selects.
So a durable change is: edit the datagroups, recompute the `BMWSigVerify` signature (MD5 digest,
RSA `e=3`, BMW's word-swapped big-number encoding, stored in datagroup `0x3010`), then write both
through the authenticated UDS coding session (SecurityAccess L3, `2E` per datagroup with the
signature last, `CheckCodingSignature`, CPS, reset). The maths is in
[`evocode/coding.py`](evocode/coding.py); the wire flow in [docs/protocol.md](docs/protocol.md).

## Catalogs — how a raw coordinate becomes a readable parameter

`0x3000,107,bit7` means nothing until a **catalog** says it is `A4A` on your CAFD. Catalogs are
per-CAFD maps built from **your own** PSdZData with `evocode build-catalog` (see
[catalogs/README.md](catalogs/README.md)). This keeps provenance clean and lets the community add
units by contributing catalogs, not code — the same code serves every NBT EVO build. To add or name
a parameter, follow **[catalogs/CONTRIBUTING.md](catalogs/CONTRIBUTING.md)** (for people and agents).

## FSC activations (owner-CA)

Separate capability from coding: an FSC (CarPlay, nav, A4A…) is verified against a single modulus
(**blobB**) in the firmware (`e=3`/MD5), not against BMW's coding key. On a car you own you can move
that trust to your **own** key and mint FSCs under it:

```bash
evocode fsc keygen -o owner.json --blobb owner_blobB.bin           # your e=3 anchor
evocode fsc find-blobb NBTCarHU                                    # locate the installed anchor + fingerprint
evocode fsc whosigned --fsc a.fsc --fsc b.fsc --recover           # whose anchor is on a used unit?
evocode fsc patch-blobb NBTCarHU --key owner.json --backup stock_blobB.bin -o NBTCarHU.patched
evocode fsc mint --key owner.json --appno 0x0143 -o carplay.fsc   # CarPlay (VIN-generic)
evocode fsc apply --fsc-dir ./fscs                                # dry-run; add --host/--l3-key/--commit to write
evocode fsc read  --host 169.254.199.99 --appno 0x0143            # read current FSC status (safe, no SecurityAccess)
evocode fsc disable --host 169.254.199.99 --appno 0x0143          # dry-run; add --l3-key/--commit to disable one
```

`verify` / `parse` / `fingerprint` / `from-log` / `read` / `disable` round it out. Installing the patched `NBTCarHU` is a
firmware-replace step (brick-risk): back up the stock anchor (`--backup`) and keep it to revert, and
rehearse the swap first in an emulator — see [docs/testing.md](docs/testing.md). evocode can do the
install itself over SSH — `evocode fw install` (optional `[ssh]` extra): backup + rename-over to a new
inode, dry-run by default (`fw pull` fetches the live binary to patch, `fw revert` restores it).
That step needs a root shell on the unit — see **[docs/root-access.md](docs/root-access.md)** for how
root/SSH is enabled (OPT_DEBUG), why it's an ENET flash and not itself an SSH operation, and its risks.

## License & provenance

Apache License 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE). Apache 2.0 was chosen over MIT
for two protections it builds in, both in its **Section 3**:

- **Automatic patent license — protects users.** Every contributor grants a perpetual, royalty-free
  patent license over their contributions, so you can use the project without a later patent claim
  from the people who wrote it. (MIT is silent on patents; Apache grants them.)
- **Patent-retaliation "self-destruct" — protects the project and community.** If anyone starts
  patent litigation claiming this work infringes, their patent license to it **terminates
  automatically** as of the day they file — so patents can't be weaponised against the community
  while still enjoying the grant.

Apache's retaliation is scoped to **patent** litigation over this work; it does not revoke rights
for copyright or unrelated disputes. Broader defensive termination would be a non-standard add-on
on top of the canonical license — open an issue to discuss rather than editing `LICENSE`.

This is an independent re-implementation that vendors no third-party code — mostly clean-room, with
one module (`swdl.py`) shaped by an existing flasher's observed wire behaviour; see
[CREDITS.md](CREDITS.md).
