vechain / vechain-sdk-js

The official JavaScript SDK for VeChain.
24 stars 9 forks source link

[Audit] Identify the scope #1422

Open victhorbi opened 1 week ago

victhorbi commented 1 week ago

Context As the VeChain-SDK is a public good, the code is open for anyone to review. VeChain Foundation wants also to get the codebase reviewed by a recognised third-party professional auditor.

Description Since the SDK is vast, giving the auditor the whole repo can be dispersive and can take a lot of time. The ask is to go through the packages and tag the portions with a risk level.

Acceptance criteria Produce a spreadsheet where each raw represent a part of the sdk, define for each entry a risk level (LOWEST, LOW, MEDIUM, HIGH, HIGHEST) to later define prioritise the code to audit.

leszek-vechain commented 2 days ago

So I was looking into the repository today and couple of things come to my mind:

I suppose based on this we can try to identify code which is more susceptible to abuse

freemanzMrojo commented 2 days ago

Hi guys, after discussing with @lucanicoladebiasi , we thought that by refactoring the network package we could:

  1. Fix any security issues for that package since the code will become different
  2. Make it better and remove circular dependencies

To better define the scope of this refactor, we have decided to start "small" by refactoring the ThorClient so we can have a better idea of the follow-up steps in this regard. With that in mind I have created this ticket https://github.com/vechain/vechain-sdk-js/issues/1450.

Any comments/questions just let us know, thanks.