Metadata-Version: 2.4
Name: chameleon-rf
Version: 0.2.0
Summary: Software for controlling and managing Chameleon Lite and Chameleon Ultra devices
Author-email: Mischif <mischif@noreply.codeberg.org>
License-Expression: SSPL-1.0
Project-URL: source, https://codeberg.org/mischif/chameleon-rf
Project-URL: releasenotes, https://codeberg.org/mischif/chameleon-rf/releases/latest
Project-URL: changelog, https://codeberg.org/mischif/chameleon-rf/src/CHANGELOG.md
Project-URL: issues, https://codeberg.org/mischif/chameleon-rf/issues
Keywords: rfid,nfc,chameleon ultra,chameleon lite,mifare,em410x,em4x05,em4x69,hid prox,ioprox,jablotron,viking
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Requires-Python: ~=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pyserial==3.5
Requires-Dist: textual==8.2.3
Requires-Dist: click==8.3.2
Dynamic: license-file

chameleon-rf
============

chameleon-rf is an application for interacting with [Chameleon Lite and Ultra devices](https://github.com/RfidResearchGroup/ChameleonUltra/wiki/hardware) - once connected to your device, you can:

- Interact with physical and cloned versions of these NFC tags:
	- MIFARE Classic (full tags and individual value blocks)

- Emulate these NFC tags:
	- MIFARE Classic

- Interact with physical and cloned versions of these RFID tags:
	- EM410X
	- HID Prox
	- ioProx
	- Jablotron
	- PAC/Stanley
	- Viking
	- EM4X05/EM4X69 (Read only)
	- IDTECK (Write only)

- Emulate these RFID tags:
	- EM410X
	- HID Prox
	- IDTECK
	- ioProx
	- Jablotron
	- PAC/Stanley
	- Viking

- Manage emulator settings:
	- Slot tag type and any type-specific settings
	- Stored slot tag data
	- Slot nickname
	- Slot enabled/disabled
	- Currently active slot

- Manage device settings:
	- Animation
	- BLE pairing
	- Button actions
	- Device mode
	- Sleep timeout

This client is in very early stages; in future versions, you will be able to:

- Scroll command history
- Read, store and emulate additional NFC-based tags like DESFire and NTAG
- Interact with magic MIFARE tags using magic commands
- Execute attacks to find tag keys

Installation
------------

If you have Python installed, installing this client is a single command:

	python -m pip install chameleon-rf

Usage
-----

Once installed, start the client with a single command:

	chameleon

Once the client has started, you will be able to connect to your device(s) and interact with them.

To see the available commands, you can type `--help`; every command should show all subcommands or arguments when appended with `--help`:

![uioverview](./docs/img/ui_overview.png)

License
-------

chameleon-rf is released under version 1 of the [Server Side Public License](./LICENSE.txt)
