edockit/dist/core/verification.d.ts

A JavaScript library for listing, parsing, and verifying the contents and signatures of electronic documents (eDoc) and Associated Signature Containers (ASiC-E), supporting EU eIDAS standards for digital signatures and electronic seals.

import { CertificateInfo } from "./certificate";
import { SignatureInfo } from "./parser";
import { RevocationResult, RevocationCheckOptions } from "./revocation/types";
import { TimestampVerificationResult } from "./timestamp/types";
/**
 * Options for verification process
 */
export interface VerificationOptions {
    checkCertificateValidity?: boolean;
    verifySignatures?: boolean;
    verifyChecksums?: boolean;
    verifyTime?: Date;
    /** Check certificate revocation via OCSP/CRL (default: true) */
    checkRevocation?: boolean;
    /** Options for revocation checking (timeouts, etc.) */
    revocationOptions?: RevocationCheckOptions;
    /** Verify RFC 3161 timestamp if present (default: true) */
    verifyTimestamps?: boolean;
}
/**
 * Result of a checksum verification
 */
export interface ChecksumVerificationResult {
    isValid: boolean;
    details: Record<string, {
        expected: string;
        actual: string;
        matches: boolean;
        fileFound: boolean;
    }>;
}
/**
 * Result of a signature verification
 */
export interface SignatureVerificationResult {
    isValid: boolean;
    reason?: string;
    /** True if verification failed due to platform limitation (e.g., RSA >4096 in Safari) */
    unsupportedPlatform?: boolean;
    errorDetails?: {
        category: string;
        originalMessage: string;
        algorithm: any;
        environment: string;
        keyLength: number;
    };
}
/**
 * Result of a certificate verification
 */
export interface CertificateVerificationResult {
    isValid: boolean;
    reason?: string;
    info?: CertificateInfo;
    /** Revocation check result (if checkRevocation was enabled) */
    revocation?: RevocationResult;
}
/**
 * Validation status for granular verification results
 * - VALID: Signature cryptographically valid, all checks pass
 * - INVALID: Definitely wrong (bad checksum, tampered content, crypto failure with supported key)
 * - INDETERMINATE: Can't conclude (expired cert without POE, missing chain, revocation unknown)
 * - UNSUPPORTED: Platform can't verify (e.g., RSA >4096 bits in Safari/WebKit)
 */
export type ValidationStatus = "VALID" | "INVALID" | "INDETERMINATE" | "UNSUPPORTED";
/**
 * Describes a limitation that prevented full verification
 */
export interface ValidationLimitation {
    /** Machine-readable code (e.g., 'RSA_KEY_SIZE_UNSUPPORTED', 'CERT_EXPIRED_NO_POE') */
    code: string;
    /** Human-readable description */
    description: string;
    /** Platform where this limitation applies (e.g., 'Safari/WebKit') */
    platform?: string;
}
/**
 * Complete verification result
 */
export interface VerificationResult {
    /** Whether the signature is valid (for backwards compatibility) */
    isValid: boolean;
    /** Granular validation status */
    status: ValidationStatus;
    /** Human-readable status explanation */
    statusMessage?: string;
    /** Limitations that prevented full verification (for INDETERMINATE/UNSUPPORTED) */
    limitations?: ValidationLimitation[];
    certificate: CertificateVerificationResult;
    checksums: ChecksumVerificationResult;
    signature?: SignatureVerificationResult;
    /** Timestamp verification result (if timestamp present and verifyTimestamps enabled) */
    timestamp?: TimestampVerificationResult;
    errors?: string[];
}
/**
 * Compute a digest (hash) of file content with browser/node compatibility
 * @param fileContent The file content as Uint8Array
 * @param algorithm The digest algorithm to use (e.g., 'SHA-256')
 * @returns Promise with Base64-encoded digest
 */
export declare function computeDigest(fileContent: Uint8Array, algorithm: string): Promise<string>;
/**
 * Verify checksums of files against signature
 * @param signature The signature information
 * @param files Map of filenames to file contents
 * @returns Promise with verification results for each file
 */
export declare function verifyChecksums(signature: {
    signedChecksums: Record<string, string>;
    digestAlgorithms?: Record<string, string>;
    algorithm?: string;
}, files: Map<string, Uint8Array>): Promise<ChecksumVerificationResult>;
/**
 * Verify certificate validity
 * @param certificatePEM PEM-formatted certificate
 * @param verifyTime Time to check validity against
 * @returns Certificate verification result
 */
export declare function verifyCertificate(certificatePEM: string, verifyTime?: Date): Promise<CertificateVerificationResult>;
/**
 * Verify the XML signature specifically using SignedInfo and SignatureValue
 * @param signatureXml The XML string of the SignedInfo element
 * @param signatureValue The base64-encoded signature value
 * @param publicKeyData The public key raw data
 * @param algorithm Key algorithm details
 * @param canonicalizationMethod The canonicalization method used
 * @returns Signature verification result
 */
export declare function verifySignedInfo(signatureXml: string, signatureValue: string, publicKeyData: ArrayBuffer, algorithm: {
    name: string;
    hash: string;
    namedCurve?: string;
}, canonicalizationMethod?: string): Promise<SignatureVerificationResult>;
/**
 * Verify a complete signature (certificate, checksums, and signature)
 * @param signatureInfo Signature information
 * @param files File contents
 * @param options Verification options
 * @returns Complete verification result
 */
export declare function verifySignature(signatureInfo: SignatureInfo, files: Map<string, Uint8Array>, options?: VerificationOptions): Promise<VerificationResult>;