README

Information

This library is a tool to assist in the conversion of Multibase/Multicodec strings and did:key method spec keys to JWK, and vice versa. It utilizes Multibase/Multicodec, Simplito-EC, and JWT Framework to aid in these conversions.

For more information on the did:key spec, please read the current unofficial draft here.

Currently, this libary only supports the following curves:

• secp256k1
• nistp384

OpenSSL and Windows

In order for key generation to work on Windows machines, this Installation documentation must be done correctly, specifically regarding openssl.cnf.

How It Works

• Public JWK Generation
  • Generating a Public Key
• Multibase Conversion
  • Converting a Multibase Key to a Public JWK
• did:key Conversion
  • Converting a did:key to a Public JWK
• Public JWK Conversion
  • Converting a Public JWK to a Multibase Key
  • Converting a Public JWK to a did:key

Requirements

• >= PHP 8.1
• composer
• ext-gmp

Installation

You can install this library via Composer :

composer require public-square/jwk-multibase-key-converter-php

Contribute

Please open a pull request.

License

This software is release under MIT license.