Crypto (safe-app-android API)

java.lang.Object
- net.maidsafe.api.Crypto

public class Crypto
extends java.lang.Object

Exposes API for the cryptographic functions

Constructor Summary

Constructors
Constructor and Description

Crypto(net.maidsafe.api.AppHandle handle)
Initialises the Crypto object

Constructors
Constructor and Description
`Crypto(net.maidsafe.api.AppHandle handle)` Initialises the Crypto object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.concurrent.CompletableFuture<byte[]>`	`decrypt(NativeHandle senderPublicEncryptKey, NativeHandle recipientSecretEncryptKey, byte[] cipherText)` Decrypts encrypted data using sender's public encryption key and recipient's private encryption key
`java.util.concurrent.CompletableFuture<byte[]>`	`decryptSealedBox(NativeHandle recipientPublicEncryptKey, NativeHandle recipientSecretEncryptKey, byte[] cipherText)` Decrypts content encrypted by sealed box encryption
`java.util.concurrent.CompletableFuture<byte[]>`	`encrypt(NativeHandle recipientPublicEncryptKey, NativeHandle senderSecretEncryptKey, byte[] data)` Encrypts data with the sender's public encryption key and recipient's private encryption key
`java.util.concurrent.CompletableFuture<byte[]>`	`encryptSealedBox(NativeHandle recipientPublicEncryptKey, byte[] data)` Encrypts data using private and public encryption keys with a seal
`java.util.concurrent.CompletableFuture<EncryptKeyPair>`	`generateEncryptKeyPair()` Generate a new encryption key pair
`static java.util.concurrent.CompletableFuture<byte[]>`	`generateNonce()` Generates a unique nonce
`java.util.concurrent.CompletableFuture<SignKeyPair>`	`generateSignKeyPair()` Generate a new signing key pair
`java.util.concurrent.CompletableFuture<NativeHandle>`	`getAppPublicEncryptKey()` Get the public encryption key for the App
`java.util.concurrent.CompletableFuture<NativeHandle>`	`getAppPublicSignKey()` Get App's public sign key
`java.util.concurrent.CompletableFuture<NativeHandle>`	`getPublicEncryptKey(byte[] key)` Create a new public encryption key from byte array
`java.util.concurrent.CompletableFuture<NativeHandle>`	`getPublicSignKey(byte[] key)` Create a new public sign key from byte array
`java.util.concurrent.CompletableFuture<byte[]>`	`getRawPublicEncryptKey(NativeHandle publicEncKey)` Retrieves the public encryption key as byte array
`java.util.concurrent.CompletableFuture<byte[]>`	`getRawPublicSignKey(NativeHandle publicSignKey)` Retrieves public sign key as byte array
`java.util.concurrent.CompletableFuture<byte[]>`	`getRawSecretEncryptKey(NativeHandle secretEncKey)` Retrieves secret encryption key as byte array
`java.util.concurrent.CompletableFuture<byte[]>`	`getRawSecretSignKey(NativeHandle secretSignKey)` Retrieves secret sign key as byte array
`java.util.concurrent.CompletableFuture<NativeHandle>`	`getSecretEncryptKey(byte[] key)` Create a new secret encryption key from a raw array
`java.util.concurrent.CompletableFuture<NativeHandle>`	`getSecretSignKey(byte[] key)` Create a new secret signing key from byte array
`static java.util.concurrent.CompletableFuture<byte[]>`	`sha3Hash(byte[] data)` Generates a SHA3 hash of the given data
`java.util.concurrent.CompletableFuture<byte[]>`	`sign(NativeHandle secretSignKey, byte[] data)` Sign data using a secret sign key
`java.util.concurrent.CompletableFuture<byte[]>`	`verify(NativeHandle publicSignKey, byte[] signedData)` Verifies signed data using the public sign key

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

- Constructor Detail
  - Crypto
```
public Crypto(net.maidsafe.api.AppHandle handle)
```
    Initialises the Crypto object
    
    Parameters:
    
    handle - App handle
- Method Detail
  - generateNonce
```
public static java.util.concurrent.CompletableFuture<byte[]> generateNonce()
```
    Generates a unique nonce
    
    Returns:
    
    Unique nonce as byte array
  - sha3Hash
```
public static java.util.concurrent.CompletableFuture<byte[]> sha3Hash(byte[] data)
```
    Generates a SHA3 hash of the given data
    
    Parameters:
    
    data - Data to be hashed
    
    Returns:
    
    Hash of the data as byte array
  - getAppPublicSignKey
```
public java.util.concurrent.CompletableFuture<NativeHandle> getAppPublicSignKey()
```
    Get App's public sign key
    
    Returns:
    
    App's public sign key as NativeHandle
  - generateSignKeyPair
```
public java.util.concurrent.CompletableFuture<SignKeyPair> generateSignKeyPair()
```
    Generate a new signing key pair
    
    Returns:
    
    New SignKeyPair instance
  - getPublicSignKey
```
public java.util.concurrent.CompletableFuture<NativeHandle> getPublicSignKey(byte[] key)
```
    Create a new public sign key from byte array
    
    Parameters:
    
    key - Byte array
    
    Returns:
    
    New public sign key NativeHandle instance
  - getSecretSignKey
```
public java.util.concurrent.CompletableFuture<NativeHandle> getSecretSignKey(byte[] key)
```
    Create a new secret signing key from byte array
    
    Parameters:
    
    key - Byte array
    
    Returns:
    
    Secret sign key as NativeHandle
  - generateEncryptKeyPair
```
public java.util.concurrent.CompletableFuture<EncryptKeyPair> generateEncryptKeyPair()
```
    Generate a new encryption key pair
    
    Returns:
    
    New EncryptKeyPair instance
  - getAppPublicEncryptKey
```
public java.util.concurrent.CompletableFuture<NativeHandle> getAppPublicEncryptKey()
```
    Get the public encryption key for the App
    
    Returns:
    
    App's public encryption key as NativeHandle
  - getPublicEncryptKey
```
public java.util.concurrent.CompletableFuture<NativeHandle> getPublicEncryptKey(byte[] key)
```
    Create a new public encryption key from byte array
    
    Parameters:
    
    key - Raw byte array
    
    Returns:
    
    New Public encryption key NativeHandle instance
  - getSecretEncryptKey
```
public java.util.concurrent.CompletableFuture<NativeHandle> getSecretEncryptKey(byte[] key)
```
    Create a new secret encryption key from a raw array
    
    Parameters:
    
    key - Raw byte array
    
    Returns:
    
    New Secret encryption key NativeHandle instance
  - sign
```
public java.util.concurrent.CompletableFuture<byte[]> sign(NativeHandle secretSignKey,
                                                           byte[] data)
```
    Sign data using a secret sign key
    
    Parameters:
    
    secretSignKey - Secret sign key
    
    data - Data to be signed
    
    Returns:
    
    Signed data as byte array
  - verify
```
public java.util.concurrent.CompletableFuture<byte[]> verify(NativeHandle publicSignKey,
                                                             byte[] signedData)
```
    Verifies signed data using the public sign key
    
    Parameters:
    
    publicSignKey - Public sign key
    
    signedData - Signed data
    
    Returns:
    
    Verified data
  - encrypt
```
public java.util.concurrent.CompletableFuture<byte[]> encrypt(NativeHandle recipientPublicEncryptKey,
                                                              NativeHandle senderSecretEncryptKey,
                                                              byte[] data)
```
    Encrypts data with the sender's public encryption key and recipient's private encryption key
    
    Parameters:
    
    recipientPublicEncryptKey - Recipient's private encryption key
    
    senderSecretEncryptKey - Sender's public encryption key
    
    data - Data to be encrypted
    
    Returns:
    
    Encrypted data as byte array
  - decrypt
```
public java.util.concurrent.CompletableFuture<byte[]> decrypt(NativeHandle senderPublicEncryptKey,
                                                              NativeHandle recipientSecretEncryptKey,
                                                              byte[] cipherText)
```
    Decrypts encrypted data using sender's public encryption key and recipient's private encryption key
    
    Parameters:
    
    senderPublicEncryptKey - Sender's public encryption key
    
    recipientSecretEncryptKey - Recipient's private encryption key
    
    cipherText - Encrypted data
    
    Returns:
    
    Decrypted data as byte array
  - encryptSealedBox
```
public java.util.concurrent.CompletableFuture<byte[]> encryptSealedBox(NativeHandle recipientPublicEncryptKey,
                                                                       byte[] data)
```
    Encrypts data using private and public encryption keys with a seal
    
    Parameters:
    
    recipientPublicEncryptKey - Recipient's public encryption key
    
    data - Data to be encrypted
    
    Returns:
    
    Encrypted data as byte array
  - decryptSealedBox
```
public java.util.concurrent.CompletableFuture<byte[]> decryptSealedBox(NativeHandle recipientPublicEncryptKey,
                                                                       NativeHandle recipientSecretEncryptKey,
                                                                       byte[] cipherText)
```
    Decrypts content encrypted by sealed box encryption
    
    Parameters:
    
    recipientPublicEncryptKey - Recipient's public encryption key
    
    recipientSecretEncryptKey - Recipient's secret encryption key
    
    cipherText - Cipher to be decrypted
    
    Returns:
    
    Decrypted data as byte array
  - getRawPublicEncryptKey
```
public java.util.concurrent.CompletableFuture<byte[]> getRawPublicEncryptKey(NativeHandle publicEncKey)
```
    Retrieves the public encryption key as byte array
    
    Parameters:
    
    publicEncKey - Public encryption key as NativeHandle
    
    Returns:
    
    Raw public encryption key as byte array
  - getRawSecretEncryptKey
```
public java.util.concurrent.CompletableFuture<byte[]> getRawSecretEncryptKey(NativeHandle secretEncKey)
```
    Retrieves secret encryption key as byte array
    
    Parameters:
    
    secretEncKey - Secret encryption key as NativeHandle
    
    Returns:
    
    Raw secret encryption key as byte array
  - getRawPublicSignKey
```
public java.util.concurrent.CompletableFuture<byte[]> getRawPublicSignKey(NativeHandle publicSignKey)
```
    Retrieves public sign key as byte array
    
    Parameters:
    
    publicSignKey - Public sign key as NativeHandle
    
    Returns:
    
    Raw public sign key as byte array
  - getRawSecretSignKey
```
public java.util.concurrent.CompletableFuture<byte[]> getRawSecretSignKey(NativeHandle secretSignKey)
```
    Retrieves secret sign key as byte array
    
    Parameters:
    
    secretSignKey - Secret sign key as NativeHandle
    
    Returns:
    
    Raw secret sign key as byte array

Class Crypto

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Crypto

Method Detail

generateNonce

sha3Hash

getAppPublicSignKey

generateSignKeyPair

getPublicSignKey

getSecretSignKey

generateEncryptKeyPair

getAppPublicEncryptKey

getPublicEncryptKey

getSecretEncryptKey

sign

verify

encrypt

decrypt

encryptSealedBox

decryptSealedBox

getRawPublicEncryptKey

getRawSecretEncryptKey

getRawPublicSignKey

getRawSecretSignKey