nhs-credential-manager-prescription-signing v1.0.4

NHS Credential Manager Prescription Signing (NCMPS)

This is a library to integrate with a locally running NHS Credential Management to sign prescriptions

Installation

As NCMPS is hosted in NPM, a simple npm install nhs-credential-manager-prescription-signing will add this to your project. Alternatively checkout this repo and run npm run build and copy the generated dist directory into your project.

Usage

All interactions come through the signPrescription method. Simply pass in your input JSON Base64 encoded.

import {signPrescription} from "nhs-credential-manager-prescription-signing";
import {Base64} from "js-base64";

function doSigning() {
    // get your JSON
    let json = {
        algorithm: "RS1",
        requestType: 1,
        version: 1,
        flags: 0,
        payloads: [
            {
                id: "123",
                payload: "Some Payload"
            }
        ]
    };
    signPrescription(Base64.encode(JSON.stringify(json)))
        .then((response: HubResponse) => {
            // do something with the response
        })
        .error(error => {
            // handle errors
        });
}

or alternatively

import {signPrescription, HubResponse} from "nhs-credential-manager-prescription-signing";

async function doSigning() {
    // get your JSON
    let json = {
        algorithm: "RS1",
        requestType: 1,
        version: 1,
        flags: 0,
        payloads: [
            {
                id: "123",
                payload: "Some Payload"
            }
        ]
    };
    let response: HubResponse = await signPrescription(Base64.encode(JSON.stringify(json)));
}

The response will be in the below format:

{
  "certificate": "certificate",
  "failed_signatures": [],
  "message": "message",
  "signatures": [
    {
      "id": "id",
      "signature": "signature"
    }
  ],
  "status_code": 0,
  "status_string": "status_string",
  "timestamp": "timestamp"
}

Examples

A Next.js example project is available in examples/react-example-webapp. This provides a simple input field to paste either a payload, unecoded json or encoded json and a button to sign. Any errors will be shown should the process fail. Feel free to use this to verify your CMS & Port Service installation. (Though the dev MSI of CMS will be required in order for it to allow connections from localhost)

Running

From within the examples/react-example-webapp directory run npm install followed by npm run dev

Troubleshooting

Please also check the Credential Management documentation if you are still having issues connecting.

Git Secrets Scanning

This repo is scanned for secrets once a day on github.

• Exclusions are contained in the file .gitallowed and includes false positives and well known details like public DNS servers
• To run your own secret scan before you commit simply run docker build -f ./git-secrets/Dockerfile . in the root of this repo
• It is planned to enforce secret scanning with rollback on push to GitHub in the future