From 48f03732a8d8c781119e55ea683bb26677088b49 Mon Sep 17 00:00:00 2001 From: Bassam Date: Thu, 23 May 2024 11:57:39 -0400 Subject: [PATCH] fix: Renaming (#92) Signed-off-by: Bassam Riman --- .../docs/atala-prism/getting-help.md | 6 -- documentation/docs/atala-prism/overview.md | 11 --- .../prism-cloud-agent/did-management.md | 22 ----- documentation/docs/concepts/multi-tenancy.md | 22 ++--- .../cloud-agent}/authentication.md | 6 +- .../cloud-agent}/building-blocks.md | 14 +-- .../identus/cloud-agent/did-management.md | 22 +++++ .../cloud-agent}/environment-variables.md | 10 +- .../cloud-agent}/overview.md | 10 +- .../cloud-agent}/secrets-storage.md | 0 documentation/docs/identus/getting-help.md | 5 + .../identus-cloud-agent}/authenticate.md | 0 .../identus-cloud-agent}/images/setup.jpg | Bin .../manage/definitions.md | 0 .../identus-cloud-agent}/manage/overview.md | 0 .../identus-cloud-agent}/manage/policies.md | 0 .../identus-cloud-agent}/manage/schemas.md | 0 .../identus-cloud-agent}/manage/setup.md | 0 .../identus-cloud-agent}/onboard.md | 0 .../identus-cloud-agent}/overview.md | 0 .../prism-mediator.md => identus/mediator.md} | 16 +-- documentation/docs/identus/overview.md | 11 +++ .../{atala-prism => identus}/prism-node.md | 0 documentation/docs/quick-start.md | 92 +++++++++--------- documentation/docs/sidebars.js | 32 +++--- docusaurus.config.js | 10 +- 26 files changed, 144 insertions(+), 145 deletions(-) delete mode 100644 documentation/docs/atala-prism/getting-help.md delete mode 100644 documentation/docs/atala-prism/overview.md delete mode 100644 documentation/docs/atala-prism/prism-cloud-agent/did-management.md rename documentation/docs/{atala-prism/prism-cloud-agent => identus/cloud-agent}/authentication.md (97%) rename documentation/docs/{atala-prism/prism-cloud-agent => identus/cloud-agent}/building-blocks.md (69%) create mode 100644 documentation/docs/identus/cloud-agent/did-management.md rename documentation/docs/{atala-prism/prism-cloud-agent => identus/cloud-agent}/environment-variables.md (97%) rename documentation/docs/{atala-prism/prism-cloud-agent => identus/cloud-agent}/overview.md (83%) rename documentation/docs/{atala-prism/prism-cloud-agent => identus/cloud-agent}/secrets-storage.md (100%) create mode 100644 documentation/docs/identus/getting-help.md rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/authenticate.md (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/images/setup.jpg (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/manage/definitions.md (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/manage/overview.md (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/manage/policies.md (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/manage/schemas.md (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/manage/setup.md (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/onboard.md (100%) rename documentation/docs/{atala-prism/prism-cloud-agent-enterprise => identus/identus-cloud-agent}/overview.md (100%) rename documentation/docs/{atala-prism/prism-mediator.md => identus/mediator.md} (53%) create mode 100644 documentation/docs/identus/overview.md rename documentation/docs/{atala-prism => identus}/prism-node.md (100%) diff --git a/documentation/docs/atala-prism/getting-help.md b/documentation/docs/atala-prism/getting-help.md deleted file mode 100644 index 0402efe48..000000000 --- a/documentation/docs/atala-prism/getting-help.md +++ /dev/null @@ -1,6 +0,0 @@ -# Getting Help - -## Help Desk - -The best way to get support is by submitting a request through our customer [Help Desk](https://iohk.zendesk.com/hc/en-us/requests/new). Additional assistance is available on our [Discord](https://discord.gg/atala) server. - diff --git a/documentation/docs/atala-prism/overview.md b/documentation/docs/atala-prism/overview.md deleted file mode 100644 index 0991e033a..000000000 --- a/documentation/docs/atala-prism/overview.md +++ /dev/null @@ -1,11 +0,0 @@ -# Overview - -Atala PRISM is a toolset designed for Decentralized Identity enablement. These tools work together to establish a framework for implementing Decentralized Identity Solutions. Here's an overview of the key components: - -* [PRISM Cloud Agent](prism-cloud-agent/overview): It is a W3C/Aries standards-based agent that provides decentralized identity services. It exposes a REST API for integration, enabling the development of solutions based on SSI technology. - -* [PRISM Node](prism-node): Serves as a [verifiable data registry](/docs/concepts/glossary#verifiable-data-registry) (VDR). The PRISM Node stores and retrieves data securely, is tamper-proof, and is responsible for publishing PRISM's protocol transactions to the Cardano blockchain. It also plays a critical role in resolving [DIDs](/docs/concepts/glossary#did) efficiently without requiring access to the underlying blockchain​​​​​​. - -* [PRISM Mediator](prism-mediator): The Mediator acts as a bridge between the [holder's](/docs/concepts/glossary#holder) device and other actors, such as [issuers](/docs/concepts/glossary#issuer) and [verifiers](/docs/concepts/glossary#verifier), ensuring secure and reliable communication without centralized management​​​​. - -* Wallet SDKs: allow the development of edge agents - Decentralized Identity mobile apps and browser extensions. The SDKs are available in [SWIFT](https://input-output-hk.github.io/atala-prism-wallet-sdk-swift/) (iOS), [TS](https://input-output-hk.github.io/atala-prism-wallet-sdk-ts/) (Browser and Node.js), and [Kotlin](https://input-output-hk.github.io/atala-prism-wallet-sdk-kmm/) (JVM and Android) diff --git a/documentation/docs/atala-prism/prism-cloud-agent/did-management.md b/documentation/docs/atala-prism/prism-cloud-agent/did-management.md deleted file mode 100644 index c3d1eed64..000000000 --- a/documentation/docs/atala-prism/prism-cloud-agent/did-management.md +++ /dev/null @@ -1,22 +0,0 @@ -# DID management - -## Managed PRISM DID - -The [PRISM Cloud Agent](/docs/concepts/glossary#cloud-agent) simplifies identity management by effectively handling PRISM [DIDs](/docs/concepts/glossary#decentralized-identifier) for users. Relying on a PRISM Cloud Agent-managed DID, users entrust the Cloud Agent with tasks such as creating, updating, storing, and using the PRISM DID. - -The PRISM Cloud Agent employs hierarchical deterministic key derivation to manage the keys of the PRISM DID. The Cloud Agent calculates and stores the derivation path whenever an activity involves new key information, such as creating a new DID or adding a new key. It internally tracks the DID counter and key counter to increment the derivation path accordingly. Details about the Cloud Agent constructs key material from the seed are on the HD-key derivation decision record. - -## Managed Peer DID - -The PRISM Cloud Agent also manages [Peer DIDs](/docs/concepts/glossary#peer-did) for [DIDComm](/docs/concepts/glossary#didcomm) activities. The Key materials for Peer DIDs are randomly generated and stored securely in [secret storage](/docs/concepts/glossary#secrets-storage), allowing control of the Peer DID. - -## Storing key material - -### PRISM DID - -PRISM DID management involves deriving key materials from a seed and derivation path. A corresponding derivation path is generated and stored in the database when creating a new DID or updating a new key. Only the derivation path, not the key material itself, is stored. The PRISM Cloud Agent can reconstruct and use key materials for PRISM DIDs by combining the stored derivation path with the provided seed at runtime. - -The Cloud Agent itself does not store the wallet seed. However, the infrastructure hosting the Cloud Agent may choose to keep it based on operation requirements and security considerations. - -### Peer DID -The PRISM Cloud Agent securely stores the key materials of peer DIDs using secret storage. diff --git a/documentation/docs/concepts/multi-tenancy.md b/documentation/docs/concepts/multi-tenancy.md index 2735dc58f..79883e0c1 100644 --- a/documentation/docs/concepts/multi-tenancy.md +++ b/documentation/docs/concepts/multi-tenancy.md @@ -4,11 +4,11 @@ ### 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. @@ -16,7 +16,7 @@ Multi-tenancy is a fundamental capability of the PRISM toolset designed to provi ## 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 @@ -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: @@ -59,7 +59,7 @@ 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 @@ -67,7 +67,7 @@ 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) diff --git a/documentation/docs/atala-prism/prism-cloud-agent/authentication.md b/documentation/docs/identus/cloud-agent/authentication.md similarity index 97% rename from documentation/docs/atala-prism/prism-cloud-agent/authentication.md rename to documentation/docs/identus/cloud-agent/authentication.md index 4b4ef7898..fd46d59ea 100644 --- a/documentation/docs/atala-prism/prism-cloud-agent/authentication.md +++ b/documentation/docs/identus/cloud-agent/authentication.md @@ -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 @@ -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`. @@ -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/) diff --git a/documentation/docs/atala-prism/prism-cloud-agent/building-blocks.md b/documentation/docs/identus/cloud-agent/building-blocks.md similarity index 69% rename from documentation/docs/atala-prism/prism-cloud-agent/building-blocks.md rename to documentation/docs/identus/cloud-agent/building-blocks.md index ab41de869..e00c3a17d 100644 --- a/documentation/docs/atala-prism/prism-cloud-agent/building-blocks.md +++ b/documentation/docs/identus/cloud-agent/building-blocks.md @@ -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** :-----:|:-----:|:-----: @@ -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. @@ -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. @@ -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. @@ -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. diff --git a/documentation/docs/identus/cloud-agent/did-management.md b/documentation/docs/identus/cloud-agent/did-management.md new file mode 100644 index 000000000..26c0509cc --- /dev/null +++ b/documentation/docs/identus/cloud-agent/did-management.md @@ -0,0 +1,22 @@ +# DID management + +## Managed PRISM DID + +The [Cloud Agent](/docs/concepts/glossary#cloud-agent) simplifies identity management by effectively handling PRISM [DIDs](/docs/concepts/glossary#decentralized-identifier) for users. Relying on a Cloud Agent-managed DID, users entrust the Cloud Agent with tasks such as creating, updating, storing, and using the PRISM DID. + +The Cloud Agent employs hierarchical deterministic key derivation to manage the keys of the PRISM DID. The Cloud Agent calculates and stores the derivation path whenever an activity involves new key information, such as creating a new DID or adding a new key. It internally tracks the DID counter and key counter to increment the derivation path accordingly. Details about the Cloud Agent constructs key material from the seed are on the HD-key derivation decision record. + +## Managed Peer DID + +The Cloud Agent also manages [Peer DIDs](/docs/concepts/glossary#peer-did) for [DIDComm](/docs/concepts/glossary#didcomm) activities. The Key materials for Peer DIDs are randomly generated and stored securely in [secret storage](/docs/concepts/glossary#secrets-storage), allowing control of the Peer DID. + +## Storing key material + +### PRISM DID + +PRISM DID management involves deriving key materials from a seed and derivation path. A corresponding derivation path is generated and stored in the database when creating a new DID or updating a new key. Only the derivation path, not the key material itself, is stored. The Cloud Agent can reconstruct and use key materials for PRISM DIDs by combining the stored derivation path with the provided seed at runtime. + +The Cloud Agent itself does not store the wallet seed. However, the infrastructure hosting the Cloud Agent may choose to keep it based on operation requirements and security considerations. + +### Peer DID +The Cloud Agent securely stores the key materials of peer DIDs using secret storage. diff --git a/documentation/docs/atala-prism/prism-cloud-agent/environment-variables.md b/documentation/docs/identus/cloud-agent/environment-variables.md similarity index 97% rename from documentation/docs/atala-prism/prism-cloud-agent/environment-variables.md rename to documentation/docs/identus/cloud-agent/environment-variables.md index 6bf27ee65..f9ec1c72c 100644 --- a/documentation/docs/atala-prism/prism-cloud-agent/environment-variables.md +++ b/documentation/docs/identus/cloud-agent/environment-variables.md @@ -1,6 +1,6 @@ # Environment Variables -The following enviroment variables can be used to configure Prism Agent: +The following enviroment variables can be used to configure Cloud Agent: | Variable Name | Description | Type | Default | |--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|----------------------------------------------| @@ -24,10 +24,10 @@ The following enviroment variables can be used to configure Prism Agent: | CONNECT_BG_JOB_RECURRENCE_DELAY | Interval at which connect job will try to process records. | String | 2 seconds | | CONNECT_BG_JOB_PROCESSING_PARALLELISM | Maximum amount of parallel connect job processings. | Int | 5 | | CONNECT_INVITATION_EXPIRY | Time leeway when accepting the connection invitation, the inviter should only accept responses if they are received within the specified time limit before expiry. | String | 300 seconds | -| AGENT_HTTP_PORT | Port on which prism agent runs. | Int | 8085 | +| AGENT_HTTP_PORT | Port on which Cloud Agent runs. | Int | 8085 | | DIDCOMM_SERVICE_URL | URL of the DIDcomm server that also runs for this agent. | String | http://localhost:8090 | -| AGENT_DB_HOST | Hostname of the server where prism agent database is running on. | String | localhost | -| AGENT_DB_PORT | Port of the prism agent database. | Int | 5432 | +| AGENT_DB_HOST | Hostname of the server where Cloud Agent database is running on. | String | localhost | +| AGENT_DB_PORT | Port of the Cloud Agent database. | Int | 5432 | | AGENT_DB_NAME | Database name where agent db will store data. | String | agent | | AGENT_DB_USER | Agent database username for login. | String | postgres | | AGENT_DB_PASSWORD | Agent database password for login. | String | postgres | @@ -39,7 +39,7 @@ The following enviroment variables can be used to configure Prism Agent: | PRESENTATION_VERIFY_HOLDER_BINDING | Description missing (please provide). | Boolean | false | | PRESENTATION_LEEWAY | Time leeway when verifying challenge dates. | String | 0 seconds | | SECRET_STORAGE_BACKEND | Secret storage for keys and credentials. If vault is used, the vault server must be running, otherwise a database can be used for development purposes only. | Enum(vault, postgres) | vault | -| VAULT_ADDR | URL of the vault service for prism agent to use for secret management. | String | http://localhost:8200 | +| VAULT_ADDR | URL of the vault service for Cloud Agent to use for secret management. | String | http://localhost:8200 | | VAULT_TOKEN | Vault service auth token. | String | root | | VAULT_APPROLE_ROLE_ID | The `role_id` for HashiCorp Vault authentication with AppRole | String | Null | | VAULT_APPROLE_SECRET_ID | The `secret_id` for HashiCorp Vault authentication with AppRole | String | Null | diff --git a/documentation/docs/atala-prism/prism-cloud-agent/overview.md b/documentation/docs/identus/cloud-agent/overview.md similarity index 83% rename from documentation/docs/atala-prism/prism-cloud-agent/overview.md rename to documentation/docs/identus/cloud-agent/overview.md index f70ea7af8..49b9d8bac 100644 --- a/documentation/docs/atala-prism/prism-cloud-agent/overview.md +++ b/documentation/docs/identus/cloud-agent/overview.md @@ -1,8 +1,8 @@ # Overview -The [PRISM Cloud Agent](/docs/concepts/glossary#cloud-agent) is a scaleable, easy-to-use, robust, and W3C standards-based agent that provides [self-sovereign identity (SSI)](/docs/concepts/glossary#self-sovereign-identity) services to build products and solutions based on it. The PRISM Cloud Agent exposes REST API for integration with any programming language. +The [Cloud Agent](/docs/concepts/glossary#cloud-agent) is a scaleable, easy-to-use, robust, and W3C standards-based agent that provides [self-sovereign identity (SSI)](/docs/concepts/glossary#self-sovereign-identity) services to build products and solutions based on it. The Cloud Agent exposes REST API for integration with any programming language. -The PRISM Cloud Agent provides all the required capabilities to leverage the power of decentralized identity through the support of W3C standards, [DIDComm](/docs/concepts/glossary#didcomm), and the Hyperledger Aries protocols, solutions based on the Cloud Agent are interoperable with the SSI ecosystem. The PRISM Cloud Agent includes the following high-level features: +The Cloud Agent provides all the required capabilities to leverage the power of decentralized identity through the support of W3C standards, [DIDComm](/docs/concepts/glossary#didcomm), and the Hyperledger Aries protocols, solutions based on the Cloud Agent are interoperable with the SSI ecosystem. The Cloud Agent includes the following high-level features: - Use the Cloud Agent API to develop [controllers](/docs/concepts/glossary#controller) that implement specific business logic according to use case requirements. - Develop controllers in any programming language and remove the requirement for developers to interact or learn the nuts and bolts of the various standards. @@ -12,9 +12,9 @@ The PRISM Cloud Agent provides all the required capabilities to leverage the pow - Highly scalable and flexible, making it well-suited for a wide range of use cases and applications. -## PRISM Agent Features +## Cloud Agent Features -This document provides an overview of the Cloud Agent feature set. This document is manually updated; as such, it may not be up to date with the most recent release of PRISM Cloud Agent. +This document provides an overview of the Cloud Agent feature set. This document is manually updated; as such, it may not be up to date with the most recent release of Cloud Agent. **Last Update**: 2023-03-06, Release 0.48.3 @@ -24,7 +24,7 @@ This document provides an overview of the Cloud Agent feature set. This document | -------- | :-------: | ------- | | Server | :white_check_mark: | | | Kubernetes | :white_check_mark: | | -| Docker | :white_check_mark: | IOG will publish docker images on Docker Hub in future. A link to the IOG Docker Hub for PRISM Cloud Agent will be provided once published. | +| Docker | :white_check_mark: | IOG will publish docker images on Docker Hub in future. A link to the IOG Docker Hub for Cloud Agent will be provided once published. | | Desktop | :warning: | Could be run as a local service on the computer | | iOS | :x: | | | Android | :x: | | diff --git a/documentation/docs/atala-prism/prism-cloud-agent/secrets-storage.md b/documentation/docs/identus/cloud-agent/secrets-storage.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent/secrets-storage.md rename to documentation/docs/identus/cloud-agent/secrets-storage.md diff --git a/documentation/docs/identus/getting-help.md b/documentation/docs/identus/getting-help.md new file mode 100644 index 000000000..63d2819ff --- /dev/null +++ b/documentation/docs/identus/getting-help.md @@ -0,0 +1,5 @@ +# Getting Help + +## Help Desk + +The best way to get support is on our [Discord](https://discord.gg/hyperledger) server. diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/authenticate.md b/documentation/docs/identus/identus-cloud-agent/authenticate.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/authenticate.md rename to documentation/docs/identus/identus-cloud-agent/authenticate.md diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/images/setup.jpg b/documentation/docs/identus/identus-cloud-agent/images/setup.jpg similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/images/setup.jpg rename to documentation/docs/identus/identus-cloud-agent/images/setup.jpg diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/definitions.md b/documentation/docs/identus/identus-cloud-agent/manage/definitions.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/definitions.md rename to documentation/docs/identus/identus-cloud-agent/manage/definitions.md diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/overview.md b/documentation/docs/identus/identus-cloud-agent/manage/overview.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/overview.md rename to documentation/docs/identus/identus-cloud-agent/manage/overview.md diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/policies.md b/documentation/docs/identus/identus-cloud-agent/manage/policies.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/policies.md rename to documentation/docs/identus/identus-cloud-agent/manage/policies.md diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/schemas.md b/documentation/docs/identus/identus-cloud-agent/manage/schemas.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/schemas.md rename to documentation/docs/identus/identus-cloud-agent/manage/schemas.md diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/setup.md b/documentation/docs/identus/identus-cloud-agent/manage/setup.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/manage/setup.md rename to documentation/docs/identus/identus-cloud-agent/manage/setup.md diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/onboard.md b/documentation/docs/identus/identus-cloud-agent/onboard.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/onboard.md rename to documentation/docs/identus/identus-cloud-agent/onboard.md diff --git a/documentation/docs/atala-prism/prism-cloud-agent-enterprise/overview.md b/documentation/docs/identus/identus-cloud-agent/overview.md similarity index 100% rename from documentation/docs/atala-prism/prism-cloud-agent-enterprise/overview.md rename to documentation/docs/identus/identus-cloud-agent/overview.md diff --git a/documentation/docs/atala-prism/prism-mediator.md b/documentation/docs/identus/mediator.md similarity index 53% rename from documentation/docs/atala-prism/prism-mediator.md rename to documentation/docs/identus/mediator.md index 5322ba5db..bfde2755b 100644 --- a/documentation/docs/atala-prism/prism-mediator.md +++ b/documentation/docs/identus/mediator.md @@ -1,8 +1,8 @@ -# PRISM Mediator +# Mediator ## Introduction -[Mediators](/docs/concepts/glossary#mediator) are indispensable in identity wallets, especially when dealing with mobile devices or edge agents. These mobile devices usually lack static IP addresses. They may only sometimes be online, posing a challenge in establishing reliable, direct connections between various parties in a decentralized ecosystem and guaranteeing delivery of [DIDComm](/docs/concepts/glossary#didcomm) messages. The PRISM Mediator functions similarly to an email inbox for the recipient, storing "Forward" messages and their final encrypted content until retrieved by the intended party. +[Mediators](/docs/concepts/glossary#mediator) are indispensable in identity wallets, especially when dealing with mobile devices or edge agents. These mobile devices usually lack static IP addresses. They may only sometimes be online, posing a challenge in establishing reliable, direct connections between various parties in a decentralized ecosystem and guaranteeing delivery of [DIDComm](/docs/concepts/glossary#didcomm) messages. The Mediator functions similarly to an email inbox for the recipient, storing "Forward" messages and their final encrypted content until retrieved by the intended party. ## Mediator's Role in Decentralized Identity Transactions @@ -10,11 +10,11 @@ Within a decentralized identity framework, the Mediator bridges the [Holder's](/ ## Security, Scalability, and Efficiency -The Mediator is an integral part of Atala PRISM, facilitating secure communication without the need for a centralized authority. It seamlessly connects various entities in the PRISM ecosystem, including Holders, Issuers, and Verifiers, ensuring the system remains secure, scalable, and efficient. +The Mediator is an integral part of Identus, facilitating secure communication without the need for a centralized authority. It seamlessly connects various entities in the Identus ecosystem, including Holders, Issuers, and Verifiers, ensuring the system remains secure, scalable, and efficient. ## Technical Specifications -The PRISM Mediator is an open-source initiative. For more details, you can refer to the [atala-prism-mediator Github repository](https://github.com/input-output-hk/atala-prism-mediator). The project aims to address the inherent limitations of edge agents, which are not always online, by assuming that the Mediator is perpetually online. Employing DIDComm v2 protocols and cryptographic methods, the Mediator guarantees all exchanged messages' authenticity, integrity, and confidentiality. +The Mediator is an open-source initiative. For more details, you can refer to the [atala-prism-mediator Github repository](https://github.com/input-output-hk/atala-prism-mediator). The project aims to address the inherent limitations of edge agents, which are not always online, by assuming that the Mediator is perpetually online. Employing DIDComm v2 protocols and cryptographic methods, the Mediator guarantees all exchanged messages' authenticity, integrity, and confidentiality. ## DIDComm V2 Mediator Test Suite @@ -32,12 +32,12 @@ You can consult the [features folder](https://github.com/input-output-hk/didcomm ### Future Enhancements in Testing -As part of our ongoing commitment to improving the PRISM Mediator, we plan to make our test sets publicly accessible, allowing users and developers to perform comparative assessments on functionality and performance against other mediators in the market. We aim to continually refine the PRISM Mediator's features based on real-world scenarios and demands, ensuring it remains a reliable and robust component in the Atala PRISM ecosystem. +As part of our ongoing commitment to improving the Mediator, we plan to make our test sets publicly accessible, allowing users and developers to perform comparative assessments on functionality and performance against other mediators in the market. We aim to continually refine the Mediator's features based on real-world scenarios and demands, ensuring it remains a reliable and robust component in the Identus ecosystem. -We are working on enhancing the scope of our testing suite to address limitations and include additional protocols and scenarios. These future updates will make the PRISM Mediator even more robust and versatile. +We are working on enhancing the scope of our testing suite to address limitations and include additional protocols and scenarios. These future updates will make the Mediator even more robust and versatile. -The PRISM Mediator will continue to develop with the same rigorous testing protocols to ensure it remains at the forefront of secure, efficient, and interoperable decentralized identity management. +The Mediator will continue to develop with the same rigorous testing protocols to ensure it remains at the forefront of secure, efficient, and interoperable decentralized identity management. ## Future Developments -Looking ahead, we are committed to the ongoing development of the PRISM Mediator, with plans to expand its feature set and integrate new protocols. Real-world use cases drive these updates to achieve feature completeness. Additionally, we aim to keep the Mediator at the forefront of industry developments, ensuring it remains aligned with emerging protocols and technological advancements. +Looking ahead, we are committed to the ongoing development of the Mediator, with plans to expand its feature set and integrate new protocols. Real-world use cases drive these updates to achieve feature completeness. Additionally, we aim to keep the Mediator at the forefront of industry developments, ensuring it remains aligned with emerging protocols and technological advancements. diff --git a/documentation/docs/identus/overview.md b/documentation/docs/identus/overview.md new file mode 100644 index 000000000..e7d2f6ecb --- /dev/null +++ b/documentation/docs/identus/overview.md @@ -0,0 +1,11 @@ +# Overview + +Identus is a toolset designed for Decentralized Identity enablement. These tools work together to establish a framework for implementing Decentralized Identity Solutions. Here's an overview of the key components: + +* [Cloud Agent](cloud-agent/overview): It is a W3C/Aries standards-based agent that provides decentralized identity services. It exposes a REST API for integration, enabling the development of solutions based on SSI technology. + +* [PRISM Node](prism-node): Serves as a [verifiable data registry](/docs/concepts/glossary#verifiable-data-registry) (VDR). The PRISM Node stores and retrieves data securely, is tamper-proof, and is responsible for publishing Identus's protocol transactions to the Distributed Ledger blockchain. It also plays a critical role in resolving [DIDs](/docs/concepts/glossary#did) efficiently without requiring access to the underlying blockchain​​​​​​. + +* [Mediator](mediator): The Mediator acts as a bridge between the [holder's](/docs/concepts/glossary#holder) device and other actors, such as [issuers](/docs/concepts/glossary#issuer) and [verifiers](/docs/concepts/glossary#verifier), ensuring secure and reliable communication without centralized management​​​​. + +* Edge Agent SDKs: allow the development of edge agents - Decentralized Identity mobile apps and browser extensions. The SDKs are available in [Swift](https://input-output-hk.github.io/atala-prism-wallet-sdk-swift/) (iOS and other Apple OS), [TS](https://input-output-hk.github.io/atala-prism-wallet-sdk-ts/) (Browser and Node.js), and [Kotlin Multiplatform](https://input-output-hk.github.io/atala-prism-wallet-sdk-kmm/) (JVM and Android) diff --git a/documentation/docs/atala-prism/prism-node.md b/documentation/docs/identus/prism-node.md similarity index 100% rename from documentation/docs/atala-prism/prism-node.md rename to documentation/docs/identus/prism-node.md diff --git a/documentation/docs/quick-start.md b/documentation/docs/quick-start.md index 69ce02ba1..f5277a534 100644 --- a/documentation/docs/quick-start.md +++ b/documentation/docs/quick-start.md @@ -21,7 +21,7 @@ Verifiers are the [relying party](/docs/concepts/glossary/#relying-party) in the -## PRISM flow +## Identus flow The diagram details how the concepts fit alongside the PRISM components in a typical SSI interaction. ![Component Diagram](/img/component-diagram.png) @@ -37,7 +37,7 @@ A Cloud Agent can issue, hold, and verify [verifiable credentials (VCs)](/docs/c It is maintained as an open source lab through the [Hyperledger Foundation: Open Enterprise Agent](https://labs.hyperledger.org/labs/open-enterprise-agent.html). -More in depth documentation about [Cloud Agent](/docs/concepts/glossary/#cloud-agent-aka-prism-cloud-agent) can be found [here](/docs/atala-prism/prism-cloud-agent/overview). +More in depth documentation about [Cloud Agent](/docs/concepts/glossary/#cloud-agent) can be found [here](/docs/identus/cloud-agent/overview). @@ -51,10 +51,10 @@ More in-depth documentation about the different Wallet SDKs can be found here ([ ### A Mediator [Mediators](/docs/concepts/glossary/#mediator) are for storing and relaying messages between Cloud Agents and Wallet SDKs. They act as a proxy that remains connected to the network and receives any message, credential, or proof request on behalf of the Wallet SDKs (which can be offline occasionally). -More in-depth documentation about PRISM Mediator can be found [here](/docs/atala-prism/prism-mediator). +More in-depth documentation about Mediator can be found [here](/docs/identus/mediator). #### A Node for a Verifiable Data Registry (VDR) -To issue and verify VCs to and from DIDs, we need a [Verifiable Data Registry (VDR)](/docs/concepts/glossary/#verifiable-data-registry) that is globally resolvable and always on. In PRISM's case, it is `prism-node`, [anchoring](/docs/concepts/glossary/#anchoring) key information required for issuance and verification on the Cardano blockchain. +To issue and verify VCs to and from DIDs, we need a [Verifiable Data Registry (VDR)](/docs/concepts/glossary/#verifiable-data-registry) that is globally resolvable and always on. In Identus's case, it is `prism-node`, [anchoring](/docs/concepts/glossary/#anchoring) key information required for issuance and verification on the Cardano blockchain. @@ -62,17 +62,17 @@ To issue and verify VCs to and from DIDs, we need a [Verifiable Data Registry (V ### Agent Deployment -This guide will demonstrate a single-tenant deployment with API Key authentication disabled and an in-memory ledger for published DID storage, which is the simplest configuration to get started as a developer. More advanced configuration options can be found in [Multi-Tenancy Management](/tutorials/multitenancy/tenant-onboarding) and associated [Environment Variables](/docs/atala-prism/prism-cloud-agent/environment-variables) configuration options. +This guide will demonstrate a single-tenant deployment with API Key authentication disabled and an in-memory ledger for published DID storage, which is the simplest configuration to get started as a developer. More advanced configuration options can be found in [Multi-Tenancy Management](/tutorials/multitenancy/tenant-onboarding) and associated [Environment Variables](/docs/identus/cloud-agent/environment-variables) configuration options. We develop on modern machines equipped with either Intel based x64 processors or Apple ARM processors with a minimum of four cores, 16 GB of memory and 128GB+ of SSD-type storage. 1. To spin up an Cloud Agent you must: * Have Git installed. * Have Docker installed. - * Clone the [Open Enterprise Agent repository](https://github.com/hyperledger-labs/open-enterprise-agent). + * Clone the [Open Enterprise Agent repository](https://github.com/hyperledger/identus-cloud-agent). ```bash -git clone https://github.com/hyperledger-labs/open-enterprise-agent +git clone https://github.com/hyperledger/identus-cloud-agent ``` @@ -81,10 +81,10 @@ git clone https://github.com/hyperledger-labs/open-enterprise-agent ``` API_KEY_ENABLED=false -PRISM_AGENT_VERSION=1.18.0 -PRISM_NODE_VERSION=2.2.1 +AGENT_VERSION=1.18.0 +NODE_VERSION=2.2.1 PORT=8000 -NETWORK=prism +NETWORK=identus VAULT_DEV_ROOT_TOKEN_ID=root PG_PORT=5432 ``` @@ -95,10 +95,10 @@ PG_PORT=5432 ``` API_KEY_ENABLED=false -PRISM_AGENT_VERSION=1.18.0 -PRISM_NODE_VERSION=2.2.1 +AGENT_VERSION=1.18.0 +NODE_VERSION=2.2.1 PORT=9000 -NETWORK=prism +NETWORK=identus VAULT_DEV_ROOT_TOKEN_ID=root PG_PORT=5433 ``` @@ -137,10 +137,10 @@ API_KEY_ENABLED disables API Key authentication. This should **not** be used bey ./infrastructure/local/run.sh -n verifier -b -e ./infrastructure/local/.env-verifier -p 9000 -d "$(ip addr show $(ip route show default | awk '/default/ {print $5}') | grep 'inet ' | awk '{print $2}' | cut -d/ -f1)" ``` - * The Issuer [API endpoint](http://localhost:8000/prism-agent/) will be accessible on port 8000 `http://localhost:8000/prism-agent/` with a [Swagger Interface](http://localhost:8000/prism-agent/redoc) available at `http://localhost:8000/prism-agent/redoc`. + * The Issuer [API endpoint](http://localhost:8000/cloud-agent/) will be accessible on port 8000 `http://localhost:8000/cloud-agent/` with a [Swagger Interface](http://localhost:8000/cloud-agent/redoc) available at `http://localhost:8000/cloud-agent/redoc`. - * The Verifier [API endpoint](http://localhost:9000/prism-agent/) will be accessible on port 9000 `http://localhost:9000/prism-agent/` with a [Swagger Interface](http://localhost:9000/prism-agent/redoc) available at `http://localhost:9000/prism-agent/redoc`. + * The Verifier [API endpoint](http://localhost:9000/cloud-agent/) will be accessible on port 9000 `http://localhost:9000/cloud-agent/` with a [Swagger Interface](http://localhost:9000/cloud-agent/redoc) available at `http://localhost:9000/cloud-agent/redoc`. @@ -152,7 +152,7 @@ API_KEY_ENABLED disables API Key authentication. This should **not** be used bey ```bash curl --location \ ---request POST 'http://localhost:8000/prism-agent/did-registrar/dids' \ +--request POST 'http://localhost:8000/cloud-agent/did-registrar/dids' \ --header 'Accept: application/json' \ --data-raw '{ "documentTemplate": { @@ -202,7 +202,7 @@ Replace the `[[publishedPrismDID]]` in the example request with the `did` value ```bash curl -X 'POST' \ - 'http://localhost:8000/prism-agent/schema-registry/schemas' \ + 'http://localhost:8000/cloud-agent/schema-registry/schemas' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ @@ -256,15 +256,15 @@ curl -X 'POST' \ ### Starting Sample App -All wallet SDK's come bundled with a sample application, that cover all the PRISM flows, including establishing connections, issuance, and verification flows. +All wallet SDK's come bundled with a sample application, that cover all the Identus flows, including establishing connections, issuance, and verification flows. -1. Clone the [TypeScript SDK](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts) repository. +1. Clone the [TypeScript SDK](https://github.com/input-output-hk/identus-edge-agent-sdk-ts) repository. ```bash -git clone https://github.com/input-output-hk/atala-prism-wallet-sdk-ts +git clone https://github.com/input-output-hk/identus-edge-agent-sdk-ts ``` 2. Ensure you have all applications installed for building the SDK and it's dependencies @@ -300,10 +300,10 @@ npm run start -1. Clone the [Swift SDK](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift) repository. +1. Clone the [Swift SDK](https://github.com/input-output-hk/identus-edge-agent-sdk-swift) repository. ```bash -git clone https://github.com/input-output-hk/atala-prism-wallet-sdk-swift +git clone https://github.com/input-output-hk/identus-edge-agent-sdk-swift ``` 2. Open the XCode project on __./Sample/AtalaPrismWalletDemo/AtalaPrismWalletDemo.xcodeproj__ @@ -315,10 +315,10 @@ git clone https://github.com/input-output-hk/atala-prism-wallet-sdk-swift -1. Clone the [KMM SDK](https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm) repository. +1. Clone the [KMM SDK](https://github.com/input-output-hk/identus-edge-agent-sdk-kmm) repository. ```bash -git clone https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm +git clone https://github.com/input-output-hk/identus-edge-agent-sdk-kmm ``` 2. Open the Wallet SDK project on IntelliJ or Android Studio. @@ -334,17 +334,17 @@ git clone https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm Mediation is the process that ensures messages get routed and stored correctly between Issuers, Verifiers and Holders, even if they are offline. The mediator offers a service that is always running and can securely store messages and deliver them to the associated DIDs using DIDComm. This enables use-cases where connectivity to a (mobile) wallet cannot be guaranteed. #### Preparation -1. To get the mediator deployed locally for the demo, clone the [Mediator repository](https://github.com/input-output-hk/atala-prism-mediator). +1. To get the mediator deployed locally for the demo, clone the [Mediator repository](https://github.com/input-output-hk/identus-mediator). ```bash -git clone https://github.com/input-output-hk/atala-prism-mediator +git clone https://github.com/input-output-hk/identus-mediator ``` 2. With a Docker service running, open a new terminal and run: :::info -The latest mediator version can be found at [Mediator releases](https://github.com/input-output-hk/atala-prism-mediator/releases). Change the version in the example if you want to use the latest version. +The latest mediator version can be found at [Mediator releases](https://github.com/input-output-hk/identus-mediator/releases). Change the version in the example if you want to use the latest version. ::: @@ -354,7 +354,7 @@ MEDIATOR_VERSION=0.10.2 docker-compose up `MEDIATOR_ENDPOINT` is then set to [http://localhost:8080](http://localhost:8080). -3. More advanced documentation and configuration options can be found [here](https://github.com/input-output-hk/atala-prism-mediator). +3. More advanced documentation and configuration options can be found [here](https://github.com/input-output-hk/identus-mediator). @@ -445,7 +445,7 @@ The below code examples show how to establish mediation when building your own a ```swift - let agent = PrismAgent(mediatorDID: did) + let agent = CloudAgent(mediatorDID: did) try await agent.start() agent.startFetchingMessages() ``` @@ -471,7 +471,7 @@ val handler = BasicMediatorHandler( mercury = mercury, store = BasicMediatorHandler.PlutoMediatorRepositoryImpl(pluto) ) -agent = PrismAgent( +agent = CloudAgent( apollo = apollo, castor = castor, pluto = pluto, @@ -495,15 +495,15 @@ agent.startFetchingMessages() To connect the Holder to both Cloud Agent instances, you must run this in both Issuer and Verifier endpoints. ### Establish a connection - Agent side -A connection must be established between the Holder and PRISM Cloud Agents to correctly deliver the Issuance + Verification Messages to the Holder. +A connection must be established between the Holder and Cloud Agents to correctly deliver the Issuance + Verification Messages to the Holder. #### Establish connection on the Issuer Cloud Agent ```bash curl --location \ ---request POST 'http://localhost:8000/prism-agent/connections' \ +--request POST 'http://localhost:8000/cloud-agent/connections' \ --header 'Content-Type: application/json' \ --data-raw '{ - "label": "Prism Agent demo connection with holder" + "label": "Cloud Agent demo connection with holder" }' ``` @@ -514,10 +514,10 @@ curl --location \ #### Establish connection on the Verifier Cloud Agent ```bash curl --location \ ---request POST 'http://localhost:9000/prism-agent/connections' \ +--request POST 'http://localhost:9000/cloud-agent/connections' \ --header 'Content-Type: application/json' \ --data-raw '{ - "label": "Prism Agent demo connection with holder" + "label": "Cloud Agent demo connection with holder" }' ``` @@ -534,14 +534,14 @@ curl --location \ 4. Open a browser at localhost:3000. 5. Start the Edge Agent by clicking the button. -6. Paste the invitation URL generated in the previous step into the `PrismAgent` connection section and click on Create Connection. +6. Paste the invitation URL generated in the previous step into the `CloudAgent` connection section and click on Create Connection. * The application will react when the connection gets established correctly and show a new connection. -4. On the OOB dialog, paste the invitation URL we generated into the `PrismAgent` connection section and click **Validate**. +4. On the OOB dialog, paste the invitation URL we generated into the `CloudAgent` connection section and click **Validate**. * The application will respond once the connection gets established correctly and show a message under messages. @@ -549,7 +549,7 @@ curl --location \ 4. Go back to the Application: 5. Click the floating button at the bottom right corner of the Contacts tab. -6. On the dialog, paste the invitation URL we generated into the `PrismAgent` connection section and click **Validate**. +6. On the dialog, paste the invitation URL we generated into the `CloudAgent` connection section and click **Validate**. * The application will react once the connection gets established correctly and show a message under messages. @@ -597,7 +597,7 @@ The credential issuance flow consists of multiple steps, detailed in this sectio Please replace the following variables in the example request before sending: -- `connectionId`: The ID of the connection previously established between agent and holder. This is part of the response of the POST message from the agent when calling the `prism-agent/connections` endpoint. It is returned in the `connectionId` attribute. There is a unique connection ID for the relationship between issuer and holder and verifier and holder. In this example, please use the `connectionId` returned when creating the connection between issuer and holder +- `connectionId`: The ID of the connection previously established between agent and holder. This is part of the response of the POST message from the agent when calling the `cloud-agent/connections` endpoint. It is returned in the `connectionId` attribute. There is a unique connection ID for the relationship between issuer and holder and verifier and holder. In this example, please use the `connectionId` returned when creating the connection between issuer and holder - `publishedPrismDID`: The short form of the PRISM DID created when setting up the Issuer agent The `connectionId` is just the ID of the connection we previously established with the issuer. @@ -609,7 +609,7 @@ The Issuing DID is the published PRISM DID in its short version which was also u ::: ```bash -curl --location --request POST 'http://localhost:8000/prism-agent/issue-credentials/credential-offers' \ +curl --location --request POST 'http://localhost:8000/cloud-agent/issue-credentials/credential-offers' \ --header 'Content-Type: application/json' \ --data-raw '{ "claims": {"emailAddress":"sampleEmail", "familyName":"", "dateOfIssuance":"2023-01-01T02:02:02Z", "drivingLicenseID":"", "drivingClass":1}, @@ -621,7 +621,7 @@ curl --location --request POST 'http://localhost:8000/prism-agent/issue-credenti ### Create CredentialRequest from CredentialOffer **Holder** -2. Because this credential Offer was created with the `automaticIssuance` true, as soon as the `PrismAgent` receives this `credentialRequest` it will respond with the `IssuedCredential` message and send this back to the holder. +2. Because this credential Offer was created with the `automaticIssuance` true, as soon as the `CloudAgent` receives this `credentialRequest` it will respond with the `IssuedCredential` message and send this back to the holder. :::info @@ -635,15 +635,15 @@ automaticIssuance is optional. It can also be manually triggered and confirmed b -4. The CredentialOffer message will be automatically accepted as soon as it reaches the browser. In exchange, a CredentialRequest message will get sent back to the `PrismAgent.` +4. The CredentialOffer message will be automatically accepted as soon as it reaches the browser. In exchange, a CredentialRequest message will get sent back to the `CloudAgent.` -4. As soon as the CredentialOffer message reaches the Swift mobile app, it will display to the user to accept or reject, and in exchange, a CredentialRequest message will get sent back to the PrismAgent. +4. As soon as the CredentialOffer message reaches the Swift mobile app, it will display to the user to accept or reject, and in exchange, a CredentialRequest message will get sent back to the CloudAgent. -4. As soon as the CredentialOffer message reaches the Android mobile app, it will be automatically accepted, and in exchange, a CredentialRequest message will get sent back to the PrismAgent. +4. As soon as the CredentialOffer message reaches the Android mobile app, it will be automatically accepted, and in exchange, a CredentialRequest message will get sent back to the CloudAgent. @@ -830,7 +830,7 @@ In the example, we show a verification flow that assumes a connection between Ho ```bash curl --location \ ---request POST 'http://localhost:9000/prism-agent/present-proof/presentations' \ +--request POST 'http://localhost:9000/cloud-agent/present-proof/presentations' \ --header 'Content-Type: application/json' \ --data-raw '{ "connectionId": [[connectionId]], @@ -952,7 +952,7 @@ agent.handleReceivedMessagesEvents().collect { list -> ```bash curl --location \ ---request GET 'http://localhost:9000/prism-agent/present-proof/presentations/[[presentationRequestId]]' \ +--request GET 'http://localhost:9000/cloud-agent/present-proof/presentations/[[presentationRequestId]]' \ --header 'Accept: application/json' ``` diff --git a/documentation/docs/sidebars.js b/documentation/docs/sidebars.js index 4fbb7c10f..a6f272f67 100644 --- a/documentation/docs/sidebars.js +++ b/documentation/docs/sidebars.js @@ -38,36 +38,36 @@ const sidebars = { }, { type: 'category', - label: 'Atala PRISM V2', + label: 'Identus', link: { type: 'generated-index', - title: 'Atala PRISM V2', - description: 'Learn about the Atala PRISM ecosystem!' + title: 'Identus', + description: 'Learn about the Identus ecosystem!' }, collapsed: false, items: [ - 'atala-prism/overview', + 'identus/overview', { type: 'category', - label: 'PRISM Cloud Agent', + label: 'Cloud Agent', collapsed: true, link: { type: 'generated-index', - title: 'PRISM Cloud Agent', - description: 'Learn about the Atala PRISM Cloud Agent!' + title: 'Cloud Agent', + description: 'Learn about the Identus Cloud Agent!' }, items: [ - 'atala-prism/prism-cloud-agent/overview', - 'atala-prism/prism-cloud-agent/building-blocks', - 'atala-prism/prism-cloud-agent/authentication', - 'atala-prism/prism-cloud-agent/did-management', - 'atala-prism/prism-cloud-agent/secrets-storage', - 'atala-prism/prism-cloud-agent/environment-variables' + 'identus/cloud-agent/overview', + 'identus/cloud-agent/building-blocks', + 'identus/cloud-agent/authentication', + 'identus/cloud-agent/did-management', + 'identus/cloud-agent/secrets-storage', + 'identus/cloud-agent/environment-variables' ] }, - 'atala-prism/prism-node', - 'atala-prism/prism-mediator', - 'atala-prism/getting-help' + 'identus/prism-node', + 'identus/mediator', + 'identus/getting-help' ], }, 'concepts/glossary' diff --git a/docusaurus.config.js b/docusaurus.config.js index 5edf326f5..65521a6ae 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -10,14 +10,14 @@ const path = require('path') /** @type {import('@docusaurus/types').Config} */ const config = { title: 'Unlock the power of your digital identity.', - tagline: 'ATALA PRISM V2 Docs', + tagline: 'IDENTUS Docs', url: 'https://docs.atalaprism.io', baseUrl: '/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', favicon: 'img/favicon.ico', - organizationName: 'input-output-hk', - projectName: 'atala-prisim-docs', + organizationName: 'Hyperledger', + projectName: 'identus-docs', markdown: { mermaid: true, }, @@ -95,7 +95,7 @@ const config = { { navbar: { logo: { - alt: 'Atala PRISM logo', + alt: ' Identus logo', src: 'img/logo-navbar-dark.png', srcDark: "img/logo-navbar-light.png", }, @@ -163,7 +163,7 @@ const config = { ], }, footer: { - copyright: `© ${new Date().getFullYear()} Atala PRISM. All rights reserved.`, + copyright: `© ${new Date().getFullYear()} Identus. All rights reserved.`, }, prism: { theme: lightCodeTheme,