Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(*): template signing and verification #688

Merged
merged 31 commits into from Aug 19, 2021
Merged

feat(*): template signing and verification #688

merged 31 commits into from Aug 19, 2021

Conversation

sanketshevkar
Copy link
Member

Closes #671

The developer while creating the archive can sign the template using a private key stored in a PKCS#12 keystore.

Changes

  • A new method added in the Template class that signs the hash of the contract text, logic and model of a template and returns an object containing signatory's metadata, timestamp, signatory's certificate, signature.
  • A new node package added (node-forge), helps in handling keystores and crypto material inside it.
  • An optional parameter, keyStore added to toArchive method in Template class using which the developer/author can pass the keystore path and password.
  • An optional parameter signatureObject added to toArchive method of TemplateSaver class that will save the object containing signatory's metadata, timestamp, signatory's certificate, signature, in a signature.json file inside the .cta archive.

Flags

  • Test for the new and updated methods is yet to be written.

Related Issues

Author Checklist

  • Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
  • Vital features and changes captured in unit and/or integration tests
  • Commits messages follow AP format
  • Extend the documentation, if necessary
  • Merging to master from fork:branchname

sanketshevkar and others added 30 commits August 16, 2021 22:36
@sanketshevkar
conflict(package.lock): resolved
87047b2 
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): set author signature as a property for template objec…
3c3e634 
…t - accordproject#671

Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(core): test to test signTemplate method in Template class - acco…
4f2594f 
…rdproject#671

Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): code formatting - accordproject#671
67a605c 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
chore(core): test template and dummy keystore for testing - accordpro…
94fd50b 
…ject#671

Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): code formatting - accordproject#671
2a7ccaf 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): eslint enable - accordproject#671
54ea868 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
cli(*): template signing option for archive command - accordproject#671
da7531e 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refacore(core): jsdoc and linting changes - accordproject#671
c6a2046 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refacore(core): code formatting - accordproject#671
b3865ed 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refacore(core): json object shorthand initialization - accordproject#671
87ac009 


Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refacore(core): type checking for signTemplate parameters - accordpro…
9035372 
…ject#671

Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): remove one time signature - accordproject#671
a27e2e3 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): remove signature file from hash - accordproject#671
d79f75c 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
feat(*): verification of template author signature - accordproject#671
ca3c2ef 
Signed-off-by: Sanket Shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(core): test for toArchive method - accordproject#671
05d54dc 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(core): test for toArchive method - accordproject#671
7a19087 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(core): test for toArchive method - accordproject#671
26efbef 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(core): tests for fromDirectory and fromArchive methods - accordp…
0318a4b 
…roject#671

Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
@sanketshevkar
bug(cli): archive without signature - accordproject#671
150cf06 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(*): change signatures.json to signature.json - accordproject…
a58d118 
…#671

Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(*): change signatures.json to signature.json - accordproject…
83d6856 
…#671

Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(cli): test for cli interface
1e87317 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(cli): test for cli interface keystore
533bc4f 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
feat(*): CLI functionality to verify signature
4bd11aa 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): code formatting
14f68b6 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(cicero-core): code formatting
6f7c6d5 
Signed-off-by: sanketshevkar <shevkar.sanket@gmail.com>
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
test(cli): coverage 100%
70c1e4b 
Signed-off-by: sanket shevkar <sanket@sankets-MacBook-Air.local>
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
chore(refactor): implemation of suggested changes
0ad578d 
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar
refactor(core): chais-fs uninstall
93c864d 
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
@sanketshevkar sanketshevkar changed the base branch from gsoc-contract-design to master August 17, 2021 03:56
mttrbrts
mttrbrts reviewed Aug 17, 2021
View reviewed changes
Copy link
Member

@mttrbrts mttrbrts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking very strong. Nearly there!

packages/cicero-cli/test/cli.js Show resolved Hide resolved
packages/cicero-cli/test/cli.js Show resolved Hide resolved
packages/cicero-cli/test/cli.js Show resolved Hide resolved
packages/cicero-cli/test/cli.js Show resolved Hide resolved
packages/cicero-core/package.json Show resolved Hide resolved
packages/cicero-core/src/template.js Outdated Show resolved Hide resolved
@sanketshevkar
refactor(core): code comments correction
3791020 
Signed-off-by: sanket shevkar <shevkar.sanket@gmail.com>
jeromesimeon
jeromesimeon approved these changes Aug 19, 2021
View reviewed changes
Copy link
Member

@jeromesimeon jeromesimeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jeromesimeon jeromesimeon merged commit c7199d8 into accordproject:master Aug 19, 2021
@jeromesimeon jeromesimeon mentioned this pull request Aug 24, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeromesimeon jeromesimeon jeromesimeon approved these changes

@mttrbrts mttrbrts mttrbrts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Method for template signing and verification in Template class
3 participants
@sanketshevkar @jeromesimeon @mttrbrts