service-profile-tool

Service profile tool is a tool that supports the Service Profile Specification at ToIP.

This is an educational tool. It is NOT meant for production.

Features

CLI

• Profile Schema Validation
• DID Resolution w/ Profile Support
• Referencing Tool
• Signature Validation
• Profile Generation

API

over http

• /POST Profile
• /GET Profiles/Profiles
• Reference Profile
• Resolve DID
• Validate Profile
• Indexing Service / Profile Search

Web UI

The focus will be on the CLI to begin with. Eventually, we'll put up a front end for it. A starting point has been made in the bin directory.

• Profile Schema Validation
• DID Resolution w/ Profile Support
• Profile Reference
• Profile Hosting Service
• Indexing Service / Profile Search
• Signature Validation
• Profile Validation
• Profile Generation

Outputs

• CLI tool located at ./dist/bin/cli
• Service APIs ( run yarn:serve to us )
• Website here

Build

To build:

yarn build

Run

CLI Tool

yarn commands run against the builds in the ./bin folder

Help

yarn cli --help

Validate

Validate schema for a Service Profile

yarn cli --validate -url <path-to-url>

Verify

Verify Service Profile Over Cryptographic Proof

yarn cli --verify -url <path-to-url>

Resolve

Resolve a DID's Service Profile

yarn cli resolve <did>

Reference

Reference a Remote Service Profile

yarn cli reference <url>

Screenshots

Web UI

CLI

Code Structure

All code is in the src directory.

• lib is for library tools
• bin are entry points/executables
• schemas are schemas

Dependencies

The service uses the universolver to resolve DID's. Thank you to DIF and the WG ID team for hosting the tool.