IKey (Microsoft Azure SDK for Key Vault 0.8.0 API)

All Superinterfaces:

AutoCloseable, Closeable
```
public interface IKey
extends Closeable
```
Interface for representing cryptographic keys with the Microsoft Azure Key Vault libraries.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<byte[]>`	`decryptAsync(byte[] ciphertext, byte[] iv, byte[] authenticationData, byte[] authenticationTag, String algorithm)` Decrypts the specified cipher text.
`Future<org.apache.commons.lang3.tuple.Triple<byte[],byte[],String>>`	`encryptAsync(byte[] plaintext, byte[] iv, byte[] authenticationData, String algorithm)` Encrypts the specified plain text.
`String`	`getDefaultEncryptionAlgorithm()` The default encryption algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513
`String`	`getDefaultKeyWrapAlgorithm()` The default key wrap algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513
`String`	`getDefaultSignatureAlgorithm()` The default signature algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513
`String`	`getKid()` The unique key identifier for this key.
`Future<org.apache.commons.lang3.tuple.Pair<byte[],String>>`	`signAsync(byte[] digest, String algorithm)` Signs the specified digest using the specified algorithm, or the keys DefaultSignatureAlgorithm if no algorithm is specified.
`Future<byte[]>`	`unwrapKeyAsync(byte[] encryptedKey, String algorithm)` Unwraps (decrypts) the specified encryped key material.
`Future<Boolean>`	`verifyAsync(byte[] digest, byte[] signature, String algorithm)` Verifies the supplied signature value using the supplied digest and algorithm.
`Future<org.apache.commons.lang3.tuple.Pair<byte[],String>>`	`wrapKeyAsync(byte[] key, String algorithm)` Wraps (encrypts) the specified symmetric key material using the specified algorithm, or the keys DefaultKeyWrapAlgorithm if none is specified.

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - getDefaultEncryptionAlgorithm
```
String getDefaultEncryptionAlgorithm()
```
    The default encryption algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513
    
    Returns:
    
    The default encryption algorithm for this key.
  - getDefaultKeyWrapAlgorithm
```
String getDefaultKeyWrapAlgorithm()
```
    The default key wrap algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513
    
    Returns:
    
    The default key wrap algorithm for this key.
  - getDefaultSignatureAlgorithm
```
String getDefaultSignatureAlgorithm()
```
    The default signature algorithm for this key, using the representations from Json Web Key Algorithms, RFC7513
    
    Returns:
    
    The default signature algorithm for this key.
  - getKid
```
String getKid()
```
    The unique key identifier for this key.
    
    Returns:
    
    The key identifier
  - decryptAsync
```
Future<byte[]> decryptAsync(byte[] ciphertext,
                            byte[] iv,
                            byte[] authenticationData,
                            byte[] authenticationTag,
                            String algorithm)
                     throws NoSuchAlgorithmException
```
    Decrypts the specified cipher text. Note that not all algorithms require, or support, all parameters.
    
    Parameters:
    
    ciphertext - The cipher text to decrypt
    
    iv - The initialization vector (optional with some algorithms)
    
    authenticationData - Additional authentication data (optional with some algorithms)
    
    authenticationTag - The authentication tag from the encrypt operation (optional with some algorithms)
    
    algorithm - The encryption algorithm to use, must be supplied
    
    Returns:
    
    A containing the plain text
    
    Throws:
    
    NoSuchAlgorithmException
  - encryptAsync
```
Future<org.apache.commons.lang3.tuple.Triple<byte[],byte[],String>> encryptAsync(byte[] plaintext,
                                                                                 byte[] iv,
                                                                                 byte[] authenticationData,
                                                                                 String algorithm)
                                                                          throws NoSuchAlgorithmException
```
    Encrypts the specified plain text. Note that not all algorithms require, or support, all parameters.
    
    Parameters:
    
    plaintext - The plain text to encrypt
    
    iv - The initialization vector (optional with some algorithms)
    
    authenticationData - Additional authentication data (optional with some algorithms)
    
    algorithm - The encryption algorithm to use, defaults to the keys DefaultEncryptionAlgorithm
    
    Returns:
    
    A containing the cipher text, the authentication tag and the algorithm that was used
    
    Throws:
    
    NoSuchAlgorithmException
  - wrapKeyAsync
```
Future<org.apache.commons.lang3.tuple.Pair<byte[],String>> wrapKeyAsync(byte[] key,
                                                                        String algorithm)
                                                                 throws NoSuchAlgorithmException
```
    Wraps (encrypts) the specified symmetric key material using the specified algorithm, or the keys DefaultKeyWrapAlgorithm if none is specified.
    
    Parameters:
    
    key - The symmetric key to wrap
    
    algorithm - The wrapping algorithm to use, defaults to the keys DefaultKeyWrapAlgorithm
    
    Returns:
    
    A containing the encrypted key and the algorithm that was used
    
    Throws:
    
    NoSuchAlgorithmException
  - unwrapKeyAsync
```
Future<byte[]> unwrapKeyAsync(byte[] encryptedKey,
                              String algorithm)
                       throws NoSuchAlgorithmException
```
    Unwraps (decrypts) the specified encryped key material.
    
    Parameters:
    
    encryptedKey - The encrypted key to decrypt
    
    algorithm - The algorithm to use, must be supplied
    
    Returns:
    
    A containing the unwrapped key
    
    Throws:
    
    NoSuchAlgorithmException
  - signAsync
```
Future<org.apache.commons.lang3.tuple.Pair<byte[],String>> signAsync(byte[] digest,
                                                                     String algorithm)
```
    Signs the specified digest using the specified algorithm, or the keys DefaultSignatureAlgorithm if no algorithm is specified.
    
    Parameters:
    
    digest - The digest to sign
    
    algorithm - The signature algorithm to use
    
    Returns:
    
    A containing the signature and the algorithm used.
  - verifyAsync
```
Future<Boolean> verifyAsync(byte[] digest,
                            byte[] signature,
                            String algorithm)
```
    Verifies the supplied signature value using the supplied digest and algorithm.
    
    Parameters:
    
    digest - The digest input
    
    signature - The signature to verify
    
    algorithm - The algorithm to use, must be provided
    
    Returns:
    
    A containing a boolean result

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Interface IKey

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

getDefaultEncryptionAlgorithm

getDefaultKeyWrapAlgorithm

getDefaultSignatureAlgorithm

getKid

decryptAsync

encryptAsync

wrapKeyAsync

unwrapKeyAsync

signAsync

verifyAsync