Adding documentation around swfencrypt and encrypted embed data#190
Adding documentation around swfencrypt and encrypted embed data#190marchbold merged 2 commits intoairsdk:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new documentation page under Tools → Compiling & Packaging describing two approaches for encrypting SWF-related content in AIR: whole-SWF encryption via swfencrypt and compiler-driven encrypted embedded blob data.
Changes:
- Introduces a new MDX page documenting
swfencryptusage and runtime behavior. - Documents the
Embed(..., encrypted=...)option andSystem.decryptBlob()workflow, including-compiler.encryption-key. - Adds a new sidebar category for the encryption docs section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/tools/building/encryption/index.mdx | New documentation page explaining SWF encryption approaches and how to decrypt embedded encrypted blobs at runtime. |
| docs/tools/building/encryption/category.json | Creates a new “Encryption” category entry in the docs sidebar hierarchy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
| [Embed(source="filename.dat", mimeType="application/octet-stream")] | ||
| private const MyData : Class; | ||
| ``` |
There was a problem hiding this comment.
The ActionScript example uses spaces around the type annotation colon (e.g., MyData : Class). Elsewhere in the docs (including the coding conventions) the style is name:Type; update this snippet to match for consistency.
| ``` | ||
| [Embed(source="filename.dat", mimeType="application/octet-stream", encrypted="true")] | ||
| private const MyData1 : Class; | ||
| [Embed(source="filename.dat", mimeType="application/octet-stream", encrypted="encryption_key_1")] | ||
| private const MyData2 : Class; | ||
| ``` |
There was a problem hiding this comment.
Same ActionScript formatting issue here: the type annotations are written with spaces around the colon (e.g., MyData1 : Class). Update to the repository’s documented convention (name:Type) for consistency.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
A new file/topic that describes the options we have for encrypting SWF content, either via the swfencrypt tool or by using the AIR compiler with embedded data and the 'encrypted' setting.