org.zaproxy.zap.extension.alert.AlertEventPublisher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zap Show documentation

The Zed Attack Proxy (ZAP) is an easy to use integrated penetration testing tool for finding vulnerabilities in web applications. It is designed to be used by people with a wide range of security experience and as such is ideal for developers and functional testers who are new to penetration testing. ZAP provides automated scanners as well as a set of tools that allow you to find security vulnerabilities manually.

There is a newer version: 2.15.0

Show newest version

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2014 The ZAP Development Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.zaproxy.zap.extension.alert;

import org.zaproxy.zap.ZAP;
import org.zaproxy.zap.eventBus.EventPublisher;

public class AlertEventPublisher implements EventPublisher {

    private static AlertEventPublisher publisher = null;
    public static final String ALERT_ADDED_EVENT = "alert.added";
    public static final String ALERT_CHANGED_EVENT = "alert.changed";
    public static final String ALERT_REMOVED_EVENT = "alert.removed";
    public static final String ALL_ALERTS_REMOVED_EVENT = "alert.all.removed";

    public static final String ALERT_ID = "alertId";
    /**
     * Indicates the {@code HistoryReference} ID of the alert.
     *
     * The field is available in the events {@link #ALERT_ADDED_EVENT}, {@link
     * #ALERT_CHANGED_EVENT} and {@link #ALERT_REMOVED_EVENT}.
     *
     * @since 2.5.0
     */
    public static final String HISTORY_REFERENCE_ID = "historyId";

    public static final String NAME = "name";
    public static final String URI = "uri";
    public static final String PARAM = "param";
    public static final String RISK = "risk";
    public static final String RISK_STRING = "riskString";
    public static final String CONFIDENCE = "confidence";
    public static final String CONFIDENCE_STRING = "confidenceString";
    public static final String SOURCE = "source";

    @Override
    public String getPublisherName() {
        return AlertEventPublisher.class.getCanonicalName();
    }

    public static synchronized AlertEventPublisher getPublisher() {
        if (publisher == null) {
            publisher = new AlertEventPublisher();
            ZAP.getEventBus()
                    .registerPublisher(
                            publisher,
                            ALERT_ADDED_EVENT,
                            ALERT_CHANGED_EVENT,
                            ALERT_REMOVED_EVENT,
                            ALL_ALERTS_REMOVED_EVENT);
        }
        return publisher;
    }
}