mcsherrylabs / iron-verifiable-credentials

A Verifiable Credentials Processor & API

Iron Verifiable Credentials Processor

An implementation of the Verifiable Credentials model and processing in Java.

Features

• Verifying VC/VP
• Issuing VC/VP
• Signature Suites
  • Ed25519Signature2020
  • Have you implemented a signature provider? List it here, open PR.
• VC HTTP API & Service

Installation

Maven

<!-- Java 17 -->
<dependency>
    <groupId>com.apicatalog</groupId>
    <artifactId>iron-verifiable-credentials</artifactId>
    <version>0.8.1</version>
</dependency>

or

<!-- Android 12 or higher (API Level >=31) -->
<dependency>
    <groupId>com.apicatalog</groupId>
    <artifactId>iron-verifiable-credentials-jre8</artifactId>
    <version>0.8.1</version>
</dependency>

Gradle

compile group: 'com.apicatalog', name: 'iron-verifiable-credentials-jre8', version: '0.8.1'

Documentation

Usage

Please use together with a cryptosuite(s) of your choice, e.g. Ed25519Signature2020. Read the suite(s) documentation for specifics.

Verifying

try {
  Vc.verify(credential|presentation, suites)
      
    // optional
    .base(...)
    .loader(documentLoader) 
    .statusVerifier(...)
    .useBundledContexts(true|false)

    // custom | suite specific | parameters
    .param(..., ....)

    // assert document validity
    .isValid();
    
} catch (VerificationError | DataError e) {
  ...
}

Issuing

// proof options
var options = suite.createOptions()...;

Vc.sign(credential|presentation, keys, options)

   // optional
   .base(...)
   .loader(documentLoader) 
   .statusVerifier(...)
   .useBundledContexts(true|false)

   // return signed document in a compacted form
   .getCompacted(context);

Contributing

All PR's welcome!

Building

Fork and clone the project repository.

Java 17

> cd iron-verfiable-credentials
> mvn clean package

Java 8

> cd iron-verfiable-credentials
> mvn -f pom_jre8.xml clean package

Resources

• Verifiable Credentials Data Model v1.1
• Verifiable Credentials Use Cases
• Verifiable Credentials Implementation Guidelines 1.0
• Data Integrity 1.0
• The did:key Method v0.7
• Decentralized Identifiers (DIDs) v1.0

Sponsors

Commercial Support

Commercial support is available at [e-mail]