Package org.apache.hadoop.security.scram

Class ScramFormatter

java.lang.Object

org.apache.hadoop.security.scram.ScramFormatter

public class ScramFormatter
extends java.lang.Object

Scram message salt and hash functions defined in RFC 5802.

Constructor Summary

Constructors

Constructor	Description
ScramFormatter(ScramMechanism mechanism)

Method Summary

Modifier and Type	Method	Description
java.lang.String	authMessage(java.lang.String clientFirstMessageBare, java.lang.String serverFirstMessage, java.lang.String clientFinalMessageWithoutProof)
byte[]	clientKey(byte[] saltedPassword)
byte[]	clientProof(byte[] saltedPassword, ScramMessages.ClientFirstMessage clientFirstMessage, ScramMessages.ServerFirstMessage serverFirstMessage, ScramMessages.ClientFinalMessage clientFinalMessage)
byte[]	clientSignature(byte[] storedKey, ScramMessages.ClientFirstMessage clientFirstMessage, ScramMessages.ServerFirstMessage serverFirstMessage, ScramMessages.ClientFinalMessage clientFinalMessage)
ScramCredential	generateCredential(java.lang.String password, int iterations)
byte[]	hash(byte[] str)
byte[]	hi(byte[] str, byte[] salt, int iterations)
byte[]	hmac(byte[] key, byte[] bytes)
byte[]	normalize(java.lang.String str)
byte[]	saltedPassword(java.lang.String password, byte[] salt, int iterations)
java.lang.String	saslName(java.lang.String username)
byte[]	secureRandomBytes()
java.lang.String	secureRandomString()
byte[]	serverKey(byte[] saltedPassword)
byte[]	serverSignature(byte[] serverKey, ScramMessages.ClientFirstMessage clientFirstMessage, ScramMessages.ServerFirstMessage serverFirstMessage, ScramMessages.ClientFinalMessage clientFinalMessage)
byte[]	storedKey(byte[] clientKey)
byte[]	storedKey(byte[] clientSignature, byte[] clientProof)
byte[]	toBytes(java.lang.String str)
java.lang.String	username(java.lang.String saslName)
byte[]	xor(byte[] first, byte[] second)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScramFormatter

public ScramFormatter(ScramMechanism mechanism)
               throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException

Method Detail

hmac

public byte[] hmac(byte[] key,
                   byte[] bytes)
            throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

hash

public byte[] hash(byte[] str)

xor

public byte[] xor(byte[] first,
                  byte[] second)

hi

public byte[] hi(byte[] str,
                 byte[] salt,
                 int iterations)
          throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

normalize

public byte[] normalize(java.lang.String str)

saltedPassword

public byte[] saltedPassword(java.lang.String password,
                             byte[] salt,
                             int iterations)
                      throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

clientKey

public byte[] clientKey(byte[] saltedPassword)
                 throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

storedKey

public byte[] storedKey(byte[] clientKey)

saslName

public java.lang.String saslName(java.lang.String username)

username

public java.lang.String username(java.lang.String saslName)

authMessage

public java.lang.String authMessage(java.lang.String clientFirstMessageBare,
                                    java.lang.String serverFirstMessage,
                                    java.lang.String clientFinalMessageWithoutProof)

clientSignature

public byte[] clientSignature(byte[] storedKey,
                              ScramMessages.ClientFirstMessage clientFirstMessage,
                              ScramMessages.ServerFirstMessage serverFirstMessage,
                              ScramMessages.ClientFinalMessage clientFinalMessage)
                       throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

clientProof

public byte[] clientProof(byte[] saltedPassword,
                          ScramMessages.ClientFirstMessage clientFirstMessage,
                          ScramMessages.ServerFirstMessage serverFirstMessage,
                          ScramMessages.ClientFinalMessage clientFinalMessage)
                   throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

storedKey

public byte[] storedKey(byte[] clientSignature,
                        byte[] clientProof)

serverKey

public byte[] serverKey(byte[] saltedPassword)
                 throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

serverSignature

public byte[] serverSignature(byte[] serverKey,
                              ScramMessages.ClientFirstMessage clientFirstMessage,
                              ScramMessages.ServerFirstMessage serverFirstMessage,
                              ScramMessages.ClientFinalMessage clientFinalMessage)
                       throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

secureRandomString

public java.lang.String secureRandomString()

secureRandomBytes

public byte[] secureRandomBytes()

toBytes

public byte[] toBytes(java.lang.String str)

generateCredential

public ScramCredential generateCredential(java.lang.String password,
                                          int iterations)