Author: |
LasLabs, Odoo Community Association (OCA) |
License: |
LGPL-3 |
Branch: |
release/10.0/base_fields_ephemeral |
Repository: |
LasLabs/server-tools |
Dependencies: |
base |
Languages: |
Python (185, 79.4%),
and
reStructuredText (48, 20.6%) |
<a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.svg">
</a>
<a name="red-october-attachments"></a>
<h2>Red October Attachments</h2>
<p>This module provides a <code>red_october</code> type to <code>ir.attachment</code>, which provides
encryption and decryption services using a remote Red October instance.</p>
<a name="installation"></a>
<h3>Installation</h3>
<p>A working Red October installation is required to use this module.</p>
<ul class="simple">
<li>Install the Python Red October library <code>pip install git+https://github.com/LasLabs/python-red-october@feature/master/code-samples</code></li>
</ul>
<a name="configuration"></a>
<h3>Configuration</h3>
<ul class="simple">
<li>Go to <code>Settings => Crypto => Vaults</code> to create and manage vaults.
* Vault must be initialized in <code>Action => Init Vault</code> from vault form view.</li>
<li>Manage crypto users in <code>Settings => Crypto => Vaults</code>.</li>
</ul>
<a name="usage"></a>
<h3>Usage</h3>
<ul class="simple">
<li>Create an Attachment of Type <code>Red October</code>.</li>
<li>Manage delegations in <code>Settings => Crypto => Delegations</code>.</li>
</ul>
<p>Note that there must be a valid rights delegation on the Vault in order to decrypt a file,
even if you are the only owner.</p>
<p>Developers looking to implement this functionality should use an <code>ir.attachment</code>
field set to type <code>red_october</code>.</p>
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/149/10.0forserver-tools"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<ul class="simple">
<li>Decouple the Red October user passwords from Odoo passwords.</li>
<li>Add caching for most methods</li>
<li>Allow for multiple RedOctoberUsers per ResUser, with a selection controlled via the session.</li>
<li>Allow for multiple RedOctoberVaults per ResCompany.</li>
<li>Allow transferring files between vaults.</li>
<li>If decrypt error, fail silently & instead hide the data. Need to handle in the encrypt too.</li>
<li>Add delegation uses & delta to <code>red.october.file.owner</code>.</li>
</ul>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Dave Lasley <<a class="reference external" href="mailto:dave@laslabs.com">dave@laslabs.com</a>></li>
</ul>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>To contribute to this module, please visit <a class="reference external" href="http://odoo-community.org">http://odoo-community.org</a>.</p>