{"id":26423780,"url":"https://github.com/piperliu/easy-cipher-content","last_synced_at":"2025-03-18T02:54:25.588Z","repository":{"id":281029416,"uuid":"934264510","full_name":"PiperLiu/easy-cipher-content","owner":"PiperLiu","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-06T15:25:25.000Z","size":2407,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T16:29:02.231Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PiperLiu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2025-02-17T14:45:03.000Z","updated_at":"2025-03-06T15:25:29.000Z","dependencies_parsed_at":"2025-03-06T16:39:30.490Z","dependency_job_id":null,"html_url":"https://github.com/PiperLiu/easy-cipher-content","commit_stats":null,"previous_names":["piperliu/easy-cipher-content"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiperLiu%2Feasy-cipher-content","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiperLiu%2Feasy-cipher-content/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiperLiu%2Feasy-cipher-content/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiperLiu%2Feasy-cipher-content/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PiperLiu","download_url":"https://codeload.github.com/PiperLiu/easy-cipher-content/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244147325,"owners_count":20405940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-03-18T02:54:24.949Z","updated_at":"2025-03-18T02:54:25.581Z","avatar_url":"https://github.com/PiperLiu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Easy Cipher Content\n\nA powerful VS Code extension for securing both text and binary files with industry-standard encryption algorithms. Easily protect your sensitive data while maintaining a seamless workflow in your development environment.\n\n![Encrypt / Decrypt One File](https://raw.githubusercontent.com/PiperLiu/easy-cipher-content/refs/heads/main/docs/example.file.gif)\n\n## Features\n\n- 🔒 **Encrypt** and 🔓 **Decrypt** content with a single click\n- 🔄 Support for both text files (line-by-line encryption) and binary files (complete file encryption)\n- 🗄️ Batch operations for entire workspaces or specific directories\n- 📂 Smart path suggestions and file browser integration\n- 🚫 Configurable ignore patterns for excluding files from batch operations\n- 🔐 Enterprise-grade encryption algorithms: AES-GCM and ChaCha20-Poly1305\n- 🛠️ Flexible key management via environment variables or JSON configuration\n\n## Getting Started\n\n### Installation\n\n1. Open VS Code\n2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)\n3. Search for \"Easy Cipher Content\"\n4. Click Install\n\n### Setup\n\nConfigure your encryption keys using one of these methods:\n\n**Environment Variables** (Recommended for security)\n```\n# For AES-GCM\nexport VSCODE_EXT_ECC_AESGCM_PASSWORD=\"your-secure-password\"\nexport VSCODE_EXT_ECC_AESGCM_SALT=\"your-salt-value\"\nexport VSCODE_EXT_ECC_AESGCM_IV=\"your-initialization-vector\"\n\n# For ChaCha20-Poly1305\nexport VSCODE_EXT_ECC_CHACHA20POLY1305_PASSWORD=\"your-secure-password\"\nexport VSCODE_EXT_ECC_CHACHA20POLY1305_SALT=\"your-salt-value\"\nexport VSCODE_EXT_ECC_CHACHA20POLY1305_NONCE=\"your-nonce-value\"\n```\n\n**JSON Configuration**\nCreate a JSON file with your encryption keys and set the path in the extension settings.\n\n## Usage\n\n### Single File Operations\n\n1. Open a file in the editor\n2. Click the 🔒 **Encrypt** or 🔓 **Decrypt** button in the editor title bar\n3. For text files, content is encrypted line-by-line, preserving the file structure\n4. For binary files, a new encrypted file is created with the `.enc` extension\n\n### Workspace Operations\n\nEncrypt or decrypt multiple files in your workspace:\n\n1. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)\n2. Type and select one of the following:\n   - `Easy Cipher Content: 🔒 Encrypt All Files in Workspace`\n   - `Easy Cipher Content: 🔓 Decrypt All Files in Workspace`\n   - `Easy Cipher Content: 🔒 Encrypt Specific Files or Directories`\n   - `Easy Cipher Content: 🔓 Decrypt Specific Files or Directories`\n\n### Path Selection\n\nWhen choosing specific files or directories to process, you have three convenient options:\n\n1. **Quick Selection**: Choose from smart suggestions of common directories and files\n2. **Custom Path**: Enter a custom path relative to your workspace or an absolute path\n3. **File Browser**: Use the integrated file picker to visually select files or folders\n\n![Path Selection Interface](https://raw.githubusercontent.com/PiperLiu/easy-cipher-content/refs/heads/main/docs/example.path.gif)\n\n### Ignoring Files and Directories\n\nCreate a `.easy-cipher-content-ignore` file in your workspace root with patterns similar to `.gitignore`:\n\n```\n# Example ignore patterns\nnode_modules/\n*.log\n.git/\ndist/\n```\n\n## Extension Settings\n\nThis extension provides the following settings:\n\n* `easy-cipher-content.algorithm`: Choose encryption algorithm (\"aes-gcm\" or \"chacha20-poly1305\")\n* `easy-cipher-content.use_env`: Whether to use environment variables for encryption keys\n* `easy-cipher-content.json_path`: Path to JSON file containing encryption keys (if not using env vars)\n* `easy-cipher-content.textFileExtensions`: Array of file extensions to be treated as text files\n* `easy-cipher-content.ignoreFile`: Name of the file containing ignore patterns\n* `easy-cipher-content.deleteOriginalAfterEncryption`: Whether to delete original files after encryption\n\n## Security Best Practices\n\n- **Never commit** encryption keys or encrypted sensitive data to public repositories\n- Use **environment variables** rather than JSON files for key management when possible\n- Set up a secure method for sharing encryption keys with team members\n- Consider using different keys for different projects or types of sensitive data\n\n## Technical Details\n\n### Text File Encryption\n\nText files are processed line by line, with each non-empty line encrypted individually. This approach:\n- Preserves file structure and line breaks\n- Makes diff tools still useful for encrypted files\n- Allows partial decryption if only certain lines need to be accessible\n\n### Binary File Encryption\n\nBinary files are encrypted as complete units, resulting in a new file with the `.enc` extension.\n\n## Known Issues\n\n- Very large binary files may cause performance issues during encryption/decryption\n- Some special encodings might not be preserved perfectly in text mode encryption\n- The extension cannot automatically detect binary vs text files outside the configured extensions\n\n## Troubleshooting\n\n**Issue**: Decryption fails with \"Invalid password\" error\n**Solution**: Verify that you're using the same encryption key that was used for encryption\n\n**Issue**: Binary files are being treated as text files\n**Solution**: Add the file extension to the `textFileExtensions` setting if it should be treated as text, or remove it if it should be treated as binary\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n## Acknowledgments\n\n- Built with [easy-cipher-mate](https://github.com/PiperLiu/easy-cipher-mate) encryption library\n- Inspired by the need for simple but secure content protection in VS Code\n\n---\n\n**Privacy Notice**: This extension performs all encryption and decryption locally on your machine. Your encryption keys and content are never transmitted to any server.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiperliu%2Feasy-cipher-content","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiperliu%2Feasy-cipher-content","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiperliu%2Feasy-cipher-content/lists"}