Picocrypt/README.md

113 lines
13 KiB
Markdown
Raw Normal View History

2021-08-16 22:32:01 +02:00
<p>English | <a href="/translations/french.md">Français</a> | <a href="/translations/spanish.md">Español</a> | <a href="/translations/german.md">Deutsch</a> | <a href="/translations/portuguese.md">Português</a> | <a href="/translations/turkish.md">Türkçe</a> | <a href="/translations/chinese.md">中文</a> | <a href="/translations/russian.md">русский</a></p>
2021-11-12 18:56:54 +01:00
<p align="center"><img align="center" src="/images/logo.svg" width="512" alt="Picocrypt"></p>
2021-03-15 03:17:52 +01:00
Picocrypt is a very small (hence <i>Pico</i>), very simple, yet very secure encryption tool that you can use to protect your files, generate checksums, shred files, and much more. It's designed to be the <i>go-to</i> tool for encryption, with a focus on security, simplicity, and reliability. Picocrypt uses the secure XChaCha20 cipher and the SHA3 hash function to provide a high level of security, even from three-letter agencies like the NSA. It's designed for maximal security, making absolutely no compromises security-wise, and is built with Go's standard x/crypto modules. <strong>Your privacy and security is under attack. Take it back with confidence by protecting your files with Picocrypt.</strong>
2021-02-18 21:41:56 +01:00
2021-11-12 18:57:12 +01:00
<p align="center"><img align="center" src="/images/screenshot.png" width="384" alt="Picocrypt"></p>
2021-02-19 21:26:53 +01:00
2021-06-07 20:55:22 +02:00
# Funding
2021-11-01 21:48:51 +01:00
Please donate to Picocrypt on <a href="https://opencollective.com/picocrypt">Open Collective</a> (crypto is accepted) to raise money for a potential audit from Cure53. Because this is a project that I spend many hours on and make no money from, I cannot pay for an audit myself. <i>Picocrypt needs support from its community.</i>
2021-06-07 20:55:22 +02:00
2021-03-29 17:17:04 +02:00
# Downloads
2021-08-07 23:10:51 +02:00
<strong>Important:</strong> There's an outdated and useless piece of abandonware called PicoCrypt on the Internet, which was last updated in 2005. PicoCrypt is not related in any way to Picocrypt (this project). Make sure you only download Picocrypt from the official website or this repository to ensure that you get the authentic and backdoor-free Picocrypt.
2021-02-25 18:37:19 +01:00
2021-05-30 01:15:25 +02:00
## Windows
2021-11-13 01:24:05 +01:00
Picocrypt for Windows is as simple as it gets. To download the latest, standalone, and portable executable for Windows, click <a href="https://github.com/HACKERALERT/Picocrypt/releases/download/1.20/Picocrypt.exe">here</a>. If Windows Defender or your antivirus flags Picocrypt as a virus, please do your part and submit it as a false positive for the betterment of everyone.
2021-03-19 21:28:59 +01:00
2021-05-30 01:15:25 +02:00
## macOS
2021-09-27 03:07:40 +02:00
Picocrypt for macOS is very simple as well. Download Picocrypt <a href="https://github.com/HACKERALERT/Picocrypt/releases/download/1.19/Picocrypt.app.zip">here</a>, extract the zip file, and run Picocrypt which is inside. If you can't open Picocrypt because it's not from a verified developer, right click on Picocrypt and hit "Open". If you still get the warning, right click on Picocrypt and hit "Open" again and you should be able to start Picocrypt.
2021-03-19 21:28:59 +01:00
2021-05-30 01:15:25 +02:00
## Linux
2021-10-11 04:08:17 +02:00
A Snap is available for Linux. Make sure you have [Snapcraft](https://snapcraft.io/) installed (`sudo apt install snapd`) and install Picocrypt: `sudo snap install picocrypt`. Due to the complexity of dependencies and static linking, I don't distribute standalone .deb or .rpm binaries because they would be unreliable and not worth the hassle. Snapcraft manages all dependencies and runtimes automatically and is the recommended way to run Picocrypt on any major Linux distribution. Additionally, Snapcraft provides better security and containerization than Flatpaks and AppImages, which is important for an encryption tool like Picocrypt. If you would prefer not to deal with Canonical, remember that building from source is always an option.
2021-02-19 02:04:25 +01:00
# Why Picocrypt?
2021-08-07 23:10:51 +02:00
Why should you use Picocrypt instead of BitLocker, NordLocker, VeraCrypt, AxCrypt, or 7-Zip? Here are a few reasons why you should choose Picocrypt:
2021-02-19 02:04:25 +01:00
<ul>
2021-05-30 01:15:25 +02:00
<li>Unlike NordLocker, BitLocker, AxCrypt, and most cloud storage providers, Picocrypt and its dependencies are completely open-source and auditable. You can verify for yourself that there aren't any backdoors or flaws.</li>
2021-10-18 04:40:44 +02:00
<li>Picocrypt is <i>tiny</i>. While NordLocker is over 100MB and VeraCrypt is over 30MB, Picocrypt sits at just 3MB, about the size of a high-resolution photo. And that's not all - Picocrypt is portable (doesn't need to be installed) and doesn't require administrator/root privileges.</li>
<li>Picocrypt is easier and more productive to use than VeraCrypt. To encrypt files with VeraCrypt, you'd have to spend at least five minutes setting up a volume. With Picocrypt's simple UI, all you have to do is drag and drop your files, enter a password, and hit Start. All the complex procedures are handled by Picocrypt internally. Who said secure encryption can't be simple?</li>
<li>Picocrypt is designed for security. 7-Zip is an archive utility and not an encryption tool, so its focus is not on security. Picocrypt, however, is built with security as the number one priority. Every part of Picocrypt exists for a reason and anything that could impact the security of Picocrypt is removed. Picocrypt is built with cryptography you can trust.</li>
<li>Picocrypt authenticates data in addition to protecting it, preventing hackers from maliciously modifying sensitive data. This is useful when you are sending encrypted files over an insecure channel and want to be sure that it arrives untouched. Picocrypt uses HMAC-SHA3 for authenticity, which is a highly secure hash function in a well-known construction.</li>
<li>Picocrypt actively protects encrypted header data from corruption by adding extra Reed-Solomon parity bytes, so if part of a volume's header (which contains important cryptographic components) corrupts (e.g., hard drive bit rot), Picocrypt can still recover the header and decrypt your data with a high success rate. Picocrypt can also encode the entire volume with Reed-Solomon to prevent any corruption to your important files.</li>
2021-02-19 02:04:25 +01:00
</ul>
2021-02-18 21:41:56 +01:00
Still not convinced? See below for even more reasons why Picocrypt stands out from the rest.
# Features
Picocrypt is a very simple tool, and most users will intuitively understand how to use it in a few seconds. On a base level, simply dropping your files, entering a password, and hitting Start is all that's needed to encrypt your files. Pretty simple, right?
While being simple, Picocrypt also strives to be powerful in the hands of knowledgeable and advanced users. Thus, there are some additional options that you may use to suit your needs.
2021-02-18 21:41:56 +01:00
<ul>
<li><strong>Password generator</strong>: Picocrypt provides a secure password generator that you can use to create cryptographically secure passwords. You can customize the password length, as well as the types of characters to include.</li>
<li><strong>File metadata</strong>: Use this to store notes, information, and text along with the file (it won't be encrypted). For example, you can put a description of the file you're encrypting before sending it to someone. When the person you sent it to drops the file into Picocrypt, your description will be shown to that person.</li>
2021-09-05 01:12:43 +02:00
<li><strong>Keyfiles</strong>: Picocrypt supports the use of keyfiles as an additional form of authentication (or the only form of authentication). Not only can you use multiple keyfiles, but you can also require the correct order of keyfiles to be present, for a successful decryption to occur. A particularly good use case of multiple keyfiles is creating a shared volume, where each person holds a keyfile, and all of them (and their keyfiles) must be present in order to decrypt the shared volume.</li>
<li><strong>Fast mode</strong>: Using this mode will greatly speed up encryption/decryption. In this mode, BLAKE2b will be used to authenticate data instead of SHA3. Doing this provides higher speeds, but at a slightly lower security margin.</li>
<li><strong>Paranoid mode</strong>: Using this mode will encrypt your data with both XChaCha20 and Serpent in a cascade fashion. This is recommended for protecting top-secret files and provides the highest level of practical security attainable. In order for a hacker to crack your encrypted data, both the XChaCha20 cipher and the Serpent cipher must be broken, assuming you've chosen a good password.</li>
<li><strong>Prevent corruption using Reed-Solomon</strong>: This feature is very useful if you are planning to archive important data on a cloud provider or external medium for a long time. If checked, Picocrypt will use the Reed-Solomon error correction code to add 8 extra bytes for every 128 bytes to prevent file corruption. This means that up to ~3% of your file can corrupt and Picocrypt will still be able to correct the errors and decrypt your files with no corruption. Of course, if your file corrupts very badly (e.g., you dropped your hard drive), Picocrypt won't be able to fully recover your files, but it will try its best to recover what it can. Note that this option will slow down encryption and decryption considerably.</li>
2021-08-07 23:10:51 +02:00
<li><strong>Keep decrypted output even if it's corrupted or modified</strong>: Picocrypt automatically checks for integrity upon decryption. If the file has been modified or is corrupted, Picocrypt will automatically delete the output for the user's safety. If you want to keep the corrupted or modified data after decryption, check this option. Also, if this option is checked and the Reed-Solomon feature was used on the encrypted file, Picocrypt will attempt to recover as much of the file as possible during decryption.</li>
2021-02-18 21:41:56 +01:00
</ul>
2021-02-19 02:04:25 +01:00
In addition to these options for encryption and decryption, Picocrypt also provides a secure file shredder and a checksum generator.
2021-02-19 02:04:25 +01:00
# Security
2021-11-01 21:48:51 +01:00
For more information on how Picocrypt handles cryptography, see <a href="Internals.md">Internals</a> for the technical details. If you're worried about the safety of me or this project, let me assure you that this repository won't be hijacked or backdoored. I have 2FA (TOTP) enabled on all accounts with a tie to Picocrypt (GitHub, Google, Reddit, Ubuntu One/Snapcraft, Discord, etc.), in addition to full-disk encryption on all of my portable devices. For further hardening, Picocrypt uses my "offline" forks of dependencies and I fetch upstream only when I have taken a look at the changes and believe that there aren't any security issues. This means that if a dependency gets hacked or deleted by the author, Picocrypt will be using my fork of it and remain completely unaffected. You can feel confident about using Picocrypt.
2021-03-17 16:40:14 +01:00
2021-03-21 18:54:02 +01:00
# Community
Here are some places where you can stay up to date with Picocrypt and get involved:
2021-03-21 18:54:02 +01:00
<ul>
2021-05-30 01:15:25 +02:00
<li><a href="https://www.reddit.com/r/Picocrypt/">Reddit</a></li>
2021-05-30 20:55:25 +02:00
<li><a href="https://discord.gg/8QM4A2caxH">Discord</a></li>
2021-03-21 18:54:02 +01:00
</ul>
I highly recommend you join Picocrypt's subreddit because all updates and polls will be posted there. Remember to only trust these social networks and be aware of hackers that might try to impersonate me. I will never ask you for your password, and anyone who does is not me. I will never tell you to download a file from a suspicious link, and anyone who does is not me.
2021-03-21 18:54:02 +01:00
2021-04-25 18:25:29 +02:00
# Stargazers
How's Picocrypt doing? Take a look below to find out.
2021-04-25 18:25:29 +02:00
[![Stargazers over time](https://starchart.cc/HACKERALERT/Picocrypt.svg)](https://starchart.cc/HACKERALERT/Picocrypt)
2021-02-19 02:36:55 +01:00
# Contribution
If you find a bug or have a feature request, please contact me or create an Issue. I'm open to collaborators and all sorts of contributions are appreciated. If you find a security issue, please follow the instructions <a href="Security.md">here</a> to report it.
2021-08-07 23:10:51 +02:00
2021-08-07 23:45:56 +02:00
If you are multilingual and you know a language in which Picocrypt hasn't been translated into yet, I would love to have your help translating this page as well as Picocrypt's interface. The more languages, the more welcoming!
2021-04-01 15:27:15 +02:00
2021-05-30 16:57:13 +02:00
# Donations
2021-11-13 00:59:49 +01:00
If you find Picocrypt useful, please consider tipping my <a href="https://paypal.me/evanyiwensu">PayPal</a>. I'm providing this software completely free of charge, and would love to have some supporters that will motivate me to continue my work on Picocrypt.
2021-05-30 05:18:13 +02:00
2021-04-01 15:27:15 +02:00
# Thank You's
2021-08-07 23:10:51 +02:00
A thank you from the bottom of my heart to my fellow supporters on Patreon:
2021-07-28 01:57:49 +02:00
<ul>
<li>Frederick Doe</li>
</ul>
2021-08-13 02:38:31 +02:00
And to people on Open Collective who made a significant contribution:
<ul>
<li>jp26 ($50)</li>
</ul>
2021-07-28 01:57:49 +02:00
You are the people that inspire me to work on Picocrypt and provide it free of charge to everyone!
Also a huge thanks to the following list of five people, who were the first to donate and support Picocrypt:
2021-04-01 15:27:15 +02:00
<ul>
2021-04-02 02:14:50 +02:00
<li>W.Graham</li>
<li>N. Chin</li>
2021-04-06 15:00:14 +02:00
<li>Manjot</li>
2021-04-05 20:00:16 +02:00
<li>Phil P.</li>
2021-05-30 01:15:25 +02:00
<li>E. Zahard</li>
2021-04-01 15:27:15 +02:00
</ul>
2021-05-30 20:59:17 +02:00
2021-08-13 02:38:31 +02:00
As well, a great thanks to these people, who have helped translate Picocrypt and make it more accessible to the world:
2021-07-18 21:49:51 +02:00
<ul>
<li>@umitseyhan75 for Turkish</li>
<li>@digitalblossom for German</li>
2021-08-16 22:32:01 +02:00
<li>@zeeaall for Brazilian Portuguese</li>
2021-08-18 04:48:10 +02:00
<li>u/francirc for Spanish</li>
2021-08-19 20:53:37 +02:00
<li>@kurpau for Lithuanian</li>
2021-10-06 20:58:58 +02:00
<li>yn for Russian</li>
2021-07-18 21:49:51 +02:00
</ul>
2021-08-13 02:38:31 +02:00
Finally, thanks to these people for helping me out when needed:
2021-05-30 20:59:17 +02:00
<ul>
<li>Fuderal on Discord for helping me setup a Discord server</li>
<li>u/greenreddits for constant feedback and support</li>
<li>u/Tall_Escape for helping me test Picocrypt</li>
2021-08-13 20:16:41 +02:00
<li>u/NSABackdoors for doing plenty of testing</li>
2021-05-30 20:59:17 +02:00
</ul>