View Javadoc
1   /**
2    * This file Copyright (c) 2003-2015 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.security;
35  
36  import info.magnolia.jcr.node2bean.Node2BeanTransformer;
37  import info.magnolia.jcr.node2bean.PropertyTypeDescriptor;
38  import info.magnolia.jcr.node2bean.TransformationState;
39  import info.magnolia.jcr.node2bean.TypeDescriptor;
40  import info.magnolia.jcr.node2bean.TypeMapping;
41  import info.magnolia.jcr.node2bean.impl.Node2BeanTransformerImpl;
42  import info.magnolia.objectfactory.ComponentProvider;
43  import info.magnolia.objectfactory.ObservedComponentFactory;
44  import info.magnolia.repository.RepositoryConstants;
45  
46  import javax.jcr.RepositoryException;
47  import javax.servlet.http.HttpServletRequest;
48  import java.util.Arrays;
49  import java.util.Collections;
50  import java.util.HashMap;
51  import java.util.Map;
52  import java.util.Set;
53  import java.util.TreeSet;
54  
55  
56  /**
57   * A very limited implementation of {@link IPSecurityManager}. On can either limit the IP addresses
58   * (no patterns), or grant access for all IPs.
59   */
60  public class IPSecurityManagerImpl implements IPSecurityManager {
61      private static final String ALL = "*";
62  
63      /**
64       * The key is the IP.
65       */
66      private Map<String, Rule> rules;
67  
68      public IPSecurityManagerImpl() {
69          this.rules = new HashMap<String, Rule>();
70      }
71  
72      @Override
73      public boolean isAllowed(HttpServletRequest req) {
74          final Rule rule = getRule(req.getRemoteAddr());
75          return rule != null && rule.allowsMethod(req.getMethod());
76      }
77  
78      @Override
79      public boolean isAllowed(String ip) {
80          return getRule(ip) != null;
81      }
82  
83      protected Rule getRule(String ip) {
84          return (rules.containsKey(ip)) ? rules.get(ip) : rules.get(ALL);
85      }
86  
87      public Map<String, Rule> getRules() {
88          return rules;
89      }
90  
91      public void setRules(Map<String, Rule> rules) {
92          this.rules = rules;
93      }
94  
95      public void addRule(String name, Rule rule) {
96          rules.put(name, rule);
97      }
98  
99      /**
100      * Provides a custom transformer as the current configuration is not c2b friendly.
101      */
102     public static final class InstanceFactory extends ObservedComponentFactory<IPSecurityManager> {
103         public InstanceFactory() {
104             super(RepositoryConstants.CONFIG, "/server/IPConfig", IPSecurityManager.class);
105         }
106 
107         @Override
108         protected Node2BeanTransformer getNode2BeanTransformer() {
109             return new IPSecurityManagerTransformer();
110         }
111     }
112 
113     /**
114      * Transformer which uses the IP value of the rule as the key.
115      */
116     public static final class IPSecurityManagerTransformer extends Node2BeanTransformerImpl {
117 
118         @Override
119         public void setProperty(TypeMapping typeMapping, TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values) throws RepositoryException {
120             final Object currentBean = state.getCurrentBean();
121             if (currentBean instanceof IPSecurityManagerImpl) {
122                 final IPSecurityManagerImpl ipSecMan = (IPSecurityManagerImpl) currentBean;
123                 for (Object o : values.values()) {
124                     if (o instanceof Rule) {
125                         final Rule rule = (Rule) o;
126                         ipSecMan.addRule(rule.getIP(), rule);
127                     }
128                 }
129             }
130             super.setProperty(typeMapping, state, descriptor, values);
131         }
132 
133         @Override
134         protected TypeDescriptor onResolveType(TypeMapping typeMapping, TransformationState state, TypeDescriptor resolvedType, ComponentProvider componentProvider) {
135             if (state.getLevel() == 2 && resolvedType == null) {
136                 return typeMapping.getTypeDescriptor(Rule.class);
137             }
138             return super.onResolveType(typeMapping, state, resolvedType, componentProvider);
139         }
140 
141     }
142 
143     /**
144      * Basic rule. Does not support patterns.
145      */
146     public static final class Rule {
147         private String name;
148         private String ip;
149         private Set<String> methods;
150 
151         public Rule() {
152             this.methods = Collections.emptySet();
153         }
154 
155         public String getName() {
156             return name;
157         }
158 
159         public void setName(String name) {
160             this.name = name;
161         }
162 
163         public String getIP() {
164             return ip;
165         }
166 
167         public void setIP(String ip) {
168             this.ip = ip;
169         }
170 
171         public boolean allowsMethod(String s) {
172             return methods.contains(s);
173         }
174 
175         public String getMethods() {
176             throw new IllegalStateException("Just faking a getter for content2bean's sake.");
177         }
178 
179         public void setMethods(String methods) {
180             this.methods = new TreeSet<String>(String.CASE_INSENSITIVE_ORDER);
181             this.methods.addAll(Arrays.asList(methods.split(",")));
182         }
183     }
184 
185 }