From 87e315f8a57a40595d1fcc07b82d2a154b45f44b Mon Sep 17 00:00:00 2001
From: Michael Telahun <mtm@trevi.et>
Date: Mon, 16 Aug 2021 10:10:43 +0300
Subject: [PATCH] itm: Add known issue section about password encryption

---
 itm/README.rst         | 24 ++++++++++++++++--------
 itm/readme/ROADMAP.rst |  1 +
 2 files changed, 17 insertions(+), 8 deletions(-)
 create mode 100644 itm/readme/ROADMAP.rst

diff --git a/itm/README.rst b/itm/README.rst
index 5413982..0ffd764 100644
--- a/itm/README.rst
+++ b/itm/README.rst
@@ -1,6 +1,6 @@
-==============
-Infrastructure
-==============
+============================
+IT Infrastructure Management
+============================
 
 .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
@@ -10,11 +10,14 @@ Infrastructure
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
     :target: https://odoo-community.org/page/development-status
     :alt: Beta
-.. |badge2| image:: https://img.shields.io/badge/github-trevi-software%2Ftrevi--misc-lightgray.png?logo=github
-    :target: https://github.com/trevi-software/trevi-misc/tree/14.0/it
+.. |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-trevi-software%2Ftrevi--misc-lightgray.png?logo=github
+    :target: https://github.com/trevi-software/trevi-misc/tree/14.0/itm
     :alt: trevi-software/trevi-misc
 
-|badge1| |badge2| 
+|badge1| |badge2| |badge3| 
 
 This module is used to record information about a site's IT infrastructure. You can record information about equipment, software, backups, networks and access credentials.
 
@@ -23,13 +26,18 @@ This module is used to record information about a site's IT infrastructure. You
 .. contents::
    :local:
 
+Known issues / Roadmap
+======================
+
+* The password for encrypting and decrypting credentials is stored in Odoo as a system parameter. An attacker who has the 'Administration/Settings' priviledge or has access to the Odoo database itself can easily decrypt a credential's password field.
+
 Bug Tracker
 ===========
 
 Bugs are tracked on `GitHub Issues <https://github.com/trevi-software/trevi-misc/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/trevi-software/trevi-misc/issues/new?body=module:%20it%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/trevi-software/trevi-misc/issues/new?body=module:%20itm%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.
 
@@ -50,6 +58,6 @@ Other credits
 Maintainers
 ~~~~~~~~~~~
 
-This module is part of the `trevi-software/trevi-misc <https://github.com/trevi-software/trevi-misc/tree/14.0/it>`_ project on GitHub.
+This module is part of the `trevi-software/trevi-misc <https://github.com/trevi-software/trevi-misc/tree/14.0/itm>`_ project on GitHub.
 
 You are welcome to contribute.
diff --git a/itm/readme/ROADMAP.rst b/itm/readme/ROADMAP.rst
new file mode 100644
index 0000000..3d96aff
--- /dev/null
+++ b/itm/readme/ROADMAP.rst
@@ -0,0 +1 @@
+* The password for encrypting and decrypting credentials is stored in Odoo as a system parameter. An attacker who has the 'Administration/Settings' priviledge or has access to the Odoo database itself can easily decrypt a credential's password field.