[[PageOutline(2-5,Contents,pullout)]]

= Gringotts encryption for Trac

== Description

[https://github.com/shlomif/gringotts Gringotts] is a GTK-based application for storing sensitive information (eg passwords, files, etc.) in an encrypted form. Gringotts itself is GPL-licensed.

This Trac plugin adds a semi-secure area for storing such information. It is essentially a mini-wiki which has an ACL (Access Control List) associated with the content. Everything stored in the database is encrypted with a 2048 key that is automatically generated when you install this plugin for the first time. The key is kept in the `trac.ini` file. Make sure you take a backup, because if the key is lost, then so is the data kept in Gringotts!

This plugin requires the [pypi:PyCrypto] package and also uses the [http://freenet.mcnabhosting.com/python/ezPyCrypto/ ezPyCrypto] wrapper.

You can either use the list of Gringotts as your main interface (it adds a navigation item), or you can use the Macro {{{[[Gringott(NameOfGringlet)]]}}} where every wiki syntax is supported.

To create a new Gringlet click on the ''create'' link in the lower right corner of the box that just appeared. You can now enter all your secrets. ACL's are entered as comma or space separated usernames.

Gringotts is also the name of the bank in the Harry Potter books.

== Bugs/Feature Requests

Existing bugs and feature requests for GringottsPlugin are 
[report:9?COMPONENT=GringottsPlugin here].

If you have any issues, create a 
[/newticket?component=GringottsPlugin new ticket].

[[TicketQuery(component=GringottsPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:gringottsplugin here].

== Source

You can check out GringottsPlugin from [/svn/gringottsplugin here] using Subversion, or [source:gringottsplugin browse the source] with Trac.

== Installation

The simplest way to install this plugin is to [export:gringottsplugin download] the zipped source, unzip it into the directory of your choice (/tmp or such), and run the following from the 0.10 directory:

{{{#!sh
python setup.py bdist_egg
}}}

If you're using Trac version 0.10 or 0.11, then you can use `easy_install`:

{{{#!sh
easy_install dist/gringotts-0.1-py2.4.egg
}}}

with a possible correction for the version number.

Next you'll have to enable the Gringotts plugin in the `trac.ini` file:

{{{#!ini
[components]
gringotts.* = enabled
}}}

If this is your first installation of Gringotts, you will need to upgrade your Trac project, to update the database schema and generate the private key:

{{{#!sh
trac-admin /path/to/your/project upgrade
}}}

For more information on plugin installation, visit the [t:TracPlugins TracPlugins] documentation page.

== Recent Changes

[[ChangeLog(gringottsplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:coling] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''