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

   1 package org.apache.maven.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 java.util.ArrayList;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26
  27 import org.apache.commons.collections.CollectionUtils;
  28 import org.apache.maven.archiva.common.ArchivaException;
  29 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  30 import org.apache.maven.archiva.configuration.ConfigurationNames;
  31 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  32 import org.apache.maven.archiva.security.ArchivaRoleConstants;
  33 import org.codehaus.plexus.redback.rbac.RBACManager;
  34 import org.codehaus.plexus.redback.rbac.RbacManagerException;
  35 import org.codehaus.plexus.redback.rbac.UserAssignment;
  36 import org.codehaus.plexus.redback.role.RoleManager;
  37 import org.codehaus.plexus.redback.role.RoleManagerException;
  38 import org.codehaus.plexus.redback.system.check.EnvironmentCheck;
  39 import org.codehaus.plexus.registry.Registry;
  40 import org.codehaus.plexus.registry.RegistryListener;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * ConfigurationSynchronization
  46  *
  47  * @version $Id$
  48  *
  49  * @plexus.component role="org.apache.maven.archiva.web.startup.SecuritySynchronization"
  50  * role-hint="default"
  51  */
  52 public class SecuritySynchronization
  53     implements RegistryListener
  54 {
  55     private Logger log = LoggerFactory.getLogger( SecuritySynchronization.class );
  56
  57     /**
  58      * @plexus.requirement role-hint="default"
  59      */
  60     private RoleManager roleManager;
  61
  62     /**
  63      * @plexus.requirement role-hint="cached"
  64      */
  65     private RBACManager rbacManager;
  66
  67     /**
  68      * @plexus.requirement role="org.codehaus.plexus.redback.system.check.EnvironmentCheck"
  69      */
  70     private Map<String, EnvironmentCheck> checkers;
  71
  72     /**
  73      * @plexus.requirement
  74      */
  75     private ArchivaConfiguration archivaConfiguration;
  76
  77     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
  78     {
  79         if ( ConfigurationNames.isManagedRepositories( propertyName ) )
  80         {
  81             synchConfiguration( archivaConfiguration.getConfiguration().getManagedRepositories() );
  82         }
  83     }
  84
  85     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
  86     {
  87         /* do nothing */
  88     }
  89
  90     private void synchConfiguration( List<ManagedRepositoryConfiguration> repos )
  91     {
  92         // NOTE: Remote Repositories do not have roles or security placed around them.
  93
  94         for ( ManagedRepositoryConfiguration repoConfig : repos )
  95         {
  96             // manage roles for repositories
  97             try
  98             {
  99                 if ( !roleManager.templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, repoConfig
 100                     .getId() ) )
 101                 {
 102                     roleManager.createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, repoConfig
 103                         .getId() );
 104                 }
 105
 106                 if ( !roleManager.templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, repoConfig
 107                     .getId() ) )
 108                 {
 109                     roleManager.createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, repoConfig
 110                         .getId() );
 111                 }
 112             }
 113             catch ( RoleManagerException e )
 114             {
 115                 // Log error.
 116                 log.error( "Unable to create roles for configured repositories: " + e.getMessage(), e );
 117             }
 118         }
 119     }
 120
 121     public void startup()
 122         throws ArchivaException
 123     {
 124         executeEnvironmentChecks();
 125
 126         synchConfiguration( archivaConfiguration.getConfiguration().getManagedRepositories() );
 127         archivaConfiguration.addChangeListener( this );
 128
 129         if ( archivaConfiguration.isDefaulted() )
 130         {
 131             assignRepositoryObserverToGuestUser( archivaConfiguration.getConfiguration().getManagedRepositories() );
 132         }
 133     }
 134
 135     private void executeEnvironmentChecks()
 136         throws ArchivaException
 137     {
 138         if ( ( checkers == null ) || CollectionUtils.isEmpty( checkers.values() ) )
 139         {
 140             throw new ArchivaException( "Unable to initialize the Redback Security Environment, "
 141                 + "no Environment Check components found." );
 142         }
 143
 144         List<String> violations = new ArrayList<String>();
 145
 146         for ( Entry<String, EnvironmentCheck> entry : checkers.entrySet() )
 147         {
 148             EnvironmentCheck check = entry.getValue();
 149             List<String> v = new ArrayList<String>();
 150             check.validateEnvironment( v );
 151             log.info( "Environment Check: " + entry.getKey() + " -> " + v.size() + " violation(s)" );
 152             for ( String s : v )
 153             {
 154                 violations.add( "[" + entry.getKey() + "] " + s );
 155             }
 156         }
 157
 158         if ( CollectionUtils.isNotEmpty( violations ) )
 159         {
 160             StringBuffer msg = new StringBuffer();
 161             msg.append( "EnvironmentCheck Failure.\n" );
 162             msg.append( "======================================================================\n" );
 163             msg.append( " ENVIRONMENT FAILURE !! \n" );
 164             msg.append( "\n" );
 165
 166             for ( String violation : violations )
 167             {
 168                 msg.append( violation ).append( "\n" );
 169             }
 170
 171             msg.append( "\n" );
 172             msg.append( "======================================================================" );
 173             log.error( msg.toString() );
 174
 175             throw new ArchivaException( "Unable to initialize Redback Security Environment, [" + violations.size()
 176                 + "] violation(s) encountered, See log for details." );
 177         }
 178     }
 179
 180     private void assignRepositoryObserverToGuestUser( List<ManagedRepositoryConfiguration> repos )
 181     {
 182         for ( ManagedRepositoryConfiguration repoConfig : repos )
 183         {
 184             String repoId = repoConfig.getId();
 185
 186             // TODO: Use the Redback / UserConfiguration..getString( "redback.default.guest" ) to get the right name.
 187             String principal = "guest";
 188
 189             try
 190             {
 191                 UserAssignment ua;
 192
 193                 if ( rbacManager.userAssignmentExists( principal ) )
 194                 {
 195                     ua = rbacManager.getUserAssignment( principal );
 196                 }
 197                 else
 198                 {
 199                     ua = rbacManager.createUserAssignment( principal );
 200                 }
 201
 202                 ua.addRoleName( ArchivaRoleConstants.toRepositoryObserverRoleName( repoId ) );
 203                 rbacManager.saveUserAssignment( ua );
 204             }
 205             catch ( RbacManagerException e )
 206             {
 207                 log.warn( "Unable to add role [" + ArchivaRoleConstants.toRepositoryObserverRoleName( repoId )
 208                                       + "] to " + principal + " user.", e );
 209             }
 210         }
 211     }
 212 }