org.apache.tez.runtime.library.common.security

Class SecureShuffleUtils

java.lang.Object

org.apache.tez.runtime.library.common.security.SecureShuffleUtils

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class SecureShuffleUtils
extends Object

utilities for generating kyes, hashes and verifying them for shuffle

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_HEADER_REPLY_URL_HASH
static String	HTTP_HEADER_URL_HASH

Constructor Summary

Constructors

Constructor and Description
SecureShuffleUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildMsgFrom(URL url) Shuffle specific utils - build string for encoding from URL
static String	generateHash(byte[] msg, SecretKey key) Base64 encoded hash of msg
static String	hashFromString(String enc_str, org.apache.tez.common.security.JobTokenSecretManager mgr) Aux util to calculate hash of a String
static void	verifyReply(String base64Hash, String msg, org.apache.tez.common.security.JobTokenSecretManager mgr) verify that base64Hash is same as HMacHash(msg)
static void	verifyReply(String base64Hash, String msg, SecretKey key) Verify that the base64 encoded hash matches the hash generated by making use of the provided key on the specified message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_HEADER_URL_HASH

public static final String HTTP_HEADER_URL_HASH

See Also:

Constant Field Values

HTTP_HEADER_REPLY_URL_HASH

public static final String HTTP_HEADER_REPLY_URL_HASH

See Also:

Constant Field Values

Constructor Detail

SecureShuffleUtils

public SecureShuffleUtils()

Method Detail

generateHash

public static String generateHash(byte[] msg,
                  SecretKey key)

Base64 encoded hash of msg

Parameters:

msg -

hashFromString

public static String hashFromString(String enc_str,
                    org.apache.tez.common.security.JobTokenSecretManager mgr)
                             throws IOException

Aux util to calculate hash of a String

Parameters:

enc_str -

mgr - JobTokenSecretManager

Returns:

Base64 encodedHash

Throws:

IOException

verifyReply

public static void verifyReply(String base64Hash,
               String msg,
               SecretKey key)
                        throws IOException

Verify that the base64 encoded hash matches the hash generated by making use of the provided key on the specified message.

* This is only meant to be used when a process needs to verify against multiple different keys (ShuffleHandler for instance)

Parameters:

base64Hash - base64 encoded hash

msg - the message

key - the key to use to generate the hash from the message

Throws:

IOException

verifyReply

public static void verifyReply(String base64Hash,
               String msg,
               org.apache.tez.common.security.JobTokenSecretManager mgr)
                        throws IOException

verify that base64Hash is same as HMacHash(msg)

Parameters:

base64Hash - (Base64 encoded hash)

msg -

Throws:

IOException - if not the same

buildMsgFrom

public static String buildMsgFrom(URL url)

Shuffle specific utils - build string for encoding from URL

Parameters:

url -

Returns:

string for encoding