CryptionUtil (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.security.cryption.CryptionUtil

```
public final class CryptionUtil
extends Object
```
暗号化・復号化ユーティリティクラス。

このクラスは、定義されている暗号化・復号化モジュールを利用して、文字列の暗号化・復号化を行うユーティリティクラスです。

暗号化・復号化モジュールは、WEB-INF/conf/cryption-config の <cryption> に定義します。
定義する暗号化・復号化モジュールは Cryption インタフェースを実装したクラスです。

<cryption-config> ..... <cryption category="sample-category" default="true"> <cryption-class>jp.co.intra_mart.foundation.security.cryption.Cryptionを実装したクラス</cryption-class> </cryption> ..... </cryption-config>
デフォルトの暗号化・復号化モジュールを指定する default="true" の指定と、カテゴリの指定は他の設定ファイルと競合する可能性があります。
cryption-config設定ファイルを追加する場合は、以下をご注意ください。
- テナント管理機能が提供する WEB-INF/conf/cryption-config/cryption-config.xml 以外のファイルでは、default="true"の指定を行わない。
- 他の設定と重複しないようなカテゴリ名で、暗号化・復号化モジュールを提供する。
暗号化・復号化を行う際に、暗号化・復号化モジュールが定義されていない場合、CryptionRuntimeExceptionがスローされます。
導入されたバージョン:

8.0.0

バージョン:

8.0.22

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`static boolean`	`checkSignature(String base, String signature)` 署名文字列が正しいかチェックします。
`static void`	`clearCache()` 非推奨です。開発用です。クラスタに含まれるノードのうち、リクエストを受け付けたノードのみを対象として設定のクリアを行います。
`static String`	`createSignature(String base)` 署名文字列を作成します。
`static String`	`decrypt(String secret)` デフォルトの暗号化・復号化モジュールを利用して、文字列を復号化します。
`static String`	`decrypt(String category, String secret)` 指定されたカテゴリの暗号化・復号化モジュールを利用して、文字列を復号化します。
`static String`	`encrypt(String plane)` デフォルトの暗号化・復号化モジュールを利用して、文字列を暗号化します。
`static String`	`encrypt(String category, String plane)` 指定されたカテゴリの暗号化・復号化モジュールを利用して、文字列を暗号化します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - checkSignature
```
public static boolean checkSignature(String base,
                                     String signature)
```
    署名文字列が正しいかチェックします。
    
    引数「base」を元に署名を作成し、その値が引数「signature」と等しい場合に、署名文字列が正しいと判斷します。
    
    パラメータ:
    
    base - 署名文字列のベースとなった文字列
    
    signature - 署名文字列
    
    戻り値:
    
    署名が正しい場合は true、それ以外は false を返却します。
  - clearCache
```
@Deprecated
public static void clearCache()
```
    非推奨です。開発用です。クラスタに含まれるノードのうち、リクエストを受け付けたノードのみを対象として設定のクリアを行います。
    
    内部に保持している設定のクリアを行ないます。
  - createSignature
```
public static String createSignature(String base)
```
    署名文字列を作成します。
    
    署名文字列の作成には、Adler32 チェックサムを利用しています。
    引数で与えられた文字列のバイトシーケンスからチェックサムを計算し、 Long.toString(long, int)を利用して文字列化しています。
    文字列化の際に使用する基数は、 Character.MAX_RADIXです。
    
    パラメータ:
    
    base - 署名文字列のベースとなる文字列
    
    戻り値:
    
    署名文字列
  - decrypt
```
public static String decrypt(String secret)
```
    デフォルトの暗号化・復号化モジュールを利用して、文字列を復号化します。
    
    利用する暗号化・復号化モジュールは、WEB-INF/conf/cryption-config 配下の設定ファイルで定義されている必要があります。
    定義する暗号化・復号化モジュールは、Cryption を実装したクラスです。
    
    「デフォルトの暗号化・復号化モジュール」とは、cryption-config.xml にて「default="true"」が設定されているモジュールです。
    「default="true"」が一つも設定されていない場合、最初に定義されているモジュールがデフォルトの暗号化・復号化モジュールとなります。
    複数のモジュールに「default="true"」が設定されている場合、「default="true"」が設定されているモジュールの中で、最初に定義されたモジュールがデフォルトの暗号化・復号化モジュールとなります。
    復号化に失敗した場合はnullを返却します。
    
    パラメータ:
    
    secret - 暗号化された文字列
    
    戻り値:
    
    復号化された文字列
    
    関連項目:
    
    Cryption
  - decrypt
```
public static String decrypt(String category,
                             String secret)
```
    指定されたカテゴリの暗号化・復号化モジュールを利用して、文字列を復号化します。
    
    利用する暗号化・復号化モジュールは、WEB-INF/conf/cryption-config 配下の設定ファイルで定義されている必要があります。
    定義する暗号化・復号化モジュールは、Cryption を実装したクラスです。
    カテゴリは、cryption-config.xml の cryption タグの category 属性に定義します。
    
    cryption-config.xmlに指定されたカテゴリが存在しない場合は、デフォルトの暗号化・復号化モジュールが使われます。
    デフォルトの暗号化・復号化モジュールに関しては、decrypt(String) を参照してください。
    復号化に失敗した場合はnullを返却します。
    
    パラメータ:
    
    category - 暗号化・復号化モジュールカテゴリ
    
    secret - 暗号化された文字列
    
    戻り値:
    
    復号化された文字列
    
    関連項目:
    
    Cryption
  - encrypt
```
public static String encrypt(String plane)
```
    デフォルトの暗号化・復号化モジュールを利用して、文字列を暗号化します。
    
    利用する暗号化・復号化モジュールは、WEB-INF/conf/cryption-config 配下の設定ファイルで定義されている必要があります。
    定義する暗号化・復号化モジュールは、Cryption を実装したクラスです。
    
    デフォルトの暗号化・復号化モジュールに関しては、decrypt(String) を参照してください。
    暗号化に失敗した場合はnullを返却します。
    
    パラメータ:
    
    plane - 暗号化する文字列
    
    戻り値:
    
    暗号化された文字列
    
    関連項目:
    
    Cryption
  - encrypt
```
public static String encrypt(String category,
                             String plane)
```
    指定されたカテゴリの暗号化・復号化モジュールを利用して、文字列を暗号化します。
    
    利用する暗号化・復号化モジュールは、WEB-INF/conf/cryption-config 配下の設定ファイルで定義されている必要があります。
    定義する暗号化・復号化モジュールは、Cryption を実装したクラスです。
    カテゴリは、cryption-config.xml の cryption タグの category 属性に定義します。
    
    cryption-config.xmlに指定されたカテゴリが存在しない場合は、デフォルトの暗号化・復号化モジュールが使われます。
    デフォルトの暗号化・復号化モジュールに関しては、decrypt(String) を参照してください。
    暗号化に失敗した場合はnullを返却します。
    
    パラメータ:
    
    category - 暗号化・復号化モジュールカテゴリ
    
    plane - 暗号化する文字列
    
    戻り値:
    
    暗号化された文字列
    
    関連項目:
    
    Cryption

クラス CryptionUtil

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

メソッドの詳細

checkSignature

clearCache

createSignature

decrypt

decrypt

encrypt

encrypt