Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisbra/vimcrypt
Encode/Decode Vims Sodium encryption
https://github.com/chrisbra/vimcrypt
Last synced: 26 days ago
JSON representation
Encode/Decode Vims Sodium encryption
- Host: GitHub
- URL: https://github.com/chrisbra/vimcrypt
- Owner: chrisbra
- License: gpl-2.0
- Created: 2021-07-25T19:43:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-13T19:51:42.000Z (over 1 year ago)
- Last Synced: 2024-10-28T19:55:00.580Z (2 months ago)
- Language: C
- Size: 38.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A small project to play around with libsodium
## The idea
Learn something about [libsodium][1], which is now also part of Vim (see [patch 8.2.3022][2]).
So here is a small utility, that let's you encrypt and decrypt messages, that can also be read by Vim.
You can use the old and new Vim cryptmethod:
- cryptmethod: 'xchacha20' - cryptmethod 'xchacha20', requires vim 8.2.3022
- cryptmethod: 'xchacha20v2' - new cryptmethod, requires [Vim v9.0.1481][3]
### Install
```sh
~$ apt install libsodium-dev # libsodium is required to build
~$ git clone https://github.com/chrisbra/vimcrypt
~$ cd vimcrypt; make
```
### Different Xchacha20 Versions
The difference between the [new xchacha20v2][3] and the [old xchacha20][2] is basically, that the new method also stores the parameters
required for correct key-derivation:
- opslimit: the maximum amount of computations to perform. By default, this is OPSLIMIT_INTERACTIVE.
- memlimit: the amount of memory you want to reserve for password hashing. By default, this is MEMLIMIT_INTERACTIVE
- alg: the algorithm used for the key derivation. By default, this is '2' (ARGON2ID13)
### Usage
```sh
~$ vimcrypt encrypt file # encrypt
~$ vimcrypt decrypt file.enc # decrypt
```
By default, when encrypting, it will leave your precious input files alone and write the encrypted file to the same name with the suffix `.enc` added.
That means, you need to decrypt files with the name `.enc`.
#### Arguments:
```
-v - be verbose
-b - Use as block size for encryption
-V 1 - Use xchacha20 (old) libsodium version
-V 2 - Use xchacha20v2 libsodium vim version
```
This matters mostly for files larger than the block size, because if the wrong block size is given, the file won't be decrypted properly.
By default, Vim uses a block size of 8192 Bytes, so this script also uses 8K block size if no one is given.
License & Copyright
-------
The GPL 2 License applies.
© 2021 by Christian Brabandt
__NO WARRANTY, EXPRESS OR IMPLIED. USE AT-YOUR-OWN-RISK__
[1]: https://doc.libsodium.org/
[2]: https://github.com/vim/vim/releases/tag/v8.2.3022
[3]: https://github.com/vim/vim/releases/tag/v9.0.1481