@0xpolygonid/js-sdk 1.21.1 → 1.23.0

package/dist/node/cjs/iden3comm/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_AUTH_VERIFY_DELAY = exports.DEFAULT_PROOF_VERIFY_DELAY = exports.SUPPORTED_PUBLIC_KEY_TYPES = exports.MediaType = exports.PROTOCOL_MESSAGE_TYPE = void 0;
+exports.DEFAULT_AUTH_VERIFY_DELAY = exports.DEFAULT_PROOF_VERIFY_DELAY = exports.defaultAcceptProfile = exports.AcceptJwsAlgorithms = exports.AcceptJwzAlgorithms = exports.AcceptAuthCircuits = exports.ProtocolVersion = exports.SUPPORTED_PUBLIC_KEY_TYPES = exports.MediaType = exports.PROTOCOL_MESSAGE_TYPE = void 0;
 const IDEN3_PROTOCOL = 'https://iden3-communication.io/';
 /**
  * Constants for Iden3 protocol
@@ -76,5 +76,29 @@ exports.SUPPORTED_PUBLIC_KEY_TYPES = {
         'JsonWebKey2020'
     ]
 };
+var ProtocolVersion;
+(function (ProtocolVersion) {
+    ProtocolVersion["V1"] = "iden3comm/v1";
+})(ProtocolVersion = exports.ProtocolVersion || (exports.ProtocolVersion = {}));
+var AcceptAuthCircuits;
+(function (AcceptAuthCircuits) {
+    AcceptAuthCircuits["AuthV2"] = "authV2";
+    AcceptAuthCircuits["AuthV3"] = "authV3";
+})(AcceptAuthCircuits = exports.AcceptAuthCircuits || (exports.AcceptAuthCircuits = {}));
+var AcceptJwzAlgorithms;
+(function (AcceptJwzAlgorithms) {
+    AcceptJwzAlgorithms["Groth16"] = "groth16";
+})(AcceptJwzAlgorithms = exports.AcceptJwzAlgorithms || (exports.AcceptJwzAlgorithms = {}));
+var AcceptJwsAlgorithms;
+(function (AcceptJwsAlgorithms) {
+    AcceptJwsAlgorithms["ES256K"] = "ES256K";
+    AcceptJwsAlgorithms["ES256KR"] = "ES256K-R";
+})(AcceptJwsAlgorithms = exports.AcceptJwsAlgorithms || (exports.AcceptJwsAlgorithms = {}));
+exports.defaultAcceptProfile = {
+    protocolVersion: ProtocolVersion.V1,
+    env: MediaType.ZKPMessage,
+    circuits: [AcceptAuthCircuits.AuthV2],
+    alg: [AcceptJwzAlgorithms.Groth16]
+};
 exports.DEFAULT_PROOF_VERIFY_DELAY = 1 * 60 * 60 * 1000; // 1 hour
 exports.DEFAULT_AUTH_VERIFY_DELAY = 5 * 60 * 1000; // 5 minutes

package/dist/node/cjs/iden3comm/handlers/auth.js

@@ -33,15 +33,17 @@ const utils_1 = require("../../utils");
 const common_1 = require("./common");
 const circuits_1 = require("../../circuits");
 const message_handler_1 = require("./message-handler");
+const utils_2 = require("../utils");
 /**
  *  createAuthorizationRequest is a function to create protocol authorization request
  * @param {string} reason - reason to request proof
  * @param {string} sender - sender did
  * @param {string} callbackUrl - callback that user should use to send response
+ * @param {AuthorizationRequestCreateOptions} opts - authorization request options
  * @returns `Promise<AuthorizationRequestMessage>`
  */
-function createAuthorizationRequest(reason, sender, callbackUrl) {
-    return createAuthorizationRequestWithMessage(reason, '', sender, callbackUrl);
+function createAuthorizationRequest(reason, sender, callbackUrl, opts) {
+    return createAuthorizationRequestWithMessage(reason, '', sender, callbackUrl, opts);
 }
 exports.createAuthorizationRequest = createAuthorizationRequest;
 /**
@@ -50,9 +52,10 @@ exports.createAuthorizationRequest = createAuthorizationRequest;
  * @param {string} message - message to sign in the response
  * @param {string} sender - sender did
  * @param {string} callbackUrl - callback that user should use to send response
+ * @param {AuthorizationRequestCreateOptions} opts - authorization request options
  * @returns `Promise<AuthorizationRequestMessage>`
  */
-function createAuthorizationRequestWithMessage(reason, message, sender, callbackUrl) {
+function createAuthorizationRequestWithMessage(reason, message, sender, callbackUrl, opts) {
     const uuidv4 = uuid.v4();
     const request = {
         id: uuidv4,
@@ -61,11 +64,14 @@ function createAuthorizationRequestWithMessage(reason, message, sender, callback
         typ: constants_1.MediaType.PlainMessage,
         type: constants_2.PROTOCOL_MESSAGE_TYPE.AUTHORIZATION_REQUEST_MESSAGE_TYPE,
         body: {
+            accept: opts?.accept,
             reason: reason,
             message: message,
             callbackUrl: callbackUrl,
-            scope: []
-        }
+            scope: opts?.scope ?? []
+        },
+        created_time: (0, js_iden3_core_1.getUnixTimestamp)(new Date()),
+        expires_time: opts?.expires_time ? (0, js_iden3_core_1.getUnixTimestamp)(opts.expires_time) : undefined
     };
     return request;
 }
@@ -125,17 +131,18 @@ class AuthHandler extends message_handler_1.AbstractMessageHandler {
         }
         // override sender did if it's explicitly specified in the auth request
         const to = authRequest.to ? js_iden3_core_1.DID.parse(authRequest.to) : ctx.senderDid;
-        const mediaType = ctx.mediaType || constants_1.MediaType.ZKPMessage;
         const guid = uuid.v4();
         if (!authRequest.from) {
             throw new Error('auth request should contain from field');
         }
+        const responseType = constants_2.PROTOCOL_MESSAGE_TYPE.AUTHORIZATION_RESPONSE_MESSAGE_TYPE;
+        const mediaType = this.getSupportedMediaTypeByProfile(ctx, responseType, authRequest.body.accept);
         const from = js_iden3_core_1.DID.parse(authRequest.from);
         const responseScope = await (0, common_1.processZeroKnowledgeProofRequests)(to, authRequest?.body.scope, from, this._proofService, { mediaType, supportedCircuits: this._supportedCircuits });
         return {
             id: guid,
-            typ: ctx.mediaType,
-            type: constants_2.PROTOCOL_MESSAGE_TYPE.AUTHORIZATION_RESPONSE_MESSAGE_TYPE,
+            typ: mediaType,
+            type: responseType,
             thid: authRequest.thid ?? guid,
             body: {
                 message: authRequest?.body?.message,
@@ -150,6 +157,9 @@ class AuthHandler extends message_handler_1.AbstractMessageHandler {
      */
     async handleAuthorizationRequest(did, request, opts) {
         const authRequest = await this.parseAuthorizationRequest(request);
+        if (!opts?.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(authRequest);
+        }
         if (!opts) {
             opts = {
                 mediaType: constants_1.MediaType.ZKPMessage
@@ -239,6 +249,9 @@ class AuthHandler extends message_handler_1.AbstractMessageHandler {
      * @inheritdoc IAuthHandler#handleAuthorizationResponse
      */
     async handleAuthorizationResponse(response, request, opts) {
+        if (!opts?.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(response);
+        }
         const authResp = (await this.handleAuthResponse(response, {
             request,
             acceptedStateTransitionDelay: opts?.acceptedStateTransitionDelay,
@@ -272,5 +285,36 @@ class AuthHandler extends message_handler_1.AbstractMessageHandler {
             }
         }
     }
+    getSupportedMediaTypeByProfile(ctx, responseType, profile) {
+        let mediaType;
+        if (profile?.length) {
+            const supportedMediaTypes = [];
+            for (const acceptProfile of profile) {
+                // 1. check protocol version
+                const { protocolVersion, env } = (0, utils_2.parseAcceptProfile)(acceptProfile);
+                const responseTypeVersion = Number(responseType.split('/').at(-2));
+                if (protocolVersion !== constants_1.ProtocolVersion.V1 ||
+                    (protocolVersion === constants_1.ProtocolVersion.V1 &&
+                        (responseTypeVersion < 1 || responseTypeVersion >= 2))) {
+                    continue;
+                }
+                // 2. check packer support
+                if (this._packerMgr.isProfileSupported(env, acceptProfile)) {
+                    supportedMediaTypes.push(env);
+                }
+            }
+            if (!supportedMediaTypes.length) {
+                throw new Error('no packer with profile which meets `accept` header requirements');
+            }
+            mediaType = supportedMediaTypes[0];
+            if (ctx.mediaType && supportedMediaTypes.includes(ctx.mediaType)) {
+                mediaType = ctx.mediaType;
+            }
+        }
+        else {
+            mediaType = ctx.mediaType || constants_1.MediaType.ZKPMessage;
+        }
+        return mediaType;
+    }
 }
 exports.AuthHandler = AuthHandler;

package/dist/node/cjs/iden3comm/handlers/common.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processZeroKnowledgeProofRequests = void 0;
+exports.verifyExpiresTime = exports.processZeroKnowledgeProofRequests = void 0;
 const js_crypto_1 = require("@iden3/js-crypto");
 const utils_1 = require("../../utils");
+const js_iden3_core_1 = require("@iden3/js-iden3-core");
 /**
  * Groups the ZeroKnowledgeProofRequest objects based on their groupId.
  * Returns a Map where the key is the groupId and the value is an object containing the query and linkNonce.
@@ -83,3 +84,14 @@ const processZeroKnowledgeProofRequests = async (to, requests, from, proofServic
     return zkpResponses;
 };
 exports.processZeroKnowledgeProofRequests = processZeroKnowledgeProofRequests;
+/**
+ * Verifies that the expires_time field of a message is not in the past. Throws an error if it is.
+ *
+ * @param message - Basic message to verify.
+ */
+const verifyExpiresTime = (message) => {
+    if (message?.expires_time && message.expires_time < (0, js_iden3_core_1.getUnixTimestamp)(new Date())) {
+        throw new Error('Message expired');
+    }
+};
+exports.verifyExpiresTime = verifyExpiresTime;

package/dist/node/cjs/iden3comm/handlers/contract-request.js

@@ -110,7 +110,8 @@ class ContractRequestHandler extends message_handler_1.AbstractMessageHandler {
             body: {
                 transaction_data: request.body.transaction_data,
                 scope: []
-            }
+            },
+            created_time: (0, js_iden3_core_1.getUnixTimestamp)(new Date())
         };
         for (const [txHash, zkpResponses] of txHashToZkpResponseMap) {
             for (const zkpResponse of zkpResponses) {
@@ -134,6 +135,9 @@ class ContractRequestHandler extends message_handler_1.AbstractMessageHandler {
      */
     async handleContractInvokeRequest(did, request, opts) {
         const ciRequest = await this.parseContractInvokeRequest(request);
+        if (!opts.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(ciRequest);
+        }
         if (ciRequest.body.transaction_data.method_id !== storage_1.FunctionSignatures.SubmitZKPResponseV1) {
             throw new Error(`please use handle method to work with other method ids`);
         }

package/dist/node/cjs/iden3comm/handlers/credential-proposal.js

@@ -30,6 +30,7 @@ const uuid = __importStar(require("uuid"));
 const js_jwz_1 = require("@iden3/js-jwz");
 const utils_1 = require("../../utils");
 const message_handler_1 = require("./message-handler");
+const common_1 = require("./common");
 /**
  * @beta
  * createProposalRequest is a function to create protocol proposal-request protocol message
@@ -47,7 +48,9 @@ function createProposalRequest(sender, receiver, opts) {
         to: receiver.string(),
         typ: constants_1.MediaType.PlainMessage,
         type: constants_1.PROTOCOL_MESSAGE_TYPE.PROPOSAL_REQUEST_MESSAGE_TYPE,
-        body: opts
+        body: opts,
+        created_time: (0, js_iden3_core_1.getUnixTimestamp)(new Date()),
+        expires_time: opts?.expires_time ? (0, js_iden3_core_1.getUnixTimestamp)(opts.expires_time) : undefined
     };
     return request;
 }
@@ -60,7 +63,7 @@ exports.createProposalRequest = createProposalRequest;
  * @param {Proposal[]} proposals - proposals
  * @returns `Promise<ProposalRequestMessage>`
  */
-function createProposal(sender, receiver, proposals) {
+function createProposal(sender, receiver, proposals, opts) {
     const uuidv4 = uuid.v4();
     const request = {
         id: uuidv4,
@@ -71,7 +74,9 @@ function createProposal(sender, receiver, proposals) {
         type: constants_1.PROTOCOL_MESSAGE_TYPE.PROPOSAL_MESSAGE_TYPE,
         body: {
             proposals: proposals || []
-        }
+        },
+        created_time: (0, js_iden3_core_1.getUnixTimestamp)(new Date()),
+        expires_time: opts?.expires_time ? (0, js_iden3_core_1.getUnixTimestamp)(opts.expires_time) : undefined
     };
     return request;
 }
@@ -210,6 +215,9 @@ class CredentialProposalHandler extends message_handler_1.AbstractMessageHandler
         if (!proposalRequest.from) {
             throw new Error(`failed request. empty 'from' field`);
         }
+        if (!opts?.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(proposalRequest);
+        }
         const senderDID = js_iden3_core_1.DID.parse(proposalRequest.from);
         const message = await this.handleProposalRequestMessage(proposalRequest);
         const response = utils_1.byteEncoder.encode(JSON.stringify(message));
@@ -227,6 +235,9 @@ class CredentialProposalHandler extends message_handler_1.AbstractMessageHandler
      * @inheritdoc ICredentialProposalHandler#handleProposal
      */
     async handleProposal(proposal, opts) {
+        if (!opts?.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(proposal);
+        }
         if (opts?.proposalRequest && opts.proposalRequest.from !== proposal.to) {
             throw new Error(`sender of the request is not a target of response - expected ${opts.proposalRequest.from}, given ${proposal.to}`);
         }

package/dist/node/cjs/iden3comm/handlers/fetch.js

@@ -33,6 +33,7 @@ const js_jwz_1 = require("@iden3/js-jwz");
 const js_iden3_core_1 = require("@iden3/js-iden3-core");
 const uuid = __importStar(require("uuid"));
 const message_handler_1 = require("./message-handler");
+const common_1 = require("./common");
 /**
  *
  * Allows to handle Credential offer protocol message and return fetched credential
@@ -147,6 +148,9 @@ class FetchHandler extends message_handler_1.AbstractMessageHandler {
             throw new Error(`jws packer options are required for ${constants_1.MediaType.SignedMessage}`);
         }
         const offerMessage = await FetchHandler.unpackMessage(this._packerMgr, offer, constants_2.PROTOCOL_MESSAGE_TYPE.CREDENTIAL_OFFER_MESSAGE_TYPE);
+        if (!opts?.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(offerMessage);
+        }
         const result = await this.handleOfferMessage(offerMessage, {
             mediaType: opts?.mediaType,
             headers: opts?.headers,
@@ -194,8 +198,11 @@ class FetchHandler extends message_handler_1.AbstractMessageHandler {
     /**
      * @inheritdoc IFetchHandler#handleCredentialFetchRequest
      */
-    async handleCredentialFetchRequest(envelope) {
+    async handleCredentialFetchRequest(envelope, opts) {
         const msgRequest = await FetchHandler.unpackMessage(this._packerMgr, envelope, constants_2.PROTOCOL_MESSAGE_TYPE.CREDENTIAL_FETCH_REQUEST_MESSAGE_TYPE);
+        if (!opts?.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(msgRequest);
+        }
         const request = await this.handleFetchRequest(msgRequest);
         return this._packerMgr.pack(constants_1.MediaType.PlainMessage, utils_1.byteEncoder.encode(JSON.stringify(request)), {});
     }
@@ -212,8 +219,11 @@ class FetchHandler extends message_handler_1.AbstractMessageHandler {
     /**
      * @inheritdoc IFetchHandler#handleIssuanceResponseMessage
      */
-    async handleIssuanceResponseMessage(envelop) {
+    async handleIssuanceResponseMessage(envelop, opts) {
         const issuanceMsg = await FetchHandler.unpackMessage(this._packerMgr, envelop, constants_2.PROTOCOL_MESSAGE_TYPE.CREDENTIAL_ISSUANCE_RESPONSE_MESSAGE_TYPE);
+        if (!opts?.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(issuanceMsg);
+        }
         await this.handleIssuanceResponseMsg(issuanceMsg);
         return Uint8Array.from([]);
     }

package/dist/node/cjs/iden3comm/handlers/message-handler.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageHandler = exports.AbstractMessageHandler = void 0;
 const constants_1 = require("../constants");
 const js_jwz_1 = require("@iden3/js-jwz");
+const common_1 = require("./common");
 /**
  * Base implementation of protocol message handler
  *
@@ -17,6 +18,9 @@ class AbstractMessageHandler {
         return messageHandler;
     }
     async handle(message, context) {
+        if (!context.allowExpiredMessages) {
+            (0, common_1.verifyExpiresTime)(message);
+        }
         if (this.nextMessageHandler)
             return this.nextMessageHandler.handle(message, context);
         return Promise.reject('Message handler not provided or message not supported');