GpgkeyPlugin

Overview

This plugin creates a table with username, key id and fingerprint. It is okay for listing only, but can be used widely.

Syntax Rules

• Add to your personal page the following user information. Multiple keys/fingerprints are possible by separating with comma:
  • GPG Key: your key id, like 0xDEADBEEF
  • GPG Fingerprint: your key fingerprint, like FFFF FFFF FFFF ...

• add yourself to the GpgkeySigningPartyList list like: 3 spaces,asterix,name (including Main. .., e.g. Main.MartinSteldinger), it can also take Groups

• To report, add the following variable:
  • %GPGLISTVIEW% - displays a table list of GPG keys and fingerprints found in user information. Takes a list of users from the GpgkeySigningPartyList topic.
  • Attribute topic - specify tree's root topic (if none, will do the entire web)
  • You can use %GPGLISTVIEW{topic="GpgkeySigningPartyList"}% to define a specific topic, from which the (gpg-) user list shall be taken.
  • The TWiki administrator can add a GPG Key/Fingerprint questionnaire to the %SYTEMWEB%.TWikiRegistration to automate.

Examples

%GPGLISTVIEW% returns:

%GPGLISTVIEW%

%GPGLISTVIEW{topic="Main.WhoUsesGPG"}% returns:

%GPGLISTVIEW{topic="Main.WhoUsesGPG"}%

GpgkeyPlugin Settings

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Gather a list of gpg keys and fingerprints

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip GpgkeyPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/GpgkeyPlugin.txt	Plugin topic
    lib/TWiki/Plugins/GpgkeyPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Test if the installation was successful: See examples above.

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins