From 714d041a53a5f562e315ee68ed831d4a2315f13a Mon Sep 17 00:00:00 2001 From: mineme0110 Date: Mon, 22 Apr 2024 15:16:43 +0100 Subject: [PATCH] Align the repo with new name identus-cloud-agent Signed-off-by: mineme0110 --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 14 +++++----- DCO.md | 2 +- README.md | 64 +++++++++++++++++++++++----------------------- SECURITY.md | 4 +-- build.sbt | 8 +++--- package.json | 16 ++++++------ 7 files changed, 55 insertions(+), 55 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 9fc08ec88a..7b208b8e3e 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,6 +1,6 @@ Code of Conduct =============== -Atala PRISM follows Hyperledger [Code of Conduct](https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct). +Identus follows Hyperledger [Code of Conduct](https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct). Please, read before contributing to the project. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 480ca729d4..a4f3e52535 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to Atala PRISM +# Contributing to Identus -We would love for you to contribute to Atala PRISM and help make it even better than it is today! +We would love for you to contribute to Identus and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: - [DCO](#dco) @@ -13,7 +13,7 @@ As a contributor, here are the guidelines we would like you to follow: ## Developer Certificate of Origin (DCO) -PRISM Cloud Agent enforces the Developer Certificate of Origin (DCO). It requires all commit messages to contain the `Signed-off-by` line with an email address that matches the commit author and the name on your GitHub account. +Cloud Agent enforces the Developer Certificate of Origin (DCO). It requires all commit messages to contain the `Signed-off-by` line with an email address that matches the commit author and the name on your GitHub account. Please read and follow set up [DCO](./DCO.md). @@ -43,13 +43,13 @@ If you would like to *implement* a new feature, please consider the size of the Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available. -You can file new issues by selecting a `Bug Report` template on our [Issues submition page](https://github.com/input-output-hk/atala-prism-building-blocks/issues/new/choose). +You can file new issues by selecting a `Bug Report` template on our [Issues submition page](https://github.com/hyperledger/identus-cloud-agent/issues/new/choose). ### Submitting a Pull Request (PR) Before you submit your Pull Request (PR) consider the following guidelines: -1. Search [GitHub](https://github.com/input-output-hk/atala-prism-building-blocks/pulls) for an open or closed PR that relates to your submission. +1. Search [GitHub](https://github.com/hyperledger/identus-cloud-agent/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. 2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. @@ -57,7 +57,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: 3. Make sure all your commits have DCO sign-off line with an email address that matches the commit author and the name on your GitHub account. -4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the https://github.com/input-output-hk/atala-prism-building-blocks repo. +4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the https://github.com/hyperledger/identus-cloud-agent repo. 5. In your forked repository, make your changes in a new git branch: @@ -85,7 +85,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: git push origin my-fix-branch ``` -11. In GitHub, send a pull request to `atala-prism-building-blocks:main`. +11. In GitHub, send a pull request to `identus-cloud-agent:main`. That's it! Thank you for your contribution! diff --git a/DCO.md b/DCO.md index 243038c4f9..e1b90b53b7 100644 --- a/DCO.md +++ b/DCO.md @@ -1,6 +1,6 @@ # Developer Certificate of Origin (DCO) -PRISM Cloud Agent enforces the Developer Certificate of Origin (DCO). It requires all commit messages to contain the `Signed-off-by` line with an email address that matches the commit author and the name on your GitHub account. +Identus Cloud Agent enforces the Developer Certificate of Origin (DCO). It requires all commit messages to contain the `Signed-off-by` line with an email address that matches the commit author and the name on your GitHub account. The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability: diff --git a/README.md b/README.md index 2387fa44a4..ba9fe2c10c 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,21 @@ atala-prism-logo
- Open Enterprise Cloud Agent + Open Cloud Agent

Coverage Status - Unit tests - End-to-end tests - Performance tests + Unit tests + End-to-end tests + Performance tests

## Overview -The Enterprise Cloud Agent is a W3C/Aries standards-based cloud agent written in Scala that provides self-sovereign identity services to build products and solutions based on it. The term "cloud" indicates that it operates on servers and is not intended for use on mobile devices. +The Cloud Agent is a W3C/Aries standards-based cloud agent written in Scala that provides self-sovereign identity services to build products and solutions based on it. The term "cloud" indicates that it operates on servers and is not intended for use on mobile devices. -Enterprise Cloud Agent supports standard-based protocols built on top of DIDComm V2 for issuing, verifying, and holding verifiable credentials using both JWT and Hyperledger AnonCreds (coming soon) formats. +Cloud Agent supports standard-based protocols built on top of DIDComm V2 for issuing, verifying, and holding verifiable credentials using both JWT and Hyperledger AnonCreds (coming soon) formats. In order to use the Cloud Agent, you establish a business logic controller responsible for communicating with the agent (initiating HTTP requests and processing webhook notifications). This controller can be created using any programming language capable of sending and receiving HTTP requests. @@ -48,15 +48,15 @@ As a result, you can concentrate on crafting self-sovereign identity solutions u Before starting to use the Cloud Agent, it is important to understand the basic concepts of self-sovereign identity (SSI). The following resources provide a good introduction to SSI: -* [Atala PRISM SSI introduction](https://docs.atalaprism.io/docs/category/concepts/) +* [Identus SSI introduction](https://docs.atalaprism.io/docs/category/concepts/) * [Linux Foundation Course: Getting Started with SSI](https://www.edx.org/learn/computer-programming/the-linux-foundation-getting-started-with-self-sovereign-identity) ### Architecture The next diagram offers a concise architectural overview, depicting a Cloud Agent instance, a controller, the interconnections linking the controller and agent, as well as the external routes to other agents and public ledgers across the Internet. -![Enterprise Cloud Agent architecture](docs/images/cloud-agent-architecture-dark.png#gh-dark-mode-only) -![Enterprise Cloud Agent architecture](docs/images/cloud-agent-architecture-light.png#gh-light-mode-only) +![Cloud Agent architecture](docs/images/cloud-agent-architecture-dark.png#gh-dark-mode-only) +![Cloud Agent architecture](docs/images/cloud-agent-architecture-light.png#gh-light-mode-only) ### Running the Cloud Agent locally on MacOS or Linux #### Prerequisites @@ -64,7 +64,7 @@ The next diagram offers a concise architectural overview, depicting a Cloud Agen - Java (OpenJDK 21) - SBT (latest version) - Git (for cloning the repository) -- Docker (for running the PostgreSQL database, Hashicorp Vault, APISIX, and PRISM Node) +- Docker (for running the PostgreSQL database, Hashicorp Vault, APISIX, and VDR) - [GITHUB_TOKEN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) environment variable (required for SBT plugins and access to the GitHub packages) #### Login to GitHub packages @@ -87,23 +87,23 @@ sbt clean compile test docker:publishLocal ### Installation and usage -Enterprise Cloud Agent is distributed as a Docker image to be run in a containerized environment. All versions can be found [here](https://github.com/orgs/input-output-hk/packages/container/package/prism-agent). +Cloud Agent is distributed as a Docker image to be run in a containerized environment. All versions can be found [here](https://github.com/orgs/input-output-hk/packages/container/package/cloud-agent). -The following sections describe how to run the Enterprise Cloud Agent in different configurations. +The following sections describe how to run the Cloud Agent in different configurations. #### Configuration -The Enterprise Cloud Agent can be configured to use different types of ledger, secret storage and DID persistence. Any combination of options is available, but the most common configurations are: +The Cloud Agent can be configured to use different types of ledger, secret storage and DID persistence. Any combination of options is available, but the most common configurations are: | Configuration | Secret Storage | DIDs persistence | VDR | | -------------- | -------------- | ---------------- | ------------------------------------ | | Dev | PostgreSQL | No | In-memory | -| Pre-production | PostgreSQL | Yes | Cardano testnet (preview or preprod) | -| Production | Hashicorp | Yes | Cardano mainnet | +| Pre-production | PostgreSQL | Yes | Distributed Ledger testnet (preview or preprod) | +| Production | Hashicorp | Yes | Distributed Ledger mainnet | -To start playing with Cloud Agent, we recommend using the Dev configuration. Pre-production and production configurations are intended for real-world use cases and require additional more complex configurations of the Cardano stack setup. +To start playing with Cloud Agent, we recommend using the Dev configuration. Pre-production and production configurations are intended for real-world use cases and require additional more complex configurations of the Distributed Ledger stack setup. -> If you're interested in a hosted version of Enterprise Cloud Agent, please, contact us at [atalaprism.io](https://atalaprism.io). +> If you're interested in a hosted version of Cloud Agent, please, contact us at [atalaprism.io](https://atalaprism.io). #### System requirements @@ -118,19 +118,19 @@ System requirements can vary depending on the use case. The following are the mi Here is a general example of running a Cloud Agent locally: ```bash -PORT=${PORT} PRISM_AGENT_VERSION=${PRISM_AGENT_VERSION} PRISM_NODE_VERSION=${PRISM_NODE_VERSION} \ +PORT=${PORT} AGENT_VERSION=${AGENT_VERSION} NODE_VERSION=${NODE_VERSION} \ docker compose \ -p "${AGENT_ROLE}" \ -f ./infrastructure/shared/docker-compose-demo.yml \ up --wait ``` -The `PORT` variable is used to specify the port number for the Cloud Agent to listen on. The `PRISM_AGENT_VERSION` and `PRISM_NODE_VERSION` variables are used to specify the versions of the Cloud Agent and PRISM Node to use. The `AGENT_ROLE` variable is used to specify the role of the Cloud Agent. The `AGENT_ROLE` variable can be set to `issuer`, `verifier` or `holder`. +The `PORT` variable is used to specify the port number for the Cloud Agent to listen on. The `AGENT_VERSION` and `NODE_VERSION` variables are used to specify the versions of the Cloud Agent and VDR to use. The `AGENT_ROLE` variable is used to specify the role of the Cloud Agent. The `AGENT_ROLE` variable can be set to `issuer`, `verifier` or `holder`. In real life, you will need to start at least two Cloud Agent instances with different roles. For example, you can start one instance with the `issuer` role and another one with the `holder` role. The `issuer` instance will be used to issue verifiable credentials (VCs) and the `holder` instance will be used to hold VCs. Here is an example of how you can do this: - + ```bash -PORT=8080 PRISM_AGENT_VERSION=${PRISM_AGENT_VERSION} PRISM_NODE_VERSION=2.2.1 \ +PORT=8080 AGENT_VERSION=${AGENT_VERSION} NODE_VERSION=2.2.1 \ docker compose \ -p "issuer" \ -f ./infrastructure/shared/docker-compose-demo.yml \ @@ -138,7 +138,7 @@ PORT=8080 PRISM_AGENT_VERSION=${PRISM_AGENT_VERSION} PRISM_NODE_VERSION=2.2.1 \ ``` ```bash -PORT=8090 PRISM_AGENT_VERSION=${PRISM_AGENT_VERSION} PRISM_NODE_VERSION=2.2.1 \ +PORT=8090 AGENT_VERSION=${AGENT_VERSION} NODE_VERSION=2.2.1 \ docker compose \ -p "holder" \ -f ./infrastructure/shared/docker-compose-demo.yml \ @@ -146,29 +146,29 @@ PORT=8090 PRISM_AGENT_VERSION=${PRISM_AGENT_VERSION} PRISM_NODE_VERSION=2.2.1 \ ``` If the Cloud Agent is started successfully, all the running containers should achieve `Healthy` state, and Cloud Agent Rest API should be available at the specified port, for example: -* `http://localhost:8080/prism-agent` for the `issuer` instance -* `http://localhost:8090/prism-agent` for the `holder` instance +* `http://localhost:8080/cloud-agent` for the `issuer` instance +* `http://localhost:8090/cloud-agent` for the `holder` instance You can check the status of the running containers using the [health endpoint](https://docs.atalaprism.io/agent-api/#tag/System/operation/systemHealth): ```bash -$ curl http://localhost:8080/prism-agent/_system/health +$ curl http://localhost:8080/cloud-agent/_system/health {"version":"1.19.1"} ``` > For more information about all available configuration parameters, please, check [Cloud Agent configuration](https://docs.atalaprism.io/docs/atala-prism/prism-cloud-agent/environment-variables) section at the documentation portal and edit the `docker-compose-demo.yml` file accordingly. -#### Compatibility between Cloud Agent and PRISM Node +#### Compatibility between Cloud Agent and VDR -There could be some incompatibilities between the most latest versions of Enterprise Cloud Agent and PRISM Node. Please, use the following table to check the compatibility between the versions: +There could be some incompatibilities between the most latest versions of Cloud Agent and VDR. Please, use the following table to check the compatibility between the versions: -| Cloud Agent | PRISM Node | +| Cloud Agent | Node (VDR) | |-------------|------------| | >=1.9.2 | 2.2.1 | | <1.9.2 | 2.1.1 | -> Please note: it is not guaranteed that the latest version of Enterprise Cloud Agent will work with the latest version of PRISM Node. We recommend using the versions from the table above. +> Please note: it is not guaranteed that the latest version of Cloud Agent will work with the latest version of VDR. We recommend using the versions from the table above. -### Following the Enterprise Cloud Agent tutorials +### Following the Cloud Agent tutorials The following tutorials will help you get started with the Cloud Agent and issue your first credentials: @@ -179,13 +179,13 @@ The following tutorials will help you get started with the Cloud Agent and issue ## User documentation -All extended documentation, tutorials and API references for the PRISM ecosystem can be found at https://docs.atalaprism.io/ +All extended documentation, tutorials and API references for the Identus ecosystem can be found at https://docs.atalaprism.io/ ## Contributing Please read our [contributions guidelines](./CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin (DCO) commit signing](./DCO.md). -We also welcome issues submitted about problems you encounter in using Enterprise Cloud Agent. +We also welcome issues submitted about problems you encounter in using Cloud Agent. ## License diff --git a/SECURITY.md b/SECURITY.md index a0bac7350f..edc45c227e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ # Reporting Security Issues -The Open Enterprise Agent (OEA) team and community take security bugs in the components of the OEA ecosystem seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. +The Open Cloud Agent (OEA) team and community take security bugs in the components of the OEA ecosystem seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/hyperledger/identus-cloud-agent/security/advisories/new) tab. @@ -12,4 +12,4 @@ Report security bugs in third-party modules to the person or team maintaining th ## Security Notification Process -Security notifications will be sent to the dedicated [open-enterprise-agent-security-notices](https://discordapp.com/channels/905194001349627914/1199354196944748614) channel in the Hyper Ledger discord server +Security notifications will be sent to the dedicated [open-cloud-agent-security-notices](https://discordapp.com/channels/905194001349627914/1199354196944748614) channel in the Hyper Ledger discord server diff --git a/build.sbt b/build.sbt index 065c03df64..703d9ec78a 100644 --- a/build.sbt +++ b/build.sbt @@ -5,14 +5,14 @@ import sbtbuildinfo.BuildInfoPlugin.autoImport.* inThisBuild( Seq( - organization := "io.iohk.atala", + organization := "org.hyperledger.identus", scalaVersion := "3.3.1", fork := true, run / connectInput := true, releaseUseGlobalVersion := false, versionScheme := Some("semver-spec"), - githubOwner := "input-output-hk", - githubRepository := "atala-prism-building-blocks", + githubOwner := "hyperledger", + githubRepository := "identus-cloud-agent", resolvers += "Local Maven Repository" at "file://" + Path.userHome.absolutePath + "/.m2/repository", resolvers += "jitpack" at "https://jitpack.io", ) @@ -692,7 +692,7 @@ lazy val agentDidcommx = project // .dependsOn(agent) // #################### -// ### prismNode #### +// ### Node (VDR) #### // #################### val prismNodeClient = project .in(file("prism-node/client/scala-client")) diff --git a/package.json b/package.json index 13262facb7..67107a6964 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "atala-prism-building-blocks", + "name": "identus-cloud-agent", "version": "1.31.0", "engines": { "node": ">=16.13.0" @@ -28,7 +28,7 @@ "prerelease": "snapshot" } ], - "tagFormat": "prism-agent-v${version}", + "tagFormat": "cloud-agent-v${version}", "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", @@ -41,7 +41,7 @@ [ "@semantic-release/exec", { - "prepareCmd": "sed -i.bak \"s/PRISM_AGENT_VERSION=.*/PRISM_AGENT_VERSION=${nextRelease.version}/\" ./infrastructure/local/.env && rm -f ./infrastructure/local/.env.bak" + "prepareCmd": "sed -i.bak \"s/AGENT_VERSION=.*/AGENT_VERSION=${nextRelease.version}/\" ./infrastructure/local/.env && rm -f ./infrastructure/local/.env.bak" } ], [ @@ -53,7 +53,7 @@ [ "@semantic-release/exec", { - "prepareCmd": "sbt \"prismAgentServer/test:runMain io.iohk.atala.api.util.Tapir2StaticOAS ${process.env.PWD}/prism-agent/service/api/http/prism-agent-openapi-spec.yaml ${nextRelease.version}\"" + "prepareCmd": "sbt \"prismAgentServer/test:runMain io.iohk.atala.api.util.Tapir2StaticOAS ${process.env.PWD}/cloud-agent/service/api/http/cloud-agent-openapi-spec.yaml ${nextRelease.version}\"" } ], [ @@ -89,7 +89,7 @@ [ "@semantic-release/exec", { - "prepareCmd": "docker buildx build --platform=linux/arm64,linux/amd64 --push -t ghcr.io/input-output-hk/prism-agent:${nextRelease.version} ./prism-agent/service/server/target/docker/stage" + "prepareCmd": "docker buildx build --platform=linux/arm64,linux/amd64 --push -t ghcr.io/hyperledger/cloud-agent:${nextRelease.version} ./cloud-agent/service/server/target/docker/stage" } ], [ @@ -107,13 +107,13 @@ "DEPENDENCIES.md", "package.json", "package-lock.json", - "prism-agent/service/api/http/prism-agent-openapi-spec.yaml", + "cloud-agent/service/api/http/cloud-agent-openapi-spec.yaml", "infrastructure/charts/agent/Chart.yaml", "infrastructure/charts/index.yaml", "infrastructure/charts/*.tgz", "infrastructure/local/.env" ], - "message": "chore(release): cut open enterprise agent ${nextRelease.version} release\n\n${nextRelease.notes}\n\nSigned-off-by: Allain Magyar " + "message": "chore(release): cut open Cloud agent ${nextRelease.version} release\n\n${nextRelease.notes}\n\nSigned-off-by: Allain Magyar " } ], [ @@ -123,7 +123,7 @@ "notifyOnFail": true, "markdownReleaseNotes": true, "onSuccessTemplate": { - "text": "A new version of Opent Enterprise Agent successfully released!\nVersion: `$npm_package_version`\nTag: $repo_url/releases/tag/$npm_package_version\n\nRelease notes:\n$release_notes" + "text": "A new version of Open Cloud Agent successfully released!\nVersion: `$npm_package_version`\nTag: $repo_url/releases/tag/$npm_package_version\n\nRelease notes:\n$release_notes" } } ]