blob: a45b6ca4d7d26b0abbec4de0d3fac1b4849f6c28 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.integration.checks.security;</a>
<span class="sourceLineNo">002</span><a id="line.2"></a>
<span class="sourceLineNo">003</span><a id="line.3">/*</a>
<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">013</span><a id="line.13"> *</a>
<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
<span class="sourceLineNo">020</span><a id="line.20"> */</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.authentication.PasswordBasedAuthenticationDataSource;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.configuration.UserConfiguration;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.configuration.UserConfigurationKeys;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.rbac.RBACManager;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.role.RoleManager;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.role.RoleManagerException;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.system.SecuritySession;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.system.SecuritySystem;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.system.check.EnvironmentCheck;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.users.User;</a>
<span class="sourceLineNo">032</span><a id="line.32">import org.apache.archiva.redback.users.UserManager;</a>
<span class="sourceLineNo">033</span><a id="line.33">import org.apache.archiva.redback.users.UserManagerException;</a>
<span class="sourceLineNo">034</span><a id="line.34">import org.apache.archiva.redback.users.UserNotFoundException;</a>
<span class="sourceLineNo">035</span><a id="line.35">import org.apache.commons.io.IOUtils;</a>
<span class="sourceLineNo">036</span><a id="line.36">import org.apache.commons.lang3.StringUtils;</a>
<span class="sourceLineNo">037</span><a id="line.37">import org.slf4j.Logger;</a>
<span class="sourceLineNo">038</span><a id="line.38">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">039</span><a id="line.39">import org.springframework.stereotype.Service;</a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41">import javax.inject.Inject;</a>
<span class="sourceLineNo">042</span><a id="line.42">import javax.inject.Named;</a>
<span class="sourceLineNo">043</span><a id="line.43">import java.io.InputStream;</a>
<span class="sourceLineNo">044</span><a id="line.44">import java.nio.file.Files;</a>
<span class="sourceLineNo">045</span><a id="line.45">import java.nio.file.Path;</a>
<span class="sourceLineNo">046</span><a id="line.46">import java.nio.file.Paths;</a>
<span class="sourceLineNo">047</span><a id="line.47">import java.util.Date;</a>
<span class="sourceLineNo">048</span><a id="line.48">import java.util.List;</a>
<span class="sourceLineNo">049</span><a id="line.49">import java.util.Properties;</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51">/**</a>
<span class="sourceLineNo">052</span><a id="line.52"> * @author Olivier Lamy</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @since 2.0</a>
<span class="sourceLineNo">054</span><a id="line.54"> */</a>
<span class="sourceLineNo">055</span><a id="line.55">@Service("environmentCheck#adminAutoCreateCheck")</a>
<span class="sourceLineNo">056</span><a id="line.56">public class AdminAutoCreateCheck</a>
<span class="sourceLineNo">057</span><a id="line.57"> implements EnvironmentCheck</a>
<span class="sourceLineNo">058</span><a id="line.58">{</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> private Logger log = LoggerFactory.getLogger( getClass() );</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> public static final String FORCE_ADMIN_FILE_PATH = "redback.admin.creation.file";</a>
<span class="sourceLineNo">063</span><a id="line.63"></a>
<span class="sourceLineNo">064</span><a id="line.64"> public static final String ADMIN_FULL_NAME_KEY = "redback.admin.fullname";</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> public static final String ADMIN_EMAIL_KEY = "redback.admin.email";</a>
<span class="sourceLineNo">067</span><a id="line.67"></a>
<span class="sourceLineNo">068</span><a id="line.68"> public static final String ADMIN_PASSWORD_KEY = "redback.admin.password";</a>
<span class="sourceLineNo">069</span><a id="line.69"></a>
<span class="sourceLineNo">070</span><a id="line.70"> @Inject</a>
<span class="sourceLineNo">071</span><a id="line.71"> @Named(value = "userManager#default")</a>
<span class="sourceLineNo">072</span><a id="line.72"> private UserManager userManager;</a>
<span class="sourceLineNo">073</span><a id="line.73"></a>
<span class="sourceLineNo">074</span><a id="line.74"> @Inject</a>
<span class="sourceLineNo">075</span><a id="line.75"> @Named(value = "userConfiguration#default")</a>
<span class="sourceLineNo">076</span><a id="line.76"> private UserConfiguration config;</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> @Inject</a>
<span class="sourceLineNo">079</span><a id="line.79"> protected SecuritySystem securitySystem;</a>
<span class="sourceLineNo">080</span><a id="line.80"></a>
<span class="sourceLineNo">081</span><a id="line.81"> @Inject</a>
<span class="sourceLineNo">082</span><a id="line.82"> private RoleManager roleManager;</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> @Inject</a>
<span class="sourceLineNo">085</span><a id="line.85"> @Named(value = "rbacManager#default")</a>
<span class="sourceLineNo">086</span><a id="line.86"> private RBACManager rbacManager;</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> public void validateEnvironment( List&lt;String&gt; violations )</a>
<span class="sourceLineNo">089</span><a id="line.89"> {</a>
<span class="sourceLineNo">090</span><a id="line.90"> try</a>
<span class="sourceLineNo">091</span><a id="line.91"> {</a>
<span class="sourceLineNo">092</span><a id="line.92"> User user = userManager.findUser( getAdminUid() );</a>
<span class="sourceLineNo">093</span><a id="line.93"> if ( user == null )</a>
<span class="sourceLineNo">094</span><a id="line.94"> {</a>
<span class="sourceLineNo">095</span><a id="line.95"> useForceAdminCreationFile();</a>
<span class="sourceLineNo">096</span><a id="line.96"> }</a>
<span class="sourceLineNo">097</span><a id="line.97"> }</a>
<span class="sourceLineNo">098</span><a id="line.98"> catch ( UserNotFoundException e )</a>
<span class="sourceLineNo">099</span><a id="line.99"> {</a>
<span class="sourceLineNo">100</span><a id="line.100"> useForceAdminCreationFile();</a>
<span class="sourceLineNo">101</span><a id="line.101"> }</a>
<span class="sourceLineNo">102</span><a id="line.102"> catch ( UserManagerException e )</a>
<span class="sourceLineNo">103</span><a id="line.103"> {</a>
<span class="sourceLineNo">104</span><a id="line.104"> useForceAdminCreationFile();</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</a>
<span class="sourceLineNo">106</span><a id="line.106"> }</a>
<span class="sourceLineNo">107</span><a id="line.107"></a>
<span class="sourceLineNo">108</span><a id="line.108"> private void useForceAdminCreationFile()</a>
<span class="sourceLineNo">109</span><a id="line.109"> {</a>
<span class="sourceLineNo">110</span><a id="line.110"> try</a>
<span class="sourceLineNo">111</span><a id="line.111"> {</a>
<span class="sourceLineNo">112</span><a id="line.112"> String forceAdminFilePath = System.getProperty( FORCE_ADMIN_FILE_PATH );</a>
<span class="sourceLineNo">113</span><a id="line.113"> if ( StringUtils.isBlank( forceAdminFilePath ) )</a>
<span class="sourceLineNo">114</span><a id="line.114"> {</a>
<span class="sourceLineNo">115</span><a id="line.115"> log.info( "{} system props is empty don't use an auto creation admin ", FORCE_ADMIN_FILE_PATH );</a>
<span class="sourceLineNo">116</span><a id="line.116"> return;</a>
<span class="sourceLineNo">117</span><a id="line.117"> }</a>
<span class="sourceLineNo">118</span><a id="line.118"> Path file = Paths.get( forceAdminFilePath );</a>
<span class="sourceLineNo">119</span><a id="line.119"> if ( !Files.exists(file) )</a>
<span class="sourceLineNo">120</span><a id="line.120"> {</a>
<span class="sourceLineNo">121</span><a id="line.121"> log.warn( "file set in sysprops {} not exists skip admin auto creation", FORCE_ADMIN_FILE_PATH );</a>
<span class="sourceLineNo">122</span><a id="line.122"> return;</a>
<span class="sourceLineNo">123</span><a id="line.123"> }</a>
<span class="sourceLineNo">124</span><a id="line.124"> log.debug( "user {} not found try auto creation", getAdminUid() );</a>
<span class="sourceLineNo">125</span><a id="line.125"> Properties properties = new Properties();</a>
<span class="sourceLineNo">126</span><a id="line.126"> InputStream fis = Files.newInputStream(file);</a>
<span class="sourceLineNo">127</span><a id="line.127"> try</a>
<span class="sourceLineNo">128</span><a id="line.128"> {</a>
<span class="sourceLineNo">129</span><a id="line.129"> properties.load( fis );</a>
<span class="sourceLineNo">130</span><a id="line.130"> }</a>
<span class="sourceLineNo">131</span><a id="line.131"> catch ( Exception e )</a>
<span class="sourceLineNo">132</span><a id="line.132"> {</a>
<span class="sourceLineNo">133</span><a id="line.133"> log.warn( "error loading properties from file {} skip admin auto creation", forceAdminFilePath );</a>
<span class="sourceLineNo">134</span><a id="line.134"> return;</a>
<span class="sourceLineNo">135</span><a id="line.135"> }</a>
<span class="sourceLineNo">136</span><a id="line.136"> finally</a>
<span class="sourceLineNo">137</span><a id="line.137"> {</a>
<span class="sourceLineNo">138</span><a id="line.138"> IOUtils.closeQuietly( fis );</a>
<span class="sourceLineNo">139</span><a id="line.139"> }</a>
<span class="sourceLineNo">140</span><a id="line.140"></a>
<span class="sourceLineNo">141</span><a id="line.141"> // ensure we have all properties</a>
<span class="sourceLineNo">142</span><a id="line.142"> String password = properties.getProperty( ADMIN_PASSWORD_KEY );</a>
<span class="sourceLineNo">143</span><a id="line.143"> String email = properties.getProperty( ADMIN_EMAIL_KEY );</a>
<span class="sourceLineNo">144</span><a id="line.144"> String fullName = properties.getProperty( ADMIN_FULL_NAME_KEY );</a>
<span class="sourceLineNo">145</span><a id="line.145"></a>
<span class="sourceLineNo">146</span><a id="line.146"> if ( StringUtils.isBlank( password ) )</a>
<span class="sourceLineNo">147</span><a id="line.147"> {</a>
<span class="sourceLineNo">148</span><a id="line.148"> log.warn( "property {} not set skip auto admin creation", ADMIN_PASSWORD_KEY );</a>
<span class="sourceLineNo">149</span><a id="line.149"> return;</a>
<span class="sourceLineNo">150</span><a id="line.150"> }</a>
<span class="sourceLineNo">151</span><a id="line.151"></a>
<span class="sourceLineNo">152</span><a id="line.152"> if ( StringUtils.isBlank( email ) )</a>
<span class="sourceLineNo">153</span><a id="line.153"> {</a>
<span class="sourceLineNo">154</span><a id="line.154"> log.warn( "property not set skip auto admin creation", ADMIN_EMAIL_KEY );</a>
<span class="sourceLineNo">155</span><a id="line.155"> return;</a>
<span class="sourceLineNo">156</span><a id="line.156"> }</a>
<span class="sourceLineNo">157</span><a id="line.157"></a>
<span class="sourceLineNo">158</span><a id="line.158"> if ( StringUtils.isBlank( fullName ) )</a>
<span class="sourceLineNo">159</span><a id="line.159"> {</a>
<span class="sourceLineNo">160</span><a id="line.160"> log.warn( "property {} not set skip auto admin creation", ADMIN_FULL_NAME_KEY );</a>
<span class="sourceLineNo">161</span><a id="line.161"> return;</a>
<span class="sourceLineNo">162</span><a id="line.162"> }</a>
<span class="sourceLineNo">163</span><a id="line.163"></a>
<span class="sourceLineNo">164</span><a id="line.164"> User u = userManager.createUser( getAdminUid(), fullName, email );</a>
<span class="sourceLineNo">165</span><a id="line.165"></a>
<span class="sourceLineNo">166</span><a id="line.166"> u.setPassword( password );</a>
<span class="sourceLineNo">167</span><a id="line.167"> u.setLocked( false );</a>
<span class="sourceLineNo">168</span><a id="line.168"> u.setPasswordChangeRequired( false );</a>
<span class="sourceLineNo">169</span><a id="line.169"> u.setPermanent( true );</a>
<span class="sourceLineNo">170</span><a id="line.170"> u.setValidated( true );</a>
<span class="sourceLineNo">171</span><a id="line.171"></a>
<span class="sourceLineNo">172</span><a id="line.172"> u = userManager.addUser( u );</a>
<span class="sourceLineNo">173</span><a id="line.173"> u.setPassword( password );</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175"> PasswordBasedAuthenticationDataSource authdatasource = new PasswordBasedAuthenticationDataSource();</a>
<span class="sourceLineNo">176</span><a id="line.176"> authdatasource.setPrincipal( u.getUsername() );</a>
<span class="sourceLineNo">177</span><a id="line.177"> authdatasource.setPassword( u.getPassword() );</a>
<span class="sourceLineNo">178</span><a id="line.178"> SecuritySession securitySession = securitySystem.authenticate( authdatasource );</a>
<span class="sourceLineNo">179</span><a id="line.179"> if ( securitySession.getAuthenticationResult().isAuthenticated() )</a>
<span class="sourceLineNo">180</span><a id="line.180"> {</a>
<span class="sourceLineNo">181</span><a id="line.181"> // good add various tokens.</a>
<span class="sourceLineNo">182</span><a id="line.182"> u = securitySession.getUser();</a>
<span class="sourceLineNo">183</span><a id="line.183"> u.setLastLoginDate( new Date() );</a>
<span class="sourceLineNo">184</span><a id="line.184"> u.setPassword( null );</a>
<span class="sourceLineNo">185</span><a id="line.185"> securitySystem.getUserManager().updateUser( u );</a>
<span class="sourceLineNo">186</span><a id="line.186"> }</a>
<span class="sourceLineNo">187</span><a id="line.187"> assignAdminRole( u );</a>
<span class="sourceLineNo">188</span><a id="line.188"></a>
<span class="sourceLineNo">189</span><a id="line.189"> }</a>
<span class="sourceLineNo">190</span><a id="line.190"> catch ( Exception e )</a>
<span class="sourceLineNo">191</span><a id="line.191"> {</a>
<span class="sourceLineNo">192</span><a id="line.192"> log.warn( "failed to automatically create an admin account {}", e.getMessage(), e );</a>
<span class="sourceLineNo">193</span><a id="line.193"> }</a>
<span class="sourceLineNo">194</span><a id="line.194"> }</a>
<span class="sourceLineNo">195</span><a id="line.195"></a>
<span class="sourceLineNo">196</span><a id="line.196"> private void assignAdminRole( User user )</a>
<span class="sourceLineNo">197</span><a id="line.197"> throws RoleManagerException</a>
<span class="sourceLineNo">198</span><a id="line.198"> {</a>
<span class="sourceLineNo">199</span><a id="line.199"> roleManager.assignRole( "system-administrator", user.getUsername() );</a>
<span class="sourceLineNo">200</span><a id="line.200"> }</a>
<span class="sourceLineNo">201</span><a id="line.201"></a>
<span class="sourceLineNo">202</span><a id="line.202"> private String getAdminUid()</a>
<span class="sourceLineNo">203</span><a id="line.203"> {</a>
<span class="sourceLineNo">204</span><a id="line.204"> return config.getString( UserConfigurationKeys.DEFAULT_ADMIN );</a>
<span class="sourceLineNo">205</span><a id="line.205"> }</a>
<span class="sourceLineNo">206</span><a id="line.206">}</a>
</pre>
</div>
</main>
</body>
</html>