DigestMD5Server

java.lang.Object
- org.jboss.sasl.digest.AbstractSaslImpl
- - org.jboss.sasl.digest.DigestMD5Base
  - - org.jboss.sasl.digest.DigestMD5Server

All Implemented Interfaces:

javax.security.sasl.SaslServer
```
public final class DigestMD5Server
extends DigestMD5Base
implements javax.security.sasl.SaslServer
```
An implementation of the DIGEST-MD5 server SASL mechanism. (RFC 2831)
The DIGEST-MD5 SASL mechanism specifies two modes of authentication.
- Initial Authentication
- Subsequent Authentication - optional, (currently not supported)
Required callbacks: - RealmCallback used as key by handler to fetch password - NameCallback used as key by handler to fetch password - PasswordCallback handler must enter password for username/realm supplied - AuthorizeCallback handler must verify that authid/authzids are allowed and set authorized ID to be the canonicalized authzid (if applicable). Environment properties that affect the implementation: javax.security.sasl.qop: specifies list of qops; default is "auth"; typically, caller should set this to "auth, auth-int, auth-conf". javax.security.sasl.strength specifies low/medium/high strength of encryption; default is all available ciphers [high,medium,low]; high means des3 or rc4 (128); medium des or rc4-56; low is rc4-40. javax.security.sasl.maxbuf specifies max receive buf size; default is 65536 javax.security.sasl.sendmaxbuffer specifies max send buf size; default is 65536 (min of this and client's max recv size) com.sun.security.sasl.digest.utf8: "true" means to use UTF-8 charset; "false" to use ISO-8859-1 encoding; default is "true". com.sun.security.sasl.digest.realm: space-separated list of realms; default is server name (fqdn parameter)

Nested Class Summary
- Nested classes/interfaces inherited from class org.jboss.sasl.digest.DigestMD5Base
  DigestMD5Base.DigestIntegrity, DigestMD5Base.DigestPrivacy

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`ALGORITHM_DIRECTIVE`
`private static java.lang.String`	`ALTERNATIVE_PROTOCOLS_PROPERTY`
`private static int`	`AUTHZID`
`private static int`	`CHARSET`
`private static int`	`CIPHER`
`private static int`	`CNONCE`
`private static int`	`DIGEST_URI`
`private java.util.List<java.lang.String>`	`digestUris`
`private static java.lang.String[]`	`DIRECTIVE_KEY`
`private static org.jboss.logging.Logger`	`log`
`private static int`	`MAXBUF`
`private static java.lang.String`	`MY_CLASS_NAME`
`private byte[]`	`myCiphers`
`private static int`	`NONCE`
`private static int`	`NONCE_COUNT`
`private static int`	`NONCE_COUNT_VALUE`
`private boolean`	`preDigestedPasswords` Should the impl request and use pre-digested passwords instead of generating the {username : realm : password} hash?
`private static int`	`QOP`
`private static int`	`REALM`
`private static java.lang.String`	`REALM_PROPERTY`
`private static int`	`RESPONSE`
`private java.util.List<java.lang.String>`	`serverRealms`
`private java.lang.String`	`specifiedQops`
`private static int`	`USERNAME`
`private static java.lang.String`	`UTF8_DIRECTIVE`
`private static java.lang.String`	`UTF8_PROPERTY`

Fields inherited from class org.jboss.sasl.digest.DigestMD5Base
authzid, cbh, CIPHER_MASKS, CIPHER_TOKENS, DEFAULT_MAXBUF, DES, DES_3_STRENGTH, DES_STRENGTH, DES3, EMPTY_BYTE_ARRAY, encoding, H_A1, MAX_CHALLENGE_LENGTH, MAX_RESPONSE_LENGTH, negotiatedCipher, negotiatedQop, negotiatedRealm, negotiatedStrength, nonce, PRE_DIGESTED_PROPERTY, RC4, RC4_40, RC4_40_STRENGTH, RC4_56, RC4_56_STRENGTH, RC4_STRENGTH, secCtx, step, UNSET, useUTF8

Fields inherited from class org.jboss.sasl.digest.AbstractSaslImpl
allQop, completed, HIGH_STRENGTH, integrity, INTEGRITY_ONLY_PROTECTION, LOW_STRENGTH, MAX_SEND_BUF, MEDIUM_STRENGTH, myClassName, NO_PROTECTION, privacy, PRIVACY_PROTECTION, qop, rawSendSize, recvMaxBufSize, sendMaxBufSize, strength

Constructor Summary

Constructors
Constructor and Description
`DigestMD5Server(java.lang.String protocol, java.lang.String serverName, java.util.Map<java.lang.String,?> props, javax.security.auth.callback.CallbackHandler cbh)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`evaluateResponse(byte[] response)`
`private byte[]`	`generateChallenge(byte[] responseValue)`
`private byte[]`	`generateChallenge(java.util.List<java.lang.String> realms, java.lang.String qopStr, java.lang.String cipherStr)` Generates challenge to be sent to client.
`private byte[]`	`generateResponseAuth(java.lang.String digestUri, byte[] urpHash, byte[] cnonce, int nonceCount, byte[] authzidBytes)` Server sends a message formatted as follows: response-auth = "rspauth" "=" response-value where response-value is calculated as above, using the values sent in step two, except that if qop is "auth", then A2 is A2 = { ":", digest-uri-value } And if qop is "auth-int" or "auth-conf" then A2 is A2 = { ":", digest-uri-value, ":00000000000000000000000000000000" }
`private byte[]`	`generateResponseAuth(java.lang.String digestUri, java.lang.String username, char[] passwd, byte[] cnonce, int nonceCount, byte[] authzidBytes)` Server sends a message formatted as follows: response-auth = "rspauth" "=" response-value where response-value is calculated as above, using the values sent in step two, except that if qop is "auth", then A2 is A2 = { ":", digest-uri-value } And if qop is "auth-int" or "auth-conf" then A2 is A2 = { ":", digest-uri-value, ":00000000000000000000000000000000" }
`java.lang.String`	`getAuthorizationID()`
`private byte[]`	`validateClientResponse(byte[][] responseVal)` Validates client's response.

Methods inherited from class org.jboss.sasl.digest.DigestMD5Base
binaryToHex, dispose, generateNonce, generateResponseValue, generateResponseValue, getMechanismName, getNegotiatedProperty, getPlatformCiphers, nonceCountToHex, parseDirectives, quotedStringValue, unwrap, wrap, writeQuotedStringValue

Methods inherited from class org.jboss.sasl.digest.AbstractSaslImpl
combineMasks, findPreferredMask, intToNetworkByteOrder, isComplete, networkByteOrderToInt, parseQop

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

Methods inherited from interface javax.security.sasl.SaslServer
dispose, getMechanismName, getNegotiatedProperty, isComplete, unwrap, wrap

- Field Detail
  - MY_CLASS_NAME
```
private static final java.lang.String MY_CLASS_NAME
```
  - UTF8_DIRECTIVE
```
private static final java.lang.String UTF8_DIRECTIVE
```
    See Also:
    
    Constant Field Values
  - ALGORITHM_DIRECTIVE
```
private static final java.lang.String ALGORITHM_DIRECTIVE
```
    See Also:
    
    Constant Field Values
  - log
```
private static final org.jboss.logging.Logger log
```
  - NONCE_COUNT_VALUE
```
private static final int NONCE_COUNT_VALUE
```
    See Also:
    
    Constant Field Values
  - UTF8_PROPERTY
```
private static final java.lang.String UTF8_PROPERTY
```
    See Also:
    
    Constant Field Values
  - REALM_PROPERTY
```
private static final java.lang.String REALM_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ALTERNATIVE_PROTOCOLS_PROPERTY
```
private static final java.lang.String ALTERNATIVE_PROTOCOLS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DIRECTIVE_KEY
```
private static final java.lang.String[] DIRECTIVE_KEY
```
  - USERNAME
```
private static final int USERNAME
```
    See Also:
    
    Constant Field Values
  - REALM
```
private static final int REALM
```
    See Also:
    
    Constant Field Values
  - NONCE
```
private static final int NONCE
```
    See Also:
    
    Constant Field Values
  - CNONCE
```
private static final int CNONCE
```
    See Also:
    
    Constant Field Values
  - NONCE_COUNT
```
private static final int NONCE_COUNT
```
    See Also:
    
    Constant Field Values
  - QOP
```
private static final int QOP
```
    See Also:
    
    Constant Field Values
  - DIGEST_URI
```
private static final int DIGEST_URI
```
    See Also:
    
    Constant Field Values
  - RESPONSE
```
private static final int RESPONSE
```
    See Also:
    
    Constant Field Values
  - MAXBUF
```
private static final int MAXBUF
```
    See Also:
    
    Constant Field Values
  - CHARSET
```
private static final int CHARSET
```
    See Also:
    
    Constant Field Values
  - CIPHER
```
private static final int CIPHER
```
    See Also:
    
    Constant Field Values
  - AUTHZID
```
private static final int AUTHZID
```
    See Also:
    
    Constant Field Values
  - specifiedQops
```
private java.lang.String specifiedQops
```
  - myCiphers
```
private byte[] myCiphers
```
  - serverRealms
```
private final java.util.List<java.lang.String> serverRealms
```
  - preDigestedPasswords
```
private boolean preDigestedPasswords
```
    Should the impl request and use pre-digested passwords instead of generating the {username : realm : password} hash?
  - digestUris
```
private final java.util.List<java.lang.String> digestUris
```
- Constructor Detail
  - DigestMD5Server
```
DigestMD5Server(java.lang.String protocol,
                java.lang.String serverName,
                java.util.Map<java.lang.String,?> props,
                javax.security.auth.callback.CallbackHandler cbh)
         throws javax.security.sasl.SaslException
```
    Throws:
    
    javax.security.sasl.SaslException
- Method Detail
  - evaluateResponse
```
public byte[] evaluateResponse(byte[] response)
                        throws javax.security.sasl.SaslException
```
    Specified by:
    
    evaluateResponse in interface javax.security.sasl.SaslServer
    
    Throws:
    
    javax.security.sasl.SaslException
  - generateChallenge
```
private byte[] generateChallenge(java.util.List<java.lang.String> realms,
                                 java.lang.String qopStr,
                                 java.lang.String cipherStr)
                          throws java.io.IOException
```
    Generates challenge to be sent to client. digest-challenge = 1#( realm | nonce | qop-options | stale | maxbuf | charset algorithm | cipher-opts | auth-param ) realm = "realm" "=" <"> realm-value <"> realm-value = qdstr-val nonce = "nonce" "=" <"> nonce-value <"> nonce-value = qdstr-val qop-options = "qop" "=" <"> qop-list <"> qop-list = 1#qop-value qop-value = "auth" | "auth-int" | "auth-conf" | token stale = "stale" "=" "true" maxbuf = "maxbuf" "=" maxbuf-value maxbuf-value = 1*DIGIT charset = "charset" "=" "utf-8" algorithm = "algorithm" "=" "md5-sess" cipher-opts = "cipher" "=" <"> 1#cipher-value <"> cipher-value = "3des" | "des" | "rc4-40" | "rc4" | "rc4-56" | token auth-param = token "=" ( token | quoted-string )
    
    Throws:
    
    java.io.IOException
  - validateClientResponse
```
private byte[] validateClientResponse(byte[][] responseVal)
                               throws javax.security.sasl.SaslException,
                                      java.io.UnsupportedEncodingException
```
    Validates client's response. digest-response = 1#( username | realm | nonce | cnonce | nonce-count | qop | digest-uri | response | maxbuf | charset | cipher | authzid | auth-param ) username = "username" "=" <"> username-value <"> username-value = qdstr-val cnonce = "cnonce" "=" <"> cnonce-value <"> cnonce-value = qdstr-val nonce-count = "nc" "=" nc-value nc-value = 8LHEX qop = "qop" "=" qop-value digest-uri = "digest-uri" "=" <"> digest-uri-value <"> digest-uri-value = serv-type "/" host [ "/" serv-name ] serv-type = 1*ALPHA host = 1*( ALPHA | DIGIT | "-" | "." ) serv-name = host response = "response" "=" response-value response-value = 32LHEX LHEX = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" cipher = "cipher" "=" cipher-value authzid = "authzid" "=" <"> authzid-value <"> authzid-value = qdstr-val sets: negotiatedQop negotiatedCipher negotiatedRealm negotiatedStrength digestUri (checked and set to clients to account for case diffs) sendMaxBufSize authzid (gotten from callback)
    
    Returns:
    
    response-value ('rspauth') for client to validate
    
    Throws:
    
    javax.security.sasl.SaslException
    
    java.io.UnsupportedEncodingException
  - generateResponseAuth
```
private byte[] generateResponseAuth(java.lang.String digestUri,
                                    java.lang.String username,
                                    char[] passwd,
                                    byte[] cnonce,
                                    int nonceCount,
                                    byte[] authzidBytes)
                             throws javax.security.sasl.SaslException
```
    Server sends a message formatted as follows: response-auth = "rspauth" "=" response-value where response-value is calculated as above, using the values sent in step two, except that if qop is "auth", then A2 is A2 = { ":", digest-uri-value } And if qop is "auth-int" or "auth-conf" then A2 is A2 = { ":", digest-uri-value, ":00000000000000000000000000000000" }
    
    Throws:
    
    javax.security.sasl.SaslException
  - generateResponseAuth
```
private byte[] generateResponseAuth(java.lang.String digestUri,
                                    byte[] urpHash,
                                    byte[] cnonce,
                                    int nonceCount,
                                    byte[] authzidBytes)
                             throws javax.security.sasl.SaslException
```
    Server sends a message formatted as follows: response-auth = "rspauth" "=" response-value where response-value is calculated as above, using the values sent in step two, except that if qop is "auth", then A2 is A2 = { ":", digest-uri-value } And if qop is "auth-int" or "auth-conf" then A2 is A2 = { ":", digest-uri-value, ":00000000000000000000000000000000" }
    
    Throws:
    
    javax.security.sasl.SaslException
  - generateChallenge
```
private byte[] generateChallenge(byte[] responseValue)
                          throws java.io.UnsupportedEncodingException
```
    Throws:
    
    java.io.UnsupportedEncodingException
  - getAuthorizationID
```
public java.lang.String getAuthorizationID()
```
    Specified by:
    
    getAuthorizationID in interface javax.security.sasl.SaslServer

Class DigestMD5Server

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.sasl.digest.DigestMD5Base

Field Summary

Fields inherited from class org.jboss.sasl.digest.DigestMD5Base

Fields inherited from class org.jboss.sasl.digest.AbstractSaslImpl

Constructor Summary

Method Summary

Methods inherited from class org.jboss.sasl.digest.DigestMD5Base

Methods inherited from class org.jboss.sasl.digest.AbstractSaslImpl

Methods inherited from class java.lang.Object

Methods inherited from interface javax.security.sasl.SaslServer

Field Detail

MY_CLASS_NAME

UTF8_DIRECTIVE

ALGORITHM_DIRECTIVE

log

NONCE_COUNT_VALUE

UTF8_PROPERTY

REALM_PROPERTY

ALTERNATIVE_PROTOCOLS_PROPERTY

DIRECTIVE_KEY

USERNAME

REALM

NONCE

CNONCE

NONCE_COUNT

QOP

DIGEST_URI

RESPONSE

MAXBUF

CHARSET

CIPHER

AUTHZID

specifiedQops

myCiphers

serverRealms

preDigestedPasswords

digestUris

Constructor Detail

DigestMD5Server

Method Detail

evaluateResponse

generateChallenge

validateClientResponse

generateResponseAuth

generateResponseAuth

generateChallenge

getAuthorizationID