source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.web.startup;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *  http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import org.apache.archiva.common.ArchivaException;
  23 import org.apache.archiva.configuration.ArchivaConfiguration;
  24 import org.apache.archiva.configuration.ConfigurationNames;
  25 import org.apache.archiva.configuration.ManagedRepositoryConfiguration;
  26 import org.apache.archiva.security.common.ArchivaRoleConstants;
  27 import org.apache.commons.collections.CollectionUtils;
  28 import org.apache.commons.lang.StringUtils;
  29 import org.codehaus.plexus.redback.rbac.RBACManager;
  30 import org.codehaus.plexus.redback.rbac.RbacManagerException;
  31 import org.codehaus.plexus.redback.rbac.UserAssignment;
  32 import org.codehaus.plexus.redback.role.RoleManager;
  33 import org.codehaus.plexus.redback.role.RoleManagerException;
  34 import org.codehaus.plexus.redback.system.check.EnvironmentCheck;
  35 import org.codehaus.plexus.redback.users.UserManager;
  36 import org.codehaus.plexus.registry.Registry;
  37 import org.codehaus.plexus.registry.RegistryListener;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40 import org.springframework.context.ApplicationContext;
  41 import org.springframework.stereotype.Service;
  42
  43 import javax.annotation.PostConstruct;
  44 import javax.inject.Inject;
  45 import javax.inject.Named;
  46 import java.util.ArrayList;
  47 import java.util.HashMap;
  48 import java.util.List;
  49 import java.util.Map;
  50 import java.util.Map.Entry;
  51
  52 /**
  53  * ConfigurationSynchronization
  54  *
  55  * @version $Id$
  56  */
  57 @Service
  58 public class SecuritySynchronization
  59     implements RegistryListener
  60 {
  61     private Logger log = LoggerFactory.getLogger( SecuritySynchronization.class );
  62
  63     @Inject
  64     private RoleManager roleManager;
  65
  66     @Inject
  67     @Named( value = "rBACManager#cached" )
  68     private RBACManager rbacManager;
  69
  70     private Map<String, EnvironmentCheck> checkers;
  71
  72     @Inject
  73     private ArchivaConfiguration archivaConfiguration;
  74
  75     @Inject
  76     private ApplicationContext applicationContext;
  77
  78     @PostConstruct
  79     public void initialize()
  80     {
  81         checkers = getBeansOfType( EnvironmentCheck.class );
  82     }
  83
  84     protected <T> Map<String, T> getBeansOfType( Class<T> clazz )
  85     {
  86         //TODO do some caching here !!!
  87         // olamy : with plexus we get only roleHint
  88         // as per convention we named spring bean role#hint remove role# if exists
  89         Map<String, T> springBeans = applicationContext.getBeansOfType( clazz );
  90
  91         Map<String, T> beans = new HashMap<String, T>( springBeans.size() );
  92
  93         for ( Entry<String, T> entry : springBeans.entrySet() )
  94         {
  95             String key = StringUtils.substringAfterLast( entry.getKey(), "#" );
  96             beans.put( key, entry.getValue() );
  97         }
  98         return beans;
  99     }
 100
 101     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 102     {
 103         if ( ConfigurationNames.isManagedRepositories( propertyName ) )
 104         {
 105             synchConfiguration( archivaConfiguration.getConfiguration().getManagedRepositories() );
 106         }
 107     }
 108
 109     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 110     {
 111         /* do nothing */
 112     }
 113
 114     private void synchConfiguration( List<ManagedRepositoryConfiguration> repos )
 115     {
 116         // NOTE: Remote Repositories do not have roles or security placed around them.
 117
 118         for ( ManagedRepositoryConfiguration repoConfig : repos )
 119         {
 120             // manage roles for repositories
 121             try
 122             {
 123                 if ( !roleManager.templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER,
 124                                                        repoConfig.getId() ) )
 125                 {
 126                     roleManager.createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER,
 127                                                      repoConfig.getId() );
 128                 }
 129                 else
 130                 {
 131                     roleManager.verifyTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER,
 132                                                      repoConfig.getId() );
 133                 }
 134
 135                 if ( !roleManager.templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER,
 136                                                        repoConfig.getId() ) )
 137                 {
 138                     roleManager.createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER,
 139                                                      repoConfig.getId() );
 140                 }
 141                 else
 142                 {
 143                     roleManager.verifyTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER,
 144                                                      repoConfig.getId() );
 145                 }
 146             }
 147             catch ( RoleManagerException e )
 148             {
 149                 // Log error.
 150                 log.error( "Unable to create roles for configured repositories: " + e.getMessage(), e );
 151             }
 152         }
 153     }
 154
 155     public void startup()
 156         throws ArchivaException
 157     {
 158         executeEnvironmentChecks();
 159
 160         synchConfiguration( archivaConfiguration.getConfiguration().getManagedRepositories() );
 161         archivaConfiguration.addChangeListener( this );
 162
 163         if ( archivaConfiguration.isDefaulted() )
 164         {
 165             assignRepositoryObserverToGuestUser( archivaConfiguration.getConfiguration().getManagedRepositories() );
 166         }
 167     }
 168
 169     private void executeEnvironmentChecks()
 170         throws ArchivaException
 171     {
 172         if ( ( checkers == null ) || CollectionUtils.isEmpty( checkers.values() ) )
 173         {
 174             throw new ArchivaException(
 175                 "Unable to initialize the Redback Security Environment, " + "no Environment Check components found." );
 176         }
 177
 178         List<String> violations = new ArrayList<String>();
 179
 180         for ( Entry<String, EnvironmentCheck> entry : checkers.entrySet() )
 181         {
 182             EnvironmentCheck check = entry.getValue();
 183             List<String> v = new ArrayList<String>();
 184             check.validateEnvironment( v );
 185             log.info( "Environment Check: " + entry.getKey() + " -> " + v.size() + " violation(s)" );
 186             for ( String s : v )
 187             {
 188                 violations.add( "[" + entry.getKey() + "] " + s );
 189             }
 190         }
 191
 192         if ( CollectionUtils.isNotEmpty( violations ) )
 193         {
 194             StringBuilder msg = new StringBuilder();
 195             msg.append( "EnvironmentCheck Failure.\n" );
 196             msg.append( "======================================================================\n" );
 197             msg.append( " ENVIRONMENT FAILURE !! \n" );
 198             msg.append( "\n" );
 199
 200             for ( String violation : violations )
 201             {
 202                 msg.append( violation ).append( "\n" );
 203             }
 204
 205             msg.append( "\n" );
 206             msg.append( "======================================================================" );
 207             log.error( msg.toString() );
 208
 209             throw new ArchivaException( "Unable to initialize Redback Security Environment, [" + violations.size()
 210                                             + "] violation(s) encountered, See log for details." );
 211         }
 212     }
 213
 214     private void assignRepositoryObserverToGuestUser( List<ManagedRepositoryConfiguration> repos )
 215     {
 216         for ( ManagedRepositoryConfiguration repoConfig : repos )
 217         {
 218             String repoId = repoConfig.getId();
 219
 220             String principal = UserManager.GUEST_USERNAME;
 221
 222             try
 223             {
 224                 UserAssignment ua;
 225
 226                 if ( rbacManager.userAssignmentExists( principal ) )
 227                 {
 228                     ua = rbacManager.getUserAssignment( principal );
 229                 }
 230                 else
 231                 {
 232                     ua = rbacManager.createUserAssignment( principal );
 233                 }
 234
 235                 ua.addRoleName( ArchivaRoleConstants.toRepositoryObserverRoleName( repoId ) );
 236                 rbacManager.saveUserAssignment( ua );
 237             }
 238             catch ( RbacManagerException e )
 239             {
 240                 log.warn( "Unable to add role [" + ArchivaRoleConstants.toRepositoryObserverRoleName( repoId ) + "] to "
 241                               + principal + " user.", e );
 242             }
 243         }
 244     }
 245 }