View Javadoc
1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements. See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership. The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License. You may obtain a copy of the License at
9    *
10   * http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied. See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.wss4j.common.bsp;
20  
21  import java.util.ArrayList;
22  import java.util.Collections;
23  import java.util.List;
24  
25  import org.apache.wss4j.common.ext.WSSecurityException;
26  
27  /**
28   * An class that enforces Basic Security Profile Rules
29   */
30  public class BSPEnforcer {
31  
32      private static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger(BSPEnforcer.class);
33  
34      private List<BSPRule> ignoredBSPRules = Collections.emptyList();
35  
36      private boolean disableBSPRules;
37  
38      public BSPEnforcer() {
39          // Complete
40      }
41  
42      public BSPEnforcer(List<BSPRule> bspRules) {
43          ignoredBSPRules = new ArrayList<>(bspRules);
44      }
45  
46      public BSPEnforcer(boolean disableBSPRules) {
47          this.disableBSPRules = disableBSPRules;
48      }
49  
50      public void handleBSPRule(BSPRule bspRule) throws WSSecurityException {
51          if (disableBSPRules) {
52              return;
53          }
54  
55          if (!ignoredBSPRules.contains(bspRule)) {
56              throw new WSSecurityException(WSSecurityException.ErrorCode.INVALID_SECURITY, "empty",
57                                            new Object[] {"BSP:" + bspRule.name() + ": " + bspRule.getMsg()}
58              );
59          } else {
60              LOG.debug("BSP:{}: {}", bspRule.name(), bspRule.getMsg());
61          }
62      }
63  
64      public void setIgnoredBSPRules(List<BSPRule> bspRules) {
65          ignoredBSPRules = new ArrayList<>(bspRules);
66      }
67  
68      public void setDisableBSPRules(boolean disableBSPRules) {
69          this.disableBSPRules = disableBSPRules;
70      }
71  
72  }