npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@shareandcharge/ocn-notary

v1.0.0

Published

Library for signing requests and verifying signatures on the Open Charging Network

Downloads

189

Readme

OCN Notary JavaScript Package

This readme contains specific information pertaining to the JavaScript package of the Open Charging Network Notary, including: how to test, build, publish, install and use.

This package is written in TypeScript to provide type definitions for developers.

Install

npm install @shareandcharge/ocn-notary

Usage

Signing a request:

First, create a request object containing the headers, url-encoded parameters and body of the OCPI request.

const Notary = require("@sharecharge/ocn-notary")

const request = {
    headers: {
        "X-Correlation-ID": "123"
        ...
    },
    body: {
        "id": "LOC1",
        ...
    }
}

Next, instantiate an empty notary object and sign the request with your Ethereum private key.

const notary = new Notary()
await notary.sign(request, privateKey)

The OCN-Signature is a base64-encoded, JSON serialized string of the Notary. Retrieving it is possible with the Notary's serialize method.

const ocnSignature = notary.serialize()
console.log(ocnSignature)
// eyJmaWVsZHMiOlsiJFsnaGVhZGVycyddWyd4LWNvcnJlbGF0aW9uLWlkJ10iLCIkWydoZWFkZXJzJ11bJ...

This string should be appended to your headers with the key OCN-Signature before sending a request to the Open Charging Network.

Verifying a request:

In order to verify the request, first deserialize the OCN-Signature header received from a counterparty.

const notary = Notary.deserialize(ocnSignature)

Then, call the verify method on the notary object with the headers, url-encoded parameters and body of the request received (see above for how this looks like).

const isValid = notary.verify(request)
console.log(isValid)
// true

Modifying a request:

It might be the case that an OCN node needs to modify a request before forwarding it to the recipient, such as in the case where the sender has specified a response_url. In order to do this, we can stash the values that will be changed:

const notary = Notary.deserialize(ocnSignature)
notary.stash({
    "$['body']['response_url']": "https://amazing.msp.org/commands/START_SESSION/42"
})

It is important to sign the new request afterwards:

await notary.sign(modifiedRequest, someOtherPrivateKey)

And finally, include the signature in the forwarded request by serializing the notary object:

headers["OCN-Signature"] = notary.serialize()