{"id":50311754,"url":"https://github.com/midnight-wonderer/embedded-xoodyak","last_synced_at":"2026-05-28T21:30:49.760Z","repository":{"id":358854330,"uuid":"1243365094","full_name":"midnight-wonderer/embedded-xoodyak","owner":"midnight-wonderer","description":"Lightweight, zero-allocation Xoodyak cryptographic scheme in C for microcontrollers.","archived":false,"fork":false,"pushed_at":"2026-05-19T09:46:32.000Z","size":88,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-19T12:19:55.674Z","etag":null,"topics":["c-library","cortex-m","cryptography","embedded","esp8266","microcontroller","xoodoo","xoodyak"],"latest_commit_sha":null,"homepage":"","language":"Assembly","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/midnight-wonderer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-19T09:19:48.000Z","updated_at":"2026-05-19T09:35:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/midnight-wonderer/embedded-xoodyak","commit_stats":null,"previous_names":["midnight-wonderer/embedded-xoodyak"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/midnight-wonderer/embedded-xoodyak","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midnight-wonderer%2Fembedded-xoodyak","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midnight-wonderer%2Fembedded-xoodyak/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midnight-wonderer%2Fembedded-xoodyak/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midnight-wonderer%2Fembedded-xoodyak/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/midnight-wonderer","download_url":"https://codeload.github.com/midnight-wonderer/embedded-xoodyak/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midnight-wonderer%2Fembedded-xoodyak/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33627934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-28T02:00:06.440Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-library","cortex-m","cryptography","embedded","esp8266","microcontroller","xoodoo","xoodyak"],"created_at":"2026-05-28T21:30:48.101Z","updated_at":"2026-05-28T21:30:49.753Z","avatar_url":"https://github.com/midnight-wonderer.png","language":"Assembly","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Embedded Xoodyak Library\n\nA portable, lightweight, and zero-allocation C library implementing the **Xoodyak** cryptographic scheme (based on the Cyclist construction and the **Xoodoo** permutation). \n\nThis library is designed specifically for resource-constrained embedded systems and microcontrollers (e.g., ESP8266, ARM Cortex-M).\n\n---\n\n## How to Build / Integrate\n\nTo use this library, add `include/` to your header search paths.\n\n### 1. Automatic Selection (Recommended)\nYou can simply compile all source files in the `src/` directory:\n* `src/Xoodyak.c`\n* `src/Xoodoo-portable.c`\n* `src/Xoodoo-helpers.c`\n* `src/Xoodoo-lx106.S`\n* `src/Xoodoo-armv6m.S`\n* `src/Xoodoo-armv7m.S`\n\nThe library uses built-in C preprocessor macros to automatically select the most optimized implementation for your target CPU architecture (Xtensa, ARMv6-M, ARMv7-M) and disable the others at compile time.\n\n### 2. Manual Selection\nAlternatively, you can compile `src/Xoodyak.c` along with only the files for your target platform:\n\n* **Portable C (Generic Fallback)**: Compile `src/Xoodyak.c` and `src/Xoodoo-portable.c`.\n* **Xtensa LX106 (ESP8266 / NodeMCU)**: Compile `src/Xoodyak.c`, `src/Xoodoo-helpers.c`, and `src/Xoodoo-lx106.S`.\n* **ARM Cortex-M0 / M0+ (ARMv6-M)**: Compile `src/Xoodyak.c`, `src/Xoodoo-helpers.c`, and `src/Xoodoo-armv6m.S`.\n* **ARM Cortex-M3 / M4 / M7 (ARMv7-M)**: Compile `src/Xoodyak.c`, `src/Xoodoo-helpers.c`, and `src/Xoodoo-armv7m.S`.\n\n---\n\n## API Usage Example\n\nHere is a simple example showing how to initialize Xoodyak, absorb a message, and squeeze a hash:\n\n```c\n#include \"Xoodyak.h\"\n#include \u003cstdio.h\u003e\n\nvoid hash_example(void) {\n    Xoodyak_Instance instance;\n    uint8_t hash[32];\n    const uint8_t msg[] = \"Hello Embedded World!\";\n\n    // 1. Initialize in Hashing Mode (no key)\n    Xoodyak_Initialize(\u0026instance, NULL, 0, NULL, 0, NULL, 0);\n\n    // 2. Absorb data\n    Xoodyak_Absorb(\u0026instance, msg, sizeof(msg) - 1);\n\n    // 3. Squeeze digest output\n    Xoodyak_Squeeze(\u0026instance, hash, sizeof(hash));\n\n    // Print hash\n    for(size_t i = 0; i \u003c sizeof(hash); ++i) {\n        printf(\"%02x\", hash[i]);\n    }\n    printf(\"\\n\");\n}\n```\n\n### Keyed mode (encryption/decryption):\n```c\n#include \"Xoodyak.h\"\n\nvoid encrypt_example(void) {\n    Xoodyak_Instance instance;\n    const uint8_t key[16] = \"MySecretKey12345\";\n    const uint8_t nonce[16] = \"UniqueNonce54321\";\n    \n    const uint8_t plaintext[] = \"Confidential data\";\n    uint8_t ciphertext[sizeof(plaintext)];\n    uint8_t tag[16];\n\n    // Initialize with Key and Nonce (ID)\n    Xoodyak_Initialize(\u0026instance, key, sizeof(key), nonce, sizeof(nonce), NULL, 0);\n\n    // Encrypt\n    Xoodyak_Encrypt(\u0026instance, plaintext, ciphertext, sizeof(plaintext));\n\n    // Squeeze out Authentication Tag\n    Xoodyak_Squeeze(\u0026instance, tag, sizeof(tag));\n}\n```\n\n## License\nThis project is dedicated to the public domain under the Creative Commons CC0 1.0 Universal Public Domain Dedication, matching the licensing of the underlying XKCP source components. See the `LICENSE.md` file for details.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidnight-wonderer%2Fembedded-xoodyak","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmidnight-wonderer%2Fembedded-xoodyak","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidnight-wonderer%2Fembedded-xoodyak/lists"}