001/* 002 * Copyright (c) 2009 The openGion Project. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 013 * either express or implied. See the License for the specific language 014 * governing permissions and limitations under the License. 015 */ 016package org.opengion.fukurou.security; 017 018import java.util.Map; 019import java.util.Collections; // 6.4.3.1 (2016/02/12) refactoring 020import java.util.LinkedHashMap; // 6.4.3.3 (2016/03/04) 021 022/** 023 * URLHashMap は、セキュリティ強化の為の Hybs独自の暗号化クラスです。 024 * 025 * このクラスは、暗号化キーを受け取り、それに基づいて暗号化/復号化を行います。 026 * ここでの暗号化は、秘密キー方式でバイト文字列に変換されたものを、16進アスキー文字に 027 * 直して、扱っています。よって、暗号化/復号化共に、文字列として扱うことが可能です。 028 * 029 * @og.rev 5.2.2.0 (2010/11/01) 新規追加 030 * @og.rev 6.4.3.3 (2016/03/04) キャッシュを、世代交代のWeakHashMapから、LinkedHashMap(固定容量) に変更します。 031 * @og.group ライセンス管理 032 * 033 * @version 5.2.2.0 (2010/11/01) 034 * @author Kazuhiko Hasegawa 035 * @since JDK1.6, 036 */ 037public final class URLHashMap { 038 private static final int SIZE = 10000; // 6.4.3.3 (2016/03/04) 固定容量なので、増やしておきます。 039 /** 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 */ 040 041 /** 042 * LinkedHashMap は、反復順序を持つMapインタフェースで、データ件数を固定に設定します。 043 * ここでは、マップに新しいマッピングが追加されると、自動的に古いマッピングを削除するポリシーを 044 * 適用するために、removeEldestEntry(Map.Entry)メソッドをオーバーライドしています。 045 * 古いマッピングの定義は、コンストラクタの、順序付けモードで指定でき、アクセス順ならtrue、挿入順ならfalse です。 046 * ここでは、固定の個数分だけ、キャッシュし、あふれた古い分は、順次キャッシュから追い出されていきます。 047 * Collections.synchronizedMap で、同期処理を行います。 048 */ 049 private static final Map<String,String> URLMAP = Collections.synchronizedMap( new LinkedHashMap<String,String>( SIZE*2,0.75f,true ) { // アクセス順 050 private static final long serialVersionUID = 643320160304L ; 051 /** 052 * このマップが一番古いエントリを削除するはずの場合にtrueを返します。 053 * 054 * @og.rev 6.4.3.3 (2016/03/04) キャッシュを、世代交代のWeakHashMapから、LinkedHashMap(固定容量) に変更します。 055 * 056 * @param eldest もっとも以前にマップに挿入されたエントリ 057 * 058 * @return もっとも古いエントリをマップから削除すべき場合はtrue。そのエントリを保持すべき場合はfalse 059 */ 060 @Override 061 protected boolean removeEldestEntry( Map.Entry<String,String> eldest ) { 062 return size() > SIZE; 063 } 064 } ); 065 066 /** 067 * デフォルトコンストラクター 068 * これは、すべてstatic メソッドで構成されているクラスなので、直接インスタンスの生成を禁止します。 069 * 070 * @og.rev 5.3.0.0 (2010/12/01) 新規追加 071 */ 072 private URLHashMap() { 073 // 直接インスタンスの生成を禁止 074 } 075 076 /** 077 * URL をハッシュ化/暗号化して返します。 078 * 共通処理を簡易化するための、便利メソッドです。 079 * ここでのハッシュ化/暗号化は、URLのパラメータ(?以降の部分)のみ行います。 080 * また、ここで渡す文字列は、URLを含む文字列なので、href のキーワードを 081 * 手がかりに、? を探して、その部分のみ、変換します。 082 * href を含まない場合は、それ自体が URL と判断して、? を探します。 083 * ? が存在しないケースは、url をそのまま返します。 084 * 085 * URLのアドレスが、"/" から始まる場合は、自身のアドレスと判断し、ハッシュ処理を行います。 086 * そうでない場合(http:// や ../ の場合)は、暗号化処理を行います。 087 * 第2引数は、ハッシュ化/暗号化されたパラメータを指定するキーになります。(標準は、h_r) 088 * 処理を選択します。 089 * href を含まず、'?' だけを含む場合は、'?' 以降を暗号化します。 090 * 091 * ハッシュの場合、このキーを元に、設定値を内部キャッシュ(Map)に設定します。 092 * Map は、3世代持っており、内部キャッシュ(SIZE=6000)を超えると、2世代目に移行し、 093 * さらに、超えると、3世代目に移行します。3世代目は、WeakHashMap を利用している 094 * ため、場合によってはデータがなくなり、アクセス不能になっている可能性があります。 095 * 096 * @param url オリジナルのURL、または、URLを含む文字列 097 * @param hkey パラメータのキーとして使用する文字 098 * @param extOnly 外部URL対応 [true:外部URLの場合のみ処理を実行/false:全実行] 099 * 100 * @return 変換されたURL を含む文字列 101 */ 102 public static String makeUrlChange( final String url , final String hkey , final boolean extOnly ) { 103 if( url == null || hkey == null ) { return null; } 104 // 外部のみ(extOnly=true)で、かつ、内部URLの形式の場合、引数そのままを返します。 105 if( extOnly && url.indexOf( "href=\"/" ) >= 0 ) { return url; } 106 107 String rtnUrl = url; 108 109 final int idx1 = url.indexOf( "href=\"" ); 110 final int idx2 = url.indexOf( '?', idx1 ); // href・・・ がない時(idx1 == -1)でも正常に動作する。 111 if( idx2 >= 0 ) { 112 final String url1 = url.substring( 0,idx2+1 ); // 最初から '?' まで(?を含む) 113 final int idx3 = url.indexOf( '"',idx2+1 ); // 6.0.2.5 (2014/10/31) refactoring 114 if( idx3 >= 0 ) { 115 String url2 = url.substring( idx2+1,idx3 ); // 純粋なパラメータ部分 116 final String url3 = url.substring( idx3 ); // ダブルクオート(含む)以降 117 // href="/ かどうか。文字列の有効長があるかどうかを先にチェックしている。 118 if( idx1 >= 0 && url.length() > idx1+7 && url.charAt( idx1+7 ) == '/' ) { 119 url2 = makeHashKey( url2 ); 120 } 121 else { 122 url2 = makeEncrypt( url2 ); 123 } 124 rtnUrl = url1 + hkey + "=" + url2 + url3 ; 125 } 126 // '?' はあるが、最後のダブルクオートがない場合は、'?' から後ろすべてを暗号化する。 127 else { 128 final String url2 = url.substring( idx2+1 ); // ?以降の部分 129 rtnUrl = url1 + hkey + "=" + makeEncrypt( url2 ) ; 130 } 131 } 132 133 return rtnUrl; 134 } 135 136 /** 137 * 引数の設定値をハッシュ化したときの値(=ハッシュキー)を作成します。 138 * 内部的に、このハッシュキーを元に、設定値を内部キャッシュ(Map)に設定します。 139 * 140 * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 141 * @og.rev 6.4.3.3 (2016/03/04) キャッシュを、世代交代のWeakHashMapから、LinkedHashMap(固定容量) に変更します。 142 * 143 * @param val オリジナルの設定値 144 * 145 * @return ハッシュキー 146 * @og.rtnNotNull 147 */ 148 public static String makeHashKey( final String val ) { 149 if( val == null ) { return ""; } 150 151 // 必殺技:最後に "X" を付けることで、ハッシュ処理されたことを示す。 152 final String key = HybsCryptography.getMD5( val ) + "X"; 153 URLMAP.put( key,val ); // 6.4.3.3 (2016/03/04) 154 return key; 155 } 156 157 /** 158 * 引数の設定値を暗号化したときの値を作成します。 159 * 暗号化なので、ハッシュ化の時の用に、内部キャッシュ(Map)に設定しません。 160 * 処理時間等を考慮すると、外部URLの暗号化や、長期にわたるURL(一旦、システムの 161 * 外部にURLを渡す:例えば、メールでリンク先を送信するなど)の作成に使用します。 162 * 163 * @param val オリジナルの設定値 164 * 165 * @return 暗号化キー 166 * @og.rtnNotNull 167 */ 168 public static String makeEncrypt( final String val ) { 169 if( val == null ) { return ""; } 170 171 // 必殺技:最後に "Y" を付けることで、暗号化処理されたことを示す。 172 final HybsCryptography crypt = new HybsCryptography(); 173 return crypt.encrypt( val ) + "Y"; 174 } 175 176 /** 177 * 指定のキーに対応した設定値を取り出します。 178 * ここでは、ハッシュ化 または 暗号化されているキーに対して、 179 * ハッシュキーであれば、関連付けられた設定値を取り出し、暗号化キーで 180 * あれば、復号化処理を行います。 181 * 182 * @og.rev 6.4.1.1 (2016/01/16) URLMAP2 を、static finalにするため、代入せずに、clear() + putAll(Map) で処理します。 183 * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 184 * @og.rev 6.4.3.3 (2016/03/04) キャッシュを、世代交代のWeakHashMapから、LinkedHashMap(固定容量) に変更します。 185 * 186 * @param key ハッシュ化/暗号化されたキー 187 * 188 * @return オリジナルの設定値 189 */ 190 public static String getValue( final String key ) { 191 if( key == null || key.isEmpty() ) { return null; } 192 193 String rtn = null; 194 195 final char ch = key.charAt( key.length()-1 ); 196 if( ch == 'X' ) { 197 rtn = URLMAP.get( key ); 198 } 199 else if( ch == 'Y' ) { 200 final HybsCryptography crypt = new HybsCryptography(); 201 rtn = crypt.decrypt( key.substring( 0,key.length()-1 ) ); 202 } 203 204 return rtn ; 205 } 206}