Skip to content

Latest commit

 

History

History
262 lines (169 loc) · 11.3 KB

README.md

File metadata and controls

262 lines (169 loc) · 11.3 KB
Raw

OpenAttestation (Encryption)

To share and store documents safely, encrypt the documents with the OpenAttestation (Encryption) repository. It is the codebase for the npm module. This module does not provide the following functionalities:

  • Programmatic wrapping of OA documents (refer to OpenAttestation)

  • Programmatic verification of OA documents (refer to OpenAttestation (Verify))

  • Programmatic issuance/revocation of document on the Ethereum blockchain

This library is used for encrypting OpenAttestation files when they are being transferred.

Installation

To install OpenAttestation (Encryption) on your local machine, run the command below:

npm i @govtechsg/oa-encryption

Usage

This section shows you how to use OpenAttestation (Encryption) to encrypt or decrypt a document.

Encrypting a document

The following shows a code example which will encrypt a document.

Note: When you run it, be sure to use different values.

const { encryptString } = require("@govtechsg/oa-encryption");

const document = {
  version: "https://schema.openattestation.com/2.0/schema.json",
  data: {
    issuers: [
      {
        documentStore: "5924d910-8916-446a-b1c3-55e2f86dd8f3:string:0xabcdabcdabcdabcdabcdabcdabcdabcdabcdabcd",
        name: "0f737b20-9e5e-4ec4-bffd-c63002616bfd:string:University of Blockchain",
        identityProof: {
          type: "5fc379dd-cd24-4c91-a4c7-cf76f9c96d8d:string:DNS-TXT",
          location: "62e1c6c3-09a9-4e52-aaf6-9daf24d43657:string:example.com",
        },
      },
    ],
  },
  privacy: { obfuscatedData: [] },
  signature: {
    type: "SHA3MerkleProof",
    targetHash: "956e27c86d4893a971600d328e235ede886f1c00b183257a822667b69886fced",
    proof: [],
    merkleRoot: "956e27c86d4893a971600d328e235ede886f1c00b183257a822667b69886fced",
  },
};

const encryptedDocument = encryptString(JSON.stringify(document));
console.log(encryptedDocument);

It will display a response that looks like:

{
  cipherText:
   'S7jca6lGDvN3ZDsPX4xc+6zLCkvRN1b1g6b0LL/IHiWn9c4JmIdmfg7fMd98fehkPMlkvScYn1/XI9ZoYA6NRjf61Kpam2A0Dx7kBR866TW+Stzbbb4AAqoXm0GX3BBvPgjhQCoGS9vJBkD0coK+DCO0Vrcdptuo2io3/zbBD6GbE5zLhnqizLrLO+RffnCeJ6LFYSUbAwBvSJv+OnNJjf+99ejaT3zKZNLB+NSu1WNG23nyzJoeYgEqg/E7i5jhD5+pZ8FvGsVQ2hM4zrnw5CvC8AfnRkR5KUEpJ4A0XJly3gQnCBN2HtIEHRmxBgPOnM2Mcm/mNVct2tqogrfyksXrLqS2YvYAEP9uGmSu3/iP2aTzS5xqiBg0UedFVQcc3cEjzaI4lXWa5t+cjzS08pssN2lT55WHsLo/XqVSTMx4/nekDl1SVm6wpfHl2htvhxvGiUF9F1tS7VpoE/+OMS7fCPkncmPKMpuUmWN79KhZS+/R0wM1sB7+HYTulYIZ3Z/vxX1YuNFSR0V6lCsVavl4tV9IhA9PvQPvmKDSyJyrD+v4AUrtEgnvyEPttfHW2MqJGGK6w9sUB3It2OvHQVXmAtVJgqpuP6cZwMlswQWfJfcjkfxWnQGCJtsCXhc7qePwxuL3C74QTFkKQcrGLGoMNcSTV5xhPxtg7zBocVs689RJkbjirhBOJajlY4NwplFga7qgyNA6yYI2BamX4fRaMq1XEuYRo8+d2kiJXSQSTEaUNQuIIsO3Nd+u8p/Dapw0xZBeyqj1Ys1N4aPFlx26OigiabXpwQNxH+ioaceU4LUsjCmF+MsPuxi3L0HLIsnvqy1LgffOswih+hqaqjHdpOMlpLcwQziD47HSOmW83jPezEEaWwiSH5eYYy4JwgsatCc+hCJEB8A8PXG1aSdRTRg+nqZQlJ4ONs+C55Svdj+6K+mdtK21qpQBIOOZjxMztubv/0/BETbPp8HDtaZdS80uLwXSNWAaf2dnbaNQkAW3idHYTgi8375FRr63/TUIeoo9Wh4YHTyjlEay/+CBokN0zREGQMaXKS/TEGxsdOIjsJjR8URyPBVFIhHNXcN1RQnxcD0WU+JvsheaoFLs/x1ITc7E',
  iv: 'TG47WMwppeS9oICk',
  tag: 'Iox0laR51y8czUw8Yx6mGQ==',
  key:
   '04d49fe8ac0a0afa5e9e2fa617551b5d7be532d0c8586a0809d7d223316d7cc5',
  type: 'OPEN-ATTESTATION-TYPE-1'
}

You can extract the key from the encrypted document and store the rest of the document anywhere.

Decrypting a document

To decrypt the document, you will need to provide the key. That makes your document content safe.

The following shows a code example which will decrypt a document that was encrypted.

Note: When you run it, be sure to use different values.

const { decryptString } = require("@govtechsg/oa-encryption");

const encryptedDocument = {
  cipherText:
    "H/smVRcwLrv7KzeMtHVYAxouaO+aaEm1jxXMw5fvHJSj3dszKK76ap17rPSa/JpiNEMXFn5pCBqnmfbveuRhjHcxKvKVSyMlbh6R+zFoge0VPwP6KDsKat/39FQddfXbbaoDz+B1vFoTc2hWFQw/IEd5DQIbj08hZiZ14A6xPfutbIiR0y5DnWQjRPWi/tPoE7aSuImWa6gr5MlJSUDcEoJ7HSqSxUS29UCn3F8WWLkaM98XYQrBDdqaKXGoG6yFyLpJkyOpdXq17qhhj5/2CNPqxZIBqIgLeVw1uUvS9XAm8QivMdtmNvTQEl1vmBALVif8FbQGuQGNnRycLo4rJpCu745qtyt9fkCblZ6aGPTt4Ghf/XtW4/dwXDJYqKotl45aY8O06/z6beWh0YOgq6qYKXdW2KscprMPtFMnoK7brKej631/NX9o7a0L83lQXQ1lL+k4JCbrQ/ZpWe3VwE8rIVd1OdVhAHDKOcAGR2n/GY1kfZ+yRjvkIuylti/bGTCl3DzBdwCi4F8ulh2uypsH1mplO+/Of1zpH/UOMLnmEOPg/ENrGZSWJSYpi/We3jVirE4rH+pXLqGLNxczS9hintWFvoV2mVFw8CqmRfakGcrEq2E5PzImBViUDZ/AUxawHtxJxKyCl9yEo/my8Mu9PFpuxQW3BryVmW1X7zCJL0DoqkoaH9hwlP2FS/cWjqiPwOSTjp+DkIuxjjnOYTcLskwEJNBpjXckvzUoz/wZ7W8gOc5cnxvY269+fEmUrsxWHcNbMu3EEFFm02EE66p9sFVQZcZqOP2Z0lINuvTh10r9fuDYDSp/u2YruZbeqJVOPHeC+5yoha8FqvmDtZ3iZcexu0X6d03Ay0xiVeIQ39+SwWs2eHspFC5FvygFJDnS4N84fuyg6E6rxpc9CUfW4YC5lyiqZfKdFHCUZ1+p8BdP0F0wMBdQmuMw1VS/CVmjW9c9P3gGAKtr5wN6XdXJY/uICdDW0RukV9JNfsdfOk0XLEqwBTbvaoRGYXoRy9Jk3KOz3xxRcWn2PwZbuf0CaZQIPJJTmU5KUBFhnFxyOZCCP6JPuHamv7ZTU5kO1b2/gZRTO9Y6RLpAFq64uFrKjzXrZWSZ",
  iv: "WK7OMSRG5ODxonBO",
  tag: "pXV7QvmTRA00OkL510pSvw==",
  key: "46b1f4f0b53e5a5b92dd8e7c9a53826a41a03d9333a501ebeb1710fcd2741420",
  type: "OPEN-ATTESTATION-TYPE-1",
};
const decryptedDocument = decryptString(encryptedDocument);
console.log(JSON.parse(decryptedDocument));

You will be able to retrieve your document content.

Important: Remember to put back the key in the object passed to the decryptString function, because the key was separated from the encrypted document previously.

API

Table of Contents

ENCRYPTION_PARAMETERS

To learn more about the default options from responses, see this StackExchange post.

algorithm

The default value of algorithm is "AES-GCM".

keyLength

The default value of keyLength is 256 bits, based on the NIST publication.

ivLength

The default value of ivLength is 96 bits, based on the NIST publication.

tagLength

The default value of tagLength is 128 bits, based on the NIST publication.

version

The default value of version is "OPEN-ATTESTATION-TYPE-1".

generateEncryptionKey

This request generates a random key represented as a hexadecimal string.

Parameters

This request supports the parameter below:

Parameter Name Data Type Necessity Description
keyLengthInBits Number Optional Default ENCRYPTION_PARAMETERS.keyLength

Results

Returns the generated key as a string.

encodeDocument

This request performs encoding on a document.

Parameters

This request supports the parameter below:

Parameter Name Data Type Necessity Description
document String Required Provide a document to encode it

Results

Returns the encoded document as a string.

decodeDocument

This request performs decoding on an encoded document.

Parameters

This request supports the parameter below:

Parameter Name Data Type Necessity Description
encoded String Required Provide an encoded document to decode it

Results

Returns the decoded document as a string.

encryptString

This request encrypts a given string with symmetric AES.

Parameters

This request supports the parameters below:

Parameter Name Data Type Necessity Description
document String Required Input a string to encrypt it
key String Optional Input an encryption key

Results

Returns an IEncryptionResults object which contains the encrypted string.

decryptString

This request decrypts a given ciphertext and its associated variables.

Parameters

This request supports the parameter below:

Property Name Data Type Necessity Description
object IEncryptionResults Required IEncryptionResults object with the corresponding values

Results

Returns the decrypted string.

IEncryptionResults

IEncryptionResults is an interface. It is the result returned by encryptString and the input expected by decryptString.

Properties

This interface has the following properties:

Property Name Data Type Necessity Description
cipherText String Required Cipher text base64 encoded
iv String Required IV base64 encoded
tag String Required AES authentication tag base64 encoded
key String Required Decryption key hexademical encoded
type String Required Encryption algorithm identifier

Additional information

If you find a bug, have a question, or want to share an idea, reach us at our Github repository.