Skip to content

Commit ea835b9

Browse files
committed
Add hooks documentation for glpi key file
1 parent b5fb88a commit ea835b9

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

source/plugins/hooks.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,30 @@ Unclassified
133133

134134
Hooks that cannot be classified in above categories :)
135135

136+
``secured_fields``
137+
.. versionadded:: 9.4.6
138+
139+
An array of fields names (with table like ``glpi_mytable.myfield``) that are stored using GLPI crypting methods.
140+
This allows pluins to add some fields to the ``glpi:security:changekey`` command.
141+
142+
.. warning::
143+
144+
Plugins have to ensure crypt migration on their side is OK; and once using it, they **must** properly declare fields.
145+
146+
All fields that would use the key file without being listed would be unreadable after key has been changed (and stored data would stay potentially unsecure).
147+
148+
``secured_configs``
149+
.. versionadded:: 9.4.6
150+
151+
An array of configuration entries that are stored using GLPI crypting methods.
152+
This allows pluins to add some entries to the ``glpi:security:changekey`` command.
153+
154+
.. warning::
155+
156+
Plugins have to ensure crypt migration on their side is OK; and once using it, they **must** properly declare fields.
157+
158+
All configuration entries that would use the key file without being listed would be unreadable after key has been changed (and stored data would stay potentially unsecure).
159+
136160
``add_javascript``
137161
Add javascript in **all** pages headers
138162

0 commit comments

Comments
 (0)