Java Doc for UsernamePasswordAuthScheme.java in » Authentication-Authorization » josso-1.7 » org » josso » auth » scheme » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Authentication Authorization » josso 1.7 » org.josso.auth.scheme

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.josso.auth.scheme .AbstractAuthenticationScheme

org.josso.auth.scheme .UsernamePasswordAuthScheme

All known Subclasses:   org.josso.auth.scheme .BindUsernamePasswordAuthScheme,
UsernamePasswordAuthScheme
public class UsernamePasswordAuthScheme extends AbstractAuthenticationScheme (Code)
Basic authentication scheme, supporting username and password credentials.
Configuration properties supported by this authenticator are :

hashAlgorithm: The message digest algorithm to be used when hashing passwords. If not specified, no hashing is used. This must be an algorithm supported by the java.security.MessageDigest class on your platform. For J2SE 1.4.2 you can check : Java Cryptography Architecture API Specification & Reference - Apendix B : Algorithms

hashEncoding: The econding used to store hashed passwords. Supported values are HEX, BASE64.

ignorePasswordCase: If true, password case will be igonred. This property is ignored if a hashAlgorithm was specified. Default to false.

ignoreUserCase: If ture, username case will be ignored.

credential-store: The credential store configured for this authenticator. Check specific stores for specific configuraiton options

credential-store-key-adapter: The credential store key adapter configured for this authenticator. Check specific stores for specific configuraiton options

Sample authenticator configuration for basic authentication (username/password) :

<authentication-scheme>
<class>org.josso.auth.scheme.UsernamePasswordAuthScheme</class> <hashAlgorithm>MD5</hashAlgorithm> <hashEncoding>HEX</hashEncoding> <ignorePasswordCase>false</ignorePasswordCase> <ignoreUserCase>false</ignoreUserCase>
 <credential-store> ... </credential-store>
<credential-store-key-adapter> ... </credential-store-key-adapter>
</authentication-scheme>

author:
   Sebastian Gonzalez Oyuela
version:
   $Id: UsernamePasswordAuthScheme.java 508 2008-02-18 13:32:29Z sgonzalez $
See Also:   org.josso.auth.CredentialStore
See Also:   org.josso.gateway.identity.service.store.AbstractStore
See Also:   UsernamePasswordCredentialProvider

Method Summary
public boolean authenticate()
     Authenticates the user using recieved credentials to proof his identity.
public Object clone()

protected String createPasswordHash(String password)
     This method allows password hashing.
protected CredentialProvider doMakeCredentialProvider()

protected String encodeBase16(byte[] bytes)
     Base16 encoding (HEX).
protected String encodeBase64(byte[] bytes)
     Base64 encoding.
protected MessageDigest getDigest()
     Only invoke this if algorithm is set.
public String getHashAlgorithm()

public String getHashCharset()

public String getHashEncoding()
     Getter for the encoding used for password hashing.
public String getName()

protected String getPassword(Credential[] credentials)
     Gets the password from the recevied credentials.
protected PasswordCredential getPasswordCredential(Credential[] credentials)
     Gets the credential that represents a password.
public Principal getPrincipal()
     The username recieved as UsernameCredential instance, if any.
public Principal getPrincipal(Credential[] credentials)
     The username recieved as UsernameCredential instance, if any.
public Credential[] getPrivateCredentials()
     Only one password credential supported.
public Credential[] getPublicCredentials()
     Only one username credential supported.
public int getSaltLength()
     Only used when CRYPT is configured, default value is 2.
protected String getUsername(Credential[] credentials)
     Gets the username from the received credentials.
protected UsernameCredential getUsernameCredential(Credential[] credentials)
     Gets the credential that represents a Username.
public void setHashAlgorithm(String hashAlgorithm)

public void setHashCharset(String hashCharset)

public void setHashEncoding(String hashEnconding)
     Setter for the encoding used for password hashing.
public void setIgnorePasswordCase(String ignorePasswordCase)

public void setIgnoreUserCase(String ignoreUserCase)

public void setName(String name)

public void setSaltLenght(String saltLenght)

public void setSaltLength(int sl)

protected boolean validatePassword(String inputPassword, String expectedPassword)
     This method validates the input password agaist the expected password.
protected boolean validateUsername(String inputUsername, String expectedUsername)
     This method validates the input password agaist the expected password.

Method Detail
authenticate
public boolean authenticate() throws SSOAuthenticationException(Code)
Authenticates the user using recieved credentials to proof his identity. the Principal if credentials are valid, null otherwise.

clone
public Object clone()(Code)

createPasswordHash
protected String createPasswordHash(String password) throws SSOAuthenticationException(Code)
This method allows password hashing. In order to work, you need to specify hashAlgorithm and hashEncoding properties. You can optionally set hashCharset property. the hashed password.

doMakeCredentialProvider
protected CredentialProvider doMakeCredentialProvider()(Code)

encodeBase16
protected String encodeBase16(byte[] bytes)(Code)
Base16 encoding (HEX).

encodeBase64
protected String encodeBase64(byte[] bytes) throws UnsupportedEncodingException(Code)
Base64 encoding. Charset ISO-8859-1 is assumed.

getDigest
protected MessageDigest getDigest() throws SSOAuthenticationException(Code)
Only invoke this if algorithm is set.
throws:
  SSOAuthenticationException -

getHashAlgorithm
public String getHashAlgorithm()(Code)

getHashCharset
public String getHashCharset()(Code)

getHashEncoding
public String getHashEncoding()(Code)
Getter for the encoding used for password hashing. Supported values : HEX, BASE64

getName
public String getName()(Code)
Obtains the Authentication Scheme name

getPassword
protected String getPassword(Credential[] credentials)(Code)
Gets the password from the recevied credentials.
Parameters:
  credentials -

getPasswordCredential
protected PasswordCredential getPasswordCredential(Credential[] credentials)(Code)
Gets the credential that represents a password.
Parameters:
  credentials -

getPrincipal
public Principal getPrincipal()(Code)
The username recieved as UsernameCredential instance, if any.

getPrincipal
public Principal getPrincipal(Credential[] credentials)(Code)
The username recieved as UsernameCredential instance, if any.

getPrivateCredentials
public Credential[] getPrivateCredentials()(Code)
Only one password credential supported.

getPublicCredentials
public Credential[] getPublicCredentials()(Code)
Only one username credential supported.

getSaltLength
public int getSaltLength()(Code)
Only used when CRYPT is configured, default value is 2.

getUsername
protected String getUsername(Credential[] credentials)(Code)
Gets the username from the received credentials.
Parameters:
  credentials -

getUsernameCredential
protected UsernameCredential getUsernameCredential(Credential[] credentials)(Code)
Gets the credential that represents a Username.

setHashAlgorithm
public void setHashAlgorithm(String hashAlgorithm)(Code)

setHashCharset
public void setHashCharset(String hashCharset)(Code)

setHashEncoding
public void setHashEncoding(String hashEnconding)(Code)
Setter for the encoding used for password hashing. Supported values : HEX, BASE64

setIgnorePasswordCase
public void setIgnorePasswordCase(String ignorePasswordCase)(Code)
Values : true , false,

setIgnoreUserCase
public void setIgnoreUserCase(String ignoreUserCase)(Code)
Values : true , false,

setName
public void setName(String name)(Code)
Sets Authentication Scheme name

setSaltLenght
public void setSaltLenght(String saltLenght)(Code)

setSaltLength
public void setSaltLength(int sl)(Code)

validatePassword
protected boolean validatePassword(String inputPassword, String expectedPassword)(Code)
This method validates the input password agaist the expected password.
Parameters:
  inputPassword -
Parameters:
  expectedPassword -

validateUsername
protected boolean validateUsername(String inputUsername, String expectedUsername)(Code)
This method validates the input password agaist the expected password.
Parameters:
  inputUsername -
Parameters:
  expectedUsername -

Fields inherited from org.josso.auth.scheme.AbstractAuthenticationScheme
protected CredentialProvider _credentialProvider(Code)(Java Doc)
protected CredentialStore _credentialStore(Code)(Java Doc)
protected CredentialStoreKeyAdapter _credentialStoreKeyAdapter(Code)(Java Doc)
protected Credential[] _inputCredentials(Code)(Java Doc)
protected Subject _subject(Code)(Java Doc)

Methods inherited from org.josso.auth.scheme.AbstractAuthenticationScheme
public void cancel()(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
public void confirm()(Code)(Java Doc)
abstract protected CredentialProvider doMakeCredentialProvider()(Code)(Java Doc)
protected CredentialStore getCredentialStore()(Code)(Java Doc)
protected CredentialStoreKeyAdapter getCredentialStoreKeyAdapter()(Code)(Java Doc)
protected Credential[] getKnownCredentials() throws SSOAuthenticationException(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public void initialize(Credential[] userCredentials, Subject s)(Code)(Java Doc)
protected boolean isAuthenticated()(Code)(Java Doc)
public Credential newCredential(String name, Object value)(Code)(Java Doc)
protected void setAuthenticated(boolean a)(Code)(Java Doc)
public void setCredentialStore(CredentialStore c)(Code)(Java Doc)
public void setCredentialStoreKeyAdapter(CredentialStoreKeyAdapter a)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.