blob: 314224461ebeb26bf842194eb5e2cd65050952bd [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.keys;</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"> * Copyright 2001-2006 The Apache Software Foundation.</a>
<span class="sourceLineNo">005</span><a id="line.5"> *</a>
<span class="sourceLineNo">006</span><a id="line.6"> * Licensed under the Apache License, Version 2.0 (the "License");</a>
<span class="sourceLineNo">007</span><a id="line.7"> * you may not use this file except in compliance with the License.</a>
<span class="sourceLineNo">008</span><a id="line.8"> * You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing, software</a>
<span class="sourceLineNo">013</span><a id="line.13"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
<span class="sourceLineNo">014</span><a id="line.14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
<span class="sourceLineNo">015</span><a id="line.15"> * See the License for the specific language governing permissions and</a>
<span class="sourceLineNo">016</span><a id="line.16"> * limitations under the License.</a>
<span class="sourceLineNo">017</span><a id="line.17"> */</a>
<span class="sourceLineNo">018</span><a id="line.18"></a>
<span class="sourceLineNo">019</span><a id="line.19">import org.slf4j.Logger;</a>
<span class="sourceLineNo">020</span><a id="line.20">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">import java.security.SecureRandom;</a>
<span class="sourceLineNo">023</span><a id="line.23">import java.util.*;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">/**</a>
<span class="sourceLineNo">026</span><a id="line.26"> * AbstractKeyManager </a>
<span class="sourceLineNo">027</span><a id="line.27"> *</a>
<span class="sourceLineNo">028</span><a id="line.28"> * @author &lt;a href="mailto:joakim@erdfelt.com"&gt;Joakim Erdfelt&lt;/a&gt;</a>
<span class="sourceLineNo">029</span><a id="line.29"> *</a>
<span class="sourceLineNo">030</span><a id="line.30"> */</a>
<span class="sourceLineNo">031</span><a id="line.31">public abstract class AbstractKeyManager</a>
<span class="sourceLineNo">032</span><a id="line.32"> implements KeyManager</a>
<span class="sourceLineNo">033</span><a id="line.33">{</a>
<span class="sourceLineNo">034</span><a id="line.34"> protected Logger log = LoggerFactory.getLogger( getClass() );</a>
<span class="sourceLineNo">035</span><a id="line.35"> </a>
<span class="sourceLineNo">036</span><a id="line.36"> private static final int KEY_LENGTH = 16;</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> private static final boolean SECURE = true;</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> private boolean randomMode = SECURE;</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> private SecureRandom secureRandom;</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> private Random random;</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> /**</a>
<span class="sourceLineNo">047</span><a id="line.47"> * Generate a UUID using &lt;a href="http://www.ietf.org/rfc/rfc4122.txt"&gt;RFC 4122&lt;/a&gt; UUID generation of a </a>
<span class="sourceLineNo">048</span><a id="line.48"> * type 4 or randomly generated UUID.</a>
<span class="sourceLineNo">049</span><a id="line.49"> * </a>
<span class="sourceLineNo">050</span><a id="line.50"> * @return the 32 character long UUID string.</a>
<span class="sourceLineNo">051</span><a id="line.51"> * @throws KeyManagerException</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53"> protected String generateUUID()</a>
<span class="sourceLineNo">054</span><a id="line.54"> throws KeyManagerException</a>
<span class="sourceLineNo">055</span><a id="line.55"> {</a>
<span class="sourceLineNo">056</span><a id="line.56"> return UUID.randomUUID().toString();</a>
<span class="sourceLineNo">057</span><a id="line.57"> }</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"> * Tests the key to see if it is expired or not.</a>
<span class="sourceLineNo">061</span><a id="line.61"> * </a>
<span class="sourceLineNo">062</span><a id="line.62"> * If the key is expired, a call to {@link #deleteKey(AuthenticationKey)} is issued,</a>
<span class="sourceLineNo">063</span><a id="line.63"> * and a {@link KeyNotFoundException} is thrown.</a>
<span class="sourceLineNo">064</span><a id="line.64"> * </a>
<span class="sourceLineNo">065</span><a id="line.65"> * @param authkey the key to test.</a>
<span class="sourceLineNo">066</span><a id="line.66"> * @throws KeyNotFoundException if the key is expired.</a>
<span class="sourceLineNo">067</span><a id="line.67"> * @throws KeyManagerException if there was a problem removing the key.</a>
<span class="sourceLineNo">068</span><a id="line.68"> */</a>
<span class="sourceLineNo">069</span><a id="line.69"> protected void assertNotExpired( AuthenticationKey authkey )</a>
<span class="sourceLineNo">070</span><a id="line.70"> throws KeyNotFoundException, KeyManagerException</a>
<span class="sourceLineNo">071</span><a id="line.71"> {</a>
<span class="sourceLineNo">072</span><a id="line.72"> if ( authkey.getDateExpires() == null )</a>
<span class="sourceLineNo">073</span><a id="line.73"> {</a>
<span class="sourceLineNo">074</span><a id="line.74"> // No expiration means a permanent entry.</a>
<span class="sourceLineNo">075</span><a id="line.75"> return;</a>
<span class="sourceLineNo">076</span><a id="line.76"> }</a>
<span class="sourceLineNo">077</span><a id="line.77"> </a>
<span class="sourceLineNo">078</span><a id="line.78"> // Test for expiration.</a>
<span class="sourceLineNo">079</span><a id="line.79"> Calendar now = getNowGMT();</a>
<span class="sourceLineNo">080</span><a id="line.80"> Calendar expiration = getNowGMT();</a>
<span class="sourceLineNo">081</span><a id="line.81"> expiration.setTime( authkey.getDateExpires() );</a>
<span class="sourceLineNo">082</span><a id="line.82"> </a>
<span class="sourceLineNo">083</span><a id="line.83"> if ( now.after( expiration ) )</a>
<span class="sourceLineNo">084</span><a id="line.84"> {</a>
<span class="sourceLineNo">085</span><a id="line.85"> deleteKey( authkey );</a>
<span class="sourceLineNo">086</span><a id="line.86"> throw new KeyNotFoundException( "Key [" + authkey.getKey() + "] has expired." );</a>
<span class="sourceLineNo">087</span><a id="line.87"> }</a>
<span class="sourceLineNo">088</span><a id="line.88"> }</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> protected Calendar getNowGMT()</a>
<span class="sourceLineNo">091</span><a id="line.91"> {</a>
<span class="sourceLineNo">092</span><a id="line.92"> return Calendar.getInstance( TimeZone.getTimeZone( "GMT" ) );</a>
<span class="sourceLineNo">093</span><a id="line.93"> }</a>
<span class="sourceLineNo">094</span><a id="line.94"></a>
<span class="sourceLineNo">095</span><a id="line.95"> public void setRandomMode( boolean randomMode )</a>
<span class="sourceLineNo">096</span><a id="line.96"> {</a>
<span class="sourceLineNo">097</span><a id="line.97"> this.randomMode = randomMode;</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> public boolean isRandomMode()</a>
<span class="sourceLineNo">101</span><a id="line.101"> {</a>
<span class="sourceLineNo">102</span><a id="line.102"> return randomMode;</a>
<span class="sourceLineNo">103</span><a id="line.103"> }</a>
<span class="sourceLineNo">104</span><a id="line.104"></a>
<span class="sourceLineNo">105</span><a id="line.105"> public void removeExpiredKeys()</a>
<span class="sourceLineNo">106</span><a id="line.106"> throws KeyManagerException</a>
<span class="sourceLineNo">107</span><a id="line.107"> {</a>
<span class="sourceLineNo">108</span><a id="line.108"> List&lt;AuthenticationKey&gt; allKeys = getAllKeys();</a>
<span class="sourceLineNo">109</span><a id="line.109"></a>
<span class="sourceLineNo">110</span><a id="line.110"> Calendar now = getNowGMT();</a>
<span class="sourceLineNo">111</span><a id="line.111"> Calendar expiration = getNowGMT();</a>
<span class="sourceLineNo">112</span><a id="line.112"></a>
<span class="sourceLineNo">113</span><a id="line.113"> log.info( "Removing expired keys." );</a>
<span class="sourceLineNo">114</span><a id="line.114"> for ( AuthenticationKey authkey : allKeys )</a>
<span class="sourceLineNo">115</span><a id="line.115"> {</a>
<span class="sourceLineNo">116</span><a id="line.116"> if ( authkey.getDateExpires() != null )</a>
<span class="sourceLineNo">117</span><a id="line.117"> {</a>
<span class="sourceLineNo">118</span><a id="line.118"> expiration.setTime( authkey.getDateExpires() );</a>
<span class="sourceLineNo">119</span><a id="line.119"></a>
<span class="sourceLineNo">120</span><a id="line.120"> if ( now.after( expiration ) )</a>
<span class="sourceLineNo">121</span><a id="line.121"> {</a>
<span class="sourceLineNo">122</span><a id="line.122"> deleteKey( authkey );</a>
<span class="sourceLineNo">123</span><a id="line.123"> }</a>
<span class="sourceLineNo">124</span><a id="line.124"> }</a>
<span class="sourceLineNo">125</span><a id="line.125"> }</a>
<span class="sourceLineNo">126</span><a id="line.126"> log.info( "Expired keys removed." );</a>
<span class="sourceLineNo">127</span><a id="line.127"> }</a>
<span class="sourceLineNo">128</span><a id="line.128">}</a>
</pre>
</div>
</main>
</body>
</html>