buby 1.3.3-java → 1.5.0-java

data/ext/burp_interfaces/burp/IProxyListener.java

@@ -0,0 +1,37 @@
+package burp;
+
+/*
+ * @(#)IProxyListener.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * Extensions can implement this interface and then call
+ * <code>IBurpExtenderCallbacks.registerProxyListener()</code> to register a
+ * Proxy listener. The listener will be notified of requests and responses being
+ * processed by the Proxy tool. Extensions can perform custom analysis or
+ * modification of these messages, and control in-UI message interception, by
+ * registering a proxy listener.
+ */
+public interface IProxyListener
+{
+    /**
+     * This method is invoked when an HTTP message is being processed by the
+     * Proxy.
+     *
+     * @param messageIsRequest Indicates whether the HTTP message is a request
+     * or a response.
+     * @param message An
+     * <code>IInterceptedProxyMessage</code> object that extensions can use to
+     * query and update details of the message, and control whether the message
+     * should be intercepted and displayed to the user for manual review or
+     * modification.
+     */
+    void processProxyMessage(
+            boolean messageIsRequest,
+            IInterceptedProxyMessage message);
+}

data/ext/burp_interfaces/burp/IRequestInfo.java

@@ -0,0 +1,95 @@
+package burp;
+
+/*
+ * @(#)IRequestInfo.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.net.URL;
+import java.util.List;
+
+/**
+ * This interface is used to retrieve key details about an HTTP request.
+ * Extensions can obtain an
+ * <code>IRequestInfo</code> object for a given request by calling
+ * <code>IExtensionHelpers.analyzeRequest()</code>.
+ */
+public interface IRequestInfo
+{
+    /**
+     * Used to indicate that there is no content.
+     */
+    static final byte CONTENT_TYPE_NONE = 0;
+    /**
+     * Used to indicate URL-encoded content.
+     */
+    static final byte CONTENT_TYPE_URL_ENCODED = 1;
+    /**
+     * Used to indicate multi-part content.
+     */
+    static final byte CONTENT_TYPE_MULTIPART = 2;
+    /**
+     * Used to indicate XML content.
+     */
+    static final byte CONTENT_TYPE_XML = 3;
+    /**
+     * Used to indicate JSON content.
+     */
+    static final byte CONTENT_TYPE_JSON = 4;
+    /**
+     * Used to indicate AMF content.
+     */
+    static final byte CONTENT_TYPE_AMF = 5;
+    /**
+     * Used to indicate unknown content.
+     */
+    static final byte CONTENT_TYPE_UNKNOWN = -1;
+
+    /**
+     * This method is used to obtain the HTTP method used in the request.
+     *
+     * @return The HTTP method used in the request.
+     */
+    String getMethod();
+
+    /**
+     * This method is used to obtain the URL in the request.
+     *
+     * @return The URL in the request.
+     */
+    URL getUrl();
+
+    /**
+     * This method is used to obtain the HTTP headers contained in the request.
+     *
+     * @return The HTTP headers contained in the request.
+     */
+    List<String> getHeaders();
+
+    /**
+     * This method is used to obtain the parameters contained in the request.
+     *
+     * @return The parameters contained in the request.
+     */
+    List<IParameter> getParameters();
+
+    /**
+     * This method is used to obtain the offset within the request where the
+     * message body begins.
+     *
+     * @return The offset within the request where the message body begins.
+     */
+    int getBodyOffset();
+
+    /**
+     * This method is used to obtain the content type of the message body.
+     *
+     * @return An indication of the content type of the message body. Available
+     * types are defined within this interface.
+     */
+    byte getContentType();
+}

data/ext/burp_interfaces/burp/IResponseInfo.java

@@ -0,0 +1,54 @@
+package burp;
+
+/*
+ * @(#)IResponseInfo.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.util.List;
+
+/**
+ * This interface is used to retrieve key details about an HTTP response.
+ * Extensions can obtain an
+ * <code>IResponseInfo</code> object for a given response by calling
+ * <code>IExtensionHelpers.analyzeResponse()</code>.
+ */
+public interface IResponseInfo
+{
+    /**
+     * This method is used to obtain the HTTP headers contained in the response.
+     *
+     * @return The HTTP headers contained in the response.
+     */
+    List<String> getHeaders();
+
+    /**
+     * This method is used to obtain the offset within the response where the
+     * message body begins.
+     *
+     * @return The offset within the response where the message body begins.
+     */
+    int getBodyOffset();
+
+    /**
+     * This method is used to obtain the HTTP status code contained in the
+     * response.
+     *
+     * @return The HTTP status code contained in the response.
+     */
+    short getStatusCode();
+
+    /**
+     * This method is used to obtain details of the HTTP cookies set in the
+     * response.
+     *
+     * @return A list of
+     * <code>ICookie</code> objects representing the cookies set in the
+     * response, if any.
+     */
+    List<ICookie> getCookies();
+}

data/ext/burp_interfaces/burp/IScanIssue.java

@@ -0,0 +1,120 @@
+package burp;
+
+/*
+ * @(#)IScanIssue.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to retrieve details of Scanner issues. Extensions can
+ * obtain details of issues by registering an
+ * <code>IScannerListener</code> or by calling
+ * <code>IBurpExtenderCallbacks.getScanIssues()</code>. Extensions can also add
+ * custom Scanner issues by registering an
+ * <code>IScannerCheck</code> or calling
+ * <code>IBurpExtenderCallbacks.addScanIssue()</code>, and providing their own
+ * implementations of this interface
+ */
+public interface IScanIssue
+{
+    /**
+     * This method returns the URL for which the issue was generated.
+     *
+     * @return The URL for which the issue was generated.
+     */
+    java.net.URL getUrl();
+
+    /**
+     * This method returns the name of the issue type.
+     *
+     * @return The name of the issue type (e.g. "SQL injection").
+     */
+    String getIssueName();
+
+    /**
+     * This method returns a numeric identifier of the issue type. See the Burp
+     * Scanner help documentation for a listing of all the issue types.
+     *
+     * @return A numeric identifier of the issue type.
+     */
+    int getIssueType();
+
+    /**
+     * This method returns the issue severity level.
+     *
+     * @return The issue severity level. Expected values are "High", "Medium",
+     * "Low", "Information" or "False positive".
+     *
+     */
+    String getSeverity();
+
+    /**
+     * This method returns the issue confidence level.
+     *
+     * @return The issue confidence level. Expected values are "Certain", "Firm"
+     * or "Tentative".
+     */
+    String getConfidence();
+
+    /**
+     * This method returns a background description for this type of issue.
+     *
+     * @return A background description for this type of issue, or
+     * <code>null</code> if none applies.
+     */
+    String getIssueBackground();
+
+    /**
+     * This method returns a background description of the remediation for this
+     * type of issue.
+     *
+     * @return A background description of the remediation for this type of
+     * issue, or
+     * <code>null</code> if none applies.
+     */
+    String getRemediationBackground();
+
+    /**
+     * This method returns detailed information about this specific instance of
+     * the issue.
+     *
+     * @return Detailed information about this specific instance of the issue,
+     * or
+     * <code>null</code> if none applies.
+     */
+    String getIssueDetail();
+
+    /**
+     * This method returns detailed information about the remediation for this
+     * specific instance of the issue.
+     *
+     * @return Detailed information about the remediation for this specific
+     * instance of the issue, or
+     * <code>null</code> if none applies.
+     */
+    String getRemediationDetail();
+
+    /**
+     * This method returns the HTTP messages on the basis of which the issue was
+     * generated.
+     *
+     * @return The HTTP messages on the basis of which the issue was generated.
+     * <b>Note:</b> The items in this array should be instances of
+     * <code>IHttpRequestResponseWithMarkers</code> if applicable, so that
+     * details of the relevant portions of the request and response messages are
+     * available.
+     */
+    IHttpRequestResponse[] getHttpMessages();
+
+    /**
+     * This method returns the HTTP service for which the issue was generated.
+     *
+     * @return The HTTP service for which the issue was generated.
+     */
+    IHttpService getHttpService();
+
+}

data/ext/burp_interfaces/burp/IScanQueueItem.java

@@ -0,0 +1,80 @@
+package burp;
+
+/*
+ * @(#)IScanQueueItem.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+/**
+ * This interface is used to retrieve details of items in the Burp Scanner
+ * active scan queue. Extensions can obtain references to scan queue items by
+ * calling
+ * <code>IBurpExtenderCallbacks.doActiveScan()</code>.
+ */
+public interface IScanQueueItem
+{
+    /**
+     * This method returns a description of the status of the scan queue item.
+     *
+     * @return A description of the status of the scan queue item.
+     */
+    String getStatus();
+
+    /**
+     * This method returns an indication of the percentage completed for the
+     * scan queue item.
+     *
+     * @return An indication of the percentage completed for the scan queue
+     * item.
+     */
+    byte getPercentageComplete();
+
+    /**
+     * This method returns the number of requests that have been made for the
+     * scan queue item.
+     *
+     * @return The number of requests that have been made for the scan queue
+     * item.
+     */
+    int getNumRequests();
+
+    /**
+     * This method returns the number of network errors that have occurred for
+     * the scan queue item.
+     *
+     * @return The number of network errors that have occurred for the scan
+     * queue item.
+     */
+    int getNumErrors();
+
+    /**
+     * This method returns the number of attack insertion points being used for
+     * the scan queue item.
+     *
+     * @return The number of attack insertion points being used for the scan
+     * queue item.
+     */
+    int getNumInsertionPoints();
+
+    /**
+     * This method allows the scan queue item to be canceled.
+     */
+    void cancel();
+
+    /**
+     * This method returns details of the issues generated for the scan queue
+     * item. <b>Note:</b> different items within the scan queue may contain
+     * duplicated versions of the same issues - for example, if the same request
+     * has been scanned multiple times. Duplicated issues are consolidated in
+     * the main view of scan results. Extensions can register an
+     * <code>IScannerListener</code> to get details only of unique, newly
+     * discovered Scanner issues post-consolidation.
+     *
+     * @return Details of the issues generated for the scan queue item.
+     */
+    IScanIssue[] getIssues();
+}

data/ext/burp_interfaces/burp/IScannerCheck.java

@@ -0,0 +1,89 @@
+package burp;
+
+/*
+ * @(#)IScannerCheck.java
+ *
+ * Copyright PortSwigger Ltd. All rights reserved.
+ *
+ * This code may be used to extend the functionality of Burp Suite Free Edition
+ * and Burp Suite Professional, provided that this usage does not violate the
+ * license terms for those products.
+ */
+import java.util.List;
+
+/**
+ * Extensions can implement this interface and then call
+ * <code>IBurpExtenderCallbacks.registerScannerCheck()</code> to register a
+ * custom Scanner check. When performing scanning, Burp will ask the check to
+ * perform active or passive scanning on the base request, and report any
+ * Scanner issues that are identified.
+ */
+public interface IScannerCheck
+{
+    /**
+     * The Scanner invokes this method for each base request / response that is
+     * passively scanned. <b>Note:</b> Extensions should not only analyze the
+     * HTTP messages provided during passive scanning, and should not make any
+     * new HTTP requests of their own.
+     *
+     * @param baseRequestResponse The base HTTP request / response that should
+     * be passively scanned.
+     * @return A list of
+     * <code>IScanIssue</code> objects, or
+     * <code>null</code> if no issues are identified.
+     */
+    List<IScanIssue> doPassiveScan(IHttpRequestResponse baseRequestResponse);
+
+    /**
+     * The Scanner invokes this method for each insertion point that is actively
+     * scanned. Extensions may issue HTTP requests as required to carry out
+     * active scanning, and should use the
+     * <code>IScannerInsertionPoint</code> object provided to build scan
+     * requests for particular payloads. <b>Note:</b> Extensions are responsible
+     * for ensuring that attack payloads are suitably encoded within requests
+     * (for example, by URL-encoding relevant metacharacters in the URL query
+     * string). Encoding is not automatically carried out by the
+     * <code>IScannerInsertionPoint</code>, because this would prevent Scanner
+     * checks from testing for certain input filter bypasses. Extensions should
+     * query the
+     * <code>IScannerInsertionPoint</code> to determine its type, and apply any
+     * encoding that may be appropriate.
+     *
+     * @param baseRequestResponse The base HTTP request / response that should
+     * be actively scanned.
+     * @param insertionPoint An
+     * <code>IScannerInsertionPoint</code> object that can be queried to obtain
+     * details of the insertion point being tested, and can be used to build
+     * scan requests for particular payloads.
+     * @return A list of
+     * <code>IScanIssue</code> objects, or
+     * <code>null</code> if no issues are identified.
+     */
+    List<IScanIssue> doActiveScan(
+            IHttpRequestResponse baseRequestResponse,
+            IScannerInsertionPoint insertionPoint);
+
+    /**
+     * The Scanner invokes this method when the custom Scanner check has
+     * reported multiple issues for the same URL path. This can arise either
+     * because there are multiple distinct vulnerabilities, or because the same
+     * (or a similar) request has been scanned more than once. The custom check
+     * should determine whether the issues are duplicates. In most cases, where
+     * a check uses distinct issue names or descriptions for distinct issues,
+     * the consolidation process will simply be a matter of comparing these
+     * features for the two issues.
+     *
+     * @param existingIssue An issue that was previously reported by this
+     * Scanner check.
+     * @param newIssue An issue at the same URL path that has been newly
+     * reported by this Scanner check.
+     * @return An indication of which issue(s) should be reported in the main
+     * Scanner results. The method should return
+     * <code>-1</code> to report the existing issue only,
+     * <code>0</code> to report both issues, and
+     * <code>1</code> to report the new issue only.
+     */
+    int consolidateDuplicateIssues(
+            IScanIssue existingIssue,
+            IScanIssue newIssue);
+}