signet-protocol 1.11.0 → 1.11.2

package/examples/jurisdictions/uae-professional.ts

@@ -0,0 +1,190 @@
+// Signet Protocol — UAE Professional Example
+// Demonstrates identity verification under PDPL (Federal Decree-Law No. 45/2021)
+// Jurisdiction: United Arab Emirates (AE)
+// Profession: Legal professional licensed by the Ministry of Justice
+// Features: UAE data protection, Arabic output, GCC mutual recognition
+
+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 — UAE Professional Verification ===\n');
+
+  // --- 1. Jurisdiction lookup ---
+  const ae = getJurisdiction('AE');
+  if (!ae) throw new Error('AE jurisdiction not found');
+
+  // Arabic output first
+  setLanguage('ar');
+  console.log(`[Arabic] ${t('credential_professional')}`);
+  console.log(getTierDescription(3));
+  console.log();
+
+  // English output for detailed information
+  setLanguage('en');
+  console.log(`Jurisdiction: ${ae.name} (${ae.nameLocal})`);
+  console.log(`Legal system: ${ae.legalSystem}`);
+  console.log(`Data protection: ${ae.dataProtection.name} - ${ae.dataProtection.fullName}`);
+  console.log(`Year enacted: ${ae.dataProtection.year}`);
+  console.log(`Supervisory authority: ${ae.dataProtection.supervisoryAuthority}`);
+  if (ae.dataProtection.notes) {
+    console.log(`Note: ${ae.dataProtection.notes}`);
+  }
+  console.log();
+
+  // --- 2. Ministry of Justice / DHA lookup ---
+  // UAE has different licensing bodies: Ministry of Justice for legal,
+  // DHA (Dubai) and DoH (Abu Dhabi) for medical professionals.
+  const legalBodies = getProfessionalBodies('AE', 'legal');
+  const medicalBodies = getProfessionalBodies('AE', 'medical');
+
+  console.log('Legal professional bodies in UAE:');
+  for (const body of legalBodies) {
+    console.log(`  - ${body.name}`);
+    if (body.nameEn) console.log(`    (${body.nameEn})`);
+    console.log(`    Digital credentials: ${body.issuesDigitalCredentials}`);
+    if (body.notes) console.log(`    Note: ${body.notes}`);
+  }
+  console.log();
+
+  console.log('Medical professional bodies in UAE:');
+  for (const body of medicalBodies) {
+    console.log(`  - ${body.name}`);
+    if (body.nameEn) console.log(`    (${body.nameEn})`);
+    console.log(`    Digital credentials: ${body.issuesDigitalCredentials}`);
+  }
+  console.log();
+
+  // --- 3. Generate identities ---
+  const professional = generateKeyPair();  // UAE legal professional
+  const subject = generateKeyPair();       // Person being verified
+
+  // --- 4. Create Tier 3 credential ---
+  console.log('--- Tier 3: Professional Verification ---');
+
+  const credential = await createProfessionalCredential(
+    professional.privateKey,
+    subject.publicKey,
+    {
+      profession: 'lawyer',
+      jurisdiction: 'AE',
+    }
+  );
+
+  const verification = await verifyCredential(credential);
+  const parsed = parseCredential(credential)!;
+
+  console.log(`${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();
+
+  // Arabic credential display
+  setLanguage('ar');
+  console.log(`[Arabic] ${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  ${t('msg_signature_valid')}`);
+  console.log();
+
+  setLanguage('en');
+
+  // --- 5. UAE PDPL compliance check ---
+  // The UAE PDPL came into effect in 2021. DIFC and ADGM have their own
+  // separate data protection regimes.
+  console.log('--- UAE PDPL Compliance Check ---');
+  const compliance = checkCredentialCompliance(credential, 'AE');
+  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();
+
+  // --- 6. GCC mutual recognition ---
+  // UAE has mutual recognition agreements with GCC member states:
+  // Saudi Arabia, Bahrain, Qatar, Kuwait, and Oman.
+  console.log('--- GCC Mutual Recognition ---');
+  const partners = getMutualRecognitionPartners('AE');
+  console.log(`Mutual recognition partners: ${partners.join(', ')}`);
+  console.log();
+
+  // Cross-border to Saudi Arabia (GCC partner)
+  console.log('--- Cross-border: AE -> SA ---');
+  const aeToSa = checkCrossBorderCompliance('AE', 'SA');
+  console.log(`Allowed: ${aeToSa.allowed}`);
+  if (aeToSa.mechanism) {
+    console.log(`Mechanism: ${aeToSa.mechanism}`);
+  }
+  for (const issue of aeToSa.issues) {
+    console.log(`  [${issue.severity.toUpperCase()}] ${issue.message}`);
+  }
+  console.log();
+
+  // Cross-border to UK (non-GCC)
+  console.log('--- Cross-border: AE -> GB ---');
+  const aeToGb = checkCrossBorderCompliance('AE', 'GB');
+  console.log(`Allowed: ${aeToGb.allowed}`);
+  if (aeToGb.mechanism) {
+    console.log(`Mechanism: ${aeToGb.mechanism}`);
+  }
+  for (const issue of aeToGb.issues) {
+    console.log(`  [${issue.severity.toUpperCase()}] ${issue.message}`);
+  }
+  console.log();
+
+  // --- 7. Child protection under Wadeema's Law ---
+  // UAE digital consent age is 18 and age of majority is 21.
+  // Wadeema's Law provides additional child protection requirements.
+  console.log("--- Child Compliance (age 15, AE) — Wadeema's Law ---");
+  const childCompliance = checkChildCompliance(15, 'AE');
+  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();
+
+  // --- 8. Signet IQ ---
+  console.log('--- Signet IQ ---');
+  const trustScore = computeTrustScore(
+    subject.publicKey,
+    [credential],
+    [],
+    Math.floor(Date.now() / 1000) - 365 * 24 * 60 * 60
+  );
+
+  setLanguage('en');
+  console.log(`[English] ${formatLocalizedTrustScore(trustScore.score)}`);
+  setLanguage('ar');
+  console.log(`[Arabic] ${formatLocalizedTrustScore(trustScore.score)}`);
+
+  console.log('\n=== UAE Professional Example Complete ===');
+}
+
+main().catch(console.error);

package/examples/jurisdictions/uk-solicitor.ts

@@ -0,0 +1,170 @@
+// Signet Protocol — UK Solicitor Example
+// Demonstrates identity verification under UK GDPR + Age Appropriate Design Code
+// Jurisdiction: United Kingdom (GB)
+// Profession: Solicitor regulated by the Law Society of England and Wales
+
+import {
+  generateKeyPair,
+  getJurisdiction,
+  getProfessionalBodies,
+  createProfessionalCredential,
+  createChildSafetyCredential,
+  verifyCredential,
+  parseCredential,
+  checkCredentialCompliance,
+  checkChildCompliance,
+  getConsentRequirements,
+  setLanguage,
+  t,
+  getTierDescription,
+  formatLocalizedTrustScore,
+  computeTrustScore,
+} from '../../src/index.js';
+
+async function main() {
+  console.log('=== Signet Protocol — UK Solicitor Verification ===\n');
+
+  // Set language to English (UK primary language)
+  setLanguage('en');
+
+  // --- 1. Look up jurisdiction and professional bodies ---
+  const gb = getJurisdiction('GB');
+  if (!gb) throw new Error('GB jurisdiction not found');
+
+  console.log(`Jurisdiction: ${gb.name} (${gb.code})`);
+  console.log(`Legal system: ${gb.legalSystem}`);
+  console.log(`Data protection: ${gb.dataProtection.name}`);
+  console.log(`Supervisory authority: ${gb.dataProtection.supervisoryAuthority}`);
+  console.log(`e-Signature recognised: ${gb.eSignatureRecognised}`);
+  console.log();
+
+  // Look up the Law Society of England and Wales
+  const legalBodies = getProfessionalBodies('GB', 'legal');
+  console.log('Legal professional bodies in GB:');
+  for (const body of legalBodies) {
+    console.log(`  - ${body.name}`);
+    console.log(`    Public register: ${body.hasPublicRegister}`);
+    if (body.registerUrl) {
+      console.log(`    Register URL: ${body.registerUrl}`);
+    }
+  }
+  console.log();
+
+  // --- 2. Generate identities ---
+  const solicitor = generateKeyPair();  // The verifying solicitor
+  const subject = generateKeyPair();    // Person being verified
+  const parent = generateKeyPair();     // Parent (for child safety credential)
+
+  // --- 3. Create a Tier 3 professional credential ---
+  // Under UK GDPR, explicit consent must be obtained before processing personal data.
+  // The solicitor verifies identity in person and issues a Signet credential.
+  console.log('--- Tier 3: Professional Verification ---');
+  console.log(getTierDescription(3));
+  console.log();
+
+  const credential = await createProfessionalCredential(
+    solicitor.privateKey,
+    subject.publicKey,
+    {
+      profession: 'solicitor',
+      jurisdiction: 'GB',
+    }
+  );
+
+  const verification = await verifyCredential(credential);
+  const parsed = parseCredential(credential)!;
+
+  console.log(`${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  Signature valid: ${verification.signatureValid}`);
+  console.log(`  Structure valid: ${verification.structureValid}`);
+  console.log(`  Tier: ${parsed.tier}, Profession: ${parsed.profession}`);
+  console.log(`  Jurisdiction: ${parsed.jurisdiction}`);
+  console.log();
+
+  // --- 4. Check compliance with UK regulations ---
+  console.log('--- UK GDPR Compliance Check ---');
+  const compliance = checkCredentialCompliance(credential, 'GB');
+  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. Consent requirements under UK GDPR ---
+  console.log('--- Consent Requirements ---');
+  const consent = getConsentRequirements('GB');
+  console.log(`Explicit consent required: ${consent.requiresExplicitConsent}`);
+  console.log(`Digital consent age: ${consent.consentAge}`);
+  console.log(`Parental consent required: ${consent.parentalConsentRequired}`);
+  console.log(`Data categories: ${consent.dataCategories.join(', ')}`);
+  if (consent.specialCategories.length > 0) {
+    console.log(`Special categories: ${consent.specialCategories.join(', ')}`);
+  }
+  if (consent.notes) {
+    console.log(`Note: ${consent.notes}`);
+  }
+  console.log();
+
+  // --- 6. Child safety credential under UK Age Appropriate Design Code ---
+  // The AADC (Children's Code) applies to services likely to be accessed by children.
+  // UK digital consent age is 13; below that, verifiable parental consent is required.
+  console.log('--- Tier 4: Child Safety (Age Appropriate Design Code) ---');
+  console.log(getTierDescription(4));
+  console.log();
+
+  const childCredential = await createChildSafetyCredential(
+    solicitor.privateKey,
+    parent.publicKey,
+    {
+      profession: 'solicitor',
+      jurisdiction: 'GB',
+      ageRange: '8-12',
+    }
+  );
+
+  const childVerification = await verifyCredential(childCredential);
+  const childParsed = parseCredential(childCredential)!;
+
+  console.log(`${t('credential_professional_child')}: ${t('status_valid')}`);
+  console.log(`  Scope: ${childParsed.scope}, Age range: ${childParsed.ageRange}`);
+  console.log(`  Signature valid: ${childVerification.signatureValid}`);
+  console.log();
+
+  // Check child compliance for a 10-year-old under UK rules
+  console.log('--- Child Compliance Check (age 10, UK) ---');
+  const childCompliance = checkChildCompliance(10, 'GB');
+  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) {
+    const prefix = issue.severity === 'error' ? '[ERROR]'
+      : issue.severity === 'warning' ? '[WARN]'
+      : '[INFO]';
+    console.log(`  ${prefix} ${issue.message}`);
+  }
+  console.log();
+
+  // --- 7. Signet IQ display ---
+  console.log('--- 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=== UK Solicitor Example Complete ===');
+}
+
+main().catch(console.error);

package/examples/jurisdictions/us-attorney.ts

@@ -0,0 +1,161 @@
+// Signet Protocol — US Attorney Example
+// Demonstrates identity verification under CCPA/COPPA
+// Jurisdiction: United States (US)
+// Profession: Attorney — licensing is state-level via bar associations
+
+import {
+  generateKeyPair,
+  getJurisdiction,
+  getProfessionalBodies,
+  createProfessionalCredential,
+  createChildSafetyCredential,
+  verifyCredential,
+  parseCredential,
+  checkCredentialCompliance,
+  checkChildCompliance,
+  getConsentRequirements,
+  setLanguage,
+  t,
+  getTierDescription,
+  formatLocalizedTrustScore,
+  computeTrustScore,
+} from '../../src/index.js';
+
+async function main() {
+  console.log('=== Signet Protocol — US Attorney Verification ===\n');
+
+  // --- 1. Jurisdiction lookup ---
+  const us = getJurisdiction('US');
+  if (!us) throw new Error('US jurisdiction not found');
+
+  console.log(`Jurisdiction: ${us.name} (${us.code})`);
+  console.log(`Legal system: ${us.legalSystem}`);
+  console.log(`Data protection: ${us.dataProtection.name}`);
+  console.log(`Note: ${us.dataProtection.notes}`);
+  console.log(`Supervisory authority: ${us.dataProtection.supervisoryAuthority}`);
+  console.log();
+
+  // State-level bar association lookup
+  // In the US, attorney licensing is handled by individual state bars.
+  // The ABA accredits law schools but does not license attorneys.
+  const legalBodies = getProfessionalBodies('US', 'legal');
+  console.log('Legal professional bodies in US:');
+  for (const body of legalBodies) {
+    console.log(`  - ${body.name}`);
+    if (body.notes) console.log(`    Note: ${body.notes}`);
+  }
+  console.log();
+
+  // --- 2. Generate identities ---
+  const attorney = generateKeyPair();   // The verifying attorney
+  const subject = generateKeyPair();    // Person being verified
+  const child = generateKeyPair();      // Child subject (for COPPA check)
+
+  // --- 3. English output: Create Tier 3 credential ---
+  setLanguage('en');
+  console.log('--- [English] Tier 3: Professional Verification ---');
+  console.log(getTierDescription(3));
+  console.log();
+
+  const credential = await createProfessionalCredential(
+    attorney.privateKey,
+    subject.publicKey,
+    {
+      profession: 'attorney',
+      jurisdiction: 'US',
+    }
+  );
+
+  const verification = await verifyCredential(credential);
+  const parsed = parseCredential(credential)!;
+
+  console.log(`${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();
+
+  // --- 4. Spanish output (bilingual) ---
+  // The US has a significant Spanish-speaking population. Signet supports
+  // bilingual output for accessibility and regulatory compliance.
+  setLanguage('es');
+  console.log('--- [Espanol] Nivel 3: Verificacion Profesional ---');
+  console.log(getTierDescription(3));
+  console.log();
+
+  console.log(`${t('credential_professional')}: ${t('status_valid')}`);
+  console.log(`  Firma valida: ${verification.signatureValid}`);
+  console.log(`  Nivel: ${parsed.tier}, Profesion: ${parsed.profession}`);
+  console.log();
+
+  // Switch back to English for the rest
+  setLanguage('en');
+
+  // --- 5. CCPA/CPRA compliance check ---
+  console.log('--- CCPA/CPRA Compliance Check ---');
+  const compliance = checkCredentialCompliance(credential, 'US');
+  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();
+
+  // --- 6. COPPA child compliance check ---
+  // COPPA requires verifiable parental consent before collecting data from
+  // children under 13. The FTC strictly enforces this.
+  console.log('--- COPPA Child Compliance (age 11) ---');
+  const childCompliance = checkChildCompliance(11, 'US');
+  console.log(`Compliant: ${childCompliance.compliant}`);
+  console.log(`Min consent age: ${childCompliance.minConsentAge}`);
+  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}`);
+    if (issue.remediation) {
+      console.log(`    Remediation: ${issue.remediation}`);
+    }
+  }
+  console.log();
+
+  // Also check a 14-year-old (above COPPA threshold but still a minor)
+  console.log('--- COPPA Child Compliance (age 14) ---');
+  const teenCompliance = checkChildCompliance(14, 'US');
+  console.log(`Compliant: ${teenCompliance.compliant}`);
+  console.log(`Parental consent required: ${teenCompliance.requiresParentalConsent}`);
+  console.log();
+
+  // --- 7. Consent requirements ---
+  console.log('--- US Consent Requirements ---');
+  const consent = getConsentRequirements('US');
+  // Note: US does not require explicit consent at the federal level (unlike GDPR).
+  // CCPA provides opt-out rights rather than opt-in consent.
+  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 ---
+  console.log('--- Signet IQ ---');
+  const trustScore = computeTrustScore(
+    subject.publicKey,
+    [credential],
+    [],
+    Math.floor(Date.now() / 1000) - 2 * 365 * 24 * 60 * 60
+  );
+  console.log(formatLocalizedTrustScore(trustScore.score));
+
+  console.log('\n=== US Attorney Example Complete ===');
+}
+
+main().catch(console.error);