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.apache.archiva.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 ) && propertyName.endsWith( ".id" ) )
 104         {
 105             if ( propertyValue != null )
 106             {
 107                 syncRepoConfiguration( (String) propertyValue );
 108             }
 109         }
 110     }
 111
 112     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 113     {
 114         /* do nothing */
 115     }
 116
 117     private void synchConfiguration( List<ManagedRepositoryConfiguration> repos )
 118     {
 119         // NOTE: Remote Repositories do not have roles or security placed around them.
 120
 121         for ( ManagedRepositoryConfiguration repoConfig : repos )
 122         {
 123             syncRepoConfiguration( repoConfig.getId() );
 124         }
 125     }
 126
 127     private void syncRepoConfiguration( String id )
 128     {
 129         // manage roles for repositories
 130         try
 131         {
 132             if ( !roleManager.templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, id ) )
 133             {
 134                 roleManager.createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, id );
 135             }
 136             else
 137             {
 138                 roleManager.verifyTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, id );
 139             }
 140
 141             if ( !roleManager.templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, id ) )
 142             {
 143                 roleManager.createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, id );
 144             }
 145             else
 146             {
 147                 roleManager.verifyTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, id );
 148             }
 149         }
 150         catch ( RoleManagerException e )
 151         {
 152             // Log error.
 153             log.error( "Unable to create roles for configured repositories: " + e.getMessage(), e );
 154         }
 155     }
 156
 157     public void startup()
 158         throws ArchivaException
 159     {
 160         executeEnvironmentChecks();
 161
 162         synchConfiguration( archivaConfiguration.getConfiguration().getManagedRepositories() );
 163         archivaConfiguration.addChangeListener( this );
 164
 165         if ( archivaConfiguration.isDefaulted() )
 166         {
 167             assignRepositoryObserverToGuestUser( archivaConfiguration.getConfiguration().getManagedRepositories() );
 168         }
 169     }
 170
 171     private void executeEnvironmentChecks()
 172         throws ArchivaException
 173     {
 174         if ( ( checkers == null ) || CollectionUtils.isEmpty( checkers.values() ) )
 175         {
 176             throw new ArchivaException(
 177                 "Unable to initialize the Redback Security Environment, " + "no Environment Check components found." );
 178         }
 179
 180         List<String> violations = new ArrayList<String>();
 181
 182         for ( Entry<String, EnvironmentCheck> entry : checkers.entrySet() )
 183         {
 184             EnvironmentCheck check = entry.getValue();
 185             List<String> v = new ArrayList<String>();
 186             check.validateEnvironment( v );
 187             log.info( "Environment Check: " + entry.getKey() + " -> " + v.size() + " violation(s)" );
 188             for ( String s : v )
 189             {
 190                 violations.add( "[" + entry.getKey() + "] " + s );
 191             }
 192         }
 193
 194         if ( CollectionUtils.isNotEmpty( violations ) )
 195         {
 196             StringBuilder msg = new StringBuilder();
 197             msg.append( "EnvironmentCheck Failure.\n" );
 198             msg.append( "======================================================================\n" );
 199             msg.append( " ENVIRONMENT FAILURE !! \n" );
 200             msg.append( "\n" );
 201
 202             for ( String violation : violations )
 203             {
 204                 msg.append( violation ).append( "\n" );
 205             }
 206
 207             msg.append( "\n" );
 208             msg.append( "======================================================================" );
 209             log.error( msg.toString() );
 210
 211             throw new ArchivaException( "Unable to initialize Redback Security Environment, [" + violations.size()
 212                                             + "] violation(s) encountered, See log for details." );
 213         }
 214     }
 215
 216     private void assignRepositoryObserverToGuestUser( List<ManagedRepositoryConfiguration> repos )
 217     {
 218         for ( ManagedRepositoryConfiguration repoConfig : repos )
 219         {
 220             String repoId = repoConfig.getId();
 221
 222             String principal = UserManager.GUEST_USERNAME;
 223
 224             try
 225             {
 226                 UserAssignment ua;
 227
 228                 if ( rbacManager.userAssignmentExists( principal ) )
 229                 {
 230                     ua = rbacManager.getUserAssignment( principal );
 231                 }
 232                 else
 233                 {
 234                     ua = rbacManager.createUserAssignment( principal );
 235                 }
 236
 237                 ua.addRoleName( ArchivaRoleConstants.toRepositoryObserverRoleName( repoId ) );
 238                 rbacManager.saveUserAssignment( ua );
 239             }
 240             catch ( RbacManagerException e )
 241             {
 242                 log.warn( "Unable to add role [" + ArchivaRoleConstants.toRepositoryObserverRoleName( repoId ) + "] to "
 243                               + principal + " user.", e );
 244             }
 245         }
 246     }
 247 }