Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PD-46 - Refactor users page #58

Merged
merged 10 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
61 changes: 32 additions & 29 deletions docs/computations.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,48 +55,51 @@ The system supports four TLS configuration modes:

1. Attested TLS

- Basic TLS configuration with attestation verification during the TLS handshake.
- No additional certificate or key files required.
- Suitable for environments requiring basic secure communication.
- Basic TLS configuration with attestation verification during the TLS handshake.
- No additional certificate or key files required.
- Suitable for environments requiring basic secure communication.

2. Mutual TLS

- Requires bi-directional authentication
- Required files:
- Key File
- Certificate File
- Server CA File
- Client CA File
- Provides highest level of security with mutual authentication
- Requires bi-directional authentication
- Required files:
- Key File
- Certificate File
- Server CA File
- Client CA File
- Provides highest level of security with mutual authentication

3. TLS

- Standard TLS configuration
- Required files:
- Key File
- Certificate File
- Suitable for environments requiring encrypted communication without mutual authentication
- Standard TLS configuration
- Required files:
- Key File
- Certificate File
- Suitable for environments requiring encrypted communication without mutual authentication

4. No TLS

- Disables TLS security
- No additional configuration required
- Should only be used in secure, isolated environments
- Not recommended for production deployments
- Disables TLS security
- No additional configuration required
- Should only be used in secure, isolated environments
- Not recommended for production deployments

#### Log Level Configuration

- **Info**: Standard logging level for general operational information

- Logs important events and milestones
- Recommended for normal operation
- Provides good balance of information without excessive detail

- **Debug**: Detailed logging for troubleshooting

- Includes extensive operation details
- Useful during development and debugging
- May impact performance

- **Warn**: Warning-level messages only

- Logs potentially harmful situations
- Does not log normal operational information
- Useful for monitoring potential issues
Expand Down Expand Up @@ -145,8 +148,8 @@ The system supports four TLS configuration modes:
2. Select appropriate TLS Configuration mode
3. Set desired Log Level based on operational requirements
4. For Mutual TLS or TLS modes:
- Upload required certificate and key files
- Verify file formats and permissions
- Upload required certificate and key files
- Verify file formats and permissions
5. Click "Close" to save configuration

#### Troubleshooting
Expand Down Expand Up @@ -177,14 +180,14 @@ Common issues and solutions:
Agent can be configured to run with [attested TLS](https://docs.cocos.ultraviolet.rs/attestation/#attested-tls).

1. Set agent tls configuration to aTLS. ![atls config](./img/ui/setatlsconfig.png)
Click on close to save config and click the update/create button to save the computation.
Click on close to save config and click the update/create button to save the computation.
2. To confirm aTLS was configured, click on the update computation button.
![atls config](./img/ui/confirmatls.png)
![atls config](./img/ui/confirmatls.png)
3. Next Run the computation and wait for the virtual machine provisioning to be complete.
![vm provision](./img/ui/provisioncomplete.png)
![vm provision](./img/ui/provisioncomplete.png)
4. Download the attestation policy. This file is used to set the expected values in the attestation report and is required for validation.
![attestation-policy-download-list](./img/ui/attestation-policy-download-list.png)
![download-attestation-list](./img/ui/download-policy-download.png)
![attestation-policy-download-list](./img/ui/attestation-policy-download-list.png)
![download-attestation-list](./img/ui/download-policy-download.png)

5. Finally to connect to agent, we need to configure the env variables on cli.

Expand Down Expand Up @@ -441,7 +444,7 @@ X-Xss-Protection: 1; mode=block

## User Keys

Cocos implements a public-key cryptography system for user authentication and role management in its multiparty confidential computing platform. Each user requires only a single public-private key pair per computation, regardless of how many roles they hold in that computation. Private keys are used for [command-line operations](https://docs.cocos.ultraviolet.rs/cli/).
Cocos implements a public-key cryptography system for user authentication and role management in its multiparty confidential computing platform. Each user requires only a single public-private key pair per computation, regardless of how many roles they hold in that computation. Private keys are used for [command-line operations](https://docs.cocos.ultraviolet.rs/cli/).

Cocos supports three types of cryptographic keys:

Expand All @@ -455,7 +458,7 @@ Cocos supports three types of cryptographic keys:

- [User generates one public-private key pair](https://docs.cocos.ultraviolet.rs/cli/#generate-keys)
- User provides their public key when being assigned to the computation
![Upload user key](./img/ui/upload-key.png)
![Upload user key](./img/ui/upload-key.png)
- System associates the public key with all of the user's designated roles

#### Operation Phase
Expand All @@ -478,7 +481,7 @@ Users use the same private key for all CLI operations, regardless of role:
#### Public Key Distribution

- Public keys are safe to share and can be viewed in the manifest
![manifest](./img/ui/manifest.png)
![manifest](./img/ui/manifest.png)
- Public key must be registered once before participation
- Same public key is used for all roles in the computation

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ X-Xss-Protection: 1; mode=block
```

For the UI click enter to log in to workspace with will bring you to the dashboard.
![Project login](img/ui/projlogin.png)
![Project login](img/ui/wkslogin.png)

## Backends

Expand Down
Binary file removed docs/img/payment.png
Binary file not shown.
Binary file removed docs/img/ui/create user.png
Binary file not shown.
Binary file added docs/img/ui/login_page.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 docs/img/ui/my_account.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 removed docs/img/ui/profile.png
Binary file not shown.
Binary file removed docs/img/ui/select_subscription.png
Binary file not shown.
Binary file added docs/img/ui/self_register.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 removed docs/img/ui/update_customer_modal.png
Binary file not shown.
Binary file added docs/img/ui/update_details.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 docs/img/ui/update_user_page.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 removed docs/img/ui/user details.png
Binary file not shown.
Binary file added docs/img/ui/user_profile.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 docs/img/ui/user_register.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 removed docs/img/ui/users.png
Binary file not shown.
File renamed without changes
Loading
Loading