ISD-2761 Add oauth lib and requirer #621

Thanhphan1147 · 2024-12-06T01:49:58Z

Overview

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

The charm style guide was applied
The contributing guide was applied
The changes are compliant with ISD054 - Manging Charm Complexity
The documentation is generated using src-docs
The documentation for charmhub is updated.
The PR is tagged with appropriate label (urgent, trivial, complex)

…l/synapse-operator into install_mas_cli_in_synapse_rock

…ation

…ynapse-operator into add_mas_database_integration

…ile, add test

…rom_template

…sql )

…ile, add test

…e synapse config, update mas config, fix register-user action, add verify-email action

gregory-schiano · 2024-12-13T15:52:23Z

requirements.txt

 requests ==2.32.3
+python-ulid ==3.0.0


Keep alphabetic ordering

gregory-schiano · 2024-12-13T15:58:06Z

src/charm.py

+        self.framework.observe(self._oauth.on.oauth_info_changed, self._on_config_changed)
+        self.framework.observe(self._oauth.on.oauth_info_removed, self._on_config_changed)
+        self.framework.observe(self._oauth.on.invalid_client_config, self._on_config_changed)


I'd rename the hook method to something more "generic"

gregory-schiano · 2024-12-13T16:09:50Z

src/pebble.py

@@ -401,6 +419,11 @@ def reconcile(  # noqa: C901 pylint: disable=too-many-branches,too-many-statemen
            ignore_order=True,
            ignore_string_case=True,
        )
+
+        restart_mas(container, rendered_mas_configuration)


To be set before restart_syname with a comment explaning it must be done before synapse

gregory-schiano · 2024-12-13T16:10:10Z

src/pebble.py

+
+        restart_mas(container, rendered_mas_configuration)
+        # Activate MAS on synapse
+        synapse.configure_mas(current_synapse_config, synapse_msc3861_configuration)


Move it before the DeepDiff to allow synapse to restart when the config has changed

github-actions · 2024-12-13T20:49:24Z

Lint checks failed for 3c0236b

```

--- /home/runner/work/synapse-operator/synapse-operator/src/charm.py 2024-12-13 20:47:48.483328+00:00
+++ /home/runner/work/synapse-operator/synapse-operator/src/charm.py 2024-12-13 20:48:12.998148+00:00
@@ -224,17 +224,17 @@
self.model.unit.status = ops.MaintenanceStatus("Configuring Synapse")

     oauth_client_config = generate_oauth_client_config(
         mas_configuration, charm_state.synapse_config
     )

   logger.info('Generated oauth client config: %s', oauth_client_config)

   logger.info("Generated oauth client config: %s", oauth_client_config)
   self._oauth.update_client_config(oauth_client_config)
   oauth_provider_info = None
   if self._oauth.is_client_created():
       oauth_provider_info = self._oauth.get_provider_info()

   logger.info('IS client created: %s', self._oauth.is_client_created())

   logger.info("IS client created: %s", self._oauth.is_client_created())

   rendered_mas_configuration = generate_mas_config(
       mas_configuration,
       charm_state.synapse_config,
       oauth_provider_info,

--- /home/runner/work/synapse-operator/synapse-operator/tests/unit/conftest.py 2024-12-13 20:47:48.487328+00:00
+++ /home/runner/work/synapse-operator/synapse-operator/tests/unit/conftest.py 2024-12-13 20:48:13.160731+00:00
@@ -122,13 +122,11 @@
monkeypatch.setattr(time, "sleep", lambda *_args, **_kwargs: "")
# Assume that MAS is working properly
monkeypatch.setattr(
"state.mas.MASConfiguration.from_charm", MagicMock(return_value=MagicMock())
)

monkeypatch.setattr(

   "charm.generate_oauth_client_config", MagicMock(return_value=None)

)

monkeypatch.setattr("charm.generate_oauth_client_config", MagicMock(return_value=None))
monkeypatch.setattr("pebble._push_mas_config", MagicMock())
monkeypatch.setattr("charm.generate_mas_config", MagicMock(return_value=""))
monkeypatch.setattr("charm.generate_synapse_msc3861_config", MagicMock(return_value={}))

harness = Harness(SynapseCharm)

github-actions · 2024-12-13T20:49:24Z

Test coverage for 3c0236b

Name                                    Stmts   Miss Branch BrPart  Cover   Missing
-----------------------------------------------------------------------------------
src/admin_access_token.py                   9      0      0      0   100%
src/auth/__init__.py                        0      0      0      0   100%
src/auth/mas.py                            68      8      2      1    87%   71-73, 117->119, 122-124, 260-264
src/backup.py                             175      5     20      2    96%   353-354, 423-424, 481->483, 484
src/backup_observer.py                    134     16     12      0    89%   132-135, 140-143, 179-182, 211-214
src/charm.py                              330     29     74     13    90%   154->156, 159, 233, 292, 296-297, 303-304, 325-326, 355, 362, 442-446, 449-450, 478-480, 500, 536-537, 544-546, 558-559, 566-568
src/charm_types.py                         30      0      0      0   100%
src/database_client.py                     57      1      8      4    92%   35, 47->exit, 69->exit, 88->98
src/database_observer.py                   49      4      2      0    92%   61-64
src/exceptions.py                           3      0      0      0   100%
src/matrix_auth_observer.py                68      8     12      3    86%   63, 66, 145, 159-163
src/media_observer.py                      45      4      2      1    89%   60-62, 81
src/mjolnir.py                            102      3     30      3    95%   85, 94->110, 115-119
src/observability.py                       14      0      0      0   100%
src/pebble.py                             217     29     44     12    84%   64->69, 183->exit, 194-198, 242-243, 263-264, 282-285, 344->349, 354-355, 367-368, 370-371, 402, 404, 406, 408, 410, 443, 495-500
src/redis_observer.py                      39      3      4      0    93%   63-66
src/s3_parameters.py                       22      0      4      0   100%
src/smtp_observer.py                       61      4     14      2    92%   82-86, 89, 108->113
src/state/__init__.py                       0      0      0      0   100%
src/state/charm_state.py                  128      9     32      7    90%   166, 170, 191, 216, 222, 228, 232-233, 316
src/state/mas.py                           73      7      4      2    88%   147, 153-154, 180-182, 197
src/state/validation.py                    36      3      2      0    92%   105-107
src/synapse/__init__.py                     4      0      0      0   100%
src/synapse/admin.py                       19      2      2      0    90%   40-41
src/synapse/api.py                        175      3     20      3    97%   176, 229, 402
src/synapse/workload.py                   138      6     24      0    94%   401-402, 412-415
src/synapse/workload_configuration.py     149     26     34     12    79%   90->exit, 94-95, 143-144, 173, 193-194, 226-227, 260, 269-270, 285, 290-291, 312-313, 332->337, 338, 356->358, 368-369, 397, 405->407, 407->409, 414-415, 435->442, 445, 465-466
src/user.py                                23      0      2      0   100%
-----------------------------------------------------------------------------------
TOTAL                                    2168    170    348     65    91%

Static code analysis report

Working... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
Run started:2024-12-13 20:48:50.348887

Test results:
>> Issue: [B105:hardcoded_password_string] Possible hardcoded password: 'client_secret_basic'
 Severity: Low   Confidence: Medium
 CWE: CWE-259 (https://cwe.mitre.org/data/definitions/259.html)
 More Info: https://bandit.readthedocs.io/en/1.8.0/plugins/b105_hardcoded_password_string.html
 Location: /home/runner/work/synapse-operator/synapse-operator/src/auth/mas.py:42:33
41	MAS_AUTHORIZATION_GRANT = ["authorization_code"]
42	MAS_TOKEN_ENDPOINT_AUTH_METHOD = "client_secret_basic"
43	MAS_OIDC_SCOPE = "openid profile email"

--------------------------------------------------

Code scanned:
  Total lines of code: 11328
  Total lines skipped (#nosec): 4
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 1
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 1
  	High: 0
Files skipped (0):

Thanhphan1147 added 30 commits November 23, 2024 01:56

add mas-cli to synapse rock

091c9fb

build mas-cli and its assets in synapse rock

a77fb66

Merge branch 'main' into install_mas_cli_in_synapse_rock

3666081

await coroutine

74419c5

Merge branch 'install_mas_cli_in_synapse_rock' of github.com:canonica…

faf57b4

…l/synapse-operator into install_mas_cli_in_synapse_rock

update assets location

bd97414

fix missing dir

a432b3b

fix lint

033304f

fix broken tests

09dac1f

fix lint

0edc5f3

update target track

ae65d33

reformat rockcraft

68c9c89

update mas-cli tests

a803b92

Merge branch '2/main' into install_mas_cli_in_synapse_rock

b166265

update synapse tag and update tests

143c5d2

Merge branch 'install_mas_cli_in_synapse_rock' of github.com:canonica…

1019432

…l/synapse-operator into install_mas_cli_in_synapse_rock

fix test

4dc8a2f

update rockcraft with changes relating to 24.04 base

23383db

remove the SAML integration and all relevant code

392262f

remove attribute_maps part from rock

b5dd209

Merge remote-tracking branch 'origin/2/main' into disable_saml_integr…

53457d9

…ation

add mas-datasource state component

04a4e68

add MAS configuration state component

d378498

update charmstate + decorator logic

dac1eb2

fix cyclic import + fix test

899d8d0

update function signatures, update fixtures, fix tests

455b985

fix integration test

962fd0a

relate to mas-database before checking for status

a87960d

fix lint

4c65b01

ensure that postgresql is deployed

16e3c53

Thanhphan1147 added 25 commits December 6, 2024 23:59

Merge branch 'add_mas_database_integration' of github.com:canonical/s…

89e7bba

…ynapse-operator into add_mas_database_integration

add_mas_template

2edd948

add diagram + update code

4a8c15c

update method prototype

544f7b6

add configuration template, add mas service to manage configuration f…

298cd6f

…ile, add test

update charmcraft

ced34c3

update encryption key length and template to match MAS spec

a1e9065

add missing policy reference

82b547f

fix unintended naming changes

4e4ff6d

Merge remote-tracking branch 'origin/2/main' into render_mas_config_f…

136b994

…rom_template

fix unit test

4eba748

remove diagram, update naming

a2f73ce

fix lint

4d1fd86

update integration test

b13e8c3

fix lint and update test ( wait for active before relating to postgre…

ad63e70

…sql )

add configuration template, add mas service to manage configuration f…

7dc4160

…ile, add test

start MAS with password login flow, update nginx routing logic, updat…

af08dc1

…e synapse config, update mas config, fix register-user action, add verify-email action

refactor + update tests

6151841

update mas config, restart mas before synapse

4d5de49

update tests

c15a461

Merge remote-tracking branch 'origin/2/main' into add_mas_to_pebble_plan

cdb4912

update src-docs

9fea606

update integration tests

a434d80

addl ib

db9e9fe

add oauth interface, add requirer implementation

74248fc

Thanhphan1147 force-pushed the add_oauth_lib_and_requirer branch from f14b722 to 74248fc Compare December 13, 2024 15:31

gregory-schiano reviewed Dec 13, 2024

View reviewed changes

fix template and tests. Fix issues from rebase

3c0236b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ISD-2761 Add oauth lib and requirer #621

ISD-2761 Add oauth lib and requirer #621

Thanhphan1147 commented Dec 6, 2024

gregory-schiano Dec 13, 2024

gregory-schiano Dec 13, 2024

gregory-schiano Dec 13, 2024

gregory-schiano Dec 13, 2024

github-actions bot commented Dec 13, 2024

github-actions bot commented Dec 13, 2024

ISD-2761 Add oauth lib and requirer #621

Are you sure you want to change the base?

ISD-2761 Add oauth lib and requirer #621

Conversation

Thanhphan1147 commented Dec 6, 2024

Overview

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

gregory-schiano Dec 13, 2024

Choose a reason for hiding this comment

gregory-schiano Dec 13, 2024

Choose a reason for hiding this comment

gregory-schiano Dec 13, 2024

Choose a reason for hiding this comment

gregory-schiano Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 13, 2024

github-actions bot commented Dec 13, 2024