Module jcifs

Package org.codelibs.jcifs.smb.impl

Class JAASAuthenticator

java.lang.Object

org.codelibs.jcifs.smb.impl.NtlmPasswordAuthenticator

org.codelibs.jcifs.smb.impl.Kerb5Authenticator

org.codelibs.jcifs.smb.impl.JAASAuthenticator

All Implemented Interfaces:

Serializable, Cloneable, Principal, CallbackHandler, Credentials, CredentialsInternal, SmbRenewableCredentials

public class JAASAuthenticator
extends Kerb5Authenticator
implements CallbackHandler, SmbRenewableCredentials

JAAS kerberos authenticator Either configure JAAS for credential caching or reuse a single instance of this authenticator -otherwise you won't get proper ticket caching. Be advised that short/NetBIOS name usage is not supported with this authenticator. Always specify full FQDNs/Realm. This can be a problem if using DFS in it's default configuration as that still returns referrals in short form. See KB-244380 for compatible server configuration. See Configuration.isDfsConvertToFQDN() for a workaround.

Author:

mbechler

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.codelibs.jcifs.smb.impl.NtlmPasswordAuthenticator

NtlmPasswordAuthenticator.AuthenticationType

Constructor Summary

Constructors

Constructor	Description
JAASAuthenticator()	Create an authenticator using the JAAS service org.codelibs.jcifs.smb This will require that a keytab is configured in this service.
JAASAuthenticator(String serviceName)	Create an authenticator using the given JAAS service This will require that a keytab is configured in this service.
JAASAuthenticator(String domain, String username, String password)	Create an authenticator using the given credentials This will create a JAAS configuration that is used to obtain a TGT.
JAASAuthenticator(String serviceName, String domain, String username, String password)	Create an authenticator using the given JAAS service and the specified credentials
JAASAuthenticator(Map<String,?> properties, String domain, String username, String password)	Create an authenticator using the given credentials This will create a JAAS configuration with the specified properties that is used to obtain a TGT.

Method Summary

Modifier and Type	Method	Description
Kerb5Authenticator	clone()	Create a copy of the credentials.
protected static void	cloneInternal(JAASAuthenticator to, JAASAuthenticator from)	Clone the context
Subject	getSubject()	Get the Subject object.
void	handle(Callback[] callbacks)
boolean	isAnonymous()	Check if these are anonymous credentials.
boolean	isGuest()	Check if these are guest credentials.
void	refresh()	Refresh the credentials.
CredentialsInternal	renew()	Renew the credentials

Methods inherited from class org.codelibs.jcifs.smb.impl.Kerb5Authenticator

cloneInternal, createContext, equals, getLifeTime, getRealm, getService, getUser, getUserDomain, getUserLifeTime, hashCode, isPreferredMech, setForceFallback, setLifeTime, setRealm, setService, setSubject, setUser, setUserLifeTime, toString

Methods inherited from class org.codelibs.jcifs.smb.impl.NtlmPasswordAuthenticator

cloneInternal, getAnsiHash, getName, getNTHash, getPassword, getSigningKey, getSpecifiedUserDomain, getUnicodeHash, getUsername, getUserSessionKey, getUserSessionKey, guessAuthenticationType, unwrap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codelibs.jcifs.smb.Credentials

getUserDomain, unwrap

Methods inherited from interface org.codelibs.jcifs.smb.impl.CredentialsInternal

createContext

Methods inherited from interface java.security.Principal

implies

Constructor Details

JAASAuthenticator

public JAASAuthenticator()

Create an authenticator using the JAAS service org.codelibs.jcifs.smb This will require that a keytab is configured in this service.

JAASAuthenticator

public JAASAuthenticator(String serviceName)

Create an authenticator using the given JAAS service This will require that a keytab is configured in this service.

Parameters:

serviceName - JAAS configuration name

JAASAuthenticator

public JAASAuthenticator(String serviceName,
 String domain,
 String username,
 String password)

Create an authenticator using the given JAAS service and the specified credentials

Parameters:

serviceName - JAAS configuration name

domain - the domain for authentication

username - the username for authentication

password - the password for authentication

JAASAuthenticator

public JAASAuthenticator(String domain,
 String username,
 String password)

Create an authenticator using the given credentials This will create a JAAS configuration that is used to obtain a TGT.

Parameters:

domain - the domain for authentication

username - the username for authentication

password - the password for authentication

JAASAuthenticator

public JAASAuthenticator(Map<String,?> properties,
 String domain,
 String username,
 String password)

Create an authenticator using the given credentials This will create a JAAS configuration with the specified properties that is used to obtain a TGT.

Parameters:

properties - JAAS properties to set

domain - the domain for authentication

username - the username for authentication

password - the password for authentication

Method Details

isAnonymous

public boolean isAnonymous()

Check if these are anonymous credentials.

Specified by:

isAnonymous in interface Credentials

Overrides:

isAnonymous in class Kerb5Authenticator

Returns:

whether these are anonymous credentials

See Also:

• Kerb5Authenticator.isAnonymous()

isGuest

public boolean isGuest()

Check if these are guest credentials.

Specified by:

isGuest in interface Credentials

Overrides:

isGuest in class NtlmPasswordAuthenticator

Returns:

whether these are guest credentials

See Also:

• NtlmPasswordAuthenticator.isGuest()

clone

public Kerb5Authenticator clone()

Description copied from interface: CredentialsInternal

Create a copy of the credentials.

Specified by:

clone in interface CredentialsInternal

Overrides:

clone in class Kerb5Authenticator

Returns:

a copy of the credentials

cloneInternal

protected static void cloneInternal(JAASAuthenticator to,
 JAASAuthenticator from)

Clone the context

Parameters:

to - the target authenticator

from - the source authenticator

refresh

public void refresh()
             throws CIFSException

Refresh the credentials.

Specified by:

refresh in interface CredentialsInternal

Overrides:

refresh in class Kerb5Authenticator

Throws:

CIFSException - if refresh fails

See Also:

• Kerb5Authenticator.refresh()

getSubject

public Subject getSubject()

Get the Subject object.

Specified by:

getSubject in interface CredentialsInternal

Overrides:

getSubject in class Kerb5Authenticator

Returns:

Subject represents the user who perform Kerberos authentication. It contains the tickets retrieve from KDC.

See Also:

• Kerb5Authenticator.getSubject()

renew

public CredentialsInternal renew()

Renew the credentials

Specified by:

renew in interface SmbRenewableCredentials

Returns:

the renewed credentials

See Also:

• SmbRenewableCredentials.renew()

handle

public void handle(Callback[] callbacks)
            throws IOException,
UnsupportedCallbackException

Specified by:

handle in interface CallbackHandler

Throws:

IOException

UnsupportedCallbackException

See Also:

• CallbackHandler.handle(javax.security.auth.callback.Callback[])