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 f98621c632..19f9cb9c9f 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 Script, components/script, description.svg, dark-invert ESPHome Configuration