Limnoria/plugins/GPG/README.rst

84 lines
1.8 KiB
ReStructuredText
Raw Normal View History

.. _plugin-GPG:
Documentation for the GPG plugin for Supybot
============================================
Purpose
-------
GPG: Provides authentication based on GPG keys.
Usage
-----
Provides authentication based on GPG keys.
.. _commands-GPG:
Commands
--------
2021-04-17 20:09:33 +02:00
.. _command-gpg-key.add:
key add <key id> <key server>
Add a GPG key to your account.
2021-04-17 20:09:33 +02:00
.. _command-gpg-key.list:
key list takes no arguments
List your GPG keys.
2021-04-17 20:09:33 +02:00
.. _command-gpg-key.remove:
key remove <fingerprint>
Remove a GPG key from your account.
2021-04-17 20:09:33 +02:00
.. _command-gpg-signing.auth:
signing auth <url>
Check the GPG signature at the <url> and authenticates you if the key used is associated to a user.
2021-04-17 20:09:33 +02:00
.. _command-gpg-signing.gettoken:
signing gettoken takes no arguments
Send you a token that you'll have to sign with your key.
2021-04-17 20:09:33 +02:00
.. _conf-GPG:
Configuration
-------------
2021-04-17 20:09:33 +02:00
2021-04-22 00:29:15 +02:00
.. _conf-supybot.plugins.GPG.auth:
supybot.plugins.GPG.auth
This is a group of:
.. _conf-supybot.plugins.GPG.auth.sign:
supybot.plugins.GPG.auth.sign
This is a group of:
.. _conf-supybot.plugins.GPG.auth.sign.TokenTimeout:
supybot.plugins.GPG.auth.sign.TokenTimeout
This config variable defaults to "600", is not network-specific, and is not channel-specific.
Determines the lifetime of a GPG signature authentication token (in seconds).
.. _conf-supybot.plugins.GPG.auth.sign.enable:
supybot.plugins.GPG.auth.sign.enable
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether or not users are allowed to use GPG signing for authentication.
2021-04-17 20:09:33 +02:00
.. _conf-supybot.plugins.GPG.public:
2021-04-22 00:29:15 +02:00
supybot.plugins.GPG.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.