CryptoHelper (Virgil SDK - Android 3.0.2 API)

java.lang.Object
- com.virgilsecurity.sdk.crypto.CryptoHelper

```
public class CryptoHelper
extends Object
```
This is utils class which covers Virgil Crypto functionality.

Author:

Andrii Iakovenko

Constructor Summary

Constructors
Constructor and Description

CryptoHelper()

Constructors
Constructor and Description
`CryptoHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`decrypt(InputStream inputStream, OutputStream outputStream, String password)` Decrypt encrypted data from stream with password.
`static void`	`decrypt(InputStream inputStream, OutputStream outputStream, String recipientId, PrivateKey privateKey)` Decrypt encrypted data from stream with private key.
`static void`	`decrypt(InputStream inputStream, OutputStream outputStream, String recipientId, PrivateKey privateKey, Password password)` Decrypt encrypted data from stream with private key.
`static String`	`decrypt(String base64Text, String password)` Decrypt text with password.
`static String`	`decrypt(String base64Text, String recipientId, PrivateKey privateKey)` Decrypt text with private key.
`static String`	`decrypt(String base64Text, String recipientId, PrivateKey privateKey, Password password)` Decrypt text with private key which protected with password.
`static void`	`encrypt(InputStream inputStream, OutputStream outputStream, String password)` Encrypt stream data with password.
`static void`	`encrypt(InputStream inputStream, OutputStream outputStream, String recipientId, PublicKey publicKey)` Encrypt stream data with password.
`static String`	`encrypt(String text, Map<String,PublicKey> recipients)` Encrypt text with public key for multiple recipients.
`static String`	`encrypt(String text, String password)` Encrypt text with password.
`static String`	`encrypt(String text, String recipientId, PublicKey publicKey)` Encrypt text with public key.
`static String`	`sign(InputStream inputStream, PrivateKey privateKey)` Sign stream with private key.
`static String`	`sign(InputStream inputStream, PrivateKey privateKey, String keyPassword)` Sign stream with private key protected with password.
`static String`	`sign(String text, PrivateKey privateKey)` Sign text with private key.
`static String`	`sign(String text, PrivateKey privateKey, Password password)` Sign text with private key.
`static String`	`signBase64(String base64string, PrivateKey privateKey)` Sign Base64 encoded string with private key.
`static boolean`	`verify(InputStream inputStream, String signature, PublicKey publicKey)` Verify stream data with signature.
`static boolean`	`verify(String text, String signature, PublicKey publicKey)` Verify text with signature.
`static boolean`	`verifyBase64(String base64string, String signature, PublicKey publicKey)` Verify Base664 encoded string with signature.

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

- Constructor Detail
  - CryptoHelper
```
public CryptoHelper()
```
- Method Detail
  - encrypt
```
public static String encrypt(String text,
             String password)
                      throws Exception
```
    Encrypt text with password.
    
    Parameters:
    text - the text to be encrypted.
    password - the password used for encryption.
    
    Returns:
    encrypted data as Base64 string.
    
    Throws:
    
    Exception
  - encrypt
```
public static void encrypt(InputStream inputStream,
           OutputStream outputStream,
           String password)
                    throws Exception
```
    Encrypt stream data with password.
    
    Parameters:
    inputStream - the input stream to be encrypted.
    outputStream - the output stream encrypted data written to.
    password - the password used for encryption.
    
    Throws:
    
    Exception
  - encrypt
```
public static String encrypt(String text,
             String recipientId,
             PublicKey publicKey)
                      throws Exception
```
    Encrypt text with public key.
    
    Parameters:
    text - the text to be encrypted.
    recipientId - the recipient ID.
    publicKey - the public key of recipient.
    
    Returns:
    encrypted data as Base64 string.
    
    Throws:
    
    Exception
  - encrypt
```
public static void encrypt(InputStream inputStream,
           OutputStream outputStream,
           String recipientId,
           PublicKey publicKey)
                    throws Exception
```
    Encrypt stream data with password.
    
    Parameters:
    inputStream - the input stream to be encrypted.
    outputStream - the output stream encrypted data written to.
    recipientId - the recipient ID.
    publicKey - the public key of recipient.
    
    Throws:
    
    Exception
  - encrypt
```
public static String encrypt(String text,
             Map<String,PublicKey> recipients)
                      throws Exception
```
    Encrypt text with public key for multiple recipients.
    
    Parameters:
    text - the text to be encrypted.
    recipients - the map of recipients. Key is recipient identifier, value is PublicKey.
    
    Returns:
    encrypted data as Base64 string.
    
    Throws:
    
    Exception
    See Also:
    PublicKey
  - decrypt
```
public static String decrypt(String base64Text,
             String password)
                      throws Exception
```
    Decrypt text with password.
    
    Parameters:
    base64Text - encrypted data as Base64 string.
    password - the password used for decryption.
    
    Returns:
    decrypted text as String.
    
    Throws:
    
    Exception
  - decrypt
```
public static void decrypt(InputStream inputStream,
           OutputStream outputStream,
           String password)
                    throws Exception
```
    Decrypt encrypted data from stream with password.
    
    Parameters:
    inputStream - the input stream to be decrypted.
    outputStream - decrypted data will be written to this stream.
    password - the password used for data decryption.
    
    Throws:
    
    Exception
  - decrypt
```
public static String decrypt(String base64Text,
             String recipientId,
             PrivateKey privateKey)
                      throws Exception
```
    Decrypt text with private key.
    
    Parameters:
    base64Text - encrypted data as Base64 string.
    recipientId - the recipient ID.
    privateKey - the private key of recipient.
    
    Returns:
    decrypted text as String.
    
    Throws:
    
    Exception
  - decrypt
```
public static void decrypt(InputStream inputStream,
           OutputStream outputStream,
           String recipientId,
           PrivateKey privateKey)
                    throws Exception
```
    Decrypt encrypted data from stream with private key.
    
    Parameters:
    inputStream - the input stream to be decrypted.
    outputStream - decrypted data will be written to this stream.
    recipientId - the recipient ID.
    privateKey - the private key of recipient.
    
    Throws:
    
    Exception
  - decrypt
```
public static String decrypt(String base64Text,
             String recipientId,
             PrivateKey privateKey,
             Password password)
                      throws Exception
```
    Decrypt text with private key which protected with password.
    
    Parameters:
    base64Text - encrypted data as Base64 string.
    recipientId - the recipient ID.
    privateKey - the private key of recipient.
    password - the private key's password.
    
    Returns:
    decrypted text as String.
    
    Throws:
    
    Exception
  - decrypt
```
public static void decrypt(InputStream inputStream,
           OutputStream outputStream,
           String recipientId,
           PrivateKey privateKey,
           Password password)
                    throws Exception
```
    Decrypt encrypted data from stream with private key.
    
    Parameters:
    inputStream - the input stream to be decrypted.
    outputStream - decrypted data will be written to this stream.
    recipientId - the recipient ID.
    privateKey - the private key of recipient.
    password - the private key's password.
    
    Throws:
    
    Exception
  - sign
```
public static String sign(String text,
          PrivateKey privateKey)
                   throws Exception
```
    Sign text with private key.
    
    Parameters:
    text - the text to be signed.
    privateKey - the private key.
    
    Returns:
    sign as Base64 string.
    
    Throws:
    
    Exception
  - sign
```
public static String sign(InputStream inputStream,
          PrivateKey privateKey)
                   throws Exception
```
    Sign stream with private key.
    
    Parameters:
    inputStream - the stream to be signed.
    privateKey - the private key.
    
    Returns:
    sign as Base64 string.
    
    Throws:
    
    Exception
  - sign
```
public static String sign(InputStream inputStream,
          PrivateKey privateKey,
          String keyPassword)
                   throws Exception
```
    Sign stream with private key protected with password.
    
    Parameters:
    inputStream - the stream to be signed.
    privateKey - the private key.
    keyPassword - the private key password.
    
    Returns:
    sign as Base64 string.
    
    Throws:
    
    Exception
  - signBase64
```
public static String signBase64(String base64string,
                PrivateKey privateKey)
                         throws Exception
```
    Sign Base64 encoded string with private key.
    
    Parameters:
    base64string - the Base64 encoded string to be signed.
    privateKey - the private key.
    
    Returns:
    sign as Base64 string.
    
    Throws:
    
    Exception
  - sign
```
public static String sign(String text,
          PrivateKey privateKey,
          Password password)
                   throws Exception
```
    Sign text with private key.
    
    Parameters:
    text - the text to be signed.
    privateKey - the private key.
    password - the private key's password.
    
    Returns:
    sign as Base64 string.
    
    Throws:
    
    Exception
  - verify
```
public static boolean verify(String text,
             String signature,
             PublicKey publicKey)
                      throws Exception
```
    Verify text with signature.
    
    Parameters:
    text - the text to be signed.
    signature - the sign as Base64 string.
    publicKey - the public key used for verification.
    
    Returns:
    true if verification success.
    
    Throws:
    
    Exception
  - verify
```
public static boolean verify(InputStream inputStream,
             String signature,
             PublicKey publicKey)
                      throws Exception
```
    Verify stream data with signature.
    
    Parameters:
    inputStream - the stream to be signed.
    signature - the sign as Base64 string.
    publicKey - the public key used for verification.
    
    Returns:
    true if verification success.
    
    Throws:
    
    Exception
  - verifyBase64
```
public static boolean verifyBase64(String base64string,
                   String signature,
                   PublicKey publicKey)
                            throws Exception
```
    Verify Base664 encoded string with signature.
    
    Parameters:
    base64string - the Base64 string to be signed.
    signature - the sign as Base64 string.
    publicKey - the public key used for verification.
    
    Returns:
    true if verification success.
    
    Throws:
    
    Exception

Class CryptoHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CryptoHelper

Method Detail

encrypt

encrypt

encrypt

encrypt

encrypt

decrypt

decrypt

decrypt

decrypt

decrypt

decrypt

sign

sign

sign

signBase64

sign

verify

verify

verifyBase64