Sam's Text Encryptor

Table of content

• Features
• Installation
• How to use
• Managing settings
• Release Notes
• Contributing
• Acknowledgements
• Disclaimer

Features

This extension encrypts and decrypts the text present in the current window. It was designed to securely encrypt an entire file and to do so with maximum simplicity.

It uses the latest updates to the crypto library and the aes-256-gcm algorithm, which is extremely secure. It is the most secure encryption algorithm available today and is used extensively in government and military applications, as well as by businesses operating in highly regulated industries.

[Back to table of content]

Installation

1. Open Extensions sidebar panel in VS Code. View → Extensions
2. Search for Sam's Text Encryptor
3. Click Install to install it.

[Back to table of content]

How to use

At any time, you can press ⌘ + ⇧ + P on Mac or Control + ⇧ + P on Windows / Linux and start typing Encrypt or Decrypt.

You can choose from the following commands:

• Encrypt file
• Decrypt file

Choose one of the two commands. You will be asked to enter a key; if you have chosen to encrypt a file you will be asked to confirm the key entered.

Once the key is entered the file will be encrypted or decrypted depending on the command chosen.

WARNING!

1. If you forget the key it will no longer be possible to decrypt the file.
2. If you modify an encrypted file it will no longer be possible to decrypt it and the original content will be lost.

These risks are inherent to modern encryption systems: they are powerful but dangerous.

[Back to table of content]

Managing settings

Click on Manage / Extension settings. There is one setting:

Show Key In Plain Text It should be set to true to make the encryption/decryption key readable in plain text as you type it. Default is false

Alternatively, you can change the values ​​directly in the configuration file:

1. Open the command palette (either with F1 or Ctrl+Shift+P or Shift+Command+P)
2. Type open settings
3. You are presented with a few options, choose Open User Settings (JSON)
4. Add or modify the following line.

{
  "samtextencryptor.showKeyInPlainText": false
}

[Back to table of content]

Release Notes

To know the release notes refer to the CHANGELOG file.

[Back to table of content]

Contributing

Contributions to this project are welcomed!

Whether you have

• questions, concerns, or suggestions for improving this extension
• want to report a bug
• submit a fix
• propose new features

please don't hesitate to reach out to us on GitHub and open an issue.

[Back to table of content]

Acknowledgements

The engine of this extension is based on the crypto-shield package, which I choosed after studying the code.

The icon is created by Freepik - Flaticon

[Back to table of content]

Disclaimer

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.