ISD-2817 Add mas to pebble plan

.trivyignore

@@ -53,7 +53,3 @@ CVE-2024-52804
 # Fix ongoing:
 # https://github.com/element-hq/synapse/pull/17985
 CVE-2024-53981
-# The 3 following CVEs will be fixed by Synapse 1.120.2
-CVE-2024-52805
-CVE-2024-52815
-CVE-2024-53863

actions.yaml

@@ -27,6 +27,20 @@ register-user:
       default: false
   required:
     - username
+verify-user-email:
+  description: |
+    Verify an user's email.
+    You need to supply an username and the email to verify.
+  properties:
+    username:
+      description: The username.
+      type: string
+    email:
+      description: The email to verify.
+      type: string
+  required:
+    - username
+    - email
 promote-user-admin:
   description: |
     Promote a user as a server administrator.

pyproject.toml

@@ -32,7 +32,7 @@ extension-pkg-whitelist = "pydantic"
 # Formatting tools configuration
 [tool.black]
 line-length = 99
-target-version = ["py38"]
+target-version = ["py310"]
 
 [tool.isort]
 line_length = 99

requirements.txt

@@ -7,5 +7,5 @@ jsonschema ==4.23.0
 ops ==2.17.1
 psycopg2-binary ==2.9.10
 pydantic ==2.10.3
-python-ulid ==3.0.0
 requests ==2.32.3
+python-ulid ==3.0.0

src-docs/charm.py.md

@@ -20,7 +20,7 @@ Charm the service.
 
 Attrs:  on: listen to Redis events. 
 
-<a href="../src/charm.py#L56"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L62"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `__init__`
 
@@ -77,7 +77,7 @@ Unit that this execution is responsible for.
 
 ---
 
-<a href="../src/charm.py#L107"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L115"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `build_charm_state`
 
@@ -94,7 +94,7 @@ Build charm state.
 
 ---
 
-<a href="../src/charm.py#L357"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L369"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `get_main_unit`
 
@@ -111,7 +111,7 @@ Get main unit.
 
 ---
 
-<a href="../src/charm.py#L372"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L384"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `get_main_unit_address`
 
@@ -128,7 +128,7 @@ Get main unit address. If main unit is None, use unit name.
 
 ---
 
-<a href="../src/charm.py#L424"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L436"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `get_signing_key`
 
@@ -145,7 +145,7 @@ Get signing key from secret.
 
 ---
 
-<a href="../src/charm.py#L131"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L139"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `get_unit_number`
 
@@ -169,7 +169,7 @@ Get unit number from unit name.
 
 ---
 
-<a href="../src/charm.py#L151"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L159"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `instance_map`
 
@@ -186,7 +186,7 @@ Build instance_map config.
 
 ---
 
-<a href="../src/charm.py#L123"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L131"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `is_main`
 
@@ -204,7 +204,7 @@ Verify if this unit is the main.
 
 ---
 
-<a href="../src/charm.py#L334"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L346"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `peer_units_total`
 
@@ -221,7 +221,7 @@ Get peer units total.
 
 ---
 
-<a href="../src/charm.py#L194"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L202"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `reconcile`
 
@@ -242,7 +242,7 @@ This is the main entry for changes that require a restart.
 
 ---
 
-<a href="../src/charm.py#L384"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L396"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `set_main_unit`
 
@@ -260,7 +260,7 @@ Create/Renew an admin access token and put it in the peer relation.
 
 ---
 
-<a href="../src/charm.py#L400"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/charm.py#L412"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `set_signing_key`
 

src-docs/pebble.py.md

@@ -7,12 +7,15 @@ Class to interact with pebble.
 
 **Global Variables**
 ---------------
+- **MAS_CONFIGURATION_PATH**
+- **MAS_PEBBLE_LAYER**
+- **MAS_SERVICE_NAME**
 - **STATS_EXPORTER_SERVICE_NAME**
 - **MAS_CONFIGURATION_PATH**
 
 ---
 
-<a href="../src/pebble.py#L44"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L50"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `check_synapse_alive`
 
@@ -37,7 +40,7 @@ Return the Synapse container alive check.
 
 ---
 
-<a href="../src/pebble.py#L66"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L72"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `check_synapse_ready`
 
@@ -56,7 +59,7 @@ Return the Synapse container ready check.
 
 ---
 
-<a href="../src/pebble.py#L82"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L88"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `restart_synapse`
 
@@ -83,7 +86,7 @@ This will force a restart even if its plan hasn't changed.
 
 ---
 
-<a href="../src/pebble.py#L104"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L110"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `check_nginx_ready`
 
@@ -102,7 +105,7 @@ Return the Synapse NGINX container check.
 
 ---
 
-<a href="../src/pebble.py#L117"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L123"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `check_mjolnir_ready`
 
@@ -121,7 +124,7 @@ Return the Synapse Mjolnir service check.
 
 ---
 
-<a href="../src/pebble.py#L133"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L139"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `restart_nginx`
 
@@ -141,7 +144,7 @@ Restart Synapse NGINX service and regenerate configuration.
 
 ---
 
-<a href="../src/pebble.py#L145"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L151"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `restart_federation_sender`
 
@@ -161,7 +164,7 @@ Restart Synapse federation sender service and regenerate configuration.
 
 ---
 
-<a href="../src/pebble.py#L158"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L164"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `replan_mjolnir`
 
@@ -180,7 +183,7 @@ Replan Synapse Mjolnir service.
 
 ---
 
-<a href="../src/pebble.py#L168"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L174"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `replan_stats_exporter`
 
@@ -200,7 +203,7 @@ Replan Synapse StatsExporter service.
 
 ---
 
-<a href="../src/pebble.py#L195"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L201"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `replan_synapse_federation_sender`
 
@@ -223,14 +226,34 @@ Replan Synapse Federation Sender service.
 
 ---
 
-<a href="../src/pebble.py#L302"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L216"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `replan_mas`
+
+```python
+replan_mas(container: Container) → None
+```
+
+Replan Matrix Authentication Service. 
+
+
+
+**Args:**
+
+ - <b>`container`</b>:  Charm container. 
+
+
+---
+
+<a href="../src/pebble.py#L320"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `reconcile`
 
 ```python
 reconcile(
     charm_state: CharmState,
     rendered_mas_configuration: str,
+    synapse_msc3861_configuration: dict,
     container: Container,
     is_main: bool = True,
     unit_number: str = ''
@@ -247,6 +270,7 @@ This is the main entry for changes that require a restart done via Pebble.
 
  - <b>`charm_state`</b>:  Instance of CharmState 
  - <b>`rendered_mas_configuration`</b>:  Rendered MAS yaml configuration. 
+ - <b>`synapse_msc3861_configuration`</b>:  Synapse's msc3861 configuration 
  - <b>`container`</b>:  Charm container. 
  - <b>`is_main`</b>:  if unit is main. 
  - <b>`unit_number`</b>:  unit number id to set the worker name. 
@@ -258,14 +282,34 @@ This is the main entry for changes that require a restart done via Pebble.
  - <b>`PebbleServiceError`</b>:  if something goes wrong while interacting with Pebble. 
 
 
+---
+
+<a href="../src/pebble.py#L630"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `restart_mas`
+
+```python
+restart_mas(container: Container, rendered_mas_configuration: str) → None
+```
+
+Update MAS configuration and restart MAS. 
+
+
+
+**Args:**
+
+ - <b>`container`</b>:  The synapse container. 
+ - <b>`rendered_mas_configuration`</b>:  YAML configuration for MAS. 
+
+
 ---
 
 ## <kbd>class</kbd> `PebbleServiceError`
 Exception raised when something fails while interacting with Pebble. 
 
 Attrs:  msg (str): Explanation of the error. 
 
-<a href="../src/pebble.py#L35"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/pebble.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>function</kbd> `__init__`