Skip to content

Commit

Permalink
fix: Renaming (#92)
Browse files Browse the repository at this point in the history
Signed-off-by: Bassam Riman <bassam.riman@iohk.io>
  • Loading branch information
CryptoKnightIOG authored May 23, 2024
1 parent d660e9f commit 48f0373
Show file tree
Hide file tree
Showing 26 changed files with 144 additions and 145 deletions.
6 changes: 0 additions & 6 deletions documentation/docs/atala-prism/getting-help.md

This file was deleted.

11 changes: 0 additions & 11 deletions documentation/docs/atala-prism/overview.md

This file was deleted.

22 changes: 0 additions & 22 deletions documentation/docs/atala-prism/prism-cloud-agent/did-management.md

This file was deleted.

22 changes: 11 additions & 11 deletions documentation/docs/concepts/multi-tenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

### Purpose

Multi-tenancy is a fundamental capability of the PRISM toolset designed to provide secure and efficient identity and credential management for diverse users, identities, and organizations. It enables the platform to serve multiple tenants while ensuring the logical isolation of their assets.
Multi-tenancy is a fundamental capability of the Identus toolset designed to provide secure and efficient identity and credential management for diverse users, identities, and organizations. It enables the platform to serve multiple tenants while ensuring the logical isolation of their assets.

### Key Benefits

- **Scalability**: PRISM's multi-tenancy support allows the platform to scale effortlessly to accommodate growing users, entities, and organizations.
- **Scalability**: Identus' multi-tenancy support allows the platform to scale effortlessly to accommodate growing users, entities, and organizations.
- **Resource Efficiency**: It optimizes resource utilization by enabling the sharing of infrastructure components, enhancing cost-effectiveness.
- **Data Isolation**: Multi-tenancy ensures that the data, such as DIDs (Decentralized Identifiers), connections, VCs (Verifiable Credentials), keys, and more, of one tenant is completely isolated from others, preserving data privacy and security.
- **Enhanced Collaboration**: Shared wallets enable collaboration between entities while maintaining data segregation.
- **Granular Control**: Administrators control the resources and permissions assigned to each entity.

## Roles in multi-tenancy

Multi-tenancy permits multiple users or systems to use the PRISM Cloud Agent within a shared instance, enhancing resource utilization while preserving each tenant's and their resources' separation. Understanding different roles in multi-tenancy is essential for the secure and efficient operation of the Cloud Agent.
Multi-tenancy permits multiple users or systems to use the Cloud Agent within a shared instance, enhancing resource utilization while preserving each tenant's and their resources' separation. Understanding different roles in multi-tenancy is essential for the secure and efficient operation of the Cloud Agent.

### Administrator

Expand All @@ -30,27 +30,27 @@ Tenants are the users or systems engaged in everyday interactions. They have rep

### Wallet

A wallet is a central component of PRISM's multi-tenancy model. It serves as the container for storing and managing a tenant's digital assets, including DIDs, connections, VCs, keys, and more. Wallets are logically isolated to ensure that the data associated with one entity remains separate and secure from others.
A wallet is a central component of Identus' multi-tenancy model. It serves as the container for storing and managing a tenant's digital assets, including DIDs, connections, VCs, keys, and more. Wallets are logically isolated to ensure that the data associated with one entity remains separate and secure from others.

### Entity

An entity represents a user or any other identity within the PRISM platform. Each entity owns a Wallet, making it the primary entity for managing and interacting with its digital credentials and assets. Entities can also share wallets, enabling collaborative use of resources.
An entity represents a user or any other identity within the Identus platform. Each entity owns a Wallet, making it the primary entity for managing and interacting with its digital credentials and assets. Entities can also share wallets, enabling collaborative use of resources.

### Authentication Method

Each entity is associated with an Authentication Method, which serves as a secure means of verifying the identity and access rights of the entity. This method ensures the entity's identity is authenticated during interactions with the platform, enhancing security.

### Logical Isolation
Logical Isolation is a core principle of PRISM's multi-tenancy model. It ensures that one entity's digital assets, transactions, and data are logically separated from others, maintaining the highest data privacy and security level.
Logical Isolation is a core principle of Identus' multi-tenancy model. It ensures that one entity's digital assets, transactions, and data are logically separated from others, maintaining the highest data privacy and security level.

### Shared Wallets
PRISM's multi-tenancy capabilities allow for the sharing of wallets among multiple entities. This feature facilitates collaborative work and resource sharing while preserving data isolation within the shared wallet. The entity can own only one wallet. Sharing it with other entities is possible, but multiple entities cannot own it.
Identus' multi-tenancy capabilities allow for the sharing of wallets among multiple entities. This feature facilitates collaborative work and resource sharing while preserving data isolation within the shared wallet. The entity can own only one wallet. Sharing it with other entities is possible, but multiple entities cannot own it.

### Tenant Management
Tenant Management is the process of onboarding, provisioning, and managing entities and wallets within the PRISM platform. Administrators can configure each entity's permissions, resources, and access control, ensuring efficient and secure multi-tenancy operations.
Tenant Management is the process of onboarding, provisioning, and managing entities and wallets within the Identus platform. Administrators can configure each entity's permissions, resources, and access control, ensuring efficient and secure multi-tenancy operations.

### DIDComm Connections
DIDComm Connections are the secure communication channels between peers within the SSI ecosystem. PRISM's multi-tenancy model ensures that the connections of one entity are logically isolated from those of other entities, preserving data privacy and security. Based on the DID-Peer of the message recipient, the corresponding wallet processes the message.
DIDComm Connections are the secure communication channels between peers within the SSI ecosystem. Identus' multi-tenancy model ensures that the connections of one entity are logically isolated from those of other entities, preserving data privacy and security. Based on the DID-Peer of the message recipient, the corresponding wallet processes the message.

### Webhook Notifications
Webhook notifications enable users to receive alerts for specific events in the system. There are two types of webhook notifications:
Expand All @@ -59,15 +59,15 @@ Webhook notifications enable users to receive alerts for specific events in the

## Relation Diagram

The following diagram illustrates the relationship between the key components of PRISM's multi-tenancy model.
The following diagram illustrates the relationship between the key components of Identus' multi-tenancy model.


```mermaid
graph TB;
Tenant(Tenant) --> |Represented by| Entity
Tenant --> |Authenticates by| AuthMethod(Authentication Method)
subgraph PRISM Platform
subgraph Identus Platform
Wallet(Wallet) -->|Contains| DIDs(DIDs )
Wallet(Wallet) -->|Contains| VCs(Verifiable Credentials)
Wallet(Wallet) -->|Contains| VSSchemas(VC Schemas)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ resource.
Authentication and authorization are critical to any identity management system, ensuring only authorized
users can access the system and its resources.

PRISM Cloud Agent provides the following authentication and authorization methods to ensure that the identity of the
Cloud Agent provides the following authentication and authorization methods to ensure that the identity of the
entity is verified and authenticated during interactions with the platform:

- apikey authentication with internal IAM service
Expand All @@ -16,7 +16,7 @@ entity is verified and authenticated during interactions with the platform:

## Default Entity and Wallet

The PRISM Cloud Agent uses the Default Entity and the Default Wallet for all interactions with the Agent over the REST API and DIDComm in the single-tenant mode.
The Cloud Agent uses the Default Entity and the Default Wallet for all interactions with the Agent over the REST API and DIDComm in the single-tenant mode.
A Default Entity is an entity with the id `00000000-0000-0000-0000-000000000000`, and a Default Wallet is a wallet with the id `00000000-0000-0000-0000-000000000000`.


Expand Down Expand Up @@ -108,7 +108,7 @@ processes.
Keycloak supports various identity protocols, including OAuth 2.0 and OpenID Connect, making it a versatile solution for
securing modern web applications.

The PRISM Cloud Agent utilizes the following Keycloak features:
The Cloud Agent utilizes the following Keycloak features:

- Authentication with JWT Token with a configured flow according to
the [ADR](https://staging-docs.atalaprism.io/adrs/adr/20230527-use-keycloak-and-jwt-tokens-for-authentication-and-authorisation-to-facilitate-multitenancy-in-cloud-agent/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Building Blocks

Atala PRISM is a toolset for implementing decentralized identity and consists of several core building blocks. These building blocks are modular components that can be easily combined and configured to meet various use cases and product requirements. By abstracting these fundamental components into modular building blocks, Atala PRISM allows for rapid development and deployment of new features and capabilities for its [Cloud Agents](/docs/concepts/glossary#cloud-agent).
Identus is a toolset for implementing decentralized identity and consists of several core building blocks. These building blocks are modular components that can be easily combined and configured to meet various use cases and product requirements. By abstracting these fundamental components into modular building blocks, Identus allows for rapid development and deployment of new features and capabilities for its [Cloud Agents](/docs/concepts/glossary#cloud-agent).

This modular architecture also provides excellent flexibility and customization options, as different building blocks can be combined in various ways to fit specific use case requirements. However, in the future, some unique use cases may arise that require designing and developing new building blocks. The Atala team continuously improves and expands the suite's capabilities to meet its users' evolving needs.

Below is a brief overview of the current building blocks of Atala PRISM:
Below is a brief overview of the current building blocks of Identus:

**Building Block**|**Definition**|**Code Name**
:-----:|:-----:|:-----:
Expand All @@ -14,7 +14,7 @@ Cryptography|A set of cryptographic primitives that ensure the integrity, authen
[DIDComm](/docs/concepts/glossary#didcomm) V2|A set of secure, standards-based communications protocols to establish and manage trusted, peer-to-peer connections and interactions between DIDs in a transport-agnostic and interoperable manner.|Mercury

## Apollo - Cryptography Module
Apollo is one of the building blocks of Atala PRISM. It is a suite of cryptographic primitives ensuring data security during storage and handling. Cryptographic primitives are mathematical algorithms and protocols that form the foundation for secure communication and data protection.
Apollo is one of the building blocks of Identus. It is a suite of cryptographic primitives ensuring data security during storage and handling. Cryptographic primitives are mathematical algorithms and protocols that form the foundation for secure communication and data protection.

The primary purpose of Apollo is to provide data integrity, authenticity, and confidentiality, which are essential components of secure information systems. Apollo ensures that tampering, unauthorized access, and other security threats do not compromise the protection of user data, giving users confidence in its security.

Expand All @@ -24,11 +24,11 @@ For authenticity, Apollo uses digital signatures to authenticate the identity of

Finally, for confidentiality, Apollo uses encryption algorithms to protect sensitive data from unauthorized access and exposure. This feature helps ensure that sensitive information remains confidential and protected against cyber-attacks and data breaches.

Overall, the Apollo building block is an essential component of Atala PRISM, providing a secure and reliable means of protecting data stored and processed within the platform.
Overall, the Apollo building block is an essential component of Identus, providing a secure and reliable means of protecting data stored and processed within the platform.

## Castor - DID Module

Castor is a building block of Atala PRISM that provides a set of DID operations, allowing users to create, manage, and resolve DIDs.
Castor is a building block of Identus that provides a set of DID operations, allowing users to create, manage, and resolve DIDs.

A [DID Document](/docs/concepts/glossary#did-document) is a JSON-LD document that contains information about a DID. It includes information such as the public keys associated with the DID, the authentication mechanisms, and linked services. Castor consists of a resolver that resolves a DID to its associated DID Document. The lookup service allows users to retrieve the DID Document for a given DID.

Expand All @@ -38,7 +38,7 @@ Castor gives users complete control over their DIDs, including creating new DIDs

## Pollux - Verifiable Credential Module

Pollux is a building block of Atala PRISM that provides a set of operations for managing and verifying verifiable credentials (VCs). This building block is a vital aspect of the [self-sovereign identity](/docs/concepts/glossary#self-sovereign-identity) paradigm. With Pollux, users can issue, manage, and verify VCs in a privacy-preserving manner. Pollux ensures that users can share their credentials with others while maintaining control over their personal information and protecting it from unauthorized access and exposure.
Pollux is a building block of Identus that provides a set of operations for managing and verifying verifiable credentials (VCs). This building block is a vital aspect of the [self-sovereign identity](/docs/concepts/glossary#self-sovereign-identity) paradigm. With Pollux, users can issue, manage, and verify VCs in a privacy-preserving manner. Pollux ensures that users can share their credentials with others while maintaining control over their personal information and protecting it from unauthorized access and exposure.

In terms of issuing credentials, Pollux provides the necessary functions to create and issue VCs, including the ability to specify the type of credential, the attributes it represents, and the trusted party attesting to the credentials.

Expand All @@ -48,6 +48,6 @@ Finally, for verifying credentials, Pollux provides the tools to check a given c

## Mercury - DIDComm Module

Mercury is a building block of Atala PRISM that provides a set of secure, standards-based communication protocols and infrastructure for establishing and managing trusted, peer-to-peer connections between decentralized identifiers. DIDs allow their owners to manage their identity and interact with others in a privacy-preserving manner.
Mercury is a building block of Identus that provides a set of secure, standards-based communication protocols and infrastructure for establishing and managing trusted, peer-to-peer connections between decentralized identifiers. DIDs allow their owners to manage their identity and interact with others in a privacy-preserving manner.

Additionally, using standards-based protocols ensures that the communication between DIDs is interoperable, meaning that different systems and platforms can communicate seamlessly.
Loading

0 comments on commit 48f0373

Please sign in to comment.