@digitalbazaar/vc 3.0.0 → 4.0.0

package/lib/index.js

@@ -107,6 +107,8 @@ export const dateRegex = new RegExp('^(\\d{4})-(0[1-9]|1[0-2])-' +
  * Other optional params passed to `sign()`:
  * @param {object} [options.documentLoader] - A document loader.
  * @param {object} [options.expansionMap] - An expansion map.
+ * @param {string|Date} [options.now] - A string representing date time in
+ *   ISO 8601 format or an instance of Date. Defaults to current date time.
  *
  * @throws {Error} If missing required properties.
  *
@@ -115,7 +117,8 @@ export const dateRegex = new RegExp('^(\\d{4})-(0[1-9]|1[0-2])-' +
 export async function issue({
   credential, suite, expansionMap,
   purpose = new CredentialIssuancePurpose(),
-  documentLoader = defaultDocumentLoader
+  documentLoader = defaultDocumentLoader,
+  now
 } = {}) {
   // check to make sure the `suite` has required params
   // Note: verificationMethod defaults to publicKey.id, in suite constructor
@@ -137,7 +140,7 @@ export async function issue({
   }
 
   // run common credential checks
-  _checkCredential(credential);
+  _checkCredential({credential, now});
 
   return jsigs.sign(credential, {purpose, documentLoader, suite, expansionMap});
 }
@@ -179,6 +182,8 @@ export async function issue({
  * @param {Function} [options.documentLoader] - A document loader.
  * @param {Function} [options.checkStatus] - Optional function for checking
  *   credential status if `credentialStatus` is present on the credential.
+ * @param {string|Date} [options.now] - A string representing date time in
+ *   ISO 8601 format or an instance of Date. Defaults to current date time.
  *
  * @returns {Promise<VerifyPresentationResult>} The verification result.
  */
@@ -222,6 +227,8 @@ export async function verify(options = {}) {
  * @param {Function} [options.documentLoader] - A document loader.
  * @param {Function} [options.checkStatus] - Optional function for checking
  *   credential status if `credentialStatus` is present on the credential.
+ * @param {string|Date} [options.now] - A string representing date time in
+ *   ISO 8601 format or an instance of Date. Defaults to current date time.
  *
  * @returns {Promise<VerifyCredentialResult>} The verification result.
  */
@@ -251,6 +258,8 @@ export async function verifyCredential(options = {}) {
  * @param {object} options.credential - Verifiable credential.
  * @param {LinkedDataSignature|LinkedDataSignature[]} options.suite - See the
  *   definition in the `verify()` docstring, for this param.
+ * @param {string|Date} [options.now] - A string representing date time in
+ *   ISO 8601 format or an instance of Date. Defaults to current date time.
  *
  * @throws {Error} If required parameters are missing (in `_checkCredential`).
  *
@@ -262,10 +271,10 @@ export async function verifyCredential(options = {}) {
  * @returns {Promise<VerifyCredentialResult>} The verification result.
  */
 async function _verifyCredential(options = {}) {
-  const {credential, checkStatus} = options;
+  const {credential, checkStatus, now} = options;
 
   // run common credential checks
-  _checkCredential(credential);
+  _checkCredential({credential, now});
 
   // if credential status is provided, a `checkStatus` function must be given
   if(credential.credentialStatus && typeof options.checkStatus !== 'function') {
@@ -307,6 +316,8 @@ async function _verifyCredential(options = {}) {
  *   verifiable credential.
  * @param {string} [options.id] - Optional VP id.
  * @param {string} [options.holder] - Optional presentation holder url.
+ * @param {string|Date} [options.now] - A string representing date time in
+ *   ISO 8601 format or an instance of Date. Defaults to current date time.
  *
  * @throws {TypeError} If verifiableCredential param is missing.
  * @throws {Error} If the credential (or the presentation params) are missing
@@ -315,7 +326,9 @@ async function _verifyCredential(options = {}) {
  * @returns {Presentation} The credential wrapped inside of a
  *   VerifiablePresentation.
  */
-export function createPresentation({verifiableCredential, id, holder} = {}) {
+export function createPresentation({
+  verifiableCredential, id, holder, now
+} = {}) {
   const presentation = {
     '@context': [CREDENTIALS_CONTEXT_V1_URL],
     type: ['VerifiablePresentation']
@@ -324,7 +337,7 @@ export function createPresentation({verifiableCredential, id, holder} = {}) {
     const credentials = [].concat(verifiableCredential);
     // ensure all credentials are valid
     for(const credential of credentials) {
-      _checkCredential(credential);
+      _checkCredential({credential, now});
     }
     presentation.verifiableCredential = credentials;
   }
@@ -405,6 +418,8 @@ export async function signPresentation(options = {}) {
  * @param {Function} [options.documentLoader] - A document loader.
  * @param {Function} [options.checkStatus] - Optional function for checking
  *   credential status if `credentialStatus` is present on the credential.
+ * @param {string|Date} [options.now] - A string representing date time in
+ *   ISO 8601 format or an instance of Date. Defaults to current date time.
  *
  * @throws {Error} If presentation is missing required params.
  *
@@ -487,6 +502,7 @@ function _getId(obj) {
 // export for testing
 /**
  * @param {object} presentation - An object that could be a presentation.
+ *
  * @throws {Error}
  * @private
  */
@@ -512,11 +528,19 @@ export function _checkPresentation(presentation) {
 
 // export for testing
 /**
- * @param {object} credential - An object that could be a VerifiableCredential.
+ * @param {object} options - The options.
+ * @param {object} options.credential - An object that could be a
+ *   VerifiableCredential.
+ * @param {string|Date} [options.now] - A string representing date time in
+ *   ISO 8601 format or an instance of Date. Defaults to current date time.
+ *
  * @throws {Error}
  * @private
  */
-export function _checkCredential(credential) {
+export function _checkCredential({credential, now = new Date()}) {
+  if(typeof now === 'string') {
+    now = new Date(now);
+  }
   // ensure first context is 'https://www.w3.org/2018/credentials/v1'
   if(credential['@context'][0] !== CREDENTIALS_CONTEXT_V1_URL) {
     throw new Error(
@@ -559,9 +583,16 @@ export function _checkCredential(credential) {
   }
 
   if('issuanceDate' in credential) {
-    if(!dateRegex.test(credential.issuanceDate)) {
+    let {issuanceDate} = credential;
+    if(!dateRegex.test(issuanceDate)) {
+      throw new Error(`"issuanceDate" must be a valid date: ${issuanceDate}`);
+    }
+    // check if `now` is before `issuanceDate`
+    issuanceDate = new Date(issuanceDate);
+    if(now < issuanceDate) {
       throw new Error(
-        `"issuanceDate" must be a valid date: ${credential.issuanceDate}`);
+        `The current date time (${now.toISOString()}) is before the ` +
+        `"issuanceDate" (${issuanceDate.toISOString()}).`);
     }
   }
 
@@ -596,11 +627,17 @@ export function _checkCredential(credential) {
     }
   });
 
-  // check expires is a date
-  if('expirationDate' in credential &&
-      !dateRegex.test(credential.expirationDate)) {
-    throw new Error(
-      `"expirationDate" must be a valid date: ${credential.expirationDate}`);
+  if('expirationDate' in credential) {
+    const {expirationDate} = credential;
+    // check if `expirationDate` property is a date
+    if(!dateRegex.test(expirationDate)) {
+      throw new Error(
+        `"expirationDate" must be a valid date: ${expirationDate}`);
+    }
+    // check if `now` is after `expirationDate`
+    if(now > new Date(expirationDate)) {
+      throw new Error('Credential has expired.');
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalbazaar/vc",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Verifiable Credentials JavaScript library.",
   "homepage": "https://github.com/digitalbazaar/vc-js",
   "author": {