119 lines
4.5 KiB
ReStructuredText
119 lines
4.5 KiB
ReStructuredText
===============
|
|
Encryption data
|
|
===============
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:2d4447d50c16329e068a3699d69972506a62f5d3235b59046149e6aa76151e0e
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
|
|
:target: https://odoo-community.org/page/development-status
|
|
:alt: Alpha
|
|
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
|
:alt: License: AGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/server-env/tree/16.0/data_encryption
|
|
:alt: OCA/server-env
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/server-env-16-0/server-env-16-0-data_encryption
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This module allows to encrypt and decrypt data. This module is not usable
|
|
by itself, it is a low level module which should work as a base for others.
|
|
An example is the module server_environment_data_encryption
|
|
|
|
.. IMPORTANT::
|
|
This is an alpha version, the data model and design can change at any time without warning.
|
|
Only for development or testing purpose, do not use in production.
|
|
`More details on development status <https://odoo-community.org/page/development-status>`_
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
To configure this module, you need to edit the main configuration file
|
|
of your instance, and add a directive called ``running_env``. Commonly
|
|
used values are 'dev', 'test', 'production'::
|
|
|
|
[options]
|
|
running_env=dev
|
|
|
|
|
|
You also need to set the encryption key(s). The main idea is to have different
|
|
encryption keys for your different environment, to avoid the possibility to retrieve
|
|
crucial information from the production environment in a developement environment, for instance.
|
|
So, if your running environment is 'dev'::
|
|
|
|
[options]
|
|
encryption_key_dev=fyeMIx9XVPBBky5XZeLDxVc9dFKy7Uzas3AoyMarHPA=
|
|
|
|
In the configuration file of your production environment, you may want to configure
|
|
all your other environments encryption key. This way, from production you can encrypt and decrypt
|
|
data for all environments.
|
|
|
|
You can generate keys with python -c 'from cryptography.fernet import Fernet; print(Fernet.generate_key())'.
|
|
|
|
Known issues / Roadmap
|
|
======================
|
|
|
|
For now the encryption is dependent on the environment. It has been designed
|
|
to store the same kind of data with different values depending on the environement
|
|
(dev, preprod, prod...).
|
|
An improvement could be to split this in 2 modules. But the environment stuff
|
|
is not a big constraint.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
|
|
In case of trouble, please check there if your issue has already been reported.
|
|
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
|
`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20data_encryption%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
|
|
|
Do not contact contributors directly about support or help with technical issues.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* Akretion
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Raphaël Reverdy <raphael.reverdy@akretion.com>
|
|
* Florian da Costa <florian.dacosta@akretion.com>
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
This module is maintained by the OCA.
|
|
|
|
.. image:: https://odoo-community.org/logo.png
|
|
:alt: Odoo Community Association
|
|
:target: https://odoo-community.org
|
|
|
|
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.
|
|
|
|
This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/16.0/data_encryption>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|