@pagopa/io-react-native-wallet 2.0.0-next.1 → 2.0.0-next.3

package/src/trust/index.ts

@@ -1,443 +1,6 @@
-import { decode, verify } from "./utils";
-import { decode as decodeJwt } from "@pagopa/io-react-native-jwt";
-import {
-  CredentialIssuerEntityConfiguration,
-  EntityConfiguration,
-  EntityStatement,
-  FederationListResponse,
-  RelyingPartyEntityConfiguration,
-  TrustAnchorEntityConfiguration,
-  WalletProviderEntityConfiguration,
-} from "./types";
-import { renewTrustChain, validateTrustChain } from "./chain";
-import { hasStatusOrThrow } from "../utils/misc";
-import type { JWK } from "../utils/jwk";
-import {
-  BuildTrustChainError,
-  FederationListParseError,
-  MissingFederationFetchEndpointError,
-  RelyingPartyNotAuthorizedError,
-  TrustAnchorKidMissingError,
-} from "./errors";
-import type { X509CertificateOptions } from "@pagopa/io-react-native-crypto";
+import * as Build from "./build-chain";
+import * as Verify from "./verify-chain";
+import * as Errors from "./errors";
+import * as Types from "./types";
 
-export type {
-  WalletProviderEntityConfiguration,
-  TrustAnchorEntityConfiguration,
-  CredentialIssuerEntityConfiguration,
-  RelyingPartyEntityConfiguration,
-  EntityConfiguration,
-  EntityStatement,
-};
-
-/**
- * Verify a given trust chain is actually valid.
- * It can handle fast chain renewal, which means we try to fetch a fresh version of each statement.
- *
- * @param trustAnchorEntity The entity configuration of the known trust anchor
- * @param chain The chain of statements to be validated
- * @param x509Options Options for the verification process
- * @param appFetch (optional) fetch api implementation
- * @param renewOnFail Whether to attempt to renew the trust chain if the initial validation fails
- * @returns The result of the chain validation
- * @throws {FederationError} If the chain is not valid
- */
-export async function verifyTrustChain(
-  trustAnchorEntity: TrustAnchorEntityConfiguration,
-  chain: string[],
-  x509Options: X509CertificateOptions = {
-    connectTimeout: 10000,
-    readTimeout: 10000,
-    requireCrl: true,
-  },
-  {
-    appFetch = fetch,
-    renewOnFail = true,
-  }: { appFetch?: GlobalFetch["fetch"]; renewOnFail?: boolean } = {}
-): Promise<ReturnType<typeof validateTrustChain>> {
-  try {
-    return validateTrustChain(trustAnchorEntity, chain, x509Options);
-  } catch (error) {
-    if (renewOnFail) {
-      const renewedChain = await renewTrustChain(chain, appFetch);
-      return validateTrustChain(trustAnchorEntity, renewedChain, x509Options);
-    } else {
-      throw error;
-    }
-  }
-}
-
-/**
- * Fetch the signed entity configuration token for an entity
- *
- * @param entityBaseUrl The url of the entity to fetch
- * @param appFetch (optional) fetch api implementation
- * @returns The signed Entity Configuration token
- */
-export async function getSignedEntityConfiguration(
-  entityBaseUrl: string,
-  {
-    appFetch = fetch,
-  }: {
-    appFetch?: GlobalFetch["fetch"];
-  } = {}
-): Promise<string> {
-  const wellKnownUrl = `${entityBaseUrl}/.well-known/openid-federation`;
-
-  return await appFetch(wellKnownUrl, {
-    method: "GET",
-  })
-    .then(hasStatusOrThrow(200))
-    .then((res) => res.text());
-}
-
-/**
- * Fetch and parse the entity configuration document for a given federation entity.
- * This is an inner method to serve public interfaces.
- *
- * To add another entity configuration type (example: Foo entity type):
- *  - create its zod schema and type by inherit from the base type (example: FooEntityConfiguration = BaseEntityConfiguration.and(...))
- *  - add such type to EntityConfiguration union
- *  - add an overload to this function
- *  - create a public function which use such type (example: getFooEntityConfiguration = (url, options) => Promise<FooEntityConfiguration>)
- *
- * @param entityBaseUrl The base url of the entity.
- * @param schema The expected schema of the entity configuration, according to the kind of entity we are fetching from.
- * @param options An optional object with additional options.
- * @param options.appFetch An optional instance of the http client to be used.
- * @returns The parsed entity configuration object
- * @throws {IoWalletError} If the http request fails
- * @throws Parse error if the document is not in the expected shape.
- */
-async function fetchAndParseEntityConfiguration(
-  entityBaseUrl: string,
-  schema: typeof WalletProviderEntityConfiguration,
-  options?: {
-    appFetch?: GlobalFetch["fetch"];
-  }
-): Promise<WalletProviderEntityConfiguration>;
-async function fetchAndParseEntityConfiguration(
-  entityBaseUrl: string,
-  schema: typeof RelyingPartyEntityConfiguration,
-  options?: {
-    appFetch?: GlobalFetch["fetch"];
-  }
-): Promise<RelyingPartyEntityConfiguration>;
-async function fetchAndParseEntityConfiguration(
-  entityBaseUrl: string,
-  schema: typeof TrustAnchorEntityConfiguration,
-  options?: {
-    appFetch?: GlobalFetch["fetch"];
-  }
-): Promise<TrustAnchorEntityConfiguration>;
-async function fetchAndParseEntityConfiguration(
-  entityBaseUrl: string,
-  schema: typeof CredentialIssuerEntityConfiguration,
-  options?: {
-    appFetch?: GlobalFetch["fetch"];
-  }
-): Promise<CredentialIssuerEntityConfiguration>;
-async function fetchAndParseEntityConfiguration(
-  entityBaseUrl: string,
-  schema: typeof EntityConfiguration,
-  options?: {
-    appFetch?: GlobalFetch["fetch"];
-  }
-): Promise<EntityConfiguration>;
-async function fetchAndParseEntityConfiguration(
-  entityBaseUrl: string,
-  schema: /* FIXME: why is it different from "typeof EntityConfiguration"? */
-  | typeof CredentialIssuerEntityConfiguration
-    | typeof WalletProviderEntityConfiguration
-    | typeof RelyingPartyEntityConfiguration
-    | typeof TrustAnchorEntityConfiguration
-    | typeof EntityConfiguration,
-  {
-    appFetch = fetch,
-  }: {
-    appFetch?: GlobalFetch["fetch"];
-  } = {}
-) {
-  const responseText = await getSignedEntityConfiguration(entityBaseUrl, {
-    appFetch,
-  });
-
-  const responseJwt = decodeJwt(responseText);
-  return schema.parse({
-    header: responseJwt.protectedHeader,
-    payload: responseJwt.payload,
-  });
-}
-
-export const getWalletProviderEntityConfiguration = (
-  entityBaseUrl: Parameters<typeof fetchAndParseEntityConfiguration>[0],
-  options?: Parameters<typeof fetchAndParseEntityConfiguration>[2]
-) =>
-  fetchAndParseEntityConfiguration(
-    entityBaseUrl,
-    WalletProviderEntityConfiguration,
-    options
-  );
-
-export const getCredentialIssuerEntityConfiguration = (
-  entityBaseUrl: Parameters<typeof fetchAndParseEntityConfiguration>[0],
-  options?: Parameters<typeof fetchAndParseEntityConfiguration>[2]
-) =>
-  fetchAndParseEntityConfiguration(
-    entityBaseUrl,
-    CredentialIssuerEntityConfiguration,
-    options
-  );
-
-export const getTrustAnchorEntityConfiguration = (
-  entityBaseUrl: Parameters<typeof fetchAndParseEntityConfiguration>[0],
-  options?: Parameters<typeof fetchAndParseEntityConfiguration>[2]
-) =>
-  fetchAndParseEntityConfiguration(
-    entityBaseUrl,
-    TrustAnchorEntityConfiguration,
-    options
-  );
-
-export const getRelyingPartyEntityConfiguration = (
-  entityBaseUrl: Parameters<typeof fetchAndParseEntityConfiguration>[0],
-  options?: Parameters<typeof fetchAndParseEntityConfiguration>[2]
-) =>
-  fetchAndParseEntityConfiguration(
-    entityBaseUrl,
-    RelyingPartyEntityConfiguration,
-    options
-  );
-
-export const getEntityConfiguration = (
-  entityBaseUrl: Parameters<typeof fetchAndParseEntityConfiguration>[0],
-  options?: Parameters<typeof fetchAndParseEntityConfiguration>[2]
-) =>
-  fetchAndParseEntityConfiguration(entityBaseUrl, EntityConfiguration, options);
-
-/**
- * Fetch and parse the entity statement document for a given federation entity.
- *
- * @param accreditationBodyBaseUrl The base url of the accreditation body which holds and signs the required entity statement
- * @param subordinatedEntityBaseUrl The url that identifies the subordinate entity
- * @param appFetch An optional instance of the http client to be used.
- * @returns The parsed entity configuration object
- * @throws {IoWalletError} If the http request fails
- */
-export async function getEntityStatement(
-  accreditationBodyBaseUrl: string,
-  subordinatedEntityBaseUrl: string,
-  {
-    appFetch = fetch,
-  }: {
-    appFetch?: GlobalFetch["fetch"];
-  } = {}
-) {
-  const responseText = await getSignedEntityStatement(
-    accreditationBodyBaseUrl,
-    subordinatedEntityBaseUrl,
-    {
-      appFetch,
-    }
-  );
-
-  const responseJwt = decodeJwt(responseText);
-  return EntityStatement.parse({
-    header: responseJwt.protectedHeader,
-    payload: responseJwt.payload,
-  });
-}
-
-/**
- * Fetch the entity statement document for a given federation entity.
- *
- * @param federationFetchEndpoint The exact endpoint provided by the parent EC's metadata.
- * @param subordinatedEntityBaseUrl The url that identifies the subordinate entity.
- * @param appFetch An optional instance of the http client to be used.
- * @returns The signed entity statement token.
- * @throws {IoWalletError} If the http request fails.
- */
-export async function getSignedEntityStatement(
-  federationFetchEndpoint: string,
-  subordinatedEntityBaseUrl: string,
-  {
-    appFetch = fetch,
-  }: {
-    appFetch?: GlobalFetch["fetch"];
-  } = {}
-) {
-  const url = new URL(federationFetchEndpoint);
-  url.searchParams.set("sub", subordinatedEntityBaseUrl);
-
-  return await appFetch(url.toString(), {
-    method: "GET",
-  })
-    .then(hasStatusOrThrow(200))
-    .then((res) => res.text());
-}
-
-/**
- * Fetch the federation list document from a given endpoint.
- *
- * @param federationListEndpoint The URL of the federation list endpoint.
- * @param appFetch An optional instance of the http client to be used.
- * @returns The federation list as an array of strings.
- * @throws {IoWalletError} If the HTTP request fails.
- * @throws {FederationError} If the result is not in the expected format.
- */
-export async function getFederationList(
-  federationListEndpoint: string,
-  {
-    appFetch = fetch,
-  }: {
-    appFetch?: GlobalFetch["fetch"];
-  } = {}
-): Promise<string[]> {
-  return await appFetch(federationListEndpoint, {
-    method: "GET",
-  })
-    .then(hasStatusOrThrow(200))
-    .then((res) => res.json())
-    .then((json) => {
-      const result = FederationListResponse.safeParse(json);
-      if (!result.success) {
-        throw new FederationListParseError(
-          `Invalid federation list format received from ${federationListEndpoint}. Error: ${result.error.message}`,
-          { url: federationListEndpoint, parseError: result.error.toString() }
-        );
-      }
-      return result.data;
-    });
-}
-
-/**
- * Build a not-verified trust chain for a given Relying Party (RP) entity.
- *
- * @param relyingPartyEntityBaseUrl The base URL of the RP entity
- * @param trustAnchorKey The public key of the Trust Anchor (TA) entity
- * @param appFetch An optional instance of the http client to be used.
- * @returns A list of signed tokens that represent the trust chain, in the order of the chain (from the RP to the Trust Anchor)
- * @throws {FederationError} When an element of the chain fails to parse or other build steps fail.
- */
-export async function buildTrustChain(
-  relyingPartyEntityBaseUrl: string,
-  trustAnchorKey: JWK,
-  appFetch: GlobalFetch["fetch"] = fetch
-): Promise<string[]> {
-  // 1: Recursively gather the trust chain from the RP up to the Trust Anchor
-  const trustChain = await gatherTrustChain(
-    relyingPartyEntityBaseUrl,
-    appFetch
-  );
-
-  // 2: Trust Anchor signature verification
-  const trustAnchorJwt = trustChain[trustChain.length - 1];
-  if (!trustAnchorJwt) {
-    throw new BuildTrustChainError(
-      "Cannot verify trust anchor: missing entity configuration in gathered chain.",
-      { relyingPartyUrl: relyingPartyEntityBaseUrl }
-    );
-  }
-
-  if (!trustAnchorKey.kid) {
-    throw new TrustAnchorKidMissingError();
-  }
-
-  await verify(trustAnchorJwt, trustAnchorKey.kid, [trustAnchorKey]);
-
-  // 3: Check the federation list
-  const trustAnchorConfig = EntityConfiguration.parse(decode(trustAnchorJwt));
-  const federationListEndpoint =
-    trustAnchorConfig.payload.metadata.federation_entity
-      .federation_list_endpoint;
-
-  if (federationListEndpoint) {
-    const federationList = await getFederationList(federationListEndpoint, {
-      appFetch,
-    });
-
-    if (!federationList.includes(relyingPartyEntityBaseUrl)) {
-      throw new RelyingPartyNotAuthorizedError(
-        "Relying Party entity base URL is not authorized by the Trust Anchor's federation list.",
-        { relyingPartyUrl: relyingPartyEntityBaseUrl, federationListEndpoint }
-      );
-    }
-  }
-
-  return trustChain;
-}
-
-/**
- * Recursively gather the trust chain for an entity and all its superiors.
- * @param entityBaseUrl The base URL of the entity for which to gather the chain.
- * @param appFetch An optional instance of the http client to be used.
- * @param isLeaf Whether the current entity is the leaf of the chain.
- * @returns A full ordered list of JWTs (ECs and ESs) forming the trust chain.
- * @throws {FederationError} If any of the fetched documents fail to parse or other errors occur during the gathering process.
- */
-async function gatherTrustChain(
-  entityBaseUrl: string,
-  appFetch: GlobalFetch["fetch"],
-  isLeaf: boolean = true
-): Promise<string[]> {
-  const chain: string[] = [];
-
-  // Fetch self-signed EC (only needed for the leaf)
-  const entityECJwt = await getSignedEntityConfiguration(entityBaseUrl, {
-    appFetch,
-  });
-  const entityEC = EntityConfiguration.parse(decode(entityECJwt));
-
-  if (isLeaf) {
-    // Only push EC for the leaf
-    chain.push(entityECJwt);
-  }
-
-  // Find authority_hints (parent, if any)
-  const authorityHints = entityEC.payload.authority_hints ?? [];
-  if (authorityHints.length === 0) {
-    // This is the Trust Anchor (no parent)
-    if (!isLeaf) {
-      chain.push(entityECJwt);
-    }
-    return chain;
-  }
-
-  const parentEntityBaseUrl = authorityHints[0]!;
-
-  // Fetch parent EC
-  const parentECJwt = await getSignedEntityConfiguration(parentEntityBaseUrl, {
-    appFetch,
-  });
-  const parentEC = EntityConfiguration.parse(decode(parentECJwt));
-
-  // Fetch ES
-  const federationFetchEndpoint =
-    parentEC.payload.metadata.federation_entity.federation_fetch_endpoint;
-  if (!federationFetchEndpoint) {
-    throw new MissingFederationFetchEndpointError(
-      `Missing federation_fetch_endpoint in parent's (${parentEntityBaseUrl}) configuration when gathering chain for ${entityBaseUrl}.`,
-      { entityBaseUrl, missingInEntityUrl: parentEntityBaseUrl }
-    );
-  }
-
-  const entityStatementJwt = await getSignedEntityStatement(
-    federationFetchEndpoint,
-    entityBaseUrl,
-    { appFetch }
-  );
-  // Validate the ES
-  EntityStatement.parse(decode(entityStatementJwt));
-
-  // Push this ES into the chain
-  chain.push(entityStatementJwt);
-
-  // Recurse into the parent
-  const parentChain = await gatherTrustChain(
-    parentEntityBaseUrl,
-    appFetch,
-    false
-  );
-
-  return chain.concat(parentChain);
-}
+export { Build, Verify, Errors, Types };

package/src/trust/types.ts

@@ -37,12 +37,10 @@ const CredentialIssuerDisplayMetadata = z.object({
 });
 
 type ClaimsMetadata = z.infer<typeof ClaimsMetadata>;
-const ClaimsMetadata = z.record(
-  z.object({
-    value_type: z.string(),
-    display: z.array(z.object({ name: z.string(), locale: z.string() })),
-  })
-);
+const ClaimsMetadata = z.object({
+  path: z.array(z.string()),
+  display: z.array(CredentialDisplayMetadata),
+});
 
 type IssuanceErrorSupported = z.infer<typeof IssuanceErrorSupported>;
 const IssuanceErrorSupported = z.object({
@@ -57,16 +55,21 @@ const IssuanceErrorSupported = z.object({
 
 // Metadata for a credential which is supported by an Issuer
 type SupportedCredentialMetadata = z.infer<typeof SupportedCredentialMetadata>;
-const SupportedCredentialMetadata = z.object({
-  format: z.union([z.literal("vc+sd-jwt"), z.literal("vc+mdoc-cbor")]),
-  scope: z.string(),
-  display: z.array(CredentialDisplayMetadata),
-  claims: ClaimsMetadata,
-  cryptographic_binding_methods_supported: z.array(z.string()),
-  credential_signing_alg_values_supported: z.array(z.string()),
-  authentic_source: z.string().optional(),
-  issuance_errors_supported: z.record(IssuanceErrorSupported).optional(),
-});
+const SupportedCredentialMetadata = z.intersection(
+  z.discriminatedUnion("format", [
+    z.object({ format: z.literal("dc+sd-jwt"), vct: z.string() }),
+    z.object({ format: z.literal("mso_mdoc"), doctype: z.string() }),
+  ]),
+  z.object({
+    scope: z.string(),
+    display: z.array(CredentialDisplayMetadata),
+    claims: z.array(ClaimsMetadata),
+    cryptographic_binding_methods_supported: z.array(z.string()),
+    credential_signing_alg_values_supported: z.array(z.string()),
+    authentic_source: z.string().optional(),
+    issuance_errors_supported: z.record(IssuanceErrorSupported).optional(),
+  })
+);
 
 export type EntityStatement = z.infer<typeof EntityStatement>;
 export const EntityStatement = z.object({
@@ -155,13 +158,16 @@ export const CredentialIssuerEntityConfiguration = BaseEntityConfiguration.and(
         openid_credential_issuer: z.object({
           credential_issuer: z.string(),
           credential_endpoint: z.string(),
-          revocation_endpoint: z.string(),
+          revocation_endpoint: z.string().optional(),
+          nonce_endpoint: z.string(),
           status_attestation_endpoint: z.string(),
           display: z.array(CredentialIssuerDisplayMetadata),
           credential_configurations_supported: z.record(
             SupportedCredentialMetadata
           ),
           jwks: z.object({ keys: z.array(JWK) }),
+          trust_frameworks_supported: z.array(z.string()),
+          evidence_supported: z.array(z.string()),
         }),
         oauth_authorization_server: z.object({
           authorization_endpoint: z.string(),

package/src/trust/{chain.ts → verify-chain.ts}

@@ -5,7 +5,6 @@ import {
 } from "./types";
 import { JWK } from "../utils/jwk";
 import * as z from "zod";
-import { getSignedEntityConfiguration, getSignedEntityStatement } from ".";
 import {
   decode,
   getTrustAnchorX509Certificate,
@@ -26,6 +25,10 @@ import {
   verifyCertificateChain,
   type X509CertificateOptions,
 } from "@pagopa/io-react-native-crypto";
+import {
+  getSignedEntityConfiguration,
+  getSignedEntityStatement,
+} from "./build-chain";
 
 // The first element of the chain is supposed to be the Entity Configuration for the document issuer
 const FirstElementShape = EntityConfiguration;
@@ -225,3 +228,40 @@ export async function renewTrustChain(
     })
   );
 }
+
+/**
+ * Verify a given trust chain is actually valid.
+ * It can handle fast chain renewal, which means we try to fetch a fresh version of each statement.
+ *
+ * @param trustAnchorEntity The entity configuration of the known trust anchor
+ * @param chain The chain of statements to be validated
+ * @param x509Options Options for the verification process
+ * @param appFetch (optional) fetch api implementation
+ * @param renewOnFail Whether to attempt to renew the trust chain if the initial validation fails
+ * @returns The result of the chain validation
+ * @throws {FederationError} If the chain is not valid
+ */
+export async function verifyTrustChain(
+  trustAnchorEntity: TrustAnchorEntityConfiguration,
+  chain: string[],
+  x509Options: X509CertificateOptions = {
+    connectTimeout: 10000,
+    readTimeout: 10000,
+    requireCrl: true,
+  },
+  {
+    appFetch = fetch,
+    renewOnFail = true,
+  }: { appFetch?: GlobalFetch["fetch"]; renewOnFail?: boolean } = {}
+): Promise<ReturnType<typeof validateTrustChain>> {
+  try {
+    return validateTrustChain(trustAnchorEntity, chain, x509Options);
+  } catch (error) {
+    if (renewOnFail) {
+      const renewedChain = await renewTrustChain(chain, appFetch);
+      return validateTrustChain(trustAnchorEntity, renewedChain, x509Options);
+    } else {
+      throw error;
+    }
+  }
+}

package/src/utils/errors.ts

@@ -1,13 +1,13 @@
 import type { ProblemDetail } from "../client/generated/wallet-provider";
-import type { CredentialIssuerEntityConfiguration } from "../trust";
 import {
+  type IssuerResponseErrorCode,
   IssuerResponseErrorCodes,
-  WalletProviderResponseErrorCodes,
+  type RelyingPartyResponseErrorCode,
   RelyingPartyResponseErrorCodes,
-  type IssuerResponseErrorCode,
   type WalletProviderResponseErrorCode,
-  type RelyingPartyResponseErrorCode,
+  WalletProviderResponseErrorCodes,
 } from "./error-codes";
+import type { CredentialIssuerEntityConfiguration } from "../trust/types";
 
 export {
   IssuerResponseErrorCodes,