@sphereon/oid4vci-client 0.7.0 → 0.7.1-next.8

package/lib/__tests__/IssuanceInitiation.spec.ts

@@ -1,3 +1,5 @@
+import { OpenId4VCIVersion } from '@sphereon/oid4vci-common';
+
 import { CredentialOfferClient } from '../CredentialOfferClient';
 
 import { INITIATION_TEST, INITIATION_TEST_HTTPS_URI, INITIATION_TEST_URI } from './MetadataMocks';
@@ -45,4 +47,15 @@ describe('Issuance Initiation', () => {
     const issuanceInitiationURI = INITIATION_TEST_HTTPS_URI.replace('?', '');
     await expect(async () => CredentialOfferClient.fromURI(issuanceInitiationURI)).rejects.toThrowError('Invalid Credential Offer Request');
   });
+
+  it('Should return Credential Offer', async () => {
+    const client = await CredentialOfferClient.fromURI(
+      'openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Flaunchpad.vii.electron.mattrlabs.io%22%2C%22credentials%22%3A%5B%7B%22format%22%3A%22ldp_vc%22%2C%22types%22%3A%5B%22OpenBadgeCredential%22%5D%7D%5D%2C%22grants%22%3A%7B%22urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Apre-authorized_code%22%3A%7B%22pre-authorized_code%22%3A%22UPZohaodPlLBnGsqB02n2tIupCIg8nKRRUEUHWA665X%22%7D%7D%7D',
+    );
+    expect(client.version).toEqual(OpenId4VCIVersion.VER_1_0_11);
+    expect(client.baseUrl).toEqual('openid-credential-offer://');
+    expect(client.scheme).toEqual('openid-credential-offer');
+    expect(client.credential_offer.credential_issuer).toEqual('https://launchpad.vii.electron.mattrlabs.io');
+    expect(client.preAuthorizedCode).toEqual('UPZohaodPlLBnGsqB02n2tIupCIg8nKRRUEUHWA665X');
+  });
 });

package/lib/__tests__/MattrE2E.spec.test.ts

@@ -0,0 +1,109 @@
+import { CredentialMapper } from '@sphereon/ssi-types'
+import { fetch } from 'cross-fetch';
+import { Alg, AuthzFlowType, Jwt } from '@sphereon/oid4vci-common';
+import { importJWK, JWK, SignJWT } from 'jose';
+
+import { OpenID4VCIClient } from '..';
+
+export const UNIT_TEST_TIMEOUT = 30000;
+
+const ISSUER_URL = 'https://launchpad.vii.electron.mattrlabs.io';
+
+const jwk: JWK = {
+  crv: 'Ed25519',
+  d: 'kTRm0aONHYwNPA-w_DtjMHUIWjE3K70qgCIhWojZ0eU',
+  x: 'NeA0d8sp86xRh3DczU4m5wPNIbl0HCSwOBcMN3sNmdk',
+  kty: 'OKP',
+};
+
+// pub  hex: 35e03477cb29f3ac518770dccd4e26e703cd21b9741c24b038170c377b0d99d9
+// priv hex: 913466d1a38d1d8c0d3c0fb0fc3b633075085a31372bbd2a8022215a88d9d1e5
+const did = `did:key:z6Mki5ZwZKN1dBQprfJTikUvkDxrHijiiQngkWviMF5gw2Hv`;
+const kid = `${did}#z6Mki5ZwZKN1dBQprfJTikUvkDxrHijiiQngkWviMF5gw2Hv`;
+describe('OID4VCI-Client using Mattr issuer should', () => {
+  async function test(format: 'ldp_vc' | 'jwt_vc_json') {
+    const offer = await getCredentialOffer(format)
+    const client = await OpenID4VCIClient.fromURI({
+      uri: offer.offerUrl,
+      flowType: AuthzFlowType.PRE_AUTHORIZED_CODE_FLOW,
+      kid,
+      alg: Alg.EdDSA
+    })
+    expect(client.flowType).toEqual(AuthzFlowType.PRE_AUTHORIZED_CODE_FLOW)
+    expect(client.credentialOffer).toBeDefined()
+    expect(client.endpointMetadata).toBeDefined()
+    expect(client.getCredentialEndpoint()).toEqual(`${ISSUER_URL}/oidc/v1/auth/credential`)
+    expect(client.getAccessTokenEndpoint()).toEqual('https://launchpad.vii.electron.mattrlabs.io/oidc/v1/auth/token')
+
+    const accessToken = await client.acquireAccessToken()
+    console.log(accessToken)
+    expect(accessToken).toMatchObject({
+      expires_in: 3600,
+      scope: 'OpenBadgeCredential',
+      token_type: 'Bearer'
+    })
+
+    const credentialResponse = await client.acquireCredentials({
+      credentialTypes: 'OpenBadgeCredential',
+      format,
+      proofCallbacks: {
+        signCallback: proofOfPossessionCallbackFunction
+      }
+    })
+    expect(credentialResponse.credential).toBeDefined()
+    const wrappedVC = CredentialMapper.toWrappedVerifiableCredential(credentialResponse.credential!)
+    expect(format.startsWith(wrappedVC.format)).toEqual(true)
+
+  }
+
+  it(
+    'succeed in a full flow with the client using OpenID4VCI version 11 and ldp_vc',
+    async () => {
+
+      await test('ldp_vc')
+    },
+    UNIT_TEST_TIMEOUT,
+  );
+  it(
+    'succeed in a full flow with the client using OpenID4VCI version 11 and jwt_vc_json',
+    async () => {
+
+      await test('jwt_vc_json')
+    },
+    UNIT_TEST_TIMEOUT,
+  );
+});
+
+interface CreateCredentialOfferResponse {
+  id: string;
+  offerUrl: string;
+}
+
+async function getCredentialOffer(format: 'ldp_vc' | 'jwt_vc_json'): Promise<CreateCredentialOfferResponse> {
+  const credentialOffer = await fetch('https://launchpad.mattrlabs.com/api/credential-offer', {
+    method: 'post',
+    headers: {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+    },
+
+    //make sure to serialize your JSON body
+    body: JSON.stringify({
+      format,
+      type: 'OpenBadgeCredential',
+      userId: '622a9f65-21c0-4c0b-9a6a-f7574c2a1549',
+      userAuthenticationRequired: false,
+    }),
+  });
+
+  return (await credentialOffer.json()) as CreateCredentialOfferResponse;
+}
+
+async function proofOfPossessionCallbackFunction(args: Jwt, kid?: string): Promise<string> {
+  const importedJwk = await importJWK(jwk, 'EdDSA');
+  return await new SignJWT({ ...args.payload })
+    .setProtectedHeader({ ...args.header })
+    .setIssuedAt()
+    .setExpirationTime('2h')
+    .sign(importedJwk);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/oid4vci-client",
-  "version": "0.7.0",
+  "version": "0.7.1-next.8+ff30029",
   "description": "OpenID for Verifiable Credential Issuance (OpenID4VCI) client",
   "source": "lib/index.ts",
   "main": "dist/index.js",
@@ -15,15 +15,14 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@sphereon/oid4vci-common": "0.7.0",
+    "@sphereon/oid4vci-common": "0.7.1-next.8+ff30029",
     "@sphereon/ssi-types": "^0.15.1",
     "cross-fetch": "^3.1.8",
-    "debug": "^4.3.4",
-    "uint8arrays": "^4.0.6"
+    "debug": "^4.3.4"
   },
   "devDependencies": {
     "@types/jest": "^29.5.3",
-    "@types/node": "^18.17.3",
+    "@types/node": "^18.17.4",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "codecov": "^3.8.3",
@@ -40,7 +39,8 @@
     "open-cli": "^7.2.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "4.9.5"
+    "typescript": "4.9.5",
+    "uint8arrays": "3.1.1"
   },
   "engines": {
     "node": ">=16"
@@ -64,5 +64,5 @@
     "OIDC4VCI",
     "OID4VCI"
   ],
-  "gitHead": "bb9fcd4c5e590302f0a1aff61f424bee5a5787e8"
+  "gitHead": "ff30029a30bf7d87285e02611e0135e01d22e3b7"
 }