Signify-Java Example

Overview

This project demonstrates how to use the cf-signify-java library, which is designed for "signing at the edge" within the KERI (Key Event Receipt Infrastructure) ecosystem. It provides examples of key generation, event signing, and identity management.

Prerequisites

• Java 21: Ensure you have Java 21 installed. You can verify your Java version by running:

  java -version

• Gradle: This project uses Gradle as the build tool.
• Running instance of KERIA

Setup

Temporary Workaround for Library Dependencies

Currently, there's an issue with the mavenCentral repository version. As a temporary workaround:

1. Clone and build the Signify Java library locally:

git clone https://github.com/cardano-foundation/cf-signify-java
cd cf-signify-java
# Ensure version is 1.0-SNAPSHOT in build.gradle
./gradlew publishToMavenLocal

2. In this example project's build.gradle, we use mavenLocal():

repositories {
    mavenLocal()
    mavenCentral()
    maven {
        url "https://oss.sonatype.org/content/repositories/snapshots"
    }
}

dependencies {
    implementation 'org.cardanofoundation:signify-java:1.0-abfbc0a-SNAPSHOT' 
    // Note: 'abfbc0a' should be replaced with the commit hash of your local build
}

Start KERIA Dependencies

The application depends on a local instance of KERIA, vLEI-Server and Witness Demo. These are specified in the Docker Compose file. To start the dependencies:

docker compose up --wait

If successful, it should print something like this:

$ docker compose up --wait
[+] Running 4/4
 ✔ Network signify-ts_default           Created                                           0.0s
 ✔ Container signify-ts-vlei-server-1   Healthy                                           5.7s
 ✔ Container signify-ts-keria-1         Healthy                                           6.2s
 ✔ Container signify-ts-witness-demo-1  Healthy                                           6.2s

You can customize the KERIA image using environment variables:

# To use a specific version
export KERIA_IMAGE_TAG=0.1.3
docker compose pull
docker compose up --wait

# To use another repository
export KERIA_IMAGE=gleif/keria
docker compose pull
docker compose up --wait

Building and Running

1. Build the project:

./gradlew build

2. Run the application:

./gradlew bootRun

The application will start on http://localhost:8080

API Examples

Here are some example curl commands to interact with the API:

Create an Identifier

curl -X POST "http://localhost:8080/api/example/identifiers/alice" \
     -H "Content-Type: application/json" \
     -d '{
           "transferable": true,
           "wits": [],
           "toad": 0,
           "icount": 1,
           "ncount": 1,
           "isith": "1",
           "nsith": "1"
         }'

Get an Identifier

curl -X GET "http://localhost:8080/api/example/identifiers/alice"

Get List of Identifiers

curl -X GET "http://localhost:8080/api/example/identifiers"

Interact with an Identifier

curl -X PUT "http://localhost:8080/api/example/identifiers/interact" \
     -H "Content-Type: application/json" \
     -d '{
           "name": "alice",
           "pre": "<identifier_prefix>"
         }'

Rotate an Identifier's Keys

curl -X PUT "http://localhost:8080/api/example/identifiers/alice/rotate"

Update an Identifier

curl -X PUT "http://localhost:8080/api/example/identifiers/alice/update" \
     -H "Content-Type: application/json" \
     -d '{
           "toad": 1,
           "wits": ["<witness_prefix>"],
           "adds": [],
           "cuts": []
         }'

Note

This is an example implementation and should be modified according to your specific needs and security requirements.

License

[License information here]