Skip to main content

GPG middleware for EH Forwarder Bot, encrypts and decrypts messages.

Project description

Module ID: blueset.gpg

A middleware for EH Forwarder Bot that encrypts and decrypts messages using GnuPG.

This middleware simply encrypts outgoing messages with recipients’ registered public key, and decrypt incoming messages with your own secret key.

All encrypted messages should be and will be ASCII armored. All messages that was not successfully encrypted/decrypted will be delivered untouched.

This middleware only encrypt/decrypt text messages. Other types of messages are kept untouched.

Dependencies

  • EH Forwarder Bot >=2.0

  • GnuPG

  • An imported key pair that is used to decrypt incoming messages

Getting Started

  1. Make sure you have access to a public key server of your choice with the gpg installed.

  2. Have at least one key pair registered in local GPG.

  3. Install this middleware:

    pip3 install efb-gpg-middleware
  4. Create a config file in your current EFB profile: <PATH_TO_EFB_PROFILE>/blueset.gpg/config.yaml:

    # Signature of your own key pair (required)
    key: BD6B65EC00638DC9083781D5D4B65BB1A106200A
    
    # Passphrase to the key pair (optional)
    password: test
    
    # Trust all key in the local stoage
    # (optional, default: true)
    always_trust: true
    
    # Path to the GPG binary
    # (optional, default: search from $PATH)
    binary: /usr/bin/gpg
    
    # Preferred public key server
    # (optional, default: pgp.mit.edu)
    server: pgp.mit.edu

How to use

Send commands as text messages in chats to interact with the middleware. All command messages will not be delivered to slave channel.

  • gpg`info: Show the key fingerprint used for this chat.

  • gpg`search query: Search for a key from the key server.

  • gpg`bind fingerprinthex: Use key for specified fingerprint for a chat.

  • gpg`clear: Do not encrypt messages sent to this chat.

When you have told the middleware to use a key for a chat, it will encrypt all your text messages sent to this chat with the key specified.

The middleware will try to decrypt all incoming text messages with GnuPG regardless of settings, and only update the message if the decryption is successful.

Footnote

If you find this module not as useful, don’t laugh. This is just a demo that shows you one type of things you can do with EFB Middleware.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

efb-gpg-middleware-1.0.1.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

efb_gpg_middleware-1.0.1-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file efb-gpg-middleware-1.0.1.tar.gz.

File metadata

File hashes

Hashes for efb-gpg-middleware-1.0.1.tar.gz
Algorithm Hash digest
SHA256 917e962fbbd480ece5c7741b5a8d5e0b079a241dcb6e168bbbb9b984908da12b
MD5 07a6989d0fdcb8b71715e36516b0888e
BLAKE2b-256 d45465cbd322ea83ada9e36bd93b2cba457f4c5f714de0077f16617ebd8a11b5

See more details on using hashes here.

File details

Details for the file efb_gpg_middleware-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for efb_gpg_middleware-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 41379913951d18bbdc4ee93aae81f05fdc22e5365c6a19859fe0a3eff14966d4
MD5 5b549d0cb9c47c58ea878360305af144
BLAKE2b-256 64b5042605f615eb1c816364957b3f9a1f54c52e9bfcf413a4e59e637f78afd3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page