From 6152f46c1c95a448628c30aee386db34b26625d2 Mon Sep 17 00:00:00 2001 From: clydebarrow <2366188+clydebarrow@users.noreply.github.com> Date: Tue, 4 Feb 2025 10:47:13 +1100 Subject: [PATCH 1/2] Add xxtea docs --- components/xxtea.rst | 22 ++++++++++++++++++++++ images/xxtea.svg | 1 + index.rst | 1 + 3 files changed, 24 insertions(+) create mode 100644 components/xxtea.rst create mode 100644 images/xxtea.svg diff --git a/components/xxtea.rst b/components/xxtea.rst new file mode 100644 index 0000000000..21fb80f1b2 --- /dev/null +++ b/components/xxtea.rst @@ -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 `_ 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` diff --git a/images/xxtea.svg b/images/xxtea.svg new file mode 100644 index 0000000000..3f691aecb3 --- /dev/null +++ b/images/xxtea.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/index.rst b/index.rst index 5aa903f660..0b1fd817ed 100644 --- a/index.rst +++ b/index.rst @@ -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 Script, components/script, description.svg, dark-invert ESPHome Configuration From 42f688f1dfbfa3ce25799999ec5364b153ecc159 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:17:30 +1300 Subject: [PATCH 2/2] Update index.rst --- index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.rst b/index.rst index 0b1fd817ed..f2c7b060f1 100644 --- a/index.rst +++ b/index.rst @@ -178,7 +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 + XXTEA, components/xxtea, xxtea.svg Script, components/script, description.svg, dark-invert ESPHome Configuration