org.apache.wss4j.common.bsp.BSPEnforcer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wss4j-ws-security-common Show documentation

There is a newer version: 3.0.4

Show newest version

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.wss4j.common.bsp;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.apache.wss4j.common.ext.WSSecurityException;

/**
 * An class that enforces Basic Security Profile Rules
 */
public class BSPEnforcer {

    private static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger(BSPEnforcer.class);

    private List ignoredBSPRules = Collections.emptyList();

    private boolean disableBSPRules;

    public BSPEnforcer() {
        // Complete
    }

    public BSPEnforcer(List bspRules) {
        ignoredBSPRules = new ArrayList<>(bspRules);
    }

    public BSPEnforcer(boolean disableBSPRules) {
        this.disableBSPRules = disableBSPRules;
    }

    public void handleBSPRule(BSPRule bspRule) throws WSSecurityException {
        if (disableBSPRules) {
            return;
        }

        if (!ignoredBSPRules.contains(bspRule)) {
            throw new WSSecurityException(WSSecurityException.ErrorCode.INVALID_SECURITY, "empty",
                                          new Object[] {"BSP:" + bspRule.name() + ": " + bspRule.getMsg()}
            );
        } else {
            LOG.debug("BSP:{}: {}", bspRule.name(), bspRule.getMsg());
        }
    }

    public void setIgnoredBSPRules(List bspRules) {
        ignoredBSPRules = new ArrayList<>(bspRules);
    }

    public void setDisableBSPRules(boolean disableBSPRules) {
        this.disableBSPRules = disableBSPRules;
    }

}