generated from ministryofjustice/template-documentation-site
/
authentication.html.md.erb
66 lines (39 loc) · 4.43 KB
/
authentication.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
title: Authentication
category: platform
last_reviewed_on: 2021-10-15
review_in: 3 months
---
<% if current_page.url != "/" %># <%= current_page.data.title %><% end %>
Locally the [MoJ Forms Editor](https://github.com/ministryofjustice/fb-editor) uses the developer callback that comes with Auth0 in order to present the user with a faux login screen. However in production it will actually show the Universal Login page that is configured in the [moj-forms tenant](https://manage.auth0.com/dashboard/eu/moj-forms/).
There are two connections configured currently, Google and Microsoft. The former is set up using a Social connection and the latter is configured using Enterprise Azure AD.
Currently the only user data we keep is their name and email address, both of which are encrypted before being saved in the DB.
The Universal Login has been configured within the Auth0 dashboard. Any changes should be done there directly. The username and password fields are required only in editor-test as they are used by the fb-acceptance-tests user.
There are two editor apps, one for Live and one for Test. Aside from the obvious differences between callback URLs, the Test app also has the username and password fields active in order for the acceptance tests to be able to log in.
The tenant environment is usually set to "development" and needs to have a manual request through the Auth0 service desk to set it to "production". The best situation is to have separate tenants per environment however it took so long to get the connections set up that to go back and request IDs and private keys just is not worth the time and effort.
The Azure client secret will expire on the 5th April 2023. At this time it will need to be regenerated by the MoJ Infrastructure and Platforms team who are responsible for the Microsoft Azure Active Directory system within the MoJ.
Currently if the same user logs in using the different connections there is no link between them so they will not see forms that they created when logged in with a different connection.
## Domain specific allowlisting
### Rules
Even though the Editor is hard coded to not allow the signup using email addresses that do not end in `@digital.justice.gov.uk` or `@justice.gov.uk` Auth0 also needs to cater for these. This is to prevent the times when a user is logged into several different accounts in the same browser.
To accomplish this there is a rule called `Email domain allowlist` which does some pre authentication javascript to check the email address of the user conforms to what we require.
`Auth Pipeline >> Rules` once you have logged into Auth0 and navigated to the `moj-forms` tenant dashboard.
Currently it is just a hardcoded array: `['justice.gov.uk', 'digital.justice.gov.uk']`.
Any changes to that array can be tested directly in the interface. Be aware that this currently affects both Test and Live environments at the same time, until we separate them out into different tenants in the future. It is also in real time so has the potential to break login for users in Live.
Below the above rule you'll also find the `Slack Notification on User Signup` rule which sends a message to the `#form-builder-deployments` channel whenever a new user signs up. It requires the `SLACK_HOOK_URL` to be set in order for it to work.
### How to add a domain to the list
In order to add a domain to the list, we have to add the corresponding string to the constant
```
ALLOWED_DOMAINS
```
in the configuration file: [config/initializers/allowed_domains.rb](https://github.com/ministryofjustice/fb-editor/blob/main/config/initializers/allowed_domains.rb)
The allow list is being used for authentication in the user session, but also by from address and send to address.
## Debugging
If a developer needs to debug the real login screen then they will need to change the URL that the initial POST request goes to. This resides in the home controller of the Editor app. `/auth/developer` would need to be changed to `/auth/auth0`. They will also need to add `http://localhost:3000/auth/auth0/callback` to the Allowed Callback URLs list and `http://localhost:3000` to the Allowed Logout URLs list. Both are comma separated lists.
You will also need to set the following environment variables:
```
AUTH0_CLIENT_ID
AUTH0_CLIENT_SECRET
AUTH0_DOMAIN
```
Once those changes are in place, opening the editor locally in an incognito window, or clearing the associated cookie, will allow a login experience very similar to what an end user will see.