DataSealer (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- edu.internet2.middleware.shibboleth.common.util.DataSealer

```
public class DataSealer
extends Object
```
Applies a MAC to time-limited information and encrypts with a symmetric key.

作成者:

Scott Cantor, Walter Hoehn, Derek Morr

コンストラクタの概要

コンストラクタ
コンストラクタと説明

DataSealer()

コンストラクタ
コンストラクタと説明
`DataSealer()`

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`String`	`getCipherAlgorithm()` Returns the encryption algorithm.
`SecretKey`	`getCipherKey()` Returns the encryption key.
`String`	`getCipherKeyAlias()` Returns the encryption key alias.
`String`	`getCipherKeyPassword()` Returns the encryption key password.
`String`	`getKeystorePassword()` Returns the keystore password.
`String`	`getKeystorePath()` Returns the keystore path.
`String`	`getKeystoreType()` Returns the keystore type.
`String`	`getMacAlgorithm()` Returns the MAC algorithm.
`SecretKey`	`getMacKey()` Returns the MAC key, if different from the encryption key.
`String`	`getMacKeyAlias()` Returns the MAC key alias.
`String`	`getMacKeyPassword()` Returns the MAC key password.
`SecureRandom`	`getRandom()` Returns the pseudorandom generator.
`void`	`init()` Initialization method used after setting all relevant bean properties.
`void`	`setCipherAlgorithm(String alg)` Sets the encryption algorithm.
`void`	`setCipherKey(SecretKey key)` Sets the encryption key.
`void`	`setCipherKeyAlias(String alias)` Sets the encryption key alias.
`void`	`setCipherKeyPassword(String password)` Sets the encryption key password.
`void`	`setKeystorePassword(String password)` Sets the keystore password.
`void`	`setKeystorePath(String path)` Sets the keystore path.
`void`	`setKeystoreType(String type)` Sets the keystore type.
`void`	`setMacAlgorithm(String alg)` Sets the MAC key algorithm.
`void`	`setMacKey(SecretKey key)` Sets the MAC key.
`void`	`setMacKeyAlias(String alias)` Sets the MAC key alias.
`void`	`setMacKeyPassword(String password)` Sets the MAC key password.
`void`	`setRandom(SecureRandom r)` Sets the pseudorandom generator.
`String`	`unwrap(String wrapped)` Decrypts and verifies an encrypted bundle of MAC'd data, and returns it.
`String`	`wrap(String data, long exp)` Encodes data into a cryptographic blob: [IV][HMAC][exp][data] where: [IV] = the Initialization Vector; byte-array [HMAC] = the HMAC; byte array [exp] = expiration time of the data; 8 bytes; Big-endian [data] = the principal; a UTF-8-encoded string The bytes are then GZIP'd.

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

- コンストラクタの詳細
  - DataSealer
```
public DataSealer()
```
- メソッドの詳細
  - init
```
public void init()
          throws DataSealerException
```
    Initialization method used after setting all relevant bean properties.
    
    例外:
    
    DataSealerException - if initialization fails
  - getCipherKey
```
public SecretKey getCipherKey()
```
    Returns the encryption key.
    
    戻り値:
    the encryption key
  - getMacKey
```
public SecretKey getMacKey()
```
    Returns the MAC key, if different from the encryption key.
    
    戻り値:
    the MAC key
  - getRandom
```
public SecureRandom getRandom()
```
    Returns the pseudorandom generator.
    
    戻り値:
    the pseudorandom generator
  - getKeystoreType
```
public String getKeystoreType()
```
    Returns the keystore type.
    
    戻り値:
    the keystore type.
  - getKeystorePath
```
public String getKeystorePath()
```
    Returns the keystore path.
    
    戻り値:
    the keystore path
  - getKeystorePassword
```
public String getKeystorePassword()
```
    Returns the keystore password.
    
    戻り値:
    the keystore password
  - getCipherKeyAlias
```
public String getCipherKeyAlias()
```
    Returns the encryption key alias.
    
    戻り値:
    the encryption key alias
  - getCipherKeyPassword
```
public String getCipherKeyPassword()
```
    Returns the encryption key password.
    
    戻り値:
    the encryption key password
  - getCipherAlgorithm
```
public String getCipherAlgorithm()
```
    Returns the encryption algorithm.
    
    戻り値:
    the encryption algorithm
  - getMacKeyAlias
```
public String getMacKeyAlias()
```
    Returns the MAC key alias.
    
    戻り値:
    the MAC key alias
  - getMacKeyPassword
```
public String getMacKeyPassword()
```
    Returns the MAC key password.
    
    戻り値:
    the MAC key password
  - getMacAlgorithm
```
public String getMacAlgorithm()
```
    Returns the MAC algorithm.
    
    戻り値:
    the MAC algorithm
  - setCipherKey
```
public void setCipherKey(SecretKey key)
```
    Sets the encryption key.
    
    パラメータ:
    key - the encryption key to set
  - setMacKey
```
public void setMacKey(SecretKey key)
```
    Sets the MAC key.
    
    パラメータ:
    key - the MAC key to set
  - setRandom
```
public void setRandom(SecureRandom r)
```
    Sets the pseudorandom generator.
    
    パラメータ:
    r - the pseudorandom generator to set
  - setKeystoreType
```
public void setKeystoreType(String type)
```
    Sets the keystore type.
    
    パラメータ:
    type - the keystore type to set
  - setKeystorePath
```
public void setKeystorePath(String path)
```
    Sets the keystore path.
    
    パラメータ:
    path - the keystore path to set
  - setKeystorePassword
```
public void setKeystorePassword(String password)
```
    Sets the keystore password.
    
    パラメータ:
    password - the keystore password to set
  - setCipherKeyAlias
```
public void setCipherKeyAlias(String alias)
```
    Sets the encryption key alias.
    
    パラメータ:
    alias - the encryption key alias to set
  - setCipherKeyPassword
```
public void setCipherKeyPassword(String password)
```
    Sets the encryption key password.
    
    パラメータ:
    password - the encryption key password to set
  - setCipherAlgorithm
```
public void setCipherAlgorithm(String alg)
```
    Sets the encryption algorithm.
    
    パラメータ:
    alg - the encryption algorithm to set
  - setMacKeyAlias
```
public void setMacKeyAlias(String alias)
```
    Sets the MAC key alias.
    
    パラメータ:
    alias - the MAC key alias to set
  - setMacKeyPassword
```
public void setMacKeyPassword(String password)
```
    Sets the MAC key password.
    
    パラメータ:
    password - the the MAC key password to set
  - setMacAlgorithm
```
public void setMacAlgorithm(String alg)
```
    Sets the MAC key algorithm.
    
    パラメータ:
    alg - the MAC algorithm to set
  - unwrap
```
public String unwrap(String wrapped)
              throws DataSealerException
```
    Decrypts and verifies an encrypted bundle of MAC'd data, and returns it.
    
    パラメータ:
    wrapped - the encoded blob
    
    戻り値:
    the decrypted data, if it's unexpired
    
    例外:
    
    DataSealerException - if the data cannot be unwrapped and verified
  - wrap
```
public String wrap(String data,
          long exp)
            throws DataSealerException
```
    Encodes data into a cryptographic blob: [IV][HMAC][exp][data] where: [IV] = the Initialization Vector; byte-array [HMAC] = the HMAC; byte array [exp] = expiration time of the data; 8 bytes; Big-endian [data] = the principal; a UTF-8-encoded string The bytes are then GZIP'd. The IV is pre-pended to this byte stream, and the result is Base32-encoded. We don't need to encode the IV or MAC's lengths. They can be obtained from Cipher.getBlockSize() and Mac.getMacLength(), respectively.
    
    パラメータ:
    data - the data to wrap
    exp - expiration time
    
    戻り値:
    the encoded blob
    
    例外:
    
    DataSealerException - if the wrapping operation fails

クラス DataSealer

コンストラクタの概要

メソッドの概要

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

コンストラクタの詳細

DataSealer

メソッドの詳細

init

getCipherKey

getMacKey

getRandom

getKeystoreType

getKeystorePath

getKeystorePassword

getCipherKeyAlias

getCipherKeyPassword

getCipherAlgorithm

getMacKeyAlias

getMacKeyPassword

getMacAlgorithm

setCipherKey

setMacKey

setRandom

setKeystoreType

setKeystorePath

setKeystorePassword

setCipherKeyAlias

setCipherKeyPassword

setCipherAlgorithm

setMacKeyAlias

setMacKeyPassword

setMacAlgorithm

unwrap

wrap