ssi-sdk

module
Version: v0.0.2-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2022 License: Apache-2.0

README

godoc ssi-sdk go version 1.19.2 license Apache 2 issues ssi-sdk-ci status codecov

ssi-sdk

Introduction

Named ssi-sdk, this SDK encapsulates a set of standards related to Self Sovereign Identity. The ssi-sdk intends to provide flexible functionality based on a set of standards-based primitives for building decentralized identity applications in a modular manner: with limited dependencies between components.

ssi-sdk

The image above outlines the SDK's vision. Standards may be added and/or removed. The standards themselves are under active development, and as such, are subject to change. When possible we aim to call out which versions or revisions of standards we are building implementations against.

The SDK has not undergone any formal security review or audit, so please use with caution.

For more information, see the vision document.

Contributing

This project is fully open source, and we welcome contributions! For more information please see CONTRIBUTING. Our current thinking about the development of the library is captured in GitHub Issues.

Specifications

Here are a set of references to specifications that this library currently supports. It is a dynamic set that will change as the library evolves.

signature suites

did methods

Building

This project uses mage, please view CONTRIBUTING for more information.

After installing mage, you can build and test the SDK with the following commands:

mage build
mage test

A utility is provided to run clean, build, and test in sequence with:

mage cbt

Mobile targets can be built with:

// Creates both Android and iOS packages
mage mobile 

// Outputs an .xcframework for the crypto, cryptosuite, did packages
mage ios 

// Outputs a .jar and .aar for the crypto, cryptosuite, did packages 
mage android 

Versioning

For information on versioning refer to our versioning guide.

The latest version is...nothing! No releases have been made.

Examples

A set of code examples can be found in the examples directory. We welcome contributions for additional examples.

To run the examples use the following command

 go run example/did/did.go 
 go run example/usecase/apartment_application/apartment_application.go

Project Resources

Resource Description
VISION Outlines the project vision
VERSIONING Project versioning strategy
CODE_OF_CONDUCT Expected behavior for project contributors, promoting a welcoming environment
CONTRIBUTING Developer guide to build, test, run, access CI, chat, discuss, file issues
GOVERNANCE Project governance
LICENSE Apache License, Version 2.0

Directories

Path Synopsis
Package did DID Peer ------------------------------------------------ https://identity.foundation/peer-did-method-spec/
Package did DID Peer ------------------------------------------------ https://identity.foundation/peer-did-method-spec/
did
A simple application using a did:key.
A simple application using a did:key.
presentation
|------------| |----------------------| |------------| | Verifier | ----> | Presentation Request | -----> | Holder | | | | \Definition | | | |------------| |----------------------| |------------|
|------------| |----------------------| |------------| | Verifier | ----> | Presentation Request | -----> | Holder | | | | \Definition | | | |------------| |----------------------| |------------|
vc
This is a simple application which creates a Verifiable Credential.
This is a simple application which creates a Verifiable Credential.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL