signet-protocol 1.11.1 → 1.11.2

package/examples/jurisdictions/india-doctor.ts

@@ -0,0 +1,207 @@
+// Signet Protocol — Indian Doctor Example
+// Demonstrates identity verification under DPDPA 2023
+// Jurisdiction: India (IN)
+// Profession: Doctor regulated by the National Medical Commission (NMC)
+// Features: DPDPA compliance, cross-border considerations, Hindi + English bilingual
+
+import {
+  generateKeyPair,
+  getJurisdiction,
+  getProfessionalBodies,
+  getMutualRecognitionPartners,
+  createProfessionalCredential,
+  verifyCredential,
+  parseCredential,
+  checkCredentialCompliance,
+  checkCrossBorderCompliance,
+  checkChildCompliance,
+  getConsentRequirements,
+  setLanguage,
+  t,
+  getTierDescription,
+  formatLocalizedTrustScore,
+  computeTrustScore,
+} from '../../src/index.js';
+
+async function main() {
+  console.log('=== Signet Protocol — Indian Doctor Verification ===\n');
+
+  // --- 1. Jurisdiction and NMC lookup ---
+  const india = getJurisdiction('IN');
+  if (!india) throw new Error('IN jurisdiction not found');
+
+  // Hindi output first
+  setLanguage('hi');
+  console.log(`[Hindi] ${t('credential_professional')}`);
+  console.log(getTierDescription(3));
+  console.log();
+
+  // Switch to English for detailed output
+  setLanguage('en');
+  console.log(`Jurisdiction: ${india.name} (${india.nameLocal})`);
+  console.log(`Legal system: ${india.legalSystem}`);
+  console.log(`Data protection: ${india.dataProtection.name} - ${india.dataProtection.fullName}`);
+  console.log(`Year enacted: ${india.dataProtection.year}`);
+  console.log(`Supervisory authority: ${india.dataProtection.supervisoryAuthority}`);
+  if (india.dataProtection.notes) {
+    console.log(`Note: ${india.dataProtection.notes}`);
+  }
+  if (india.notes) {
+    console.log(`Additional: ${india.notes}`);
+  }
+  console.log();
+
+  // Look up the National Medical Commission
+  // NMC replaced the Medical Council of India in 2020
+  const medicalBodies = getProfessionalBodies('IN', 'medical');
+  console.log('Medical professional bodies in India:');
+  for (const body of medicalBodies) {
+    console.log(`  - ${body.name}`);
+    console.log(`    Website: ${body.website}`);
+    console.log(`    Public register: ${body.hasPublicRegister}`);
+    if (body.registerUrl) {
+      console.log(`    Register URL: ${body.registerUrl}`);
+    }
+    if (body.notes) {
+      console.log(`    Note: ${body.notes}`);
+    }
+  }
+  console.log();
+
+  // --- 2. Generate identities ---
+  const doctor = generateKeyPair();    // The verifying doctor
+  const patient = generateKeyPair();   // Person being verified
+
+  // --- 3. Create Tier 3 credential ---
+  // Under DPDPA 2023, explicit consent is required before processing personal data.
+  // India's Aadhaar system provides national digital identity infrastructure.
+  console.log('--- Tier 3: Professional Verification ---');
+  console.log(getTierDescription(3));
+  console.log();
+
+  const credential = await createProfessionalCredential(
+    doctor.privateKey,
+    patient.publicKey,
+    {
+      profession: 'doctor',
+      jurisdiction: 'IN',
+    }
+  );
+
+  const verification = await verifyCredential(credential);
+  const parsed = parseCredential(credential)!;
+
+  // English output
+  console.log(`[English] ${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  Signature valid: ${verification.signatureValid}`);
+  console.log(`  Tier: ${parsed.tier}, Profession: ${parsed.profession}`);
+  console.log(`  Jurisdiction: ${parsed.jurisdiction}`);
+  console.log();
+
+  // Hindi output
+  setLanguage('hi');
+  console.log(`[Hindi] ${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  ${t('msg_signature_valid')}`);
+  console.log();
+
+  setLanguage('en');
+
+  // --- 4. DPDPA 2023 compliance check ---
+  // The DPDPA 2023 replaces the IT Act 2000 data protection provisions.
+  // Full enforcement is still pending — rules are being phased in.
+  console.log('--- DPDPA 2023 Compliance Check ---');
+  const compliance = checkCredentialCompliance(credential, 'IN');
+  console.log(`Compliant: ${compliance.compliant}`);
+
+  for (const issue of compliance.issues) {
+    const prefix = issue.severity === 'error' ? '[ERROR]'
+      : issue.severity === 'warning' ? '[WARN]'
+      : '[INFO]';
+    console.log(`  ${prefix} ${issue.message}`);
+    console.log(`    Regulation: ${issue.regulation}`);
+    if (issue.remediation) {
+      console.log(`    Remediation: ${issue.remediation}`);
+    }
+  }
+  console.log();
+
+  // --- 5. Cross-border considerations ---
+  // DPDPA 2023 may restrict transfers to certain jurisdictions via government
+  // notification. India has mutual recognition with Singapore and the UK.
+  console.log('--- Cross-border: IN -> SG ---');
+  const inToSg = checkCrossBorderCompliance('IN', 'SG');
+  console.log(`Allowed: ${inToSg.allowed}`);
+  if (inToSg.mechanism) {
+    console.log(`Mechanism: ${inToSg.mechanism}`);
+  }
+
+  for (const issue of inToSg.issues) {
+    console.log(`  [${issue.severity.toUpperCase()}] ${issue.message}`);
+    if (issue.remediation) {
+      console.log(`    Remediation: ${issue.remediation}`);
+    }
+  }
+  console.log();
+
+  console.log('--- Cross-border: IN -> GB ---');
+  const inToGb = checkCrossBorderCompliance('IN', 'GB');
+  console.log(`Allowed: ${inToGb.allowed}`);
+  if (inToGb.mechanism) {
+    console.log(`Mechanism: ${inToGb.mechanism}`);
+  }
+  for (const issue of inToGb.issues) {
+    console.log(`  [${issue.severity.toUpperCase()}] ${issue.message}`);
+  }
+  console.log();
+
+  // Mutual recognition partners
+  const partners = getMutualRecognitionPartners('IN');
+  console.log(`Mutual recognition partners: ${partners.join(', ')}`);
+  console.log();
+
+  // --- 6. Child compliance under DPDPA 2023 + POCSO ---
+  // India's digital consent age is 18 — the highest among major jurisdictions.
+  // This means ALL minors require parental consent for data processing.
+  console.log('--- Child Compliance (age 16, IN) ---');
+  const childCompliance = checkChildCompliance(16, 'IN');
+  console.log(`Compliant: ${childCompliance.compliant}`);
+  console.log(`Min consent age: ${childCompliance.minConsentAge} (one of the highest globally)`);
+  console.log(`Age of majority: ${childCompliance.ageOfMajority}`);
+  console.log(`Parental consent required: ${childCompliance.requiresParentalConsent}`);
+
+  for (const issue of childCompliance.issues) {
+    const prefix = issue.severity === 'error' ? '[ERROR]'
+      : issue.severity === 'warning' ? '[WARN]'
+      : '[INFO]';
+    console.log(`  ${prefix} ${issue.message}`);
+  }
+  console.log();
+
+  // --- 7. Consent requirements ---
+  console.log('--- Consent Requirements ---');
+  const consent = getConsentRequirements('IN');
+  console.log(`Explicit consent required: ${consent.requiresExplicitConsent}`);
+  console.log(`Digital consent age: ${consent.consentAge}`);
+  console.log(`Data categories: ${consent.dataCategories.join(', ')}`);
+  console.log();
+
+  // --- 8. Signet IQ (bilingual) ---
+  setLanguage('en');
+  console.log(`--- [English] ${t('msg_signet_iq')} ---`);
+  const trustScore = computeTrustScore(
+    patient.publicKey,
+    [credential],
+    [],
+    Math.floor(Date.now() / 1000) - 365 * 24 * 60 * 60
+  );
+  console.log(formatLocalizedTrustScore(trustScore.score));
+  console.log();
+
+  setLanguage('hi');
+  console.log(`--- [Hindi] ${t('msg_signet_iq')} ---`);
+  console.log(formatLocalizedTrustScore(trustScore.score));
+
+  console.log('\n=== Indian Doctor Example Complete ===');
+}
+
+main().catch(console.error);

package/examples/jurisdictions/japan-notary.ts

@@ -0,0 +1,157 @@
+// Signet Protocol — Japanese Notary Example
+// Demonstrates identity verification under APPI (Act on the Protection of Personal Information)
+// Jurisdiction: Japan (JP)
+// Profession: Notary regulated by the Japan National Notaries Association
+// Features: APPI compliance, cross-border transfer to Korea (adequacy), Japanese output
+
+import {
+  generateKeyPair,
+  getJurisdiction,
+  getProfessionalBodies,
+  getMutualRecognitionPartners,
+  createProfessionalCredential,
+  verifyCredential,
+  parseCredential,
+  checkCredentialCompliance,
+  checkCrossBorderCompliance,
+  checkChildCompliance,
+  getConsentRequirements,
+  setLanguage,
+  t,
+  getTierDescription,
+  formatLocalizedTrustScore,
+  computeTrustScore,
+} from '../../src/index.js';
+
+async function main() {
+  console.log('=== Signet Protocol -- Japanese Notary Verification ===\n');
+
+  // Set language to Japanese
+  setLanguage('ja');
+
+  // --- 1. Jurisdiction and professional body lookup ---
+  const jp = getJurisdiction('JP');
+  if (!jp) throw new Error('JP jurisdiction not found');
+
+  console.log(`[JP] ${jp.nameLocal} (${jp.name})`);
+  console.log(`Legal system: ${jp.legalSystem}`);
+  console.log(`Data protection: ${jp.dataProtection.name} - ${jp.dataProtection.fullName}`);
+  console.log(`Supervisory authority: ${jp.dataProtection.supervisoryAuthority}`);
+  if (jp.dataProtection.notes) {
+    console.log(`Note: ${jp.dataProtection.notes}`);
+  }
+  console.log();
+
+  // Look up the Japan National Notaries Association
+  const notaryBodies = getProfessionalBodies('JP', 'notary');
+  console.log('Notary professional bodies:');
+  for (const body of notaryBodies) {
+    console.log(`  - ${body.name}`);
+    if (body.nameEn) console.log(`    (${body.nameEn})`);
+    console.log(`    Website: ${body.website}`);
+    console.log(`    Public register: ${body.hasPublicRegister}`);
+  }
+  console.log();
+
+  // --- 2. Generate identities ---
+  const notary = generateKeyPair();    // The verifying notary
+  const subject = generateKeyPair();   // Person being verified
+
+  // --- 3. Create Tier 3 credential (Japanese output) ---
+  console.log(`--- ${t('tier_3')}: ${t('credential_professional')} ---`);
+  console.log(getTierDescription(3));
+  console.log();
+
+  const credential = await createProfessionalCredential(
+    notary.privateKey,
+    subject.publicKey,
+    {
+      profession: 'notary',
+      jurisdiction: 'JP',
+    }
+  );
+
+  const verification = await verifyCredential(credential);
+  const parsed = parseCredential(credential)!;
+
+  console.log(`${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  ${t('msg_signature_valid')}`);
+  console.log(`  Tier: ${parsed.tier}, Profession: ${parsed.profession}`);
+  console.log(`  Jurisdiction: ${parsed.jurisdiction}`);
+  console.log();
+
+  // --- 4. APPI compliance check ---
+  // Japan's APPI was significantly amended in 2022 with stricter cross-border
+  // transfer rules and mandatory breach notification within 72 hours.
+  console.log('--- APPI Compliance Check ---');
+  const compliance = checkCredentialCompliance(credential, 'JP');
+  console.log(`Compliant: ${compliance.compliant}`);
+
+  for (const issue of compliance.issues) {
+    const prefix = issue.severity === 'error' ? '[ERROR]'
+      : issue.severity === 'warning' ? '[WARN]'
+      : '[INFO]';
+    console.log(`  ${prefix} ${issue.message}`);
+    console.log(`    Regulation: ${issue.regulation}`);
+    if (issue.remediation) {
+      console.log(`    Action: ${issue.remediation}`);
+    }
+  }
+  console.log();
+
+  // --- 5. Cross-border transfer to South Korea ---
+  // Japan and South Korea both have EU adequacy decisions, and maintain mutual
+  // recognition for professional credentials and data transfers.
+  console.log('--- Cross-border transfer: JP -> KR ---');
+  const jpToKr = checkCrossBorderCompliance('JP', 'KR');
+  console.log(`Allowed: ${jpToKr.allowed}`);
+  if (jpToKr.mechanism) {
+    console.log(`Mechanism: ${jpToKr.mechanism}`);
+  }
+
+  for (const issue of jpToKr.issues) {
+    console.log(`  [${issue.severity.toUpperCase()}] ${issue.message}`);
+  }
+  console.log();
+
+  // Mutual recognition partners
+  const partners = getMutualRecognitionPartners('JP');
+  console.log(`Mutual recognition partners: ${partners.join(', ')}`);
+  console.log();
+
+  // --- 6. Child compliance under APPI + Child Welfare Act ---
+  // Japan's digital consent age is 15. Below that, parental consent is required.
+  console.log('--- Child compliance (age 12, JP) ---');
+  const childCompliance = checkChildCompliance(12, 'JP');
+  console.log(`Compliant: ${childCompliance.compliant}`);
+  console.log(`Min consent age: ${childCompliance.minConsentAge}`);
+  console.log(`Age of majority: ${childCompliance.ageOfMajority}`);
+  console.log(`Parental consent required: ${childCompliance.requiresParentalConsent}`);
+
+  for (const issue of childCompliance.issues) {
+    console.log(`  [${issue.severity.toUpperCase()}] ${issue.message}`);
+  }
+  console.log();
+
+  // --- 7. Consent requirements ---
+  console.log('--- Consent requirements ---');
+  const consent = getConsentRequirements('JP');
+  console.log(`Explicit consent required: ${consent.requiresExplicitConsent}`);
+  console.log(`Digital consent age: ${consent.consentAge}`);
+  console.log(`Data categories: ${consent.dataCategories.join(', ')}`);
+  console.log();
+
+  // --- 8. Signet IQ (Japanese output) ---
+  console.log(`--- ${t('msg_signet_iq')} ---`);
+  const trustScore = computeTrustScore(
+    subject.publicKey,
+    [credential],
+    [],
+    Math.floor(Date.now() / 1000) - 365 * 24 * 60 * 60
+  );
+  console.log(formatLocalizedTrustScore(trustScore.score));
+
+  console.log('\n=== Japanese Notary Example Complete ===');
+}
+
+main().catch(console.error);

package/examples/jurisdictions/multi-jurisdiction.ts

@@ -0,0 +1,174 @@
+// Signet Protocol — Multi-Jurisdiction Example
+// Demonstrates cross-border credential usage across multiple jurisdictions
+// Scenario: A UK solicitor's credential is used in France, Germany, and Singapore
+// Features: Cross-border compliance, most restrictive requirements, multi-language
+
+import {
+  generateKeyPair,
+  getJurisdiction,
+  getMutualRecognitionPartners,
+  createProfessionalCredential,
+  verifyCredential,
+  parseCredential,
+  checkCredentialCompliance,
+  checkCrossBorderCompliance,
+  checkMultiJurisdictionCompliance,
+  getMostRestrictiveRequirements,
+  getConsentRequirements,
+  setLanguage,
+  t,
+  getTierDescription,
+  formatLocalizedTrustScore,
+  computeTrustScore,
+} from '../../src/index.js';
+
+async function main() {
+  console.log('=== Signet Protocol — Multi-Jurisdiction Verification ===\n');
+
+  // --- 1. Create a UK solicitor credential ---
+  const solicitor = generateKeyPair();
+  const subject = generateKeyPair();
+
+  setLanguage('en');
+  console.log('--- Step 1: Issue credential in UK ---');
+
+  const credential = await createProfessionalCredential(
+    solicitor.privateKey,
+    subject.publicKey,
+    {
+      profession: 'solicitor',
+      jurisdiction: 'GB',
+    }
+  );
+
+  const verification = await verifyCredential(credential);
+  const parsed = parseCredential(credential)!;
+
+  console.log(`Credential: ${t('credential_professional')}`);
+  console.log(`  Tier: ${parsed.tier}, Profession: ${parsed.profession}`);
+  console.log(`  Origin jurisdiction: ${parsed.jurisdiction}`);
+  console.log(`  Signature valid: ${verification.signatureValid}`);
+  console.log();
+
+  // --- 2. Check compliance in each target jurisdiction ---
+  const targetJurisdictions = ['FR', 'DE', 'SG'];
+  const allJurisdictions = ['GB', ...targetJurisdictions];
+
+  console.log('--- Step 2: Multi-jurisdiction compliance check ---');
+  const complianceResults = checkMultiJurisdictionCompliance(credential, allJurisdictions);
+
+  for (const [code, result] of complianceResults) {
+    const j = getJurisdiction(code);
+    console.log(`\n[${code}] ${j?.name || code}: ${result.compliant ? 'COMPLIANT' : 'NON-COMPLIANT'}`);
+
+    for (const issue of result.issues) {
+      const prefix = issue.severity === 'error' ? 'ERROR'
+        : issue.severity === 'warning' ? 'WARN'
+        : 'INFO';
+      console.log(`  [${prefix}] ${issue.message}`);
+    }
+  }
+  console.log();
+
+  // --- 3. Cross-border compliance for each pair ---
+  console.log('--- Step 3: Cross-border transfer checks ---');
+  for (const target of targetJurisdictions) {
+    const targetJ = getJurisdiction(target);
+    const crossBorder = checkCrossBorderCompliance('GB', target);
+
+    console.log(`\nGB -> ${target} (${targetJ?.name}):`);
+    console.log(`  Allowed: ${crossBorder.allowed}`);
+    if (crossBorder.mechanism) {
+      console.log(`  Mechanism: ${crossBorder.mechanism}`);
+    }
+    for (const issue of crossBorder.issues) {
+      console.log(`  [${issue.severity.toUpperCase()}] ${issue.message}`);
+    }
+  }
+  console.log();
+
+  // --- 4. Most restrictive requirements ---
+  // When a credential is used across jurisdictions, the safest approach is
+  // to apply the most restrictive requirements from all jurisdictions.
+  console.log('--- Step 4: Most restrictive requirements ---');
+  const mostRestrictive = getMostRestrictiveRequirements(allJurisdictions);
+
+  console.log(`Jurisdictions considered: ${mostRestrictive.jurisdictions.join(', ')}`);
+  console.log(`Highest consent age: ${mostRestrictive.highestConsentAge}`);
+  console.log(`Highest age of majority: ${mostRestrictive.highestAgeOfMajority}`);
+  console.log(`Explicit consent required: ${mostRestrictive.requiresExplicitConsent}`);
+  console.log(`Shortest breach notification: ${mostRestrictive.shortestBreachNotification}h`);
+  console.log(`All require erasure: ${mostRestrictive.allRequireErasure}`);
+  console.log();
+
+  // Compare consent requirements across jurisdictions
+  console.log('--- Consent requirements by jurisdiction ---');
+  for (const code of allJurisdictions) {
+    const consent = getConsentRequirements(code);
+    const j = getJurisdiction(code);
+    console.log(`  ${code} (${j?.name}): consent age=${consent.consentAge}, explicit=${consent.requiresExplicitConsent}`);
+  }
+  console.log();
+
+  // --- 5. Mutual recognition networks ---
+  console.log('--- Step 5: Mutual recognition partners ---');
+  for (const code of allJurisdictions) {
+    const partners = getMutualRecognitionPartners(code);
+    const j = getJurisdiction(code);
+    console.log(`  ${code} (${j?.name}): ${partners.join(', ')}`);
+  }
+  console.log();
+
+  // --- 6. Multi-language output ---
+  // Demonstrate the same credential information in English, French, and German
+  console.log('--- Step 6: Multi-language credential display ---\n');
+
+  const trustScore = computeTrustScore(
+    subject.publicKey,
+    [credential],
+    [],
+    Math.floor(Date.now() / 1000) - 2 * 365 * 24 * 60 * 60
+  );
+
+  // English
+  setLanguage('en');
+  console.log(`[English]`);
+  console.log(`  ${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  ${t('msg_signature_valid')}`);
+  console.log(`  ${getTierDescription(3)}`);
+  console.log(`  ${formatLocalizedTrustScore(trustScore.score)}`);
+  console.log();
+
+  // French
+  setLanguage('fr');
+  console.log(`[Francais]`);
+  console.log(`  ${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  ${t('msg_signature_valid')}`);
+  console.log(`  ${getTierDescription(3)}`);
+  console.log(`  ${formatLocalizedTrustScore(trustScore.score)}`);
+  console.log();
+
+  // German
+  setLanguage('de');
+  console.log(`[Deutsch]`);
+  console.log(`  ${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  ${t('msg_signature_valid')}`);
+  console.log(`  ${getTierDescription(3)}`);
+  console.log(`  ${formatLocalizedTrustScore(trustScore.score)}`);
+  console.log();
+
+  // --- 7. Summary ---
+  setLanguage('en');
+  console.log('--- Summary ---');
+  console.log('A UK solicitor credential can be used across jurisdictions with');
+  console.log('varying compliance requirements. Key considerations:');
+  console.log('  - GB->FR: EU adequacy (post-Brexit data bridge), GDPR alignment');
+  console.log('  - GB->DE: Strictest GDPR enforcement, 16+ consent age');
+  console.log('  - GB->SG: PDPA applies, different consent framework');
+  console.log('  - Most restrictive consent age across all: ' + mostRestrictive.highestConsentAge);
+  console.log('  - All require breach notification within ' + mostRestrictive.shortestBreachNotification + 'h');
+
+  console.log('\n=== Multi-Jurisdiction Example Complete ===');
+}
+
+main().catch(console.error);