|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object javax.crypto.CipherSpi
public abstract class CipherSpi
このクラスは、Cipher
クラスの Service Provider Interface (SPI) を定義します。特定の暗号アルゴリズムの実装を提供する各暗号化サービスプロバイダは、このクラスのすべての抽象メソッドを実装する必要があります。
この CipherSpi
クラスのインスタンスをカプセル化する Cipher
のインスタンスを生成するには、アプリケーションは Cipher
エンジンクラスの getInstance
ファクトリメソッドの 1 つを呼び出して、要求された「変換」を指定します。アプリケーションは、必要に応じて、プロバイダの名前を指定することもできます。
「変換」とは、出力を生成するために、指定された入力に対して実行する操作 (または一連の操作) を記述する文字列のことです。変換には常に暗号化アルゴリズム名 (DES など) が含まれており、フィードバックモードとパディング方式があとに続くことがあります。
変換の形式は次のとおりです。
後者の場合、モードとパディング方式についてはプロバイダ固有のデフォルト値が使用されます。有効な変換の例を次に示します。
Cipher c = Cipher.getInstance("DES/CBC/PKCS5Padding");
プロバイダは、「アルゴリズム/モード/パディング」の各組み合わせに対して個別のクラスを提供するか、あるいは「アルゴリズム」、「アルゴリズム/モード」、または「アルゴリズム//パディング」 (二重スラッシュに注意) に対応するサブ変換を表すより汎用的なクラスを提供することができます。汎用的なクラスを提供する場合、要求されたモードやパディングは、プロバイダの CipherSpi
のサブクラスの engineSetMode
および engineSetPadding
メソッドを呼び出す、Cipher
の getInstance
メソッドにより自動的に設定されます。
プロバイダのマスタークラス内の Cipher
プロパティの形式は、次のどれかになります。
// provider's subclass of "CipherSpi" implements "algName" with
// pluggable mode and padding
Cipher.
algName
// provider's subclass of "CipherSpi" implements "algName" in the
// specified "mode", with pluggable padding
Cipher.
algName/mode
// provider's subclass of "CipherSpi" implements "algName" with the
// specified "padding", with pluggable mode
Cipher.
algName//padding
// provider's subclass of "CipherSpi" implements "algName" with the
// specified "mode" and "padding"
Cipher.
algName/mode/padding
たとえば、プロバイダは、DES/ECB/PKCS5Padding、DES/CBC/PKCS5Padding、DES/CFB/PKCS5Padding、および DES/OFB/PKCS5Padding をそれぞれ実装する CipherSpi
のサブクラスを提供できます。そのプロバイダには、マスタークラスに次の Cipher
プロパティがあります。
Cipher.
DES/ECB/PKCS5Padding
Cipher.
DES/CBC/PKCS5Padding
Cipher.
DES/CFB/PKCS5Padding
Cipher.
DES/OFB/PKCS5Padding
別のプロバイダは、上記の各モード用のクラス (つまり、ECB、CBC、CFB、およびOFB のそれぞれに 1 つのクラス)、PKCS5Padding 用のクラス、および CipherSpi
からサブクラス化される汎用 DES クラスを実装することがあります。そのプロバイダには、マスタークラスに次の Cipher
プロパティがあります。
Cipher.
DES
Cipher
エンジンクラスの getInstance
ファクトリメソッドは、「アルゴリズム」の形式の変換のための CipherSpi
のプロバイダの実装をインスタンス化するために次の規則に従います。
CipherSpi
のサブクラスをプロバイダが登録しているかどうかを確認する
答えが YES の場合は、このクラスをインスタンス化します。モードおよびパディング方式はデフォルトの値 (プロバイダが提供) を使用します。
答えが NO の場合は、NoSuchAlgorithmException
例外をスローします。
Cipher
エンジンクラスの getInstance
ファクトリメソッドは、「アルゴリズム/モード/パディング」の形式の変換のための CipherSpi
のプロバイダの実装をインスタンス化するために次の規則に従います。
CipherSpi
のサブクラスをプロバイダが登録しているかどうかを確認する
答えが YES の場合は、インスタンス化します。
答えが NO の場合は、次のステップに進みます。
CipherSpi
のサブクラスをプロバイダが登録しているかどうかを確認する
答えが YES の場合は、インスタンス化し、新しいインスタンスで engineSetPadding(padding)
を呼び出します。
答えが NO の場合は、次のステップに進みます。
CipherSpi
のサブクラスをプロバイダが登録しているかどうかを確認する
答えが YES の場合は、インスタンス化し、新しいインスタンスで engineSetMode(mode)
を呼び出します。
答えが NO の場合は、次のステップに進みます。
CipherSpi
のサブクラスをプロバイダが登録しているかどうかを確認する
答えが YES の場合は、インスタンス化し、新しいインスタンスで engineSetMode(mode)
および engineSetPadding(padding)
を呼び出します。
答えが NO の場合は、NoSuchAlgorithmException
例外をスローします。
KeyGenerator
,
SecretKey
コンストラクタの概要 | |
---|---|
CipherSpi()
|
メソッドの概要 | |
---|---|
protected abstract byte[] |
engineDoFinal(byte[] input,
int inputOffset,
int inputLen)
単一の部分から成る操作でデータを暗号化または復号化するか、複数の部分から成る操作を終了します。 |
protected abstract int |
engineDoFinal(byte[] input,
int inputOffset,
int inputLen,
byte[] output,
int outputOffset)
単一の部分から成る操作でデータを暗号化または復号化するか、複数の部分から成る操作を終了します。 |
protected int |
engineDoFinal(ByteBuffer input,
ByteBuffer output)
単一の部分から成る操作でデータを暗号化または復号化するか、複数の部分から成る操作を終了します。 |
protected abstract int |
engineGetBlockSize()
ブロックサイズを返します (バイト単位)。 |
protected abstract byte[] |
engineGetIV()
新しいバッファの初期化ベクタ (IV) を返します。 |
protected int |
engineGetKeySize(Key key)
指定された鍵オブジェクトの鍵サイズをビット単位で返します。 |
protected abstract int |
engineGetOutputSize(int inputLen)
入力の長さ inputLen (バイト単位) を指定して、次の update または doFinal 操作の結果を保持するために必要な出力バッファの長さをバイト数で返します。 |
protected abstract AlgorithmParameters |
engineGetParameters()
この暗号で使用されるパラメータを返します。 |
protected abstract void |
engineInit(int opmode,
Key key,
AlgorithmParameterSpec params,
SecureRandom random)
鍵、アルゴリズムパラメータのセット、および乱数の発生源を使用してこの暗号を初期化します。 |
protected abstract void |
engineInit(int opmode,
Key key,
AlgorithmParameters params,
SecureRandom random)
鍵、アルゴリズムパラメータのセット、および乱数の発生源を使用してこの暗号を初期化します。 |
protected abstract void |
engineInit(int opmode,
Key key,
SecureRandom random)
鍵と乱数の発生源を使用してこの暗号を初期化します。 |
protected abstract void |
engineSetMode(String mode)
この暗号のモードを設定します。 |
protected abstract void |
engineSetPadding(String padding)
この暗号のパディング機構を設定します。 |
protected Key |
engineUnwrap(byte[] wrappedKey,
String wrappedKeyAlgorithm,
int wrappedKeyType)
前にラップされた鍵をラップ解除します。 |
protected abstract byte[] |
engineUpdate(byte[] input,
int inputOffset,
int inputLen)
複数の部分から成る暗号化または復号化操作 (この暗号の初期化方法により異なる) を継続し、別のデータ部分を処理します。 |
protected abstract int |
engineUpdate(byte[] input,
int inputOffset,
int inputLen,
byte[] output,
int outputOffset)
複数の部分から成る暗号化または復号化操作 (この暗号の初期化方法により異なる) を継続し、別のデータ部分を処理します。 |
protected int |
engineUpdate(ByteBuffer input,
ByteBuffer output)
複数の部分から成る暗号化または復号化操作 (この暗号の初期化方法により異なる) を継続し、別のデータ部分を処理します。 |
protected byte[] |
engineWrap(Key key)
鍵をラップします。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
---|
public CipherSpi()
メソッドの詳細 |
---|
protected abstract void engineSetMode(String mode) throws NoSuchAlgorithmException
mode
- 暗号化モード
NoSuchAlgorithmException
- 要求された暗号化モードが存在しない場合protected abstract void engineSetPadding(String padding) throws NoSuchPaddingException
padding
- パディング機構
NoSuchPaddingException
- 要求されたパディング機構が存在しない場合protected abstract int engineGetBlockSize()
protected abstract int engineGetOutputSize(int inputLen)
inputLen
(バイト単位) を指定して、次の update
または doFinal
操作の結果を保持するために必要な出力バッファの長さをバイト数で返します。
この呼び出しでは、以前の update
呼び出しの処理されていない (バッファにある) データを考慮し、パディングします。
次の update
または doFinal
呼び出しの実際の出力長は、このメソッドが返す長さより小さいことがあります。
inputLen
- 入力長 (バイト単位)
protected abstract byte[] engineGetIV()
これは、IV がユーザ指定のパスフレーズから派生するパスワードベースの暗号化または復号化のコンテキストにおいて役立ちます。
protected abstract AlgorithmParameters engineGetParameters()
返されるパラメータは、この暗号を初期化するのに使用したものと同じ場合があります。または、返されるパラメータには、この暗号にアルゴリズムパラメータが必要で、かつアルゴリズムパラメータで初期化されなかった場合に、基本となる暗号実装で使用されるデフォルトとランダムのパラメータ値の組み合わせが含まれることもあります。
protected abstract void engineInit(int opmode, Key key, SecureRandom random) throws InvalidKeyException
この暗号は、opmode
の値に従って、暗号化、復号化、鍵ラッピング、または鍵ラッピング解除の 4 つの操作の 1 つに合わせて初期化されます。
この暗号が、指定された key
から派生できないアルゴリズムパラメータを必要とする場合、基本となる暗号実装は、暗号化または鍵ラッピング用に初期化されていれば、プロバイダ固有のデフォルトまたはランダム値を使用して必要なパラメータ自体を生成し、復号化または鍵ラッピング解除用に初期化されていれば、InvalidKeyException
を発生させます。生成されたパラメータは、engineGetParameters
または engineGetIV
(パラメータが IV の場合) を使用して取り出すことができます。
この暗号 (基本となるフィードバックまたはパディング方式を含む) が乱数バイトを必要とする場合 (たとえば、パラメータ生成のため) は、random
から取得します。
Cipher オブジェクトが初期化されると、以前に取得した状態はすべて失われます。つまり、Cipher を初期化することは、その Cipher の新しいインスタンスを作成して初期化することと同じです。
opmode
- この暗号の操作モード (ENCRYPT_MODE
、DECRYPT_MODE
、WRAP_MODE
、または UNWRAP_MODE
のどれか)key
- 暗号化鍵random
- 乱数のソース
InvalidKeyException
- 指定された鍵がこの暗号の初期化に不適切な場合、またはこの暗号が復号化用に初期化され、指定された鍵から判定することができないアルゴリズムパラメータを必要とする場合protected abstract void engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException
この暗号は、opmode
の値に従って、暗号化、復号化、鍵ラッピング、または鍵ラッピング解除の 4 つの操作の 1 つに合わせて初期化されます。
この暗号がアルゴリズムパラメータを必要とし、params
が null の場合、基本となる暗号実装は、暗号化または鍵ラッピング用に初期化されていれば、プロバイダ固有のデフォルトまたはランダム値を使用して必要なパラメータ自体を生成し、復号化または鍵ラッピング解除用に初期化されていれば、InvalidAlgorithmParameterException
を発生させます。生成されたパラメータは、engineGetParameters
または engineGetIV
(パラメータが IV の場合) を使用して取り出すことができます。
この暗号 (基本となるフィードバックまたはパディング方式を含む) が乱数バイトを必要とする場合 (たとえば、パラメータ生成のため) は、random
から取得します。
Cipher オブジェクトが初期化されると、以前に取得した状態はすべて失われます。つまり、Cipher を初期化することは、その Cipher の新しいインスタンスを作成して初期化することと同じです。
opmode
- この暗号の操作モード (ENCRYPT_MODE
、DECRYPT_MODE
、WRAP_MODE
、または UNWRAP_MODE
のどれか)key
- 暗号化鍵params
- アルゴリズムパラメータrandom
- 乱数のソース
InvalidKeyException
- 指定された鍵がこの暗号の初期化に不適切な場合
InvalidAlgorithmParameterException
- 指定されたアルゴリズムパラメータがこの暗号に不適切な場合、またはこの暗号が復号化用に初期化され、アルゴリズムパラメータを必要とし、params
が null の場合protected abstract void engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException
この暗号は、opmode
の値に従って、暗号化、復号化、鍵ラッピング、または鍵ラッピング解除の 4 つの操作の 1 つに合わせて初期化されます。
この暗号がアルゴリズムパラメータを必要とし、params
が null の場合、基本となる暗号実装は、暗号化または鍵ラッピング用に初期化されていれば、プロバイダ固有のデフォルトまたはランダム値を使用して必要なパラメータ自体を生成し、復号化または鍵ラッピング解除用に初期化されていれば、InvalidAlgorithmParameterException
を発生させます。生成されたパラメータは、engineGetParameters
または engineGetIV
(パラメータが IV の場合) を使用して取り出すことができます。
この暗号 (基本となるフィードバックまたはパディング方式を含む) が乱数バイトを必要とする場合 (たとえば、パラメータ生成のため) は、random
から取得します。
Cipher オブジェクトが初期化されると、以前に取得した状態はすべて失われます。つまり、Cipher を初期化することは、その Cipher の新しいインスタンスを作成して初期化することと同じです。
opmode
- この暗号の操作モード (ENCRYPT_MODE
、DECRYPT_MODE
、WRAP_MODE
、または UNWRAP_MODE
のどれか)key
- 暗号化鍵params
- アルゴリズムパラメータrandom
- 乱数のソース
InvalidKeyException
- 指定された鍵がこの暗号の初期化に不適切な場合
InvalidAlgorithmParameterException
- 指定されたアルゴリズムパラメータがこの暗号に不適切な場合、またはこの暗号が復号化用に初期化され、アルゴリズムパラメータを必要とし、params
が null の場合protected abstract byte[] engineUpdate(byte[] input, int inputOffset, int inputLen)
inputOffset
から始まる、input
バッファ内の最初の inputLen
バイトが処理され、結果が新しいバッファに格納されます。
input
- 入力バッファinputOffset
- 入力を開始する input
内のオフセットinputLen
- 入力長
protected abstract int engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException
inputOffset
から始まる、input
バッファ内の最初の inputLen
バイトが処理され、結果は output
バッファの outputOffset
から始まる位置に格納されます。
output
バッファが小さすぎて結果を保持できない場合は、ShortBufferException
がスローされます。
input
- 入力バッファinputOffset
- 入力を開始する input
内のオフセットinputLen
- 入力長output
- 結果を格納するバッファoutputOffset
- 結果が格納される output
内のオフセット
output
に格納されたバイト数
ShortBufferException
- 指定された出力バッファが小さすぎて結果を保持できない場合protected int engineUpdate(ByteBuffer input, ByteBuffer output) throws ShortBufferException
input.position()
で始まるすべての input.remaining()
バイトが処理されます。結果は出力バッファに格納されます。戻り時には、入力バッファの位置はその制限と等しくなり、制限は変更しません。出力バッファの位置は、このメソッドで返される値の n だけ進みます。出力バッファの制限は変更しません。
output.remaining()
バッファが小さすぎて結果を保持できない場合は、ShortBufferException
がスローされます。
サブクラスでは、バイト配列よりも効率的に ByteBuffer を処理できる場合は、このメソッドのオーバーライドを検討してください。
input
- 入力 ByteBufferoutput
- 出力 ByteByffer
output
に格納されたバイト数
ShortBufferException
- 出力バッファ内に残っている容量が不足している場合
NullPointerException
- どちらかのパラメータが null
の場合protected abstract byte[] engineDoFinal(byte[] input, int inputOffset, int inputLen) throws IllegalBlockSizeException, BadPaddingException
inputOffset
から始まる input
バッファ内の最初の inputLen
バイト、および前の update
操作でバッファに入れられた可能性のあるすべての入力バイトが処理され、パディング (要求された場合) が適用されます。結果は新しいバッファに格納されます。
終了時に、このメソッドはこの暗号オブジェクトを前に engineInit
を呼び出して初期化されたときの状態にリセットします。つまり、オブジェクトはリセットされて、さらにデータを暗号化または復号化するために使用できます (engineInit
の呼び出しで指定された操作モードにより異なる)。
注: 例外がスローされる場合、この暗号オブジェクトはリセットしないと再度使用できない場合があります。
input
- 入力バッファinputOffset
- 入力を開始する input
内のオフセットinputLen
- 入力長
IllegalBlockSizeException
- この暗号がブロック暗号であり、パディングが要求されておらず (暗号化モードの場合のみ)、この暗号で処理されたデータの入力長の合計がブロックサイズの倍数でない場合。または、この暗号化アルゴリズムでは提供された入力データを処理できない場合
BadPaddingException
- この暗号が復号化モードであり、パディング (またはパディング解除) が要求されたが、復号化されたデータが適切なパディングバイトでバインドされない場合protected abstract int engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException, IllegalBlockSizeException, BadPaddingException
inputOffset
から始まる input
バッファ内の最初の inputLen
バイト、および前の update
操作でバッファに入れられた可能性のあるすべての入力バイトが処理され、パディング (要求された場合) が適用されます。結果は、outputOffset
から始まる output
バッファに格納されます。
output
バッファが小さすぎて結果を保持できない場合は、ShortBufferException
がスローされます。
終了時に、このメソッドはこの暗号オブジェクトを前に engineInit
を呼び出して初期化されたときの状態にリセットします。つまり、オブジェクトはリセットされて、さらにデータを暗号化または復号化するために使用できます (engineInit
の呼び出しで指定された操作モードにより異なる)。
注: 例外がスローされる場合、この暗号オブジェクトはリセットしないと再度使用できない場合があります。
input
- 入力バッファinputOffset
- 入力を開始する input
内のオフセットinputLen
- 入力長output
- 結果を格納するバッファoutputOffset
- 結果が格納される output
内のオフセット
output
に格納されたバイト数
IllegalBlockSizeException
- この暗号がブロック暗号であり、パディングが要求されておらず (暗号化モードの場合のみ)、この暗号で処理されたデータの入力長の合計がブロックサイズの倍数でない場合。または、この暗号化アルゴリズムでは提供された入力データを処理できない場合
ShortBufferException
- 指定された出力バッファが小さすぎて結果を保持できない場合
BadPaddingException
- この暗号が復号化モードであり、パディング (またはパディング解除) が要求されたが、復号化されたデータが適切なパディングバイトでバインドされない場合protected int engineDoFinal(ByteBuffer input, ByteBuffer output) throws ShortBufferException, IllegalBlockSizeException, BadPaddingException
input.position()
で始まるすべての input.remaining()
バイトが処理されます。結果は出力バッファに格納されます。戻り時には、入力バッファの位置はその制限と等しくなり、制限は変更しません。出力バッファの位置は、このメソッドで返される値の n だけ進みます。出力バッファの制限は変更しません。
output.remaining()
バッファが小さすぎて結果を保持できない場合は、ShortBufferException
がスローされます。
終了時に、このメソッドはこの暗号オブジェクトを前に engineInit
を呼び出して初期化されたときの状態にリセットします。つまり、オブジェクトはリセットされて、さらにデータを暗号化または復号化するために使用できます (engineInit
の呼び出しで指定された操作モードにより異なる)。
注: 例外がスローされる場合、この暗号オブジェクトはリセットしないと再度使用できない場合があります。
サブクラスでは、バイト配列よりも効率的に ByteBuffer を処理できる場合は、このメソッドのオーバーライドを検討してください。
input
- 入力 ByteBufferoutput
- 出力 ByteByffer
output
に格納されたバイト数
IllegalBlockSizeException
- この暗号がブロック暗号であり、パディングが要求されておらず (暗号化モードの場合のみ)、この暗号で処理されたデータの入力長の合計がブロックサイズの倍数でない場合。または、この暗号化アルゴリズムでは提供された入力データを処理できない場合
ShortBufferException
- 出力バッファ内に残っている容量が不足している場合
BadPaddingException
- この暗号が復号化モードであり、パディング (またはパディング解除) が要求されたが、復号化されたデータが適切なパディングバイトでバインドされない場合
NullPointerException
- どちらかのパラメータが null
の場合protected byte[] engineWrap(Key key) throws IllegalBlockSizeException, InvalidKeyException
この具象メソッドは、事前に定義されたこの抽象クラスに追加されたものです。下位互換性のために、抽象メソッドにはできません。鍵をラップするために、プロバイダによってオーバーライドされる場合があります。そのようなオーバーライドを行うと、指定された鍵をラップできない場合に、IllegalBlockSizeException または InvalidKeyException (指定された環境下) がスローされます。このメソッドがオーバーライドされない場合は、常に UnsupportedOperationException がスローされます。
key
- ラップされる鍵
IllegalBlockSizeException
- この暗号がブロック暗号であり、パディングが要求されておらず、ラップされる鍵のエンコーディングの長さがブロックサイズの倍数でない場合
InvalidKeyException
- この暗号を使用して鍵をラップすることが不可能か安全でない場合 (たとえば、ハードウェア保護された鍵がソフトウェアだけの暗号に渡される場合)protected Key engineUnwrap(byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType) throws InvalidKeyException, NoSuchAlgorithmException
この具象メソッドは、事前に定義されたこの抽象クラスに追加されたものです。下位互換性のために、抽象メソッドにはできません。前にラップされた鍵をラップ解除するために、プロバイダによってオーバーライドされる場合があります。そのようなオーバーライドを行うと、指定された、ラップされている鍵をラップ解除できない場合に、InvalidKeyException がスローされます。このメソッドがオーバーライドされない場合は、常に UnsupportedOperationException がスローされます。
wrappedKey
- ラップを解除される鍵wrappedKeyAlgorithm
- ラップされた鍵に関連したアルゴリズムwrappedKeyType
- ラップされた鍵のタイプ。SECRET_KEY
、PRIVATE_KEY
、または PUBLIC_KEY
のどれか
NoSuchAlgorithmException
- インストールされているどのプロバイダも wrappedKeyAlgorithm
の wrappedKeyType
のタイプの鍵を作成できない場合
InvalidKeyException
- wrappedKey
が wrappedKeyAlgorithm
のラップキータイプ wrappedKeyType
を表していない場合protected int engineGetKeySize(Key key) throws InvalidKeyException
この具象メソッドは、この定義済みの抽象クラスに追加されています。プロバイダによりオーバーライドされない場合は、UnsupportedOperationException
をスローします。
key
- 鍵オブジェクト
InvalidKeyException
- key
が無効な場合
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。