This repo is an API for creating and querying claims in privacy-preserving ways. For a full system, use the mobile app linked at the public EndorserSearch.com server; there's a test server.
Requires node v14+
Project | Version |
---|---|
nodejs.org | ^16.18.0 |
npmjs.com | ^9.1.3 |
# install dependencies
npm ci
# set up the environment (optional)
cp .env.local .env
# setup/migrate DB
NODE_ENV=dev DBUSER=sa DBPASS=sasa npm run flyway migrate
# note that it fails if you don't run `npm ci`; `npm install` isn't enough (Ug!)
# run in development mode
NODE_ENV=dev npm run dev
# register ths first permissioned user by adding a DID thus:
echo "INSERT INTO registration (did) VALUES ('YOUR_DID');" | sqlite3 ../endorser-ch-dev.sqlite3
# ... but as an alternative for test DB & user setup: run a local test with instructions below to generate sample data, then: `cp ../endorser-ch-test-local.sqlite3 ../endorser-ch-dev.sqlite3` and rerun `npm run dev` and you'll have user #0 and others from the CREDS in [this file](./test/util.js)
Debug: npm run dev:debug
Release:
- Update CHANGELOG.md & package.json, then tag the release.
Run on Docker:
- Set ENDORSER_VERSION to that tag and run the following:
export ENDORSER_VERSION=release-1.1.35
docker build -t endorser-ch:$ENDORSER_VERSION --build-arg ENDORSER_VERSION .
docker run -d -p 3001:3000 -v /Users/trent/dev/home/endorser-ch-db:/mnt/database --name endorser-ch --env-file $PATH/.env -e APP_DB_FILE=/mnt/database/endorser-ch-dev.sqlite3 -e NODE_ENV=dev endorser-ch:$ENDORSER_VERSION
When running on another domain (other than EndorserSearch.com):
- You should edit the .env SERVICE_ID with the value people should supply in the object field of RegisterAction.
Run the local automated tests and build sample data with this: ./test/test.sh
-
Note that this sometimes fails without reason and a rerun works, especially on "Load Claims Incrementally". (Network issue with infura.io?)
-
That creates a sample DB file ../endorser-ch-test-local.sqlite3 which you may then use as baseline data for running in dev mode by copying to ../endorser-ch-dev.sqlite3
-
You can also run the server in offline test mode by setting environment variable
NODE_ENV=test-local
and then it will accept all JWTs and it won't do any real JWT validity checking, including expiration. (This may be changed when I figure out how to validate JWTs without being online. It is accomplished with theprocess.env.NODE_ENV === 'test-local'
code currently only found in server/api/services/claim.service.js )
You can use the test server APIs at https://test.endorser.ch:8000
First, ensure your DID is registered (see above). Then make a claim that looks
like claimPlanAction
in this test file, wrapped in a JWT.
Here's an example in node:
let claimPlanAction = {
"@context": "https://schema.org",
"@type": "PlanAction",
"agent": { identifier: null }, // supply DID for intiator of this plan
"identifier": null, // supply plan ID
"name": "KickStarter for Time",
"description": "Deliver the games and set them up",
"image": "https://live.staticflickr.com/2853/9194403742_c8297b965b_b.jpg",
"startTime": "2022-07",
"endTime": "2023-03"
}
// generate a JWT with that payload, and POST to /api/claim:
fetch(
"https://endorser.ch/api/claim",
{
method: "POST",
header: { "Content-Type": "application/json" }
},
body: JSON.stringify({ jwtEncoded: jwt })
)
That will give you a resulting ID (or a result with an "error" property).
Following are a few ways to generate a JWT with contents {a:1}
:
# Setup:
# - Run `npm install` in this project.
# - Get the endorser-mobile project, run `yarn` there, and run the following in a shell inside there.
# Note that this command may fail with a `hunk` message, but it's worth continuing because the rest may work.
npx yarn-add-no-save esm typescript ts-node tslib @types/node
# Edit tsconfig.json and set `isolatedModules` to false.
# Run the CLI:
npx ts-node
// Then run the following in that node REPL:
const testUtil = require('../endorser-ch/test/util') // import does not work
// One approach:
await testUtil.credentials[0].signJWT({a:1})
// Another approach:
const didJwt = require('did-jwt')
const cred = testUtil.creds[0]
const signer = didJwt.SimpleSigner(cred.privateKey)
const uportTokenPayload = { exp: 1, iat: 0, iss: cred.did }
await didJwt.createJWT({a:1}, { issuer: cred.did, signer })
// Another approach (not-fully-tested): use the endorser-mobile project and create an identifier and use the utility.accessToken method from this:
//import * as utility from './endorser-mobile/src/utility/utility' // require does not work
# Now you can go to a terminal and put that JWT value into a JWT env var make a call as user #0.
curl -H "Uport-Push-Token: $JWT" -H "Content-Type: application/json" https://test.endorser.ch:8000/api/claims
Let's create some claims. First, we'll create a claim of attendance. Here's the payload structure:
{
"@context": "http://schema.org",
"@type": "JoinAction",
"agent": { "did": "did:ethr:0xdf0d8e5fd234086f6649f77bb0059de1aebd143e" },
"event": {
"organizer": { "name": "Bountiful Voluntaryist Community" },
"name": "Saturday Morning Meeting",
"startTime": "2018-12-29T08:00:00.000-07:00"
}
}
- To send to the server, package that in a JWT (see code above) and POST to the /api/claim endpoint inside a body of
{ jwtEncoded: ... }
Now to confirm that activity, place all the previous into the object
of an AgreeAction
:
{
"@context": "http://endorser.ch",
"@type": "AgreeAction",
"object": {
"@type": "JoinAction",
"agent": { "did": "did:ethr:0xdf0d8e5fd234086f6649f77bb0059de1aebd143e" },
"event": {
"organizer": { "name": "Bountiful Voluntaryist Community" },
"name": "Saturday Morning Meeting",
"startTime": "2018-12-29T08:00:00.000-07:00"
}
}
}
# These JWTs are old so they'll require running in "test-local" mode.
export UPORT_PUSH_TOKEN=eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NkstUiJ9.eyJpYXQiOjE1NjAyMTI0MTMsImV4cCI6MTU2MDI5ODgxMywiaXNzIjoiZGlkOmV0aHI6MHgwMGM5YzIzMjZjNzNmNzMzODBlODQwMmIwMWRlOWRlZmNmZjJiMDY0In0.mUydq67R-gzz7c6iQBd06uKu2OEO32vqFbMWTxK3k5VUcDwFQR9XEj28KflBMmohm72nlITd_0kK0zIYSGaDwgA
# see claims
curl http://localhost:3000/api/claim -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
# register
curl http://localhost:3000/api/claim -h ...UNFINISHED: RegisterAction with agent & participant...
# create an action claim
curl http://localhost:3000/api/claim -H "Content-Type: application/json" -d '{"jwtEncoded": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpYXQiOjE1NzQxMzcwMDAsInN1YiI6ImRpZDpldGhyOjB4MDBjOWMyMzI2YzczZjczMzgwZTg0MDJiMDFkZTlkZWZjZmYyYjA2NCIsImNsYWltIjp7IkBjb250ZXh0IjoiaHR0cDovL3NjaGVtYS5vcmciLCJAdHlwZSI6IkpvaW5BY3Rpb24iLCJhZ2VudCI6eyJkaWQiOiJkaWQ6ZXRocjoweDAwYzljMjMyNmM3M2Y3MzM4MGU4NDAyYjAxZGU5ZGVmY2ZmMmIwNjQifSwiZXZlbnQiOnsib3JnYW5pemVyIjp7Im5hbWUiOiJCb3VudGlmdWwgVm9sdW50YXJ5aXN0IENvbW11bml0eSJ9LCJuYW1lIjoiU2F0dXJkYXkgTW9ybmluZyBNZWV0aW5nIiwic3RhcnRUaW1lIjoiMjAxOC0xMi0yOVQwODowMDowMC4wMDAtMDc6MDAifX0sImlzcyI6ImRpZDpldGhyOjB4MDBjOWMyMzI2YzczZjczMzgwZTg0MDJiMDFkZTlkZWZjZmYyYjA2NCJ9.juVv789ByzMRt7ny29TaG2jxSQ74hRjEbtbCw3XziRLCBOnHYr55puFSn24rEjPTe8QjfGy6OXptvkVdrqQfHg"}' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl http://localhost:3000/api/claim/1 -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl http://localhost:3000/api/action/1 -H 'Uport-Push-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NkstUiJ9.eyJpYXQiOjE1NTU4MDc0MTYsImV4cCI6MTU1NzEwMzQxNiwiYXVkIjoiZGlkOmV0aHI6MHg2MWU3YmFlNzM5NDZjZGY4ZWUyZWE3ZWE4ZmQzYWZjZGVlOTcxMjBhIiwidHlwZSI6Im5vdGlmaWNhdGlvbnMiLCJ2YWx1ZSI6ImFybjphd3M6c25zOnVzLXdlc3QtMjoxMTMxOTYyMTY1NTg6ZW5kcG9pbnQvR0NNL3VQb3J0L2I3ODJkNGEzLWYwYzMtM2I1OS1hMjk3LTY4ZTlmYmViYWQyOSIsImlzcyI6ImRpZDpldGhyOjB4ZGYwZDhlNWZkMjM0MDg2ZjY2NDlmNzdiYjAwNTlkZTFhZWJkMTQzZSJ9.7GnYLHHO8gT3ApW-c3pa0FH1Yj15xDB_UJmzpiHNvqpmxMZo_CnHYxyg9R-I71CZqfiO_7X7IXhj-oCI9jzmWwE' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl 'http://localhost:3000/api/claim?claimContents=Bountiful' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
# confirmation
curl http://localhost:3000/api/claim -H "Content-Type: application/json" -d '{"jwtEncoded": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpYXQiOjE1NzQxMzcwMDAsInN1YiI6ImRpZDpldGhyOjB4MDBjOWMyMzI2YzczZjczMzgwZTg0MDJiMDFkZTlkZWZjZmYyYjA2NCIsImNsYWltIjp7IkBjb250ZXh0IjoiaHR0cDovL2VuZG9yc2VyLmNoIiwiQHR5cGUiOiJDb25maXJtYXRpb24iLCJvcmlnaW5hbENsYWltIjp7IkBjb250ZXh0IjoiaHR0cDovL3NjaGVtYS5vcmciLCJAdHlwZSI6IkpvaW5BY3Rpb24iLCJhZ2VudCI6eyJkaWQiOiJkaWQ6ZXRocjoweGRmMGQ4ZTVmZDIzNDA4NmY2NjQ5Zjc3YmIwMDU5ZGUxYWViZDE0M2UifSwiZXZlbnQiOnsib3JnYW5pemVyIjp7Im5hbWUiOiJCb3VudGlmdWwgVm9sdW50YXJ5aXN0IENvbW11bml0eSJ9LCJuYW1lIjoiU2F0dXJkYXkgTW9ybmluZyBNZWV0aW5nIiwic3RhcnRUaW1lIjoiMjAxOC0xMi0yOVQwODowMDowMC4wMDAtMDc6MDAifX19LCJpc3MiOiJkaWQ6ZXRocjoweDAwYzljMjMyNmM3M2Y3MzM4MGU4NDAyYjAxZGU5ZGVmY2ZmMmIwNjQifQ.l5EXnyKXkoghFxloNA_2Nu2scIq75qw11BVtCyMSbhIkz4lm1IL02i_demSUoCUJgCMRUdkKmy3RIsHBMUn-IQ"}' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl 'http://localhost:3000/api/claim?claimType=JoinAction' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl http://localhost:3000/api/action/1 -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl http://localhost:3000/api/event/1 -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl http://localhost:3000/api/event/1/actionClaimsAndConfirmations -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl 'http://localhost:3000/api/report/actionClaimsAndConfirmationsSince?dateTime=2018-12-29T08:00:00.000-07:00' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl 'http://localhost:3000/util/objectWithKeysSorted?object=\{"b":\[5,1,2,3,\{"bc":3,"bb":2,"ba":1\}\],"a":4\}'
curl 'http://localhost:3000/api/action?eventStartTime=2018-12-29T08:00:00.000-07:00' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
# tenure
curl http://localhost:3000/api/claim -H "Content-Type: application/json" -d '{"jwtEncoded": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpYXQiOjE1NzQxMzcwMDAsInN1YiI6ImRpZDpldGhyOjB4MDBjOWMyMzI2YzczZjczMzgwZTg0MDJiMDFkZTlkZWZjZmYyYjA2NCIsImNsYWltIjp7IkBjb250ZXh0IjoiaHR0cDovL2VuZG9yc2VyLmNoIiwiQHR5cGUiOiJUZW51cmUiLCJzcGF0aWFsVW5pdCI6eyJnZW8iOnsiQHR5cGUiOiJHZW9TaGFwZSIsInBvbHlnb24iOiI0MC44ODM5NDQsLTExMS44ODQ3ODcgNDAuODg0MDg4LC0xMTEuODg0Nzg3IDQwLjg4NDA4OCwtMTExLjg4NDUxNSA0MC44ODM5NDQsLTExMS44ODQ1MTUgNDAuODgzOTQ0LC0xMTEuODg0Nzg3In19LCJwYXJ0eSI6eyJkaWQiOiJkaWQ6ZXRocjoweGRmMGQ4ZTVmZDIzNDA4NmY2NjQ5Zjc3YmIwMDU5ZGUxYWViZDE0M2UifX0sImlzcyI6ImRpZDpldGhyOjB4MDBjOWMyMzI2YzczZjczMzgwZTg0MDJiMDFkZTlkZWZjZmYyYjA2NCJ9.BfhZevLwMi48ATRvfZeJeDicbjIiruMIjBVXP__wQP-Ir8TtAf8fFC0iTDW4b6zTyZgk-YH1X781uIO4TsfBag"}' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl http://localhost:3000/api/tenure/1 -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl 'http://localhost:3000/api/report/tenureClaimsAtPoint?lat=40.883944&lon=-111.884787' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN"
curl 'http://localhost:3000/api/report/tenureClaimsAndConfirmationsAtPoint?lat=40.883944&lon=-111.884787' -H "Uport-Push-Token: $UPORT_PUSH_TOKEN" | json_pp
curl -X POST http://localhost:3000/api/claim/makeMeGloballyVisible -H "Content-Type: application/json" -H "Uport-Push-Token: $UPORT_PUSH_TOKEN" -d '{"url":"http://IgniteCommunity.org"}'
We have Swagger docs on production.
... but note that these are created by hand and may not be up to date with the latest code. (I hope to automatically generate these from the code in the future so that both planned & existing APIs are available.)
More recent endpoints, especially the ones under the "api/v2" path, return an object with "data" (for GETs) or "success" (for POSTs), or alternatively "error" when there is a problem.
The reports with "v2" in the URL include paging that will retrieve more than just the most recent matches (currently 50). These endpoints return an object with a "data" property that contains all the results, and then a "hitLimit" property that tells whether there may be more results:
{
"data": [...],
"hitLimit": true
}
Without extra parameters, these will return the most recent batch. To get results further back, add a "beforeId" parameter.
For example, the default "api/v2/report/claims" will return data with the oldest having an ID of "01GQBE7Q0RQQAGJMEEW6RSGKTF", so if you call it with that as the "beforeId" then you'll get the next batch that goes further in the past (excluding that one):
curl -X GET "https://endorser.ch:3000/api/v2/report/claims?beforeId=01GQBE7Q0RQQAGJMEEW6RSGKTF" -H "accept: application/json"
These endpoints return a "success" property, possibly with some data.
Project initialized with https://github.com/cdimascio/generator-express-no-stress
- Sovrin AKA Hyperledger Indy
- Accredible and their verification system which uses Tierion
- Blockcerts for blockchain credentials
- [Open Badges spec] (https://www.imsglobal.org/sites/default/files/Badges/OBv2p0Final/index.html)
-
When the API disallows and says a user "has already claimed" or "has already registered" their maximum for the week, you can up their limit in the database registration table (or, if they haven't been set explicitly in the DB for that user, increase the DEFAULT_MAX settings at the top of jwt.service.js).
-
Repeated sign-in (because it doesn't remember you): After sign-in, see what browser it uses after you log in from uPort, and use that from now on to start the flow. (On some Android phones, we've noticed that it's hard to tell which browser that is because the app shows endorser.ch inside a uPort window; we eventually found it was Duck-Duck-Go... so try all the possible browsers, and watch closely as it jumps to the browser to see if there's any indication.)
-
"CORS problems": is endorser-ch running?
-
"Please make sure to have at least one network": check that your .env has set a value for INFURA_PROJECT_ID (see .env setup above)
-
"Unsupported DID method 'ethr'": dependencies? see https://github.com/trentlarson/endorser-ch/commit/a836946c1b1897000dbe7e6d610df32aa32742ba
-
"Converting circular structure to JSON": network connected?
-
"Error: expected "Content-Type" header field" during automated tests: run them again.
-
This:
../fsevents.cc:85:58: error: expected ';' after top level declarator
void FSEvents::Initialize(v8::Handle<v8::Object> exports) {
^
;
23 warnings and 9 errors generated.
make: *** [Release/obj.target/fse/fsevents.o] Error 1
gyp ERR! build error
gyp ERR! stack Error: `make` failed with exit code: 2
...
node-pre-gyp ERR! build error
node-pre-gyp ERR! stack Error: Failed to execute '/Users/tlarson/.nvm/versions/node/v12.13.1/bin/node /Users/tlarson/.nvm/versions/node/v12.13.1/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js ...
...
npm ERR! [email protected] install: `node-pre-gyp install --fallback-to-build`
npm ERR! Exit status 1
...
... probably means you're running a different version of node. Prod is on node v10.15.0 and npm 6.4.1
- This:
> [email protected] flyway /Users/tlarson/dev/home/endorser-ch
> flyway -c conf/flyway.js "migrate"
flyway-8.5.10/jre/lib/server/libjvm.dylib: truncated gzip input
tar: Error exit delayed from previous errors.
(node:12554) UnhandledPromiseRejectionWarning: Error: Error: Untaring file failed 1
at /Users/tlarson/dev/home/endorser-ch/node_modules/node-flywaydb/bin/flyway.js:76:19
at processTicksAndRejections (internal/process/task_queues.js:93:5)
(node:12554) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:12554) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
... may require removal of node_modules and reinstall.
- Make sure API works: http://localhost:3000/api-explorer
- Run test/test.sh
- Test these :3001 URLs by running the web app http://localhost:3001/reportClaim?claimId=1
... and see confirmations eventually (even if they're HIDDEN which causes console errors) http://localhost:3001/reportClaims
... to see a list of claims http://localhost:3001/reportConfirms
... gives 5 confirmations
... and then go to a place not logged in http://localhost:3001/reportBestAttendance
... and see all hidden
... then test the following user story if you have time.
User stories:
-
in endorser-ch
- run test/test.sh (can quit after first set of tests for a quick, non-network validation)
- run: NODE_ENV=test-local npm run dev
-
in mobile app
-
change to TEST_USER_NUM = 11 (Annabelle's Friend) in src/utilities/claimsTest.js
-
run:
npm run build && npm run start
-
show attendance results
- on Best Attendance screen http://localhost:3001/reportBestAttendance and see all DIDs are hidden except public 22c
-
show search results for skills http://localhost:3001/reportSearch
- search for "carpentry" and see all DIDs are hidden
- run in endorser-ch: npm run set-3-visible
- search for "carpentry" and see 332 DIDs are shown and some are transitive, eg. in identifierVisibleToDids
-
show eligibility results
- on search screen Call Endpoint with: /api/report/actionClaimsAndConfirmationsSince?dateTime=2018-01-01T00:00:00Z
- processed to see confirmations searchResults.map((obj) => {return {did: obj.did, numActions: obj.actions.length, numConfirms: R.sum(obj.actions.map((a)=>a.confirmations.length))}}) ... and see 3 confirmations, two hidden and one 22c public
-
show voting results
- see votes on search screen Call Endpoint with: /api/report/orgRoleClaimsAndConfirmationsOnDate?orgName=Cottonwood%20Cryptography%20Club&roleName=President&onDate=2019-06-18
- processed to see votes R.map(o=>{return {did:o.did, roles:R.map(role=>{return {votes:role.confirmations.length, roleName:role.orgRole.roleName}})(o.orgRoles)}})(searchResults) ... and 2 results, three for hidden and two for 332
-
show tenure results and links to find people
- go to Residence Report http://localhost:3001/reportResidences
- see duplicate tenure claims, one hidden
- change to TEST_USER_NUM = -1 (Trent) in src/utilities/claimsTest.js
- in tenure claim, see a different user hidden
- confirm something about Annabelle did:ethr:0xaaa29f09c29fb0666b8302b64871d7029032b479 ... and see claim with ID 32 saved http://localhost:3001/claim?claimId=32
- change to TEST_USER_NUM = 11 (Annabelle's Friend) in src/utilities/claimsTest.js
- in tenure claim, go to see how there's now a reachable path to find out the other owner
-
-
using data generated from tests
-
Users #2 & #3 want to find any common contact.
-
See some records & confirmations.
- search on "give"
- confirmed by me: user #2: see 0 gave 2 hours, confirmed by connections
- hidden & linked: user #3: see ? gave 3 USD, not-visible is visible to others
-
User #2 wants to verify skills of user #3
- find my own claim: user #3: search for carpentry, use second to last in list
-
This will help visualize the network from the test data:
-
Get from DB:
select "{source:'" || substring(subject, 12, 1) || "', target:'" || substring(object, 12, 1) || "', type: 'suit'}," from network;
-
Go to https://observablehq.com/@d3/mobile-patent-suits and substitute that data into the 'links' variable, wrapped in '[]'.
-
See the network links at the top.
Here is a sample CSV for contacts, with data taken from the tests.
... though I just saw this in the docs and I don't really know what it means.
./test/test.sh :debug
mkdir metrics
cd metrics
# Use Node & NPM/Yarn
# ... with tea:
#tea +nodejs.org +pnpm.io sh
mkdir node_modules # so it doesn't search in parent directories
pnpm add bent ramda
// This is just if you want to get private data. (See below, too.)
#pnpm add [email protected]
node --experimental-modules
// The rest is inside your node CLI.
//let getServer = () => { return 'http://localhost:3000' }
let getServer = () => { return 'https://api.endorser.ch' }
const bent = require('bent')
const fs = require('node:fs')
// These are just if you want to get private data. (See below, too.)
//const OWNER_DID = 'OWNER_DID'
//const OWNER_PRIVATE_KEY_HEX = 'OWNER_PRIVATE_KEY_HEX'
//const didJwt = await import('did-jwt')
// 'count' returns { data: [...], maybeMoreAfter: 'ID' }
let count = async (moreBefore) => {
let options = { "Content-Type": "application/json" }
/**/
// These are just if you want to get private data.
const nowEpoch = Math.floor(Date.now() / 1000)
const endEpoch = nowEpoch + 60
const tokenPayload = { exp: endEpoch, iat: nowEpoch, iss: OWNER_DID }
const signer = didJwt.SimpleSigner(OWNER_PRIVATE_KEY_HEX)
const accessJwt = await didJwt.createJWT(tokenPayload, { issuer: OWNER_DID, signer })
options = R.mergeLeft({ "Authorization": "Bearer " + accessJwt }, options)
/**/
const getJson = bent('json', options)
return getJson(getServer() + '/api/v2/report/claims?beforeId=' + moreBefore)
}
const R = require('ramda')
let all = []
let fillAll = async () => {
let moreBefore = 'Z'
do {
const result = await count(moreBefore)
all = R.concat(all, result.data)
moreBefore = result.hitLimit ? result.data[result.data.length - 1].id : ''
console.log(all.length, moreBefore, '...')
} while (moreBefore)
console.log('Grand total:', all.length)
const totalSum = R.map(i => R.set(R.lensProp('month'), i.issuedAt.substring(0, 7), i), all)
const grouped = R.groupBy(i => i.month, totalSum)
const table = R.map(i => i.length, grouped)
// output grouped totals
console.log('Grouped:', JSON.stringify(table, null, 2))
// output each row in CSV format
//all.map(record => console.log(record.issuedAt.substring(0, 7), ",", record.claimType))
}
await fillAll()
// write months & types to CSV
all.map(record => fs.appendFileSync('metrics.csv', record.issuedAt.substring(0, 7) + ',' + record.issuedAt + ',' + record.claimType + '\n'))
// write months and issuer DIDs to CSV
all.map(record => fs.appendFileSync('metrics-issuer.csv', record.issuedAt.substring(0, 7) + ',' + record.issuedAt + ',' + record.issuer + '\n'))
// write months and number of unique DIDs
let monthUniqDids = R.uniq(R.map(record => record.issuedAt.substring(0, 7) + ',' + record.issuer, all))
let monthUniqDidsStripped = R.sortBy(pair => pair[0], R.toPairs(R.countBy(k => k.substring(0,7), monthUniqDids)))
R.map((pair) => fs.appendFileSync('metrics-uniq-issuer.csv', pair[0] + ',' + pair[1] + '\n'), monthUniqDidsStripped)
// write months and number of hidden DIDs
let monthHiddenDids = R.countBy(R.identity, R.map(rec => rec.issuedAt.substring(0, 7), R.filter(rec => rec.issuer === 'did:none:HIDDEN', all)))
let monthHiddenDidsSorted = R.sortBy(pair => pair[0], R.toPairs(monthHiddenDids))
R.map((pair) => fs.appendFileSync('metrics-hidden-issuer.csv', pair[0] + ',' + pair[1] + '\n'), monthHiddenDidsSorted)
See tasks.yml.
This is licensed as public domain software, but I sure would enjoy a note if you get people using it.
Note that new deployments can remove the code for: "legacy Confirmation", "legacy context"
Here's a way to verify a JWT signature.
- Go to an empty directory (where you'll install and run code)
yarn add [email protected] [email protected]
node
const infuraProjectId = '...' // get one at infura.io
const didJWT = require('did-jwt')
const Resolver = require('did-resolver').Resolver
const ethrDid = require('ethr-did-resolver').getResolver({rpcUrl: 'https://mainnet.infura.io/v3/' + infuraProjectId})
let resolver = new Resolver(ethrDid)
let result;
async function verify(jwt) {
result = await didJWT.verifyJWT(jwt, {resolver: resolver})
console.log("Result of 'verify':\n", result, '\n... and doc\n', result.doc);
}
- Finally, enter this with your JWT string:
verify("PASTE JWT HERE")
- If you see
Signature invalid for JWT
, you're being tricked. Otherwise, it checks out.- If you see some other error (eg. "expired"), that's OK... it still passed the signature check, as long as it gets past this line: https://github.com/decentralized-identity/did-jwt/blob/v4.0.0/src/JWT.ts#L231
DB Settings:
APP_DB_FILE
is used to select the DB file (see conf/flyway.js)NODE_ENV
is used to determine the DB file ifAPP_DB_FILE
is not set (see conf/flyway.js)
Open questions:
- Should we require top-level @context and @type (where multiple become ItemList)?
- How do I find the app address or ID? 0xa55...40b, from phone to IP: 0x669...e8a then 0x1b2...2e6
- What is the strange "notifications" JWT from 2020-01-26 21:59:50.106 ?
- Why does the did-jwt verifyJWT throw: Error: Signature invalid for JWT ... on this content:
{
'@context': '123456789012345678',
'@type': '123456789012',
originalClaims: [
{
'@context': '12345678901234567',
'@type': '1234567890',
agent: {
did: '123456789012345678901234567890123456789012345678901'
},
event: {
organizer: {
name: '12345678901234567890123456789012'
},
name: '123456789012345678901234',
startTime: '12345678901234567890123456789'
}
}
]
}
... but if you add or remove a character anywhere then it validates just fine? (Note that I tried another 340-character string and its signature verified OK.) If we fix this, we can fix some hacks in SignClaim (look for "milliseconds").
References