Skip to content

Commit

Permalink
fix: anchors to the glossary and tiny typos
Browse files Browse the repository at this point in the history
Signed-off-by: Yurii Shynbuiev <yurii.shynbuiev@iohk.io>
  • Loading branch information
yshyn-iohk committed Feb 17, 2025
1 parent 36c30c4 commit 545e261
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 20 deletions.
48 changes: 35 additions & 13 deletions documentation/home/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ An administrator is a role who oversees the agent and releated resources, includ


## C
### Claim
### Claim {#claim}
An assertion made about a [subject](#did-subject).

### Claims {#claims}
Synonym of [claim](#claim) in the plural form.

### Cloud Agent {#cloud-agent}
The Cloud Agent is a scaleable, easy-to-use, robust, and W3C standards-based agent that provides self-sovereign identity (SSI) services to build products and solutions based on it. The Cloud Agent exposes REST API for integration with any programming language.

Expand All @@ -31,6 +34,11 @@ An invitation from one entity to another to establish a connection.
### Connection request
A request to establish a connection.

### Credential Definition {#credential-definition}
The term [refers](https://hyperledger.github.io/anoncreds-spec/#term:credential-definition) to the AnonCreds v1 implementation.
Credential Definition contains public and private part.
The public part is published and available for anyone to use to verify the credential. The private part is used to issue credentials.

### Credential schema
A data template for verifiable credentials (VCs). It contains claims of the VCs, credential schema author, type, name, version, and proof of authorship.

Expand All @@ -43,11 +51,14 @@ When the Holder accepts or rejects a credential offer, a credential request is c


## D
### Decentralized Identifier (DID) {#decentralized-identifier}
### Decentralized Identifier {#decentralized-identifier}
A globally unique persistent identifier that does not require a centralized registration authority and is often cryptographically generated. All DIDs use distributed ledger technology (DLT) or some other decentralized network.

### DID {#did}
See [decentralized identifier](#decentralized-identifer)
See [decentralized identifier](#decentralized-identifier)

### DIDs {#dids}
See [decentralized identifiers](#decentralized-identifier)

### DIDComm {#didcomm}
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.
Expand All @@ -64,8 +75,8 @@ The DID method defines how to implement a specific DID method schema. The specif
### DID resolution
The process for retrieving a [DID document](#did-document).

### DID subject
The entity is identified by a [DID](#decentralized-identifer-(did)) and described by a [DID documents](#did-document). Anything can be a DID subject: person, group, organization, physical thing, digital thing, etc.
### DID subject {#did-subject}
The entity is identified by a [DID](#decentralized-identifier) and described by a [DID documents](#did-document). Anything can be a DID subject: person, group, organization, physical thing, digital thing, etc.

### DID Url
A DID itself is a type of a URL, while `did` is a registered schema type, like `http` and `https`. With Identus, we refer DID URLs to a DID that includes path and query parameters and can resolve a resource via one of the service endpoints in the DID document. For example:
Expand All @@ -87,7 +98,7 @@ An `entity,` in the context of the Identus platform, is an identity representing
Each entity possesses an Edge Agent and is associated with an authentication method.
Entities are crucial for secure and verifiable transactions within the SSI ecosystem.

### Edge Agent SDK
### Edge Agent SDK {#edge-agent-sdk}
For use with web and mobile (iOS, Android, TypeScript) enable identity holders to store credentials and respond to proof requests.

### Edge Agent
Expand Down Expand Up @@ -125,10 +136,10 @@ A subject that receives a connection invitation and accepts it by sending a conn
A subject that initiates a connection request by sending a connection invitation.

### Issuer {#issuer}
An entity that asserts claim(s) about one or more [subjects](#did-subject) then creates a [verifiable credentials](#verifiable-credentials) from these claims and transmits the VC to a holder.
An entity that asserts claim(s) about one or more [subjects](#did-subject) then creates a [verifiable credential](#verifiable-credential) from these claims and transmits the VC to a holder.

### Issue Credential Protocol
Allows you to create, retrieve, and manage issued [verifiable credentials (VCs)](#verifiable-credentials) between a VC issuer and a VC holder.
Allows you to create, retrieve, and manage issued [verifiable credentials (VCs)](#verifiable-credential) between a VC issuer and a VC holder.

## K
### Keycloak Service
Expand Down Expand Up @@ -201,14 +212,17 @@ Requesting Party Token (RPT) is a concept within the [UMA](#uma) framework. It r


## S
### Secrets storage
### Secrets storage {#secrets-storage}
This component securely stores sensitive information, such as private keys associated with an individual's digital identity, Edge Agent seed, etc.
Secrets storage plays a crucial role in SSI implementations because it ensures that sensitive information is securely stored and protected against unauthorized access or disclosure

### SSI
### Subject {#subject}
See [DID Subject](#did-subject)

### SSI {#ssi}
See [Self-Sovereign Identity](#self-sovereign-identity)

### Self-Sovereign Identity (SSI)
### Self-Sovereign Identity (SSI) {#self-sovereign-identity}
An identity model that shifts control to the edges, focused on security, privacy using public/private key encryption.


Expand Down Expand Up @@ -237,21 +251,29 @@ User-Managed Access (UMA) is an authorization framework that allows users to con


## V
### Vault Service
### Vault Service {#vault-service}
HashiCorp Vault is a widely used open-source and enterprise-grade solution designed for securely storing, accessing, and managing secrets and sensitive data in modern computing environments.
It offers a centralized platform for managing cryptographic keys, passwords, API keys, tokens, and other secrets.

### Verifiable Credential (VC) {#verifiable-credential}
A verifiable credential is a tamper-evident credential that contains one or more claims made by an issuer whose authorship can be cryptographically verified. It is possible to use VCs to create a [verifiable presentation](#verifiable-presentation). Also, the claims in a VC can be about different subjects.

### Verifiable Credentials (VCs) {#verifiable-credentials}
Synonym of the [Verifiable Credential (VC)](#verifiable-credential).

### Verifiable Data Registry {#verifiable-data-registry}
A system that mediates the creation and verification of identifiers, keys, and other relevant data.

### Verifiable Presentation
### Verifiable Presentation {#verifiable-presentation}
Data is derived from one or more [verifiable credentials](#verifiable-credential), issued by issuers, and shared (presented) to a specific verifier. The verifiable presentation is tamper-evident and encoded in a way to trust the authorship of the data after a cryptographic verification.

### Verifier
An entity that receives one or more [verifiable credentials](#verifiable-credential) optionally, inside a [verifiable presentation](#verifiable-presentation). Also known as a relying party.



## W
### Wallet SDK {#wallet-sdk}
A software development kit (SDK) that enables developers to build applications that interact with the Identus platform.
The Wallet SDK provides a set of tools, libraries, and APIs that simplify the integration of SSI features, such as DID operations, verifiable credentials, and secure communications, into web and mobile applications.
Wallet SDK is much wider term than [Edge Agent SDK](#edge-agent-sdk), as it includes all the features of Edge Agent SDK and more.
2 changes: 1 addition & 1 deletion documentation/home/identus/cloud-agent/building-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Below is a brief overview of the current building blocks of Identus:
**Building Block**|**Definition**|**Code Name**
:-----:|:-----:|:-----:
Cryptography|A set of cryptographic primitives that ensure the integrity, authenticity, and confidentiality of all data we store and process in a provable secure way.|Apollo
[Decentralized Identifiers (DID)](/home/concepts/glossary#decentralized-identifer)|A set of DID operations to create, manage, and resolve standards-based DIDs in a user-controlled manner.|Castor
[Decentralized Identifiers (DID)](/home/concepts/glossary#decentralized-identifier)|A set of DID operations to create, manage, and resolve standards-based DIDs in a user-controlled manner.|Castor
[Verifiable Credentials](/home/concepts/glossary#verifiable-credential)|A set of credential operations to issue, manage, and verify standards-based [verifiable credentials](/home/concepts/glossary#verifiable-credential) in a privacy-preserving manner.|Pollux
[DIDComm](/home/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

Expand Down
4 changes: 2 additions & 2 deletions documentation/home/identus/cloud-agent/secrets-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Introduction

To ensure maximum security, storing sensitive information, including secrets, actively and securely in the [Secrets Storage](</home/concepts/glossary#secrets storage>). The Cloud Agent manages the following types of secrets:
To ensure maximum security, storing sensitive information, including secrets, actively and securely in the [Secrets Storage](</home/concepts/glossary#secrets-storage>). The Cloud Agent manages the following types of secrets:

- **seed**: a secret used to derive cryptographic keys
- **private key**: a secret used to sign and decrypt data
- any other sensitive data from entities' (for instance, credential definition and the link-secret used by the AnonCreds)

The default secret storage for the Cloud Agent is the [HashiCorp Vault Service](</home/concepts/glossary#Vault Service>). Other implementations of secret storage can be implemented based on the needs.
The default secret storage for the Cloud Agent is the [HashiCorp Vault Service](</home/concepts/glossary#vault-service>). Other implementations of secret storage can be implemented based on the needs.

## Technical Overview

Expand Down
4 changes: 2 additions & 2 deletions documentation/home/identus/prism-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ The PRISM Node acts as a second-layer node for the distributed ledger. It functi

PRISM Node's primary purpose is to provide a secure and trustworthy platform for storing and managing data on the distributed ledger. By leveraging the blockchain's security and decentralization, the PRISM Node stores and retrieves data in a secure and immutable manner. All operations are independently verified and authenticated using cryptographic signatures and other security measures, so all data is accurate and trustworthy.

The PRISM Node runs alongside a blockchain. It keeps the internal state synchronized with the underlying blockchain and indexed for efficient lookup operations. Furthermore, it implements `did:prism` method in an efficient and scalable way by publishing transactions to the distributed ledger. These transactions support the PRISM Node's protocol and perform the creation, update, resolution, and deactivation of [decentralized identifiers (DIDs)](/home/concepts/glossary#decentralized-identifiers).
The PRISM Node runs alongside a blockchain. It keeps the internal state synchronized with the underlying blockchain and indexed for efficient lookup operations. Furthermore, it implements `did:prism` method in an efficient and scalable way by publishing transactions to the distributed ledger. These transactions support the PRISM Node's protocol and perform the creation, update, resolution, and deactivation of [decentralized identifiers (DIDs)](/home/concepts/glossary#decentralized-identifier).

The PRISM Node generates a transaction with information about the DID operation and verifies and validates the DID operation before publishing it to the blockchain. Once the transaction gets confirmed on the blockchain, the PRISM Node updates its internal state to reflect the changes.

The second-layer PRISM Node also plays a critical role in resolving DIDs. Because the PRISM Node keeps the internal state indexed, it allows retrieving information about a particular DID quickly and efficiently without requiring access to the underlying blockchain.

Overall, second-layer nodes are essential for the PRISM Node protocol, providing the necessary off-chain processing and data storage capabilities to make DIDs scalable and efficient.

At its core, PRISM depends on protocols defining how to manage decentralized identifiers and [Verifiable Credentials (VCs)](/home/concepts/glossary#verifiable-credentials). The PRISM Node is the main component that implements these protocols. First, we should explain how the protocol works to understand what the PRISM Node does.
At its core, PRISM depends on protocols defining how to manage decentralized identifiers and [Verifiable Credentials (VCs)](/home/concepts/glossary#verifiable-credential). The PRISM Node is the main component that implements these protocols. First, we should explain how the protocol works to understand what the PRISM Node does.

- Any user can run a PRISM Node to self-validate information or rely on a set of actors that run nodes on his behalf. The level of delegation of trust is a decision made by each user.
- Any user willing to create a DID can do so without any need to interact with any PRISM Node. Creating a DID can be optionally announced publicly by publishing a creation operation on-chain. The action of posting an operation on-chain does require interaction with a PRISM Node.
Expand Down
2 changes: 1 addition & 1 deletion documentation/home/identus/prism-node/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The second-layer PRISM Node also plays a critical role in resolving DIDs. Becaus

Overall, second-layer nodes are essential for the PRISM Node protocol, providing the necessary off-chain processing and data storage capabilities to make DIDs scalable and efficient.

At its core, PRISM depends on protocols defining how to manage decentralized identifiers and [Verifiable Credentials (VCs)](/home/concepts/glossary#verifiable-credentials). The PRISM Node is the main component that implements these protocols. First, we should explain how the protocol works to understand what the PRISM Node does.
At its core, PRISM depends on protocols defining how to manage decentralized identifiers and [Verifiable Credentials (VCs)](/home/concepts/glossary#verifiable-credential). The PRISM Node is the main component that implements these protocols. First, we should explain how the protocol works to understand what the PRISM Node does.

- Any user can run a PRISM Node to self-validate information or rely on a set of actors that run nodes on his behalf. The level of delegation of trust is a decision made by each user.
- Any user willing to create a DID can do so without any need to interact with any PRISM Node. Creating a DID can be optionally announced publicly by publishing a creation operation on-chain. The action of posting an operation on-chain does require interaction with a PRISM Node.
Expand Down
2 changes: 1 addition & 1 deletion documentation/home/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Identus consists of core libraries that facilitate typical SSI interactions betw


### A Cloud Agent
A Cloud Agent can issue, hold, and verify [verifiable credentials (VCs)](/home/concepts/glossary/#verifiable-credentials) for any entity and manage [decentralized identifiers (DIDs)](/home/concepts/glossary/#decentralized-identifier) and DID-based connections. The Cloud Agent has an easy-to-use REST API to enable easy integration into any solution and uses [DIDComm V2](/home/concepts/glossary/#didcomm) as a messaging protocol for Cloud Agent-to-Cloud Agent communication.
A Cloud Agent can issue, hold, and verify [verifiable credentials (VCs)](/home/concepts/glossary/#verifiable-credential) for any entity and manage [decentralized identifiers (DIDs)](/home/concepts/glossary/#decentralized-identifier) and DID-based connections. The Cloud Agent has an easy-to-use REST API to enable easy integration into any solution and uses [DIDComm V2](/home/concepts/glossary/#didcomm) as a messaging protocol for Cloud Agent-to-Cloud Agent communication.

It is maintained as an open source through the [Hyperledger Identus](https://www.hyperledger.org/projects/identus).

Expand Down

0 comments on commit 545e261

Please sign in to comment.