1
0
mirror of https://github.com/HACKERALERT/Picocrypt.git synced 2024-12-10 22:15:20 +01:00
Picocrypt/README.md

173 lines
19 KiB
Markdown
Raw Normal View History

<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> | <a href="/translations/hungarian.md">Magyar</a> | <a href="/translations/italian.md">Italiano</a> | <a href="/translations/persian.md">پارسی</a> | <a href="/translations/polish.md">Polski</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
2022-07-16 05:32:56 +02: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. 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 Argon2id key derivation 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 are under attack. Take it back with confidence by protecting your files with Picocrypt.</strong>
2021-02-18 21:41:56 +01:00
2022-04-05 22:38:42 +02:00
<p align="center"><img align="center" src="/images/screenshot.png" width="318" alt="Picocrypt"></p>
2021-02-19 21:26:53 +01:00
2021-06-07 20:55:22 +02:00
# Funding
2022-06-26 05:55:11 +02:00
Please donate to Picocrypt on <a href="https://opencollective.com/picocrypt">Open Collective</a> (crypto is accepted) to raise money for a security 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
2022-07-01 05:26:05 +02:00
**Important**: There are multiple entities under the name "Picocrypt". For example, there's an old encryption tool called PicoCrypt that uses a broken cipher. There's also an ERC-funded research project called PICOCRYPT. There are even domains related to Picocrypt that I've never registered. Please don't confuse any of these unrelated projects with Picocrypt (this project). Make sure to only download Picocrypt from this repository to ensure that you get the authentic and backdoor-free Picocrypt. When sharing Picocrypt with others, be sure to link to this repository to prevent any confusion.
2022-04-19 05:16:35 +02:00
2021-05-30 01:15:25 +02:00
## Windows
2022-05-24 05:27:54 +02: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.29/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.
2022-05-17 05:53:38 +02:00
2022-05-24 05:27:54 +02:00
If the executable above doesn't work, it likely means that your system doesn't support OpenGL. For this situation, I've provided an alternate implementation that will run on any Windows system, which you may download <a href="https://github.com/HACKERALERT/Picocrypt/releases/download/1.29/Picocrypt-NoGL.exe">here</a>.
2021-03-19 21:28:59 +01:00
2021-05-30 01:15:25 +02:00
## macOS
2022-07-16 05:32:56 +02:00
Picocrypt for macOS is very simple as well. Download Picocrypt <a href="https://github.com/HACKERALERT/Picocrypt/releases/download/1.29/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, control-click on Picocrypt and hit "Open" to bypass the warning.
2021-03-19 21:28:59 +01:00
2022-07-16 05:32:56 +02:00
One thing to keep in mind is that Picocrypt on macOS requires Rosetta 2 and OpenGL, both of which are likely to be removed by Apple in the future. This means that Picocrypt may no longer run on macOS in the future as Apple pushes their proprietary graphics and silicon. The solution? Don't buy Apple. They don't care about developers.
2022-07-14 00:23:14 +02:00
2021-05-30 01:15:25 +02:00
## Linux
2022-05-24 05:27:54 +02:00
There are multiple ways to use Picocrypt on Linux. The recommended way is to install Picocrypt from a .deb <a href="https://github.com/HACKERALERT/Picocrypt/releases/download/1.29/Picocrypt.deb">here</a> (Debian 11+ and Ubuntu 20+). If the .deb doesn't suit your needs or you don't use a Debian-based distro, feel free to use the AppImage from <a href="https://github.com/HACKERALERT/Picocrypt/releases/download/1.29/Picocrypt.AppImage">here</a>. If neither of the options above work, you may install Picocrypt from Snapcraft, which should work on all distros. Find the instructions for Snapcraft <a href="https://snapcraft.io/picocrypt">here</a>.
2021-02-19 02:04:25 +01:00
2022-01-05 05:35:54 +01:00
## Paranoid Packs
2022-03-20 03:54:13 +01:00
The Paranoid Pack is a compressed archive that contains executables for every version of Picocrypt ever released for Windows, macOS, and Linux. As long as you have it stored in a place you can access, you'll be able to open it and use any version of Picocrypt in case this repository mysteriously vanishes or the entire Internet burns down. Think of it as a seed vault for Picocrypt. As long as one person has the Paranoid Pack within reach, they can share it with the rest of the world and keep Picocrypt functional in cases of catastrophic events like GitHub shutting down suddenly or the NSA capturing me (just in case, you know?). The best way to ensure Picocrypt is accessible many decades from now is to keep a Paranoid Pack in a safe place. So if you are worried about being unable to access Picocrypt in the future, well, here's your solution. Just head to the Releases tab and get yourself a copy.
2022-01-05 05:35:54 +01:00
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>
2022-07-16 05:32:56 +02:00
<li>Picocrypt is <i>tiny</i>. While NordLocker is over 50 MiB and VeraCrypt is over 20 MiB, Picocrypt sits at just 2 MiB, about the size of a medium-resolution photo. And that's not all - Picocrypt is portable (doesn't need to be installed) and doesn't require administrator/root privileges.</li>
2022-08-28 05:22:20 +02:00
<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 Encrypt. 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.</li>
2022-07-16 05:32:56 +02:00
<li>Picocrypt actively protects 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
2022-04-08 23:51:00 +02:00
# Comparison
2022-04-15 05:32:50 +02:00
Here's how Picocrypt compares to other popular encryption tools.
2022-04-08 23:51:00 +02:00
2022-04-23 06:46:06 +02:00
| | Picocrypt | VeraCrypt | 7-Zip (GUI) | BitLocker | Cryptomator | NordLocker | AxCrypt |
| -------------- | -------------- | -------------- | -------------- | -------------- | -------------- | -------------- | -------------- |
| Free |✅ Yes |✅ Yes |✅ Yes |🟧 Partially |✅ Yes |🟧 Partially |🟧 Partially |
| Open Source |✅ GPLv3 |✅ Multi |✅ LGPL |❌ No |✅ GPLv3 |❌ No |❌ No |
| Cross-Platform |✅ Yes |✅ Yes |❌ No |❌ No |✅ Yes |❌ No |❌ No |
2022-07-16 05:32:56 +02:00
| Size |✅ 2 MiB |❌ 20 MiB |✅ 2 MiB |✅ Included |❌ 50 MiB |❌ 60 MiB |🟧 8 MiB |
2022-04-23 06:46:06 +02:00
| Portable |✅ Yes |✅ Yes |❌ No |✅ Yes |❌ No |❌ No |✅ Yes |
| Permissions |✅ None |❌ Admin |❌ Admin |❌ Admin |❌ Admin |❌ Admin |❌ Admin |
| Ease-Of-Use |✅ Easy |❌ Hard |✅ Easy |🟧 Medium |🟧 Medium |🟧 Medium |✅ Easy |
2022-04-25 02:24:07 +02:00
| Cipher |✅ XChaCha20 |✅ AES-256 |✅ AES-256 |🟧 AES-128 |✅ AES-256 |✅ AES-256 |🟧 AES-128 |
2022-08-15 22:33:37 +02:00
| Key Derivation |✅ Argon2 |🆗 PBKDF2 |❌ SHA-256 |❓ Unknown |✅ Scrypt |✅ Argon2 |🆗 PBKDF2 |
2022-04-23 06:46:06 +02:00
| Data Integrity |✅ Always |❌ No |❌ No |❓ Unknown |✅ Always |✅ Always |✅ Always |
| Reed-Solomon |✅ Yes |❌ No |❌ No |❌ No |❌ No |❌ No |❌ No |
| Compression |✅ Yes |❌ No |✅ Yes |✅ Yes |❌ No |❌ No |✅ Yes |
| Telemetry |✅ None |✅ None |✅ None |❓ Unknown |✅ None |❌ Analytics |❌ Accounts |
| Audited |🟧 Planned |✅ Yes |❌ No |❓ Unknown |✅ Yes |❓ Unknown |❌ No |
# Features
2022-08-28 05:22:20 +02:00
Picocrypt is a very simple tool, and most users will intuitively understand how to use it in a few seconds. On a basic level, simply dropping your files, entering a password, and hitting Encrypt is all that's needed to encrypt your files. Dropping the output back into Picocrypt, entering the password, and hitting Decrypt is all that's needed to decrypt those 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>
2022-04-08 23:51:00 +02:00
<li><strong>Comments</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>
2022-08-28 05:22:20 +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 to decrypt the shared volume. By checking the "Require correct order" box and dropping your keyfile in last, you can also ensure that you'll always be the one clicking the Decrypt button.</li>
2022-07-16 05:32:56 +02:00
<li><strong>Paranoid mode</strong>: Using this mode will encrypt your data with both XChaCha20 and Serpent in a cascade fashion, and use HMAC-SHA3 to authenticate data instead of BLAKE2b. This is recommended for protecting top-secret files and provides the highest level of practical security attainable. 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. It's safe to say that in this mode, your files are impossible to crack.</li>
<li><strong>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 of data 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 may slow down encryption and decryption speeds.</li>
2022-04-08 23:51:00 +02:00
<li><strong>Force decrypt</strong>: Picocrypt automatically checks for file 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 would like to override these safeguards, check this option. Also, if this option is checked and the Reed-Solomon feature was used on the encrypted volume, Picocrypt will attempt to recover as much of the file as possible during decryption.</li>
2022-08-28 05:47:01 +02:00
<li><strong>Split into chunks</strong>: Don't feel like dealing with gargantuan files? No worries! With Picocrypt, you can choose to split your output file into custom-sized chunks, so large files can become more manageable and easier to upload to cloud providers. Simply choose a unit (KiB, MiB, GiB, or TiB) and enter your desired chunk size for that unit. To decrypt the chunks, simply drag one of them into Picocrypt and the chunks will be automatically recombined during decryption.</li>
2022-08-28 05:22:20 +02:00
<li><strong>Compress files</strong>: By default, Picocrypt uses a zip file with no compression to quickly merge files together when encrypting multiple files. If you would like to compress these files, however, simply check this box and the standard Deflate compression algorithm will be applied during encryption.</li>
2021-02-18 21:41:56 +01:00
</ul>
2021-02-19 02:04:25 +01:00
# Security
2021-12-09 00:49:25 +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 isolated 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
2022-05-16 02:55:13 +02:00
## Signatures
For the paranoid, Picocrypt is signed with PGP. The fingerprint and public key are listed below.
<pre>B342A744BDEEA57B6A583E33A247E73798946F55</pre>
<pre>-----BEGIN PGP PUBLIC KEY BLOCK-----
mDMEYoGUHxYJKwYBBAHaRw8BAQdAvmQA+pdbDB/ynJxHhNDpz6Sb5tgkNuuNJIvw
HYwZtqi0CVBpY29jcnlwdIiTBBMWCgA7FiEEs0KnRL3upXtqWD4zokfnN5iUb1UF
AmKBlB8CGwMFCwkIBwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQokfnN5iUb1UZ
RgEA8jbIsdqCr21DWxcqW/eLlbxRkuA8kflVYvWWUxtVqsUA/jQPSDpvA8rakvaL
PIbXjQvrAMkEVIc0HbCzLxr1k3sH
=YFwz
-----END PGP PUBLIC KEY BLOCK-----</pre>
2021-03-21 18:54:02 +01:00
# Community
2022-08-28 05:22:20 +02:00
Consider joining <a href="https://www.reddit.com/r/Picocrypt/">r/Picocrypt</a>. While I won't be active in this subreddit myself, it's still a great place to ask questions and help one another out, especially if something happens to me or this repository in the future. Remember to only trust this specific subreddit and be aware of hackers that might try to impersonate me on other platforms. 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.
2022-04-08 23:51:00 +02:00
![Stargazers Over Time](https://starchart.cc/HACKERALERT/Picocrypt.svg)
2021-04-25 18:25:29 +02:00
2021-05-30 16:57:13 +02:00
# Donations
2022-08-12 05:23:43 +02:00
When I was actively developing Picocrypt, I accepted donations, but now that Picocrypt is complete and production-ready, there's no need anymore. Instead, take your time and effort to share the love of Picocrypt with others. Donations are nice, but being able to help others is a lot more valuable to me than a few spare dollars. Knowing that Picocrypt is helping people secure their files is plenty enough for me.
2022-06-26 05:55:11 +02:00
# FAQ
**Is Picocrypt accepting new features?**
2022-07-16 05:32:56 +02:00
No, Picocrypt is considered feature-complete and won't be getting any new features. Unlike other tools which try to constantly add new features (which introduces new bugs and security holes), Picocrypt focuses on just a few core features but does each of them exceptionally well. Remember Picocrypt's ideology: small, simple, and secure.
2022-06-26 05:55:11 +02:00
**Will Android/iOS be supported?**
2022-07-16 05:32:56 +02:00
No, I don't plan on supporting Android or iOS because they are very different from traditional desktop operating systems and require different toolchains to develop apps for. Due to the nature of open-source software, however, a community-built version of Picocrypt for Android or iOS may appear in the future.
2022-06-26 05:55:11 +02:00
**Why is Picocrypt not updated frequently?**
2022-06-26 22:58:00 +02:00
People seem to have the notion that software must be constantly updated to stay relevant and secure. While this may be true for a lot of the software we use today, it is not for Picocrypt. Picocrypt is "good software" and good software doesn't need constant updates to remain relevant and secure. Good software will always be good software.
2021-05-30 05:18:13 +02:00
2022-09-17 04:20:27 +02:00
# Acknowledgements
2021-11-20 05:49:20 +01:00
A thank you from the bottom of my heart to the people on Open Collective who have made a significant contribution:
2021-08-13 02:38:31 +02:00
<ul>
2022-08-15 02:40:27 +02:00
<li>Guest ($842)</li>
<li>YellowNight ($818)</li>
2022-04-28 23:06:52 +02:00
<li>evelian ($50)</li>
2021-08-13 02:38:31 +02:00
<li>jp26 ($50)</li>
2022-01-26 18:05:37 +01:00
<li>guest-116103ad ($50)</li>
2022-08-12 03:47:44 +02:00
<li>oli ($20)</li>
2022-06-26 01:09:32 +02:00
<li>Markus ($15)</li>
2021-11-20 05:49:20 +01:00
<li>Tybbs ($10)</li>
<li>N. Chin ($10)</li>
<li>Manjot ($10)</li>
<li>Phil P. ($10)</li>
2022-08-12 03:47:44 +02:00
<li>Raymond ($10)</li>
2021-12-30 19:03:21 +01:00
<li>donor39 (backer)</li>
2022-02-09 21:58:07 +01:00
<li>Pokabu (backer)</li>
2022-09-17 04:20:27 +02:00
<li>akp (backer)</li>
2021-08-13 02:38:31 +02:00
</ul>
2022-04-09 03:59:22 +02:00
2021-11-20 05:49:20 +01:00
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>
2022-04-15 05:12:15 +02:00
<li>@digitalblossom & @Pokabu26 for German</li>
2022-08-15 02:40:27 +02:00
<li>@zeeaall & @Rayserzor for Portuguese</li>
2022-09-17 04:20:27 +02:00
<li>u/francirc & @victorhck for Spanish</li>
<li>yn & Voron for Russian</li>
2021-12-16 03:22:24 +01:00
<li>@Etim-Orb for Hungarian</li>
2022-02-06 16:57:19 +01:00
<li>@Minibus93 for Italian</li>
2022-04-05 22:33:08 +02:00
<li>Michel for French</li>
2022-05-24 14:44:00 +02:00
<li>@MasterKia for Persian</li>
2022-07-06 19:44:38 +02:00
<li>@ungespurv for Polish</li>
2022-08-22 05:10:33 +02:00
<li>@qaqland for Chinese</li>
2021-07-18 21:49:51 +02:00
</ul>
2022-04-19 05:16:35 +02:00
Finally, thanks to these people/organizations for helping me out when needed:
2021-05-30 20:59:17 +02:00
<ul>
<li>[ REDACTED ] for helping me create an AppImage for Picocrypt</li>
2022-05-16 02:55:13 +02:00
<li>u/Upstairs-Fishing867 for helping me test PGP signatures</li>
2021-05-30 20:59:17 +02:00
<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-12-16 03:22:24 +01:00
<li>@samuel-lucas6 for feedback, suggestions, and support</li>
2022-07-16 05:32:56 +02:00
<li><a href="https://privacytools.io">PrivacyTools</a> for listing Picocrypt</li>
2022-04-19 05:16:35 +02:00
<li><a href="https://privacyguides.org">PrivacyGuides</a> for listing Picocrypt</li>
2022-09-17 04:20:27 +02:00
<li>...You?</li>
2021-05-30 20:59:17 +02:00
</ul>