cryptit 0.1.6
Encryption has never been so easy!
License: MIT
Keywords: encryption,encrypting-files,aes-encryption,aes-256,aes-256-cbc,sha3-256,decryption,file-protector,encryption-tool


CryptIt
=======


.. image:: https://travis-ci.org/KKStudLab/cryptit.svg?branch=master
   :target: https://travis-ci.org/KKStudLab/cryptit
   :alt: Build Status


.. image:: https://landscape.io/github/KKStudLab/cryptit/master/landscape.svg?style=flat
   :target: https://landscape.io/github/KKStudLab/cryptit/master
   :alt: Code Health


.. image:: https://requires.io/github/KKStudLab/cryptit/requirements.svg?branch=master
   :target: https://requires.io/github/KKStudLab/cryptit/requirements/?branch=master
   :alt: Requirements Status


.. image:: https://img.shields.io/badge/python-2.7+,%203.5+-blue.svg
   :target: https://github.com/KKStudLab/cryptit
   :alt: Python


.. image:: https://badge.fury.io/py/cryptit.svg
   :target: https://badge.fury.io/py/cryptit
   :alt: PyPI version


CryptIt — is a simple and powerful cross-platform encryption tool, which can be used to protect your data from other people (like NSA, Government, Illuminati, big bro and so on) in the easiest possible way. 

Cryptographic security of encrypted files is based on `Advanced Encryption Standard <https://en.wikipedia.org/wiki/Advanced_Encryption_Standard>`_  (AES) algorithm in `CBC mode <https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher_Block_Chaining_.28CBC.29>`_ with a key of 256-bits length.

To use cryptit you need to install python and pip on your personal computer, generate strong session password (for this step you can read useful article on `xkcd <https://xkcd.com/936/>`_ site, it's very important) and then read following instructions bellow.

**How does it work?**

You choose the mode in which the program would be launched [encryption or decryption] and pass a path to target file or directory as an argument. After that, you generate strong password and type that password in the program. Then cryptit calculates hash (\ `SHA-3 <https://en.wikipedia.org/wiki/SHA-3>`_ 256) of your password and uses it as key for AES-256 in CBC mode.

..

   *Encryption has never been so easy!*


Installation
------------

PyPI
^^^^

To install CryptIt, run this command in your terminal:

.. code-block:: sh

   $ pip install cryptit

This is the preferred method to install CryptIt, as it will always install the most recent stable release.

Source files
^^^^^^^^^^^^

In case you downloaded or cloned the source code from `GitHub <https://github.com/KKStudLab/cryptit>`_ or your own fork, you can run the following to install cameo for development:

.. code-block:: sh

   $ git clone https://github.com/KKStudLab/cryptit.git
   $ cd cryptit
   $ vitualenv --python=python[version] venv
   $ source venv/bin/active
   $ pip install --editable .

**Note**\ : *Don't forget about 'sudo'!*

Basic Usage
-----------

Available command list:

.. code-block:: sh

   $ cryptit -h
   usage: cryptit [-h] [-e] [-d] [path]

   positional arguments:
     path           path to target file or directory

   optional arguments:
     -h, --help     show this help message and exit
     -e, --encrypt  encryption mode [by default]
     -d, --decrypt  decryption mode

Encryption mode
^^^^^^^^^^^^^^^

To encrypt files on your PC open terminal and type following command, use -e option and put just path to target file or directory.

.. code-block::

   root@kali:~/Pictures$ cryptit -e .
   [*] Start time: 2017-09-05_21-36-30
   [*] CryptIt mode: Encryption(AES-256 CBC mode)
   [*] Path: .
   [!] Enter your password: 
   [#] Encrypting files: 3it [00:00, 47.33it/s]
   [*] Encrypting was successful!!
   [*] Enctyption time: 0.0646049976349 seconds
   [*] Print archive info(y/n): y


   Archive info:
   (cryptit_2017-09-05_21-36-30.zip)

   Screenshot from 2017-08-18 21-47-25.png.aes
   [!] Modified:       2017-09-05 21:36:32
   [!] System:     3 (0 = Windows, 3 = Unix)
   [!] ZIP version:    20
   [!] Compressed:     244264 bytes
   [!] Uncompressed:   244264 bytes
   Wallpapers/36571921725_64b1d675cf_k.jpg.aes
   [!] Modified:       2017-09-05 21:36:32
   [!] System:     3 (0 = Windows, 3 = Unix)
   [!] ZIP version:    20
   [!] Compressed:     666952 bytes
   [!] Uncompressed:   666952 bytes

Decryption mode
^^^^^^^^^^^^^^^

.. code-block::

   root@kali:~/Pictures$ cryptit -d cryptit_2017-09-05_21-36-30.zip 
   [*] Start time: 2017-09-05_21-48-36
   [*] CryptIt mode: Decryption(AES-256 CBC mode)
   [*] Path: cryptit_2017-09-05_21-36-30.zip
   [!] Enter your password: 
   [#] Decrypting files: 2it [00:00, 102.09it/s]
   [*] Decrypting was successful!!
   [*] Dectyption time: 0.0205860137939 seconds
   [!] Output dir: /Pictures/cryptit_2017-09-05_21-36-30

Bugs, issues and contributing
-----------------------------

If you find `bugs <https://github.com/KKStudLab/cryptit/issues>`_ or have `suggestions <https://github.com/KKStudLab/cryptit/issues>`_ about improving the module, don't hesitate to contact `us <https://github.com/KKStudLab/cryptit/blob/master/AUTHORS.md>`_.

License
-------

This project is licensed under the MIT License - see the `LICENSE <https://github.com/KKStudLab/cryptit/blob/master/LICENSE>`_ file for details

Copyright (c) 2017 - `Maxim Krivich <https://github.com/maxkrivich>`_\ , `Ivan Kudryashov <https://github.com/entick>`_\ , `Danil Naumenko <https://github.com/umqa>`_

`maxkrivich.github.io <https://maxkrivich.github.io/>`_