https://github.com/marcelbuesing/mgpg

A mattermost client for conveniently encrypting messages
https://github.com/marcelbuesing/mgpg

Last synced: about 1 month ago
JSON representation

A mattermost client for conveniently encrypting messages

• Host: GitHub
• URL: https://github.com/marcelbuesing/mgpg
• Owner: marcelbuesing
• Created: 2019-10-30T21:02:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-03T22:14:01.000Z (about 5 years ago)
• Last Synced: 2024-09-14T03:00:09.422Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 45.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  
📦✨  mgpg


  


    Mattermost Crypto Client

  


  


    

    

    

  


  


    Docs

  


  Built with 🦀



# About

A mattermost client for conveniently encrypting messages using GnuPG via [GPGME](https://gnupg.org/software/gpgme/index.html).

# Setup

Install from source:

```

cargo install mgpg

```

When running mgpg for the first time you'll be guided through a setup process.

Your Mattermost password will be securely stored in your "keyring".

Other configuration values are stored in "~./config/mgpg" in plain format.

To rerun the setup process, replacing all previous values, run `mgpg --reinit`.

# Usage

Make sure GPG is aware of the recipient's public key by importing the key.

You can verify that the public key has been imported via `gpg --fingerprint [email protected]` or alternatively, check the output of `gpg --list-keys`.

Encrypt message using the public key of the recipient and send it as a direct message to the recipient:

```

echo "In God we trust. The rest we monitor." | mgpg --to [email protected]

```

In addition to encrypting messages you may also sign them, before sending them:

```

echo "It's a brave new world out there." | mgpg --sign --to [email protected]

```

Pass message as parameter:

```

mgpg --sign --to [email protected] -- "In God we trust. The rest we monitor."

```

# Help

```

mgpg --help

mgpg 0.1.0

USAGE:

    mgpg [FLAGS] [OPTIONS] [--] [message]

FLAGS:

    -h, --help       Prints help information

        --reinit

    -s, --sign

    -V, --version    Prints version information

OPTIONS:

    -t, --to ...

ARGS:

    

```