HeliosCryptoManager

java.lang.Object
- eu.h2020.helios_social.core.security.HeliosCryptoManager

All Implemented Interfaces:

HeliosCrypto
```
public class HeliosCryptoManager
extends java.lang.Object
implements HeliosCrypto
```
Singleton class to implement HELIOS cryptographic interface HeliosCrypto

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`createHMAC(byte[] data, byte[] secret)` Calculates the HMAC (message authentication code) for a byte array using SHA 256.
`javax.crypto.SecretKey`	`decryptAESKey(java.security.PrivateKey decryptionRSAKey, byte[] encryptedAESKey)` Decrypts an encrypted AES key using a RSA decryption key.
`byte[]`	`decryptBytes(byte[] cryptotextBytes, javax.crypto.SecretKey AESKey, byte[] iv)` Decrypts a cryptotext using AES in Galois Counter Mode and with NoPadding.
`byte[]`	`encryptAESKey(java.security.PublicKey encryptionRSAKey, javax.crypto.SecretKey AESKey)` Encrypts an AES key using a RSA encryption key.
`byte[]`	`encryptBytes(byte[] plaintextBytes, javax.crypto.SecretKey AESKey, byte[] iv)` Encrypts an array of bytes using AES in Galois Counter Mode and with NoPadding.
`javax.crypto.SecretKey`	`generateAESKey()` Generates a random AES key.
`java.security.KeyPair`	`generateRSAKeyPair()` Generates a random RSA 2048 bit public key - private key pair for encryption or signing.
`static HeliosCryptoManager`	`getInstance()` Get the singleton instance of this Manager.
`byte[]`	`signBytes(java.security.PrivateKey signingRSAKey, byte[] bytesToSign)` Signs a byte array using RSA and SHA 256.
`boolean`	`verifyBytes(java.security.PublicKey verificationRSAKey, byte[] bytesToSign, byte[] signatureToVerify)` Checks if a signature is valid, that is, generated with the private RSA key corresponding to the public key.
`boolean`	`verifyHMAC(byte[] hmac, byte[] data, byte[] secret)` Checks if a HMAC value is valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static HeliosCryptoManager getInstance()
```
    Get the singleton instance of this Manager.
    
    Returns:
    
    HeliosCryptoManager
  - generateAESKey
```
public javax.crypto.SecretKey generateAESKey()
```
    Description copied from interface: HeliosCrypto
    
    Generates a random AES key.
    
    Specified by:
    
    generateAESKey in interface HeliosCrypto
    
    Returns:
    
    new AES key SecretKey
  - generateRSAKeyPair
```
public java.security.KeyPair generateRSAKeyPair()
```
    Description copied from interface: HeliosCrypto
    
    Generates a random RSA 2048 bit public key - private key pair for encryption or signing.
    
    Specified by:
    
    generateRSAKeyPair in interface HeliosCrypto
    
    Returns:
    
    new RSA key pair KeyPair
  - encryptAESKey
```
public byte[] encryptAESKey(java.security.PublicKey encryptionRSAKey,
                            javax.crypto.SecretKey AESKey)
```
    Description copied from interface: HeliosCrypto
    
    Encrypts an AES key using a RSA encryption key. Used mode is ECB and OAEPWithSHA1AndMGF1Padding. (It is faster to encrypt a message using AES and then encrypt the AES key with RSA than to encrypt the whole message with RSA.)
    
    Specified by:
    
    encryptAESKey in interface HeliosCrypto
    
    Parameters:
    
    encryptionRSAKey - The RSA key that is used for encryption PublicKey
    
    AESKey - The key that will be encrypted SecretKey
    
    Returns:
    
    The AES key in encrypted form as byte array
  - decryptAESKey
```
public javax.crypto.SecretKey decryptAESKey(java.security.PrivateKey decryptionRSAKey,
                                            byte[] encryptedAESKey)
```
    Description copied from interface: HeliosCrypto
    
    Decrypts an encrypted AES key using a RSA decryption key.
    
    Specified by:
    
    decryptAESKey in interface HeliosCrypto
    
    Parameters:
    
    decryptionRSAKey - The RSA key that is used for decryption PrivateKey
    
    encryptedAESKey - The AES key in encrypted form as byte array
    
    Returns:
    
    The decrypted AES key SecretKey
  - encryptBytes
```
public byte[] encryptBytes(byte[] plaintextBytes,
                           javax.crypto.SecretKey AESKey,
                           byte[] iv)
```
    Description copied from interface: HeliosCrypto
    
    Encrypts an array of bytes using AES in Galois Counter Mode and with NoPadding. The authentication tag length is 128 bits. The value of iv must be different for every encryption so the method chooses one randomly. The decryption is impossible without the correct initial value, thus the value of iv must be saved afterwards. The iv can then be stored or sent with the plaintext.
    
    Specified by:
    
    encryptBytes in interface HeliosCrypto
    
    Parameters:
    
    plaintextBytes - The plaintext
    
    AESKey - The AES key that is used for encryption SecretKey
    
    iv - The random initial value (12 bytes) that the method generates for GCM
    
    Returns:
    
    The cryptotext as byte array
  - decryptBytes
```
public byte[] decryptBytes(byte[] cryptotextBytes,
                           javax.crypto.SecretKey AESKey,
                           byte[] iv)
```
    Description copied from interface: HeliosCrypto
    
    Decrypts a cryptotext using AES in Galois Counter Mode and with NoPadding. Returns null if the cryptotext is not generated correctly.
    
    Specified by:
    
    decryptBytes in interface HeliosCrypto
    
    Parameters:
    
    cryptotextBytes - The cryptotext
    
    AESKey - The AES key that is used for decryption SecretKey
    
    iv - The initial value for GCM. Must be the same that was used in encryption, otherwise decryption fails.
    
    Returns:
    
    The plaintext as byte array
  - signBytes
```
public byte[] signBytes(java.security.PrivateKey signingRSAKey,
                        byte[] bytesToSign)
```
    Description copied from interface: HeliosCrypto
    
    Signs a byte array using RSA and SHA 256.
    
    Specified by:
    
    signBytes in interface HeliosCrypto
    
    Parameters:
    
    signingRSAKey - The RSA key that is used for signing PrivateKey
    
    bytesToSign - The byte array that is to be signed
    
    Returns:
    
    The signature as byte array
  - verifyBytes
```
public boolean verifyBytes(java.security.PublicKey verificationRSAKey,
                           byte[] bytesToSign,
                           byte[] signatureToVerify)
```
    Description copied from interface: HeliosCrypto
    
    Checks if a signature is valid, that is, generated with the private RSA key corresponding to the public key.
    
    Specified by:
    
    verifyBytes in interface HeliosCrypto
    
    Parameters:
    
    verificationRSAKey - The public RSA key that is used for verification PublicKey
    
    bytesToSign - The byte array that was signed
    
    signatureToVerify - The signature that is to be verified
    
    Returns:
    
    True if the signature was valid, false otherwise.
  - createHMAC
```
public byte[] createHMAC(byte[] data,
                         byte[] secret)
```
    Description copied from interface: HeliosCrypto
    
    Calculates the HMAC (message authentication code) for a byte array using SHA 256.
    
    Specified by:
    
    createHMAC in interface HeliosCrypto
    
    Parameters:
    
    data - The input bytes
    
    secret - The secret key
    
    Returns:
    
    The HMAC of length 256 bits as byte array
  - verifyHMAC
```
public boolean verifyHMAC(byte[] hmac,
                          byte[] data,
                          byte[] secret)
```
    Description copied from interface: HeliosCrypto
    
    Checks if a HMAC value is valid.
    
    Specified by:
    
    verifyHMAC in interface HeliosCrypto
    
    Parameters:
    
    hmac - The 256 bit HMAC that is to be checked
    
    data - The input that was used to generate the HMAC
    
    secret - The secret key that was used to generate the HMAC
    
    Returns:
    
    True if the HMAC was valid, false otherwise.

Class HeliosCryptoManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

generateAESKey

generateRSAKeyPair

encryptAESKey

decryptAESKey

encryptBytes

decryptBytes

signBytes

verifyBytes

createHMAC

verifyHMAC