MDIP v0.5-beta

MDIP v0.5-beta is now available. Visit our website at keychain.org for details.

THIS RELEASE IS BETA SOFTWARE

This open-source software is provided as-is with no guarantees. It is only to be used for non-production research and development purposes. Thank you for visiting our repository. Discussions and Issues are welcome.

Release 0.5-beta introduces encrypted wallets, sqlite and mongodb database support, a python pip package for keymaster, encrypted message send and receive in the web wallet, numerous performance improvements, credential issuance improvements from user feedback, and more.

What's Changed

• fix: satoshi-mediator startup improvements by @macterra in #434
• refactor: issueCredential by @macterra in #438
• fix: Added exception handling to ipfs-mediator by @macterra in #439
• fix: Node sync with mongodb by @macterra in #442
• fix: Node sync with sqlite by @macterra in #445
• refactor: Error classes by @macterra in #446
• refactor: Add utils to mdip/common by @macterra in #452
• feat: Added includeHash option to encryptMessage by @macterra in #450
• feat: Added messages tab to web wallet by @macterra in #454
• fix: Reset corrupted json db files by @macterra in #458
• fix: Prevent hyperswarm gossip storm by @macterra in #459
• refactor: Remove event caching from gatekeeper by @macterra in #461
• feat: Add optional encrypted JSON wallet by @Bushstar in #462
• chore: point to dockerhub for bitcoin-core by @Edgeman-SelfID in #468
• feat: Re-enable hash check on operations by @macterra in #463
• feat: Added encrypted wallet support to services by @macterra in #474
• feat: refactor wallet to use decorator pattern for optional encryption by @Bushstar in #479
• feat: Python pip keymaster-sdk package by @Bushstar in #469
• fix: update api and mediator to set wallet when using encryption by @Bushstar in #482
• feat: Added wallet cache by @macterra in #477
• fix: gatekeeper.start() handles multiple calls by @macterra in #485
• docs: Added CONTRIBUTING.md by @macterra in #487
• feat: Added KC_MDIP_PROTOCOL to config by @macterra in #489
• fix: Confirmation delay on hyperswarm registry by @macterra in #490
• feat: Added gatekeeper status by @macterra in #491
• feat: Added db and versions to status by @macterra in #497
• feat: encrypt web wallet by @Bushstar in #483
• feat: Added gatekeeper status interval to config by @macterra in #500
• chore: Updated package versions and protocol by @macterra in #501
• docs: deployment guide 1 by @Flaxscrip in #395
• fix: Report status for empty db by @macterra in #503

New Contributors

• @Bushstar made their first contribution in #462

Full Changelog: v0.4.1-beta...v0.5-beta

MDIP v0.4.1-beta

MDIP v0.4.1-beta is now available. Visit our website at keychain.org for details.

THIS RELEASE IS BETA SOFTWARE

This open-source software is provided as-is with no guarantees. It is only to be used for non-production research and development purposes. Thank you for visiting our repository. Discussions and Issues are welcome.

This minor update addresses issues in the satoshi-mediator (#424) and the hyperswarm-mediator (#365). Client software that use the gatekeeper or keymaster npm packages must upgrade to v0.4.1 to work with the v0.4.1 services respectively.

What's Changed

• refactor: gatekeeper gc service by @macterra in #416
• refactor: Upgrade groups by @macterra in #419
• refactor: Upgrade schemas by @macterra in #421
• refactor: Upgrade polls by @macterra in #422
• refactor: Update batches by @macterra in #425
• fix: hyperswarm-mediator limit msg size by @macterra in #428

Full Changelog: v0.4-beta...v0.4.1-beta

MDIP v0.4-beta

MDIP v0.4-beta is now available. Visit our website at keychain.org for details.

THIS RELEASE IS BETA SOFTWARE

This open-source software is provided as-is with no guarantees. It is only to be used for non-production research and development purposes. Thank you for visiting our repository. Discussions and Issues are welcome.

Release 0.4-beta introduces IPFS document storage support, redis database support, npm packages, numerous performance improvements, challenge/response improvements from user feedback, and more.

What's Changed

• fix: Handle and log bad messages in hyperswarm-mediator by @macterra in #343
• fix: response DIDs should be ephemeral by @macterra in #340
• refactor: Renamed main service files by @macterra in #357
• refactor: Simplify start functions by @macterra in #359
• chore: Deprecate TESS blockchain support by @macterra in #362
• fix: Return 404 on DID not found by @macterra in #363
• refactor: improve consistency of Keymaster API by @macterra in #366
• ci: replace trivy with anchore by @Edgeman-SelfID in #367
• fix: Handle invalid DIDs on import by @macterra in #375
• test: add expect cli tests by @Edgeman-SelfID in #379
• feat: Add redis support for gatekeeper by @macterra in #369
• fix: DID not found error message by @macterra in #386
• fix: improve verifyDb by @macterra in #388
• refactor: createChallenge by @macterra in #392
• refactor: processEvents by @macterra in #394
• fix: Make Feathercoin node work on MacOS by @macterra in #401
• chore: point to dockerhub registry vs ghcr registry by @Edgeman-SelfID in #402
• fix: Improve batch import tracking by @macterra in #405
• refactor: Replaced json-schema-faker dependency by @macterra in #408
• feat: Adds IPFS package and service by @macterra in #398
• chore: Updated package versions by @macterra in #411
• chore: Updated node version to 18.18.2 by @macterra in #413
• fix: Specify platform for docker on mac by @macterra in #414

Full Changelog: v0.3-beta...v0.4-beta

MDIP v0.3-beta

MDIP Fall 2024 v0.3-beta is now available. Visit our website at keychain.org for details.

THIS RELEASE IS BETA SOFTWARE

This open-source software is provided as-is with no guarantees. It is only to be used for non-production research and development purposes. Thank you for visiting our repository. Discussions and Issues are welcome.

Our Fall Beta release introduces numerous new features, new interfaces, and support for new P2P processes like mdip authentication.

• Multi-Registry Satoshi Mediator - Support for Testnet BTC and FTC with more to come.
• MDIP Keymaster Interfaces - WebUI, OpenAPI, CLI, NodeJS SDK, and npm library
• Keys, Wallet, and Identity Management - Identity and keys portability across user devices
• MDIP Authentication w/QR Support - Challenge/response process with embeded callback URL (easier than OAuth)
• Peer-to-Peer Challenge/Response Support - Includes credentials and issuer verification
• Improved Repository Structure, Containerization, and system Documentation

What's Changed

• Prevent duplicate names by @macterra in #209
• Add separate docker build and improve start-node to fail on error by @Edgeman-SelfID in #213
• Added params to getDIDs by @macterra in #212
• Added wallet check/fix by @macterra in #217
• Refactor docker build push by @Edgeman-SelfID in #214
• Refactors resolveDID parameters by @macterra in #218
• fix: Fixed backup-wallet for CLI by @macterra in #221
• feat: Add registry dropdowns to create assets by @macterra in #223
• Added cache for confirmed doc versions by @macterra in #227
• Documentation Restructure & Web UI Docs by @alexfornuto in #215
• link cleanup by @alexfornuto in #231
• Changed verify semantics in resolveDID by @macterra in #235
• Added cache for unconfirmed versions by @macterra in #239
• Added names to wallet check and fix by @macterra in #240
• fix: docker publish needs a tag by @Edgeman-SelfID in #241
• feat: Add ephemeral to challenge and response by @macterra in #243
• fix: logging in hyperswarm gc by @macterra in #245
• chore: Moved source files into src folder by @macterra in #247
• chore: extend eslint for react-app and other policies by @Edgeman-SelfID in #248
• refactor: Made DID lists scrollable by @macterra in #250
• chore: activate container scanning by @Edgeman-SelfID in #251
• docs: Updated README by @macterra in #249
• refactor: Fixed sonarjs lint warnings by @macterra in #254
• refactor: Updating keymaster route names by @howitworks18 in #252
• feat: Use only confirmed keys by @macterra in #257
• chore: Update kc-app to use standard SDK by @macterra in #260
• Refactored exceptions by @macterra in #263
• fix: only run scan for release tag when releasing by @Edgeman-SelfID in #264
• fix: ignore critical errors for now by @Edgeman-SelfID in #265
• refactor: Improve db sync performance by @macterra in #266
• refactor: gatekeeper endpoints by @macterra in #268
• feat: Adds supported registries configuration by @macterra in #272
• fix: Clear queue before relaying msg by @macterra in #273
• fix: DID import/export by @macterra in #274
• fix: Updated CLI docs by @macterra in #277
• fix: Recover wallet by @macterra in #280
• Added sat-mediator by @macterra in #278
• feat: Add Feathercoin testnet (TFTC) support by @macterra in #283
• feat: Adds testnet nodes by @macterra in #286
• feat: Added registration info to confirmed versions by @macterra in #288
• Matt/updated response handling by @howitworks18 in #261
• Matt/route names feedback update by @howitworks18 in #292
• Add installaton steps to quickstart page by @alexfornuto in #297
• adds API source JSON and redoc page by @alexfornuto in #295
• DOC: add experimental warnings by @alexfornuto in #302
• feat: Added responder DID to verifyResponse return values by @macterra in #304
• remove ToC block from API page by @alexfornuto in #305
• DOCS: add challenge did to verify-response example by @alexfornuto in #301
• feat: Added updateCredential by @macterra in #308
• fix: docker permissions by @macterra in #311
• refactor: Consolidated docker compose files by @macterra in #313
• DOCS: document recovery without explicit DID by @alexfornuto in #314
• Adds WebUI support for QR code URL and parameters by @Flaxscrip in #316
• Updated /response/verify by @macterra in #321
• feat: Added npm packages by @macterra in #323
• feat: publish @mdip packages by @macterra in #327
• feat: Sync wallet apps by @macterra in #328
• chore: Removed deprecated explorer route by @macterra in #329
• feat: Added retries to create/verifyResponse by @macterra in #333
• Update README.md by @Flaxscrip in #332
• Update README.md by @Flaxscrip in #331
• chore: Updated to v0.3.0 by @macterra in #337

New Contributors

• @howitworks18 made their first contribution in #252

Full Changelog: v0.2-alpha...v0.3-beta

v0.2-alpha

MDIP Summer 2024 v0.2-alpha release is now available. Visit our website at keychain.org for details.

THIS RELEASE IS ALPHA SOFTWARE

Note: This open-source software is provided as-is with no guarantees. It is only to be used for non-production research and development purposes. Thank you for visiting our repository. Discussions and Issues are welcome.

This release include refactoring of most components of the protocol as well as numerous node syncing improvements. In addition, the release introduces the following major new capabilities:

• Browser-side Keymaster Wallet
• Multi-Featured Keymaster WebUI
• MDIP Keymaster API Server
• TESS blockchain mediator registry
• MDIP Challenge/response verification
• Polling and ballot voting functions
• Hierarchical DID groups

See below for additional changes and improvements.

What's Changed

• Added node name by @macterra in #67
• Adds eslint to continuous integration by @macterra in #68
• Adds /ready endpoint to gatekeeper service by @macterra in #79
• prepare source content for Docusaurus... by @alexfornuto in #78
• Fix for unpublish-credential failing silently by @macterra in #89
• Init CLI User Manual as Documentation Section by @alexfornuto in #86
• Refactor gatekeeper persistence by @macterra in #81
• Remove unused dependencies by @macterra in #92
• Added admin script by @macterra in #95
• Adds support for voting by @macterra in #96
• Document Voting by @alexfornuto in #98
• Support groups within groups by @macterra in #100
• Add TESS mediator by @macterra in #97
• Refactored wallet backup and recovery by @macterra in #104
• Verify response against challenge by @macterra in #125
• Added btc-mediator by @macterra in #131
• Refactored start/stop scripts by @macterra in #138
• Keymaster UI Demo by @macterra in #137
• Disabled BTC support by @macterra in #142
• Backup selected ID by @macterra in #144
• Changed DID prefix to did:test by @macterra in #145
• Keymaster API pt 2 (names and groups) by @macterra in #146
• enables parallel keymasters on individual ports by @Flaxscrip in #150
• Added schemas and credentials to Keymaster API by @macterra in #154
• Improve syncing by @macterra in #161
• Add keymaster to packages by @macterra in #167
• Add hyperswarm DID garbage collection by @macterra in #168
• Stop registering create events on the DID's registry by @macterra in #172
• Switch default registry to TESS by @macterra in #171
• Avoid duplicate batches by @macterra in #173
• Fix for local DIDs by @macterra in #176
• Handle no-ops in groupAdd and groupRemove by @macterra in #178
• Refactored updateDID and revokeDID by @macterra in #179
• Added keymaster-app (browser wallet) by @macterra in #180
• Fix for confirmed versions by @macterra in #188
• Add wallet features to keymaster UI by @macterra in #189
• Switch to use id on select by @macterra in #190
• Improve hyperswarm syncing by @macterra in #191
• Hyperswarm mediator removes stale connections by @macterra in #194
• Adds TESS address to insufficient funds warning by @macterra in #196
• Added credential pub features to web UI by @macterra in #197
• Activate code coverage reporting by @Edgeman-SelfID in #199
• Add coverall badge in README for coverage status by @Edgeman-SelfID in #200
• Add issued credentials to web UI by @macterra in #198
• Fix for listIssued by @macterra in #203
• Improve test coverage by @macterra in #205

New Contributors

• @Flaxscrip made their first contribution in #150
• @Edgeman-SelfID made their first contribution in #199

Full Changelog: v0.1-alpha...v0.2-alpha

MDIP Spring 2024 - Experimental Alpha v0.1-alpha

Release Notes

MDIP kc v0.1-alpha is now available. The project site will be be available at: https://keychain.org/

THIS RELEASE IS EXPERIMENTAL ALPHA SOFTWARE

Note: This open-source software is only to be used for non-production research and development purposes.

What's in this Release:

This is the first release of 'kc', the reference implementation of the Multi Dimensional Identity Protocol (MDIP). This experimental software implements all basic functionality needed to operate an MDIP node and to create MDIP-compatible Decentralized Identity (DID) and Verifiable Credential (VC) documents.

The reference implementation provides for DID registration using a Hyperswarm P2P channel. The MDIP protocol itself is registry-agnostic; future releases will provide additional registration networks (eg. Bitcoin and other P2P ledgers).

Major Components Included:

• MDIP DID scheme specification
• Gatekeeper MDIP server
• Keymaster MDIP SDK
• Hyperswarm-mediator registry
• kc command line interface (CLI)
• End-User CLI manual

Other Released Components Included:

• Unit tests
• Docker files
• Workflow demo script
• Bash completion script
• Example credential schemas
• Release script

What's Changed Since Initial Commit

• Hyperswarm p2p support by @macterra in #1
• Renamed new-wallet command to import-wallet by @macterra in #3
• Adds .env support for config by @macterra in #12
• Added mergeBatch by @macterra in #13
• Explore by @macterra in #18
• Improved hyperswarm syncing by @macterra in #27
• Redesigned challenge/response features by @macterra in #31
• Renames txn to operation by @macterra in #35
• Added didDocumentData by @macterra in #37
• Moved gatekeeper port to configuration (default 4224) by @macterra in #39
• Alpha DID format by @macterra in #47
• Fixed workflow demo by @macterra in #53
• Added error handling to CLI by @macterra in #54
• Added DID scheme doc by @macterra in #58
• accept-credential takes optional name by @macterra in #62
• import-wallet will not overwrite wallet by @macterra in #63
• Sort commands in help by @macterra in #64
• Adds CLI user manual by @macterra in #60
• Copy Edit for User Manual by @alexfornuto in #65

New Contributors

• @macterra made their first contribution in #1
• @alexfornuto made their first contribution in #65

Full Changelog: https://github.com/KeychainMDIP/kc/commits/v0.1-alpha