Skip to Content

Encryption Application

Last modified by Admin on 2026/08/05 18:22
cogLet admins encrypt data directly in the wiki.
TypeXAR
Category
Developed by

Thomas Delafosse, O.J. Sousa Rodrigues

Active Installs20
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Success

Installable with the Extension Manager

 Sources Issues  Download v1.3

Table of contents

Description

The aim of this macro is to allow XWiki users to protect some sensitive data directly inside the wiki. The idea is to encrypt this data and to let admins choose who can decrypt it. 

Encrypt a field in a wiki page

Once you have installed this application in your wiki, a new macro called 'EncryptionMacro' will be available from the WYSIWYG editor.
This macro enables you to encrypt directly fields you want to protect on your wiki.
To use this macro, simply insert it in a wiki page, and give a name to the field you want to encrypt as shown below:

Macro.png
If you want to use this macro directly in wiki mode, use {{encryptionMacro name="nameOfYourField"/ }}

Then save the page and click on "Display" and then "Edit" in view mode to precise the string to encrypt:
SetPassword.png

Once this is done, admins can decrypt the field by clicking on "Display":
PasswordDisplayed.png

Manage decryption rights

By default, only global Admins can decrypt the data that has been encrypted through this application. But they can extend these rights by precising which users have decryption rights on a page by clicking on "Manage decryption rights". A new window will appear where they can add and/or remove users that have these rights:
ManageRights.png
Add all the users that should be able to perform decryption on the page and then click on 'Save and View'

Admins can even manage decryption rights on a whole space or a whole wiki in a similar way by going to the Administration page: Administration

Warning

Warning

In order to encrypt/decrypt fields, an encryption key is stored in a file called 'EncryptionToolKey.txt' in the permanent directory of your wiki. Do not delete or alter this file, or all the data encrypted in the wiki would be lost !

Known Issues regarding this Macro

Is there some issue we know nothing about? Please contribute and create an issue on: https://jira.xwiki.org/browse/ENCRYPTAPP

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Versions

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [extensions:ExtensionCode.VersionsHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-encryption-ui 1.3):

  • org.xwiki.contrib:application-encryption-api 1.3

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected