You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ORPA-pyOpenRPA/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/crypto/settings.py

105 lines
4.4 KiB

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# ------------------------------------------------------------------------------
# Application Name
# ------------------------------------------------------------------------------
app_name = 'crypto'
# ------------------------------------------------------------------------------
# Version Number
# ------------------------------------------------------------------------------
major_version = "1"
minor_version = "4"
patch_version = "1"
# ------------------------------------------------------------------------------
# Debug Flag (switch to False for production release code)
# ------------------------------------------------------------------------------
debug = False
# ------------------------------------------------------------------------------
# Usage String
# ------------------------------------------------------------------------------
usage = """
Encrypt by explicit file path:
------------------------------
crypto <options> [file path] <file path 2...>
Encrypt all top level files in directory:
-----------------------------------------
crypto <options> [directory path] <directory path 2...>
Create a tar archive from directory and encrypt the archive:
-----------------------------------------------------------
crypto --tar [directory path] <directory path 2...>
Decrypt by explicit file path:
------------------------------
decrypto <options> [file path] <file path 2...>
Decrypt all top level encrypted files in directory:
---------------------------------------------------
decrypto <options> [directory path] <directory path 2...>
Enter `crypto --help` or `decrypto --help` to view the available options.
"""
# ------------------------------------------------------------------------------
# Help String
# ------------------------------------------------------------------------------
help = """
-------------------------------------------------
crypto
Simple symmetric GPG file encryption
Copyright 2015 Christopher Simpkins
MIT license
Source: https://github.com/chrissimpkins/crypto
Docs: https://chrissimpkins.github.io/crypto/
-------------------------------------------------
ABOUT
crypto provides a simple interface to symmetric Gnu Privacy Guard (gpg) encryption and decryption for one or more files. gpg must be installed on your system in order to use the crypto and decrypto executables.
USAGE
ENCRYPTION
crypto <options> [file path] <file path...>
crypto <options> [directory path] <directory path...>
DECRYPTION
decrypto <options> [file path] <file path...>
decrypto <options> [directory path] <directory path...>
CRYPTO OPTIONS
--armor | -a Use a portable ASCII armored encryption format
--hash Generate SHA256 hash digest of encrypted file(s)
--space Favor reduced file size over encryption speed
--speed Favor encryption speed over reduced file size
--tar Create tar archive of directory of files before encryption
DECRYPTO OPTIONS
--nountar Do not automatically unpack decrypted tar archives
--overwrite | -o Overwrite an existing file with the decrypted file
--stdout | -s Print file contents to the standard output stream
OTHER OPTIONS
--help | -h Display crypto and decrypto help
--usage Display crypto and decrypto usage
--version | -v Display version number
DESCRIPTION
Use one or more explicit file path arguments to encrypt or decrypt the file(s). crypto and decrypto will attempt to encrypt or decrypt (respectively) any explicit filepaths that you include irrespective of the file type. Encrypted files are generated on the path '<original_filepath>.crypt'. The original file is not modified or removed by crypto.
Use one or more directory arguments with the crypto executable to encrypt all files in the top level of each directory with the same passphrase. Previously encrypted files with a '.crypt' file type will not be generated again in a directory. Remove them before you run the command if you intend to repeat encryption with a file.
Use one or more directory arguments with decrypto to decrypt all .crypt, .gpg, .asc, and .pgp files in the top level of each directory. decrypto automatically unpacks decrypted tar archives.
Encryption is performed with the AES256 cipher algorithm. Decryption will take place with any cipher algorithm that your version of gpg supports.
"""