Interface ISoc2ReportGenerator
- Namespace
- Excalibur.Compliance
- Assembly
- Excalibur.Compliance.Abstractions.dll
Service for generating SOC 2 compliance reports.
public interface ISoc2ReportGenerator
Remarks
This service supports generation of both Type I (point-in-time) and Type II (period-based) SOC 2 compliance reports.
Type I reports assess control design at a specific point in time, while Type II reports assess both design and operating effectiveness over a period (minimum 90 days per SOC 2 standards).
Methods
GenerateAndStoreReportAsync(ReportGenerationRequest, CancellationToken)
Generates a report and stores it.
Task<Soc2Report> GenerateAndStoreReportAsync(ReportGenerationRequest request, CancellationToken cancellationToken)
Parameters
requestReportGenerationRequestThe report generation request.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<Soc2Report>
The generated and stored report.
GenerateTypeIIReportAsync(DateTimeOffset, DateTimeOffset, ReportOptions, CancellationToken)
Generates a SOC 2 Type II report (period assessment).
Task<Soc2Report> GenerateTypeIIReportAsync(DateTimeOffset periodStart, DateTimeOffset periodEnd, ReportOptions options, CancellationToken cancellationToken)
Parameters
periodStartDateTimeOffsetThe start of the assessment period.
periodEndDateTimeOffsetThe end of the assessment period.
optionsReportOptionsReport generation options.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<Soc2Report>
The generated Type II report.
Remarks
Type II reports assess both control design and operating effectiveness over a period of time. The minimum period is typically 90 days but can be configured via MinimumTypeIIPeriodDays.
Exceptions
- ArgumentException
Thrown when the period is less than the minimum required (typically 90 days).
GenerateTypeIReportAsync(DateTimeOffset, ReportOptions, CancellationToken)
Generates a SOC 2 Type I report (point-in-time assessment).
Task<Soc2Report> GenerateTypeIReportAsync(DateTimeOffset asOfDate, ReportOptions options, CancellationToken cancellationToken)
Parameters
asOfDateDateTimeOffsetThe point-in-time date for the assessment.
optionsReportOptionsReport generation options.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<Soc2Report>
The generated Type I report.
Remarks
Type I reports assess whether controls are suitably designed as of a specific date. They do not test operating effectiveness.
GetControlDescriptionsAsync(TrustServicesCriterion, CancellationToken)
Gets control descriptions for a specific criterion.
Task<IReadOnlyList<ControlDescription>> GetControlDescriptionsAsync(TrustServicesCriterion criterion, CancellationToken cancellationToken)
Parameters
criterionTrustServicesCriterionThe criterion to get controls for.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<IReadOnlyList<ControlDescription>>
Control descriptions mapped to the criterion.
GetTestResultsAsync(TrustServicesCriterion, DateTimeOffset, DateTimeOffset, CancellationToken)
Gets test results for a criterion during a specific period.
Task<IReadOnlyList<TestResult>> GetTestResultsAsync(TrustServicesCriterion criterion, DateTimeOffset periodStart, DateTimeOffset periodEnd, CancellationToken cancellationToken)
Parameters
criterionTrustServicesCriterionThe criterion to get test results for.
periodStartDateTimeOffsetStart of the test period.
periodEndDateTimeOffsetEnd of the test period.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<IReadOnlyList<TestResult>>
Test results for the criterion.