CIA Compliance Manager API Documentation - v1.1.6
    Preparing search index...

    Service for compliance mapping and status reporting

    This service maps security levels to compliance with various regulatory frameworks, helping organizations understand their compliance posture and identify gaps that need to be addressed to meet regulatory requirements. 📋

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    name: string = 'BaseService'

    Service name for identification

    Methods

    • Get compliance status based on security levels

      Evaluates current security levels against multiple compliance frameworks (NIST 800-53, ISO 27001, GDPR, HIPAA, SOC2, PCI DSS, etc.) and provides detailed compliance status, gaps, and remediation guidance.

      Parameters

      Returns ComplianceStatusDetails

      Compliance status details including compliant/non-compliant frameworks and remediation steps

      const service = new ComplianceService(dataProvider);

      // Check compliance for High security levels
      const status = service.getComplianceStatus('High', 'High', 'High');
      console.log('Overall Status:', status.status);
      console.log('Compliance Score:', status.complianceScore, '%');
      console.log('Compliant Frameworks:', status.compliantFrameworks);
      console.log('Non-Compliant Frameworks:', status.nonCompliantFrameworks);

      // Get remediation steps
      status.remediationSteps.forEach(step => {
      console.log('- ', step);
      });
    • Get compliant frameworks for a specific security level

      Identifies which compliance frameworks are fully met by the current security configuration. Useful for compliance reporting and gap analysis.

      Parameters

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel = availabilityLevel

        Integrity security level (optional, defaults to availabilityLevel)

      • confidentialityLevel: SecurityLevel = availabilityLevel

        Confidentiality security level (optional, defaults to availabilityLevel)

      Returns string[]

      Array of compliant framework names

      const service = new ComplianceService(dataProvider);

      // Check which frameworks High security meets
      const frameworks = service.getCompliantFrameworks('High', 'High', 'High');
      console.log('Compliant with:', frameworks.join(', '));
      // Output: "Compliant with: NIST 800-53, ISO 27001, NIST CSF, GDPR, HIPAA, SOC2, PCI DSS..."

      // Check moderate security levels
      const moderateFrameworks = service.getCompliantFrameworks('Moderate', 'Moderate', 'Moderate');
      console.log('Moderate meets:', moderateFrameworks.length, 'frameworks');
    • Get description of a specific compliance framework

      Parameters

      • framework: string

        Framework name

      Returns string

      Framework description

    • Get compliance status for a specific framework

      Evaluates whether current security levels meet a specific compliance framework's requirements. Returns detailed status showing full compliance, partial compliance, or non-compliance.

      Parameters

      • framework: string

        Framework name (e.g., "NIST 800-53", "ISO 27001", "GDPR")

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel

        Integrity security level

      • confidentialityLevel: SecurityLevel

        Confidentiality security level

      Returns ComplianceStatusType

      Compliance status for the framework ("compliant", "partially-compliant", or "non-compliant")

      const service = new ComplianceService(dataProvider);

      // Check GDPR compliance
      const gdprStatus = service.getFrameworkStatus('GDPR', 'High', 'High', 'High');
      console.log('GDPR Status:', gdprStatus); // "compliant"

      // Check HIPAA with moderate levels
      const hipaaStatus = service.getFrameworkStatus('HIPAA', 'Moderate', 'Moderate', 'Moderate');
      console.log('HIPAA Status:', hipaaStatus); // "partially-compliant" or "non-compliant"

      // Evaluate all frameworks
      const frameworks = ['NIST 800-53', 'ISO 27001', 'GDPR', 'HIPAA'];
      frameworks.forEach(framework => {
      const status = service.getFrameworkStatus(framework, 'High', 'High', 'Moderate');
      console.log(`${framework}: ${status}`);
      });
    • Validate input parameters (to be overridden by subclasses)

      Parameters

      • input: unknown

        Input to validate

      Returns boolean

      True if valid, false otherwise