Javascript NPM packaging #239

micwallace · 2022-03-29T03:58:35Z

This branch adds stuff for publishing the JS as a typescript library on NPM (https://www.npmjs.com/package/@tokenscript/attestation)

It also:

Moves postMesssage integration logic out of Authenticator to a separate IntegrationExample class for usage in the old demos.
Adds old schema versions, that are currently used by TN demos to a folder tn-compat. When the getUseTicket function is called there is an optional argument to use the old versions. These can be removed once we have updated TN ticket issuing to use the new schema.
Ensure ASN parsing errors are included in thrown exceptions in getUseTicket.

This doesn't necessarily need to be merged into main, we could keep a separate branch for JS library publishing and I'll keep it up to date with main. Let me know what you think.

Cheers,
Michael

This has now been implemented in TN.

…o feature/js-packaging

…tion into feature/js-packaging

…re/js-packaging

… schema for use with current TN examples.

- Add .npmignore. - Add src/module in package.json. - Add prepublishOnly command in package.json.

jot2re · 2022-03-29T13:45:58Z

Hi Michael, thanks a lot!
I think it would make sense to have it all merged in main to keep it all in place, and simply remove the code for handling tickets when we can.
But @oleggrib is the one who is most aware of what is best to do regarding TS and JS code :)

…estation into feature/js-packaging

…into feature/js-packaging

jot2re · 2022-04-04T07:39:55Z

@oleggrib can you check and merge this into main if you think it is fine?

jest tests in attestation.id

- Hybrid ES6 & commonjs build. - Add various functions to remove dependencies from projects using the library.

micwallace · 2022-04-11T02:27:57Z

Hey @oleggrib the library is now integrated with TN & attestation.id, and I have confirmed all existing tests are passing.

Let me know if you want me to resolve the merge conflict from main.

jot2re

I have a hard time judging the TS/JS stuff, but ran a test and things still seem to work on my end.

src/main/javascript/crypto/package.json

- Added proof validation function for TN. - Change getUseTicket function to static for consistency. - Fix type signature for logging functions.

Update version to be in sync with jar major and minor version.

micwallace · 2022-04-14T05:46:15Z

Hey @oleggrib & @jot2re

As discussed here I've had to make the package into a commonjs version rather than es6 or hybrid to make it work with both TN and attestation.id.

In the new version I have also added a proof validation function to Authenticator.js to validate the proof in TN. Can you have a look and see if it's okay?

jot2re · 2022-04-15T14:10:09Z

Thanks a lot @micwallace ! I think we need @oleggrib to judge it

micwallace · 2022-04-28T11:49:24Z

Hey @oleggrib & @jot2re

Issues with the attestation packaging have been ironed out and it's working well as a commonjs module in attestation.id and TN for all platforms in use (webpack, UMD bundle, react, next.js). Please review the changes at your earliest convenience.

oleggrib

Can you check my comments and make some updates/comments so we can move this repo to the /authenticator and avoid duplication.
for testing - we can put /attestation and /authenticator next each to other and update path to read JAVA-builds to test JS version.
@micwallace , @jot2re , ok?

oleggrib · 2022-04-29T02:49:36Z

data-modules/output/asn/AuthenticationFramework.asn

    notAfter        GeneralizedTime,
-    notAfterInt     INTEGER OPTIONAL -- NotAfter time since epoch in milliseconds
+    notAfterInt     INTEGER OPTIONAL -- NotAfter time since epoch in seconds


@jot2re , I think we have to make all 4 dates required. because SmartContract require integers

Yes, they are definitely needed for something running on the smart contract. However, optional for the any web2 usage. Because if we make them all required then the schema is not backward compatible with old attestations (furthermore GeneralizedTime becomes totally superfluous and should just be removed).
However, as we talked about loosing backward compatibility is not really an issue since we have only issued 1 hour valid attestations for awhile, and I think it is fair to deprecated those few "unlimited time" old attestations we issued.
So ideally I would just want to remove GeneralizedTime and deprecate the initial attestation, but I think that should be cleared with Weiwu. This would also require many code changes.

The logic in all the code bases (including smart contract), is that notAfterInt is optional but required to work on smart contracts, and when new attestations are issued notAfterInt and notBeforeInt will always be set unless explicitly requested to not be included.

yes, correct, but do we use option to force old legasy format somewhere? As I know - we dont use it and always add int values.
even more - libs updated to always read Int and GeneralizedTime both(if exists) and compare them, so in real usage we always use new format only @jot2re

Yes, true. I do think the best would simply be to get rid of the GeneralizedTime field. But I don't think we should do that before we get a good and integrated CI/CD setup.
I can change the backend code to always enforce that notBeforeInt and notAfterInt are included, but in that case we should make a separate issue, since this is not related to NPM packaging ;)

ok, lets leave it for separate issue

Added a new issue #249

oleggrib · 2022-04-29T03:05:34Z

src/main/javascript/crypto/src/Authenticator.ts

+            } else {
+                ticket = Ticket.fromBase64(base64ticket,{"6": KeyPair.publicFromBase64(base64senderPublicKey)});
+            }
+


Better remove hardcoded conferenceID "6" and receive keysArray as argument, like here
https://github.com/TokenScript/attestation/blob/ticket_validator/src/main/javascript/crypto/src/Authenticator.ts#L682-L710

this code can be updated after merge with main, because its related to the Ticket

oleggrib · 2022-04-29T03:08:30Z

src/main/javascript/crypto/src/Authenticator.ts

@@ -163,7 +81,7 @@ export class Authenticator {
            logger(DEBUGLEVEL.MEDIUM,'ticked valid (signature OK)');
        } catch (e) {
            logger(DEBUGLEVEL.MEDIUM,'getUseTicket: ticket validation failed',e);
-            throw new Error("getUseTicket: ticked validation failed");
+            throw new Error("getUseTicket: ticked validation failed: " + e.message);


we need some way to set DEBUGLEVEL, because it can't be set in config.ts, because its will be ready NPM package.
lets add some variable to the .env , so code can read and use it

added commit, where I moved debug variable to the process.env.DISPLAY_DEBUG_LEVEL or window.DISPLAY_DEBUG_LEVEL so we can change debug level even for UMD builds

oleggrib · 2022-04-29T03:22:52Z

src/main/javascript/crypto/src/tn-compat/SignedDevconTicket.ts

+    @AsnProp({ type: AsnPropTypes.Utf8String }) public devconId: string;
+    @AsnProp({ type: AsnPropTypes.Integer }) public ticketId: number;
+    @AsnProp({ type: AsnPropTypes.Integer }) public ticketClass: number;
+}


Can you check main branch for code?
https://github.com/TokenScript/attestation/blob/main/src/main/javascript/crypto/src/asn1/shemas/SignedDevconTicket.ts#L10-L17
its single object , compatible with old and new ticket ASN schema
and Ticket.ts updated to be compatable with ID as integer/string and old and new ticket formats

we can merge this branch with main and stay Tickets.ts from main branch. it can read both Ticket formats

jot2re · 2022-04-29T07:29:53Z

src/main/javascript/crypto/src/libs/Attestation.ts

@@ -64,6 +65,13 @@ export class Attestation {
        if (decodedAttestationObj.validity){
            me.notValidBefore = decodedAttestationObj.validity.notBefore.generalizedTime.getTime();
            me.notValidAfter = decodedAttestationObj.validity.notAfter.generalizedTime.getTime();
+            // TODO validate time when it will be updated in Java code


It should be updated in the java code, so I think the code fragment can be enabled.

jot2re · 2022-04-29T07:31:25Z

src/main/javascript/crypto/src/tn-compat/Ticket.ts

+
+
+    public getUrlEncoding() {
+        // TODO implement


Maybe throw an exception if it happens to be called? It will make debugging easier.

usually throw an error is good option, but in this case I prefer to use Ticket reader from main branch, so no need to update duplicated code. we can remove tn-compat/Ticket.ts because schema is not compatable with legacy ticket. main branch already can work with both ticket types.

jot2re · 2022-04-29T07:54:19Z

src/main/javascript/crypto/src/IntegrationExample.ts

+
+    attachPostMessageListener(listener: Function){
+        if (window.addEventListener) {
+            window.addEventListener("message", (e) => {


To avoid potential cross origin attacks, it should be validated that the origin of the message is as expected, ie. something like the following should be added

if (event.origin !== "http://example.org") // Compliant return;

this part of code just add event listener , so we have to check event.origin in the callback function. this part of code doesnt have access to the event object

…l window.DISPLAY_DEBUG_LEVEL variables

oleggrib and others added 16 commits March 24, 2022 01:04

added variable message for requestAttest, optional date as integer

347a95e

Converted to seconds since epoch instead of ms

4acc848

Move iframe integration logic out of Authenticator object.

30fa388

This has now been implemented in TN.

Update package.json

27d5cc3

Update package.json

bc2f2dd

Merge branch 'main' of https://github.com/TokenScript/attestation int…

d051f50

…o feature/js-packaging

Merge branch 'feature/js-packaging' of github.com:TokenScript/attesta…

77d001b

…tion into feature/js-packaging

added .npmignore and updated package.json

5254f38

Add module exports & fix main & types in package.json

d4bb358

Merge remote-tracking branch 'origin/feature/js-packaging' into featu…

b838876

…re/js-packaging

tests updates, attestation fixed, timestamp validation disabled

de8a8e9

updated pkg no

5911d4d

Update webpack bundle filename and entrypoint.

c78e78b

Ensure ASN schema parsing exception messages are shown.

3cf47cb

Added getUseTicket compatibility option to use old SignedDevconTicket…

ec91886

… schema for use with current TN examples.

Various package maintenance changes

ff0a539

- Add .npmignore. - Add src/module in package.json. - Add prepublishOnly command in package.json.

jot2re requested a review from oleggrib March 29, 2022 13:46

micwallace and others added 5 commits April 1, 2022 16:54

Merge branch '236-eip155-issue' of https://github.com/TokenScript/att…

b829bed

…estation into feature/js-packaging

Merge branch 'main' into js_pr212

b1365cc

Merge branch 'js_pr212' of https://github.com/TokenScript/attestation …

2f0dd2e

…into feature/js-packaging

Bump version.

ddb43f9

Bump version.

e5c40a1

micwallace added 2 commits April 4, 2022 21:34

Add clean script to prevent old build files on publish.

7b328fc

Bump version to remove old build artifacts.

bb440ee

micwallace mentioned this pull request Apr 8, 2022

Attestation.id is failing when trying to fully authenticate mock token - github examples #240

Closed

micwallace added 2 commits April 11, 2022 10:29

NPM hybrid es6/commonjs module compilation to support

39e704c

jest tests in attestation.id

NPM package version 1.0.8-alpha

61dabfb

- Hybrid ES6 & commonjs build. - Add various functions to remove dependencies from projects using the library.

jot2re approved these changes Apr 11, 2022

View reviewed changes

src/main/javascript/crypto/package.json Outdated Show resolved Hide resolved

micwallace added 3 commits April 14, 2022 13:29

Update package to commonjs & WIP proof validation.

697308b

Version 1.0.11-alpha

e6a629e

- Added proof validation function for TN. - Change getUseTicket function to static for consistency. - Fix type signature for logging functions.

Version 0.3.1

e828eca

Update version to be in sync with jar major and minor version.

oleggrib reviewed Apr 29, 2022

View reviewed changes

jot2re reviewed Apr 29, 2022

View reviewed changes

This was referenced May 1, 2022

Remove legacy use of GeneralizedTime #249

Open

Added ticket proof validation to client. SmartTokenLabs/token-negotiator#160

Merged

log level variable moved to process.env.DISPLAY_DEBUG_LEVEL and globa…

f59d65f

…l window.DISPLAY_DEBUG_LEVEL variables

micwallace merged commit e783cc9 into main May 3, 2022

jot2re mentioned this pull request Jun 2, 2022

Create release flow to eliminate need for snapshots #218

Closed

jot2re deleted the feature/js-packaging branch November 14, 2022 15:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Javascript NPM packaging #239

Javascript NPM packaging #239

micwallace commented Mar 29, 2022

jot2re commented Mar 29, 2022

jot2re commented Apr 4, 2022

micwallace commented Apr 11, 2022

jot2re left a comment

micwallace commented Apr 14, 2022

jot2re commented Apr 15, 2022

micwallace commented Apr 28, 2022

oleggrib left a comment

oleggrib Apr 29, 2022

jot2re Apr 29, 2022

jot2re Apr 29, 2022

oleggrib Apr 29, 2022

jot2re Apr 29, 2022

oleggrib Apr 29, 2022

jot2re May 1, 2022

oleggrib Apr 29, 2022

oleggrib May 3, 2022

oleggrib Apr 29, 2022

oleggrib May 3, 2022

oleggrib Apr 29, 2022

oleggrib May 3, 2022

jot2re Apr 29, 2022

jot2re Apr 29, 2022

oleggrib May 3, 2022

jot2re Apr 29, 2022

oleggrib May 3, 2022

Javascript NPM packaging #239

Javascript NPM packaging #239

Conversation

micwallace commented Mar 29, 2022

jot2re commented Mar 29, 2022

jot2re commented Apr 4, 2022

micwallace commented Apr 11, 2022

jot2re left a comment

Choose a reason for hiding this comment

micwallace commented Apr 14, 2022

jot2re commented Apr 15, 2022

micwallace commented Apr 28, 2022

oleggrib left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment