Skip to content
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
* [Prometheus Metrics](./advanced_metrics.md)
* [Lighthouse UI (Siren)](./lighthouse-ui.md)
* [Installation](./ui-installation.md)
* [Authentication](./ui-authentication.md)
* [Configuration](./ui-configuration.md)
* [Usage](./ui-usage.md)
* [FAQs](./ui-faqs.md)
Expand Down
Binary file added book/src/imgs/ui-autoconnect-auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/src/imgs/ui-exit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/src/imgs/ui-fail-auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/src/imgs/ui-session-auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions book/src/lighthouse-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ _Documentation for Siren users and developers._

Siren is a user interface built for Lighthouse that connects to a Lighthouse Beacon Node and
a Lighthouse Validator Client to monitor performance and display key validator
metrics.
metrics.

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

## Contributing
Expand Down
31 changes: 31 additions & 0 deletions book/src/ui-authentication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Authentication

To enhance the security of your account, we offer the option to set a session password. This additional layer of protection ensures that only authorized individuals can access your account, even in the event of unauthorized device access. In the absence of a session password, Siren will revert to the api-token specified in your configuration settings as the default security measure.

![](imgs/ui-session-auth.png)

Session passwords must contain at least:

- 12 characters
- 1 lowercase letter
- 1 uppercase letter
- 1 number
- 1 special character


## Protected Actions

Prior to executing any sensitive validator action, Siren will request authentication of the session password or api-token.

![](imgs/ui-exit.png)


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.

![](imgs/ui-fail-auth.png)

## Auto Connect

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.

![](imgs/ui-autoconnect-auth.png)