zap-cdk
    Preparing search index...

    Interface ISpiderParameters

    Interface representing the parameters for a spider configuration. ISpiderParameters

    interface ISpiderParameters {
        acceptCookies?: boolean;
        context?: string;
        handleODataParametersVisited?: boolean;
        handleParameters?: "ignore_completely" | "ignore_value" | "use_all";
        logoutAvoidance?: boolean;
        maxChildren?: number;
        maxDepth?: number;
        maxDuration?: number;
        maxParseSizeBytes?: number;
        parseComments?: boolean;
        parseDsStore?: boolean;
        parseGit?: boolean;
        parseRobotsTxt?: boolean;
        parseSitemapXml?: boolean;
        parseSVNEntries?: boolean;
        postForm?: boolean;
        processForm?: boolean;
        sendRefererHeader?: boolean;
        threadCount?: number;
        url?: string;
        user?: string;
        userAgent?: string;
    }
    Index

    Properties

    acceptCookies? context? handleODataParametersVisited? handleParameters? logoutAvoidance? maxChildren? maxDepth? maxDuration? maxParseSizeBytes? parseComments? parseDsStore? parseGit? parseRobotsTxt? parseSitemapXml? parseSVNEntries? postForm? processForm? sendRefererHeader? threadCount? url? user? userAgent?

    Properties

    acceptCookies?: boolean

    Whether the spider will accept cookies, default: true.

    context?: string

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

    handleODataParametersVisited?: boolean

    Whether the spider will handle OData responses, default: false.

    handleParameters?: "ignore_completely" | "ignore_value" | "use_all"

    How query string parameters are used.

    logoutAvoidance?: boolean

    Whether the Spider should attempt to avoid logout related paths/functionality, default: false.

    maxChildren?: number

    The maximum number of children to add to each node in the tree.

    maxDepth?: number

    The maximum tree depth to explore, default: 5.

    maxDuration?: number

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

    maxParseSizeBytes?: number

    The max size of a response that will be parsed, default: 2621440 (2.5 Mb).

    parseComments?: boolean

    Whether the spider will parse HTML comments in order to find URLs, default: true.

    parseDsStore?: boolean

    Whether the spider will parse .DS_Store files in order to find URLs, default: false.

    parseGit?: boolean

    Whether the spider will parse Git metadata in order to find URLs, default: false.

    parseRobotsTxt?: boolean

    Whether the spider will parse 'robots.txt' files in order to find URLs, default: true.

    parseSitemapXml?: boolean

    Whether the spider will parse 'sitemap.xml' files in order to find URLs, default: true.

    parseSVNEntries?: boolean

    Whether the spider will parse SVN metadata in order to find URLs, default: false.

    postForm?: boolean

    Whether the spider will submit POST forms, default: true.

    processForm?: boolean

    Whether the spider will process forms, default: true.

    sendRefererHeader?: boolean

    Whether the spider will send the referer header, default: true.

    threadCount?: number

    The number of spider threads, default: 2 * Number of available processor cores.

    url?: string

    URL to start spidering from, default: first context URL.

    user?: string

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

    userAgent?: string

    The user agent to use in requests, default: '' (use the default ZAP one).

    Settings

    Member Visibility

    On This Page

    Properties