Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add xxtea docs #4640

Merged
merged 2 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
22 changes: 22 additions & 0 deletions components/xxtea.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
XXTEA Component
===============

.. seo::
:description: Lightweight encryption algorithm for ESPHome
:keywords: xxtea

This component cannot be used directly in YAML, but can be used in lambdas to encrypt and decrypt data.

The encryption used is `XXTEA <https://en.wikipedia.org/wiki/XXTEA>`_ which is fast and compact. XXTEA is known
to be susceptible to a chosen-plaintext attack, so it should not be used where plain-text injection is possible.

The algorithm has been modified from the original to use a 256 bit key instead of the original 128 bit key.

See the API docs for more information on how to use this component.

See Also
--------

- :doc:`index`
- :apiref:`xxtea/xxtea.h`
- :ghedit:`Edit`
1 change: 1 addition & 0 deletions images/xxtea.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ ESPHome-specific components or components supporting ESPHome device provisioning
Improv via Serial, components/improv_serial, improv.svg, dark-invert
Interval, components/interval, description.svg, dark-invert
JSON, components/json, json.svg, dark-invert
XXTEA, components/xxtea, xxtea.svg, dark-invert
jesserockz marked this conversation as resolved.
Show resolved Hide resolved
Script, components/script, description.svg, dark-invert

ESPHome Configuration
Expand Down