Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcvspt/gpg-pysuite
Python GPG suite
https://github.com/marcvspt/gpg-pysuite
gnupgp gpg pgp python python-gnupg python3
Last synced: 11 days ago
JSON representation
Python GPG suite
- Host: GitHub
- URL: https://github.com/marcvspt/gpg-pysuite
- Owner: marcvspt
- Created: 2023-06-18T01:53:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-18T00:04:59.000Z (over 1 year ago)
- Last Synced: 2023-09-18T01:24:29.062Z (over 1 year ago)
- Topics: gnupgp, gpg, pgp, python, python-gnupg, python3
- Language: Python
- Homepage:
- Size: 29.3 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GPG Python Suite
In this repository we have a tool that use `python-gnupg`, **GPG Python Suite** doesn't import the **GPG keys** in the machine, the keys that you can generate are going to be exported in `.asc` files on the current directory.
- [GPG Python Suite](#gpg-python-suite)
- [Download and Install](#download-and-install)
- [Usage](#usage)
- [Generate keys](#generate-keys)
- [Encrypt messages](#encrypt-messages)
- [Decrypt messages](#decrypt-messages)
- [Signing messages](#signing-messages)
- [Verify signatures](#verify-signatures)
## Download and Install
```bash
git clone https://github.com/marcvspt/gpg-pysuite
cd gpg-pysuite/
pip3 install -r requirements.txt
```
## Usage
```bash
$ python3 gpg_pysuite.py -h
usage: gpg_pysuite.py [-h] {generate,encrypt,decrypt,sign,verify}
GnuPG Python suite
positional arguments:
{generate,encrypt,decrypt,sign,verify}
options:
-h, --help show this help message and exit
```
### Generate keys
```bash
$ python3 gpg_pysuite.py generate -h
usage: gpg_pysuite.py generate [-h] -p PASSPHRASE -n NAME -e EMAIL [-b BASE_NAME] [--bits BITS]
Generate GPG key pair RSA
options:
-h, --help show this help message and exit
-p PASSPHRASE, --passphrase PASSPHRASE
Password for the private key
-n NAME, --name NAME User name
-e EMAIL, --email EMAIL
User e-mail
-b BASE_NAME, --base-name BASE_NAME
Base name for the keys
--bits BITS Key length in bits
```
### Encrypt messages
The tool can encrypt the messages with the **public key** (Asymmetric) and **private key** (Symmetric).
```bash
$ python3 gpg_pysuite.py encrypt -h
Encrypt message with GPG
options:
-h, --help show this help message and exit
-k GPG_KEY, --gpg-key GPG_KEY
Path to GPG public key (Asymmetric) or private key (Symmetric)
-m MESSAGE, --message MESSAGE
Message to encrypt
-o OUTFILE, --outfile OUTFILE
Path to save the GPG message encrypted
```
### Decrypt messages
```bash
$ python3 gpg_pysuite.py decrypt -h
Decrypt GPG encrypted message
options:
-h, --help show this help message and exit
-k PRIV_KEY, --private-key PRIV_KEY
Path to GPG private key
-p PASSPHRASE, --passphrase PASSPHRASE
GPG private key password
-m MESSAGE, --message-file MESSAGE
Path to GPG message encrypted
-o OUTFILE, --outfile OUTFILE
Path to save the message decrypted
```
### Signing messages
```bash
$ python3 gpg_pysuite.py sign -h
usage: gpg_pysuite.py sign [-h] -c PUBKEY -k PRIVKEY -p PASSPHRASE -m MESSAGE [-o OUTFILE]
Sign message with GPG
options:
-h, --help show this help message and exit
-k PRIV_KEY, --private-key PRIV_KEY
Path to GPG private key
-p PASSPHRASE, --passphrase PASSPHRASE
GPG Private Key password
-m MESSAGE, --message MESSAGE
Message to sign
-o OUTFILE, --outfile OUTFILE
Path to save the GPG sessage signed
```
### Verify signatures
The tool can verify the signatures with the **public key**.
```bash
$ python3 gpg_pysuite.py verify -h
Verify signature with GPG
options:
-h, --help show this help message and exit
-c PUB_KEY, --public-key PUB_KEY
Path to GPG public key
-m MESSAGE, --signed-message MESSAGE
Path to signed message
```