commit
caf47fc57d
|
|
@ -0,0 +1,112 @@
|
|||
==================================
|
||||
Server Environment Data Encryption
|
||||
==================================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |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/14.0/server_environment_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-14-0/server-env-14-0-server_environment_data_encryption
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/254/14.0
|
||||
:alt: Try me on Runbot
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module changes a little the behavior of server_environment modules.
|
||||
When Odoo does not find the value of the field in the configuration file,
|
||||
it will fallback on a Odoo encrypted field instead.
|
||||
Also it allows you
|
||||
to configure the environment dependent fields for all your environments
|
||||
from the production server.
|
||||
|
||||
.. 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
|
||||
=============
|
||||
|
||||
In order to use this module properly, each environment should have their own encryption key
|
||||
and the production environment should have the keys of all environments.
|
||||
|
||||
Example :
|
||||
Development environment ::
|
||||
|
||||
[options]
|
||||
running_env=dev
|
||||
encryption_key_dev=XXX
|
||||
|
||||
Pre-production environment ::
|
||||
|
||||
[options]
|
||||
running_env=preprod
|
||||
encryption_key_preprod=YYY
|
||||
|
||||
Production environment ::
|
||||
|
||||
[options]
|
||||
running_env=prod
|
||||
encryption_key_dev=XXX
|
||||
encryption_key_preprod=YYY
|
||||
encryption_key_prod=ZZZ
|
||||
|
||||
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 smashing it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_data_encryption%0Aversion:%2014.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
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Florian da Costa <florian.dacosta@akretion.com>
|
||||
* Sébastien Beau <sebastien.beau@akretion.com>
|
||||
* Benoît Guillot <benoit.guillot@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/14.0/server_environment_data_encryption>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import models
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
||||
{
|
||||
"name": "Server Environment Data Encryption",
|
||||
"version": "16.0.1.0.0",
|
||||
"development_status": "Alpha",
|
||||
"category": "Tools",
|
||||
"website": "https://github.com/OCA/server-env",
|
||||
"author": "Akretion, Odoo Community Association (OCA)",
|
||||
"license": "AGPL-3",
|
||||
"installable": True,
|
||||
"depends": ["server_environment", "data_encryption"],
|
||||
}
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * server_environment_data_encryption
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 14.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: Automatically generated\n"
|
||||
"Language-Team: none\n"
|
||||
"Language: ca\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: nplurals=2; plural=n != 1;\n"
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid "Define values for "
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model.fields,field_description:server_environment_data_encryption.field_server_env_mixin__display_name
|
||||
msgid "Display Name"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model.fields,field_description:server_environment_data_encryption.field_server_env_mixin__id
|
||||
msgid "ID"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model.fields,field_description:server_environment_data_encryption.field_server_env_mixin____last_update
|
||||
msgid "Last Modified on"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model,name:server_environment_data_encryption.model_server_env_mixin
|
||||
msgid "Mixin to add server environment in existing models"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid "Modify values for {} environment"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid "The encryption key for current environement is not defined"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid ""
|
||||
"you need to define the running_env entry in your odoo configuration file"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * server_environment_data_encryption
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 14.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid "Define values for "
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model.fields,field_description:server_environment_data_encryption.field_server_env_mixin__display_name
|
||||
msgid "Display Name"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model.fields,field_description:server_environment_data_encryption.field_server_env_mixin__id
|
||||
msgid "ID"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model.fields,field_description:server_environment_data_encryption.field_server_env_mixin____last_update
|
||||
msgid "Last Modified on"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: model:ir.model,name:server_environment_data_encryption.model_server_env_mixin
|
||||
msgid "Mixin to add server environment in existing models"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid "Modify values for {} environment"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid "The encryption key for current environement is not defined"
|
||||
msgstr ""
|
||||
|
||||
#. module: server_environment_data_encryption
|
||||
#: code:addons/server_environment_data_encryption/models/server_env_mixin.py:0
|
||||
#, python-format
|
||||
msgid ""
|
||||
"you need to define the running_env entry in your odoo configuration file"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import server_env_mixin
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||
|
||||
import json
|
||||
import logging
|
||||
|
||||
from lxml import etree
|
||||
|
||||
from odoo import _, api, models
|
||||
from odoo.exceptions import ValidationError
|
||||
from odoo.tools.config import config
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class ServerEnvMixin(models.AbstractModel):
|
||||
_inherit = "server.env.mixin"
|
||||
|
||||
def _current_env_encrypted_key_exists(self):
|
||||
env = self.env["encrypted.data"]._retrieve_env()
|
||||
key_name = "encryption_key_%s" % env
|
||||
key_str = config.get(key_name)
|
||||
key_exists = key_str and True or False
|
||||
if not key_exists:
|
||||
logging.warning(
|
||||
"The minimal configuration is missing. You need at least to add an "
|
||||
"encryption key for the current environment : %s. While the "
|
||||
"configuration is missing, the module has no effect",
|
||||
env,
|
||||
)
|
||||
return key_exists
|
||||
|
||||
def _compute_server_env_from_default(self, field_name, options):
|
||||
"""First return database encrypted value then default value"""
|
||||
# in case of bad configuration (no encryption key for current env) the module
|
||||
# is useless, we do fallback directly on serven_environement behavior
|
||||
if not self._current_env_encrypted_key_exists():
|
||||
return super()._compute_server_env_from_default(field_name, options)
|
||||
encrypted_data_name = "{},{}".format(self._name, self.id)
|
||||
env = self.env.context.get("environment", None)
|
||||
|
||||
vals = (
|
||||
self.env["encrypted.data"]
|
||||
.sudo()
|
||||
._encrypted_read_json(encrypted_data_name, env=env)
|
||||
)
|
||||
if vals.get(field_name):
|
||||
self[field_name] = vals[field_name]
|
||||
else:
|
||||
return super()._compute_server_env_from_default(field_name, options)
|
||||
|
||||
def _inverse_server_env(self, field_name):
|
||||
"""
|
||||
When this module is installed, we store values into encrypted data
|
||||
env instead of a default field in database (not env dependent).
|
||||
"""
|
||||
# in case of bad configuration (no encryption key for current env) the module
|
||||
# is useless, we do fallback directly on serven_environement behavior
|
||||
if not self._current_env_encrypted_key_exists():
|
||||
return super()._inverse_server_env(field_name)
|
||||
is_editable_field = self._server_env_is_editable_fieldname(field_name)
|
||||
encrypted_data_obj = self.env["encrypted.data"].sudo()
|
||||
env = self.env.context.get("environment", None)
|
||||
for record in self:
|
||||
if record[is_editable_field]:
|
||||
encrypted_data_name = "{},{}".format(record._name, record.id)
|
||||
values = encrypted_data_obj._encrypted_read_json(
|
||||
encrypted_data_name, env=env
|
||||
)
|
||||
new_val = {field_name: record[field_name]}
|
||||
values.update(new_val)
|
||||
encrypted_data_obj._encrypted_store_json(
|
||||
encrypted_data_name, values, env=env
|
||||
)
|
||||
|
||||
def action_change_env_data_encrypted_fields(self):
|
||||
action_id = self.env.context.get("params", {}).get("action")
|
||||
if not action_id:
|
||||
# We don't know which action we are using... take default one
|
||||
action = self.get_formview_action()
|
||||
else:
|
||||
action = (
|
||||
self.env["ir.actions.act_window"].browse(action_id).sudo().read()[0]
|
||||
)
|
||||
action["view_mode"] = "form"
|
||||
action["res_id"] = self.id
|
||||
views_form = []
|
||||
for view_id, view_type in action.get("views", []):
|
||||
if view_type == "form":
|
||||
views_form.append((view_id, view_type))
|
||||
action["views"] = views_form
|
||||
return action
|
||||
|
||||
def _get_extra_environment_info_div(self, current_env, extra_envs):
|
||||
# if the module configuration is missing (no current env encryption key)
|
||||
# display a warning instead as the module has no effect.
|
||||
if not self._current_env_encrypted_key_exists():
|
||||
button_div = "<div>"
|
||||
warning_string = _(
|
||||
"The encryption key for current environement is not defined"
|
||||
)
|
||||
elem = etree.fromstring(
|
||||
"""
|
||||
<div class="d-flex justify-content-between">
|
||||
<div class="alert lead {} text-center d-inline">
|
||||
<strong>{}</strong>
|
||||
</div>
|
||||
</div>
|
||||
""".format(
|
||||
"alert-danger", warning_string
|
||||
)
|
||||
)
|
||||
return elem
|
||||
|
||||
# TODO we could use a qweb template here
|
||||
button_div = "<div>"
|
||||
button_string = _("Define values for ")
|
||||
for environment in extra_envs:
|
||||
button = """
|
||||
<button name="action_change_env_data_encrypted_fields"
|
||||
type="object" string="{}{}"
|
||||
class="btn btn-lg btn-primary ml-2"
|
||||
context="{}"/>
|
||||
""".format(
|
||||
button_string, environment, {"environment": environment}
|
||||
)
|
||||
button_div += "{}".format(button)
|
||||
button_div += "</div>"
|
||||
alert_string = _("Modify values for {} environment").format(current_env)
|
||||
alert_type = (
|
||||
current_env == config.get("running_env") and "alert-info" or "alert-warning"
|
||||
)
|
||||
elem = etree.fromstring(
|
||||
"""
|
||||
<div class="d-flex justify-content-between">
|
||||
<div class="alert lead {} text-center d-inline">
|
||||
<strong>{}</strong>
|
||||
</div>
|
||||
{}
|
||||
</div>
|
||||
""".format(
|
||||
alert_type, alert_string, button_div
|
||||
)
|
||||
)
|
||||
return elem
|
||||
|
||||
def _set_readonly_form_view(self, doc):
|
||||
for field in doc.iter("field"):
|
||||
env_fields = self._server_env_fields.keys()
|
||||
field_name = field.get("name")
|
||||
if field_name in env_fields:
|
||||
continue
|
||||
field.set("readonly", "1")
|
||||
field.set("modifiers", json.dumps({"readonly": True}))
|
||||
|
||||
def _update_form_view_from_env(self, arch, view_type):
|
||||
if view_type != "form":
|
||||
return arch
|
||||
current_env = self.env.context.get("environment") or config.get("running_env")
|
||||
# Important to keep this list sorted. It makes sure the button to
|
||||
# switch environment will always be in the same order. (more user
|
||||
# friendly) and the test would fail without it as the order could
|
||||
# change randomly and the view would then also change randomly
|
||||
other_environments = sorted(
|
||||
[
|
||||
key[15:]
|
||||
for key, val in config.options.items()
|
||||
if key.startswith("encryption_key_") and val and key[15:] != current_env
|
||||
]
|
||||
)
|
||||
|
||||
if not current_env:
|
||||
raise ValidationError(
|
||||
_(
|
||||
"you need to define the running_env entry in your odoo "
|
||||
"configuration file"
|
||||
)
|
||||
)
|
||||
node = arch.xpath("//sheet")
|
||||
if node:
|
||||
node = node[0]
|
||||
elem = self._get_extra_environment_info_div(current_env, other_environments)
|
||||
node.insert(0, elem)
|
||||
|
||||
if current_env != config.get("running_env"):
|
||||
self._set_readonly_form_view(arch)
|
||||
else:
|
||||
_logger.error("Missing sheet for form view on object {}".format(self._name))
|
||||
return arch
|
||||
|
||||
@api.model
|
||||
def _get_view(self, view_id=None, view_type="form", **options):
|
||||
arch, view = super()._get_view(view_id=view_id, view_type=view_type, **options)
|
||||
arch = self._update_form_view_from_env(arch, view_type)
|
||||
return arch, view
|
||||
|
||||
def _get_view_cache_key(self, view_id=None, view_type="form", **options):
|
||||
res = super()._get_view_cache_key(
|
||||
view_id=view_id, view_type=view_type, **options
|
||||
)
|
||||
res += (self.env.context.get("environment", False),)
|
||||
return res
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
In order to use this module properly, each environment should have their own encryption key
|
||||
and the production environment should have the keys of all environments.
|
||||
|
||||
Example :
|
||||
Development environment ::
|
||||
|
||||
[options]
|
||||
running_env=dev
|
||||
encryption_key_dev=XXX
|
||||
|
||||
Pre-production environment ::
|
||||
|
||||
[options]
|
||||
running_env=preprod
|
||||
encryption_key_preprod=YYY
|
||||
|
||||
Production environment ::
|
||||
|
||||
[options]
|
||||
running_env=prod
|
||||
encryption_key_dev=XXX
|
||||
encryption_key_preprod=YYY
|
||||
encryption_key_prod=ZZZ
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
* Florian da Costa <florian.dacosta@akretion.com>
|
||||
* Sébastien Beau <sebastien.beau@akretion.com>
|
||||
* Benoît Guillot <benoit.guillot@akretion.com>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
This module changes a little the behavior of server_environment modules.
|
||||
When Odoo does not find the value of the field in the configuration file,
|
||||
it will fallback on a Odoo encrypted field instead.
|
||||
Also it allows you
|
||||
to configure the environment dependent fields for all your environments
|
||||
from the production server.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,459 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
|
||||
<title>Server Environment Data Encryption</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: grey; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="server-environment-data-encryption">
|
||||
<h1 class="title">Server Environment Data Encryption</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-env/tree/14.0/server_environment_data_encryption"><img alt="OCA/server-env" src="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-env-14-0/server-env-14-0-server_environment_data_encryption"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/254/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This module changes a little the behavior of server_environment modules.
|
||||
When Odoo does not find the value of the field in the configuration file,
|
||||
it will fallback on a Odoo encrypted field instead.
|
||||
Also it allows you
|
||||
to configure the environment dependent fields for all your environments
|
||||
from the production server.</p>
|
||||
<div class="admonition important">
|
||||
<p class="first admonition-title">Important</p>
|
||||
<p class="last">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.
|
||||
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
|
||||
</div>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
|
||||
<p>In order to use this module properly, each environment should have their own encryption key
|
||||
and the production environment should have the keys of all environments.</p>
|
||||
<p>Example :
|
||||
Development environment</p>
|
||||
<pre class="literal-block">
|
||||
[options]
|
||||
running_env=dev
|
||||
encryption_key_dev=XXX
|
||||
</pre>
|
||||
<p>Pre-production environment</p>
|
||||
<pre class="literal-block">
|
||||
[options]
|
||||
running_env=preprod
|
||||
encryption_key_preprod=YYY
|
||||
</pre>
|
||||
<p>Production environment</p>
|
||||
<pre class="literal-block">
|
||||
[options]
|
||||
running_env=prod
|
||||
encryption_key_dev=XXX
|
||||
encryption_key_preprod=YYY
|
||||
encryption_key_prod=ZZZ
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-env/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
|
||||
<a class="reference external" href="https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_data_encryption%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Akretion</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Florian da Costa <<a class="reference external" href="mailto:florian.dacosta@akretion.com">florian.dacosta@akretion.com</a>></li>
|
||||
<li>Sébastien Beau <<a class="reference external" href="mailto:sebastien.beau@akretion.com">sebastien.beau@akretion.com</a>></li>
|
||||
<li>Benoît Guillot <<a class="reference external" href="mailto:benoit.guillot@akretion.com">benoit.guillot@akretion.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<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>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>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/14.0/server_environment_data_encryption">OCA/server-env</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import test_server_environment_data_encrypt
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<form string="Test">
|
||||
<header>
|
||||
<button
|
||||
string="Reset Confirmation"
|
||||
type="object"
|
||||
name="set_draft"
|
||||
states="done"
|
||||
/>
|
||||
</header>
|
||||
<sheet>
|
||||
<group col="4">
|
||||
<field name="test" modifiers="{"required": true}" />
|
||||
<field
|
||||
name="test2"
|
||||
attrs="{'readonly': [('type_env_is_editable', '=', False)]}"
|
||||
on_change="1"
|
||||
modifiers="{"readonly": [["type_env_is_editable", "=", false]]}"
|
||||
/>
|
||||
<field name="date" modifiers="{"readonly": true}" />
|
||||
</group>
|
||||
</sheet>
|
||||
</form>
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
<form string="Test">
|
||||
<header>
|
||||
<button
|
||||
string="Reset Confirmation"
|
||||
type="object"
|
||||
name="set_draft"
|
||||
states="done"
|
||||
/>
|
||||
</header>
|
||||
<sheet>
|
||||
<div class="d-flex justify-content-between">
|
||||
<div class="alert lead alert-info text-center d-inline">
|
||||
<strong>Modify values for test environment</strong>
|
||||
</div>
|
||||
<div>
|
||||
<button
|
||||
name="action_change_env_data_encrypted_fields"
|
||||
type="object"
|
||||
string="Define values for preprod"
|
||||
class="btn btn-lg btn-primary ml-2"
|
||||
context="{'environment': 'preprod'}"
|
||||
/>
|
||||
|
||||
<button
|
||||
name="action_change_env_data_encrypted_fields"
|
||||
type="object"
|
||||
string="Define values for prod"
|
||||
class="btn btn-lg btn-primary ml-2"
|
||||
context="{'environment': 'prod'}"
|
||||
/>
|
||||
</div>
|
||||
</div><group col="4">
|
||||
<field name="test" modifiers="{"required": true}" />
|
||||
<field
|
||||
name="test2"
|
||||
attrs="{'readonly': [('type_env_is_editable', '=', False)]}"
|
||||
on_change="1"
|
||||
modifiers="{"readonly": [["type_env_is_editable", "=", false]]}"
|
||||
/>
|
||||
<field name="date" modifiers="{"readonly": true}" />
|
||||
</group>
|
||||
</sheet>
|
||||
</form>
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
<form string="Test">
|
||||
<header>
|
||||
<button
|
||||
string="Reset Confirmation"
|
||||
type="object"
|
||||
name="set_draft"
|
||||
states="done"
|
||||
/>
|
||||
</header>
|
||||
<sheet>
|
||||
<div class="d-flex justify-content-between">
|
||||
<div class="alert lead alert-warning text-center d-inline">
|
||||
<strong>Modify values for prod environment</strong>
|
||||
</div>
|
||||
<div>
|
||||
<button
|
||||
name="action_change_env_data_encrypted_fields"
|
||||
type="object"
|
||||
string="Define values for preprod"
|
||||
class="btn btn-lg btn-primary ml-2"
|
||||
context="{'environment': 'preprod'}"
|
||||
/>
|
||||
|
||||
<button
|
||||
name="action_change_env_data_encrypted_fields"
|
||||
type="object"
|
||||
string="Define values for test"
|
||||
class="btn btn-lg btn-primary ml-2"
|
||||
context="{'environment': 'test'}"
|
||||
/>
|
||||
</div>
|
||||
</div><group col="4">
|
||||
<field name="test" modifiers="{"readonly": true}" readonly="1" />
|
||||
<field
|
||||
name="test2"
|
||||
attrs="{'readonly': [('type_env_is_editable', '=', False)]}"
|
||||
on_change="1"
|
||||
modifiers="{"readonly": true}"
|
||||
readonly="1"
|
||||
/>
|
||||
<field name="date" modifiers="{"readonly": true}" readonly="1" />
|
||||
</group>
|
||||
</sheet>
|
||||
</form>
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from lxml import etree
|
||||
|
||||
from odoo.addons.data_encryption.tests.common import CommonDataEncrypted
|
||||
|
||||
|
||||
class TestServerEnvDataEncrypted(CommonDataEncrypted):
|
||||
def test_dynamic_view_current_env(self):
|
||||
self.maxDiff = None
|
||||
self.set_new_key_env("prod")
|
||||
self.set_new_key_env("preprod")
|
||||
mixin_obj = self.env["server.env.mixin"]
|
||||
base_path = Path(__file__).parent / "fixtures" / "base.xml"
|
||||
xml_str = base_path.read_text()
|
||||
xml = etree.XML(xml_str)
|
||||
res_xml = mixin_obj._update_form_view_from_env(xml, "form")
|
||||
expected_xml_path = Path(__file__).parent / "fixtures" / "res1.xml"
|
||||
expected_xml = expected_xml_path.read_text()
|
||||
# convert both to xml with parser removing space then convert to string to
|
||||
# compare
|
||||
parser = etree.XMLParser(remove_blank_text=True)
|
||||
res_xml_str = etree.tostring(etree.XML(etree.tostring(res_xml), parser=parser))
|
||||
expected_xml_str = etree.tostring(etree.XML(expected_xml, parser=parser))
|
||||
self.assertEqual(res_xml_str, expected_xml_str)
|
||||
|
||||
def test_dynamic_view_other_env(self):
|
||||
self.maxDiff = None
|
||||
self.set_new_key_env("prod")
|
||||
self.set_new_key_env("preprod")
|
||||
mixin_obj = self.env["server.env.mixin"]
|
||||
base_path = Path(__file__).parent / "fixtures" / "base.xml"
|
||||
xml_str = base_path.read_text()
|
||||
xml = etree.XML(xml_str)
|
||||
res_xml = mixin_obj.with_context(environment="prod")._update_form_view_from_env(
|
||||
xml, "form"
|
||||
)
|
||||
expected_xml_path = Path(__file__).parent / "fixtures" / "res2.xml"
|
||||
expected_xml = expected_xml_path.read_text()
|
||||
# convert both to xml with parser removing space then convert to string to
|
||||
# compare
|
||||
parser = etree.XMLParser(remove_blank_text=True)
|
||||
res_xml_str = etree.tostring(etree.XML(etree.tostring(res_xml), parser=parser))
|
||||
expected_xml_str = etree.tostring(etree.XML(expected_xml, parser=parser))
|
||||
self.assertEqual(res_xml_str, expected_xml_str)
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../server_environment_data_encryption
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
import setuptools
|
||||
|
||||
setuptools.setup(
|
||||
setup_requires=['setuptools-odoo'],
|
||||
odoo_addon=True,
|
||||
)
|
||||
Loading…
Reference in New Issue