Skip to content

Commit 12503aa

Browse files
rickimooreWoodpile37
authored andcommitted
Feat: lighthouse book - ui authentication (sigp#4232)
## Proposed Changes Added page explanation for authentication under Siren UI book. ## Additional Info Please provide any additional information. For example, future considerations or information useful for reviewers.
1 parent 92ee01c commit 12503aa

File tree

7 files changed

+37
-2
lines changed

7 files changed

+37
-2
lines changed

book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
* [Prometheus Metrics](./advanced_metrics.md)
3535
* [Lighthouse UI (Siren)](./lighthouse-ui.md)
3636
* [Installation](./ui-installation.md)
37+
* [Authentication](./ui-authentication.md)
3738
* [Configuration](./ui-configuration.md)
3839
* [Usage](./ui-usage.md)
3940
* [FAQs](./ui-faqs.md)

book/src/imgs/ui-autoconnect-auth.png

3.27 MB
Loading

book/src/imgs/ui-exit.png

507 KB
Loading

book/src/imgs/ui-fail-auth.png

555 KB
Loading

book/src/imgs/ui-session-auth.png

215 KB
Loading

book/src/lighthouse-ui.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ _Documentation for Siren users and developers._
1111

1212
Siren is a user interface built for Lighthouse that connects to a Lighthouse Beacon Node and
1313
a Lighthouse Validator Client to monitor performance and display key validator
14-
metrics.
14+
metrics.
1515

1616
The UI is currently in active development. Its resides in the
1717
[Siren](https://github.com/sigp/siren) repository.
@@ -24,7 +24,8 @@ information:
2424
- [Installation Guide](./ui-installation.md) - Information to install and run the Lighthouse UI.
2525
- [Configuration Guide](./ui-configuration.md) - Explanation of how to setup
2626
and configure Siren.
27-
- [Usage](./ui-usage.md) - Details various Siren components.
27+
- [Authentication Guide](./ui-authentication.md) - Explanation of how Siren authentication works and protects validator actions.
28+
- [Usage](./ui-usage.md) - Details various Siren components.
2829
- [FAQs](./ui-faqs.md) - Frequently Asked Questions.
2930

3031
## Contributing

book/src/ui-authentication.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Authentication
2+
3+
To enhance the security of your account, we offer the option to set a session password. This allows the user to avoid re-entering the api-token when performing critical mutating operations on the validator. Instead a user can simply enter their session password. In the absence of a session password, Siren will revert to the api-token specified in your configuration settings as the default security measure.
4+
5+
> This does not protect your validators from unauthorized device access.
6+
7+
![](imgs/ui-session-auth.png)
8+
9+
Session passwords must contain at least:
10+
11+
- 12 characters
12+
- 1 lowercase letter
13+
- 1 uppercase letter
14+
- 1 number
15+
- 1 special character
16+
17+
18+
## Protected Actions
19+
20+
Prior to executing any sensitive validator action, Siren will request authentication of the session password or api-token.
21+
22+
![](imgs/ui-exit.png)
23+
24+
25+
In the event of three consecutive failed attempts, Siren will initiate a security measure by locking all actions and prompting for configuration settings to be renewed to regain access to these features.
26+
27+
![](imgs/ui-fail-auth.png)
28+
29+
## Auto Connect
30+
31+
In the event that auto-connect is enabled, refreshing the Siren application will result in a prompt to authenticate the session password or api-token. If three consecutive authentication attempts fail, Siren will activate a security measure by locking the session and prompting for configuration settings to be reset to regain access.
32+
33+
![](imgs/ui-autoconnect-auth.png)

0 commit comments

Comments
 (0)