zap-cdk
    Preparing search index...

    Interface IActiveScanParameters

    IActiveScanParameters Represents the parameters for an active scan.

    interface IActiveScanParameters {
        addQueryParam?: boolean;
        context?: string;
        defaultPolicy?: string;
        delayInMs?: number;
        handleAntiCSRFTokens?: boolean;
        injectPluginIdInHeader?: boolean;
        maxAlertsPerRule?: number;
        maxRuleDurationInMins?: number;
        maxScanDurationInMins?: number;
        policy?: string;
        scanHeadersAllRequests?: boolean;
        tests?: ITest[];
        threadPerHost?: number;
        url?: string;
        user?: string;
    }
    Index

    Properties

    addQueryParam? context? defaultPolicy? delayInMs? handleAntiCSRFTokens? injectPluginIdInHeader? maxAlertsPerRule? maxRuleDurationInMins? maxScanDurationInMins? policy? scanHeadersAllRequests? tests? threadPerHost? url? user?

    Properties

    addQueryParam?: boolean

    If set, will add an extra query parameter to requests that do not have one, default: false.

    context?: string

    Name of the context to attack, default: first context.

    defaultPolicy?: string

    The name of the default scan policy to use, default: Default Policy.

    delayInMs?: number

    The delay in milliseconds between each request, default: 0.

    handleAntiCSRFTokens?: boolean

    If set, then automatically handle anti CSRF tokens, default: false.

    injectPluginIdInHeader?: boolean

    If set, then the relevant rule Id will be injected into the X-ZAP-Scan-ID header of each request, default: false.

    maxAlertsPerRule?: number

    Maximum number of alerts to raise per rule, default: 0 (unlimited).

    maxRuleDurationInMins?: number

    The max time in minutes any individual rule will be allowed to run for, default: 0 (unlimited).

    maxScanDurationInMins?: number

    The max time in minutes the active scanner will be allowed to run for, default: 0 (unlimited).

    policy?: string

    Name of the scan policy to be used, default: Default Policy.

    scanHeadersAllRequests?: boolean

    If set, then the headers of requests that do not include any parameters will be scanned, default: false.

    tests?: ITest[]

    List of tests to perform.

    threadPerHost?: number

    The max number of threads per host, default: 2 * Number of available processor cores.

    url?: string

    The subtree to active scan, default: all URLs of the context.

    user?: string

    An optional user to use for authentication, must be defined in the environment.

    Settings

    Member Visibility

    On This Page

    Properties