Java Authentication and Authorization Service

<h2 id="administration">Administration</h2>
<p>For the <a href="/facts/System_administrator/zNhThrh9">system administrator</a>, JAAS consists of two kinds of <a href="/facts/Configuration_file/DDzU0FLJ">configuration file</a>:
</p>
<ul><li>*.login.conf: specifies how to plug vendor-supplied <a href="/facts/Login/xNRgTVnV">login</a> modules into particular applications</li>
<li>*.policy: specifies which identities (users or programs) are granted which permissions</li></ul>
<p>For example, an application may have this login.conf file indicating how different authentication mechanisms are to be run to authenticate the user:
</p>
   PetShopApplication {
      com.sun.security.auth.module.LdapLoginModule sufficient;
      com.foo.SmartcardLoginModule                 requisite;
      com.sun.security.auth.module.UnixLoginModule required debug=true;
   }

<h2 id="application-interface">Application interface</h2>
<p>For the application developer, JAAS is a standard library that provides:
</p>
<ul><li>a representation of identity (<i><a href="/facts/Principal_(computer_security)/xNIbeTbK">Principal</a></i>) and a set of credentials (<i><a href="/facts/Subject_(access_control)/08zE5Pz8">Subject</a></i>)</li>
<li>a <a href="/facts/Login/xNRgTVnV">login</a> service that will invoke your application <a href="/facts/Callback_(computer_programming)/vPlrCJXG">callbacks</a> to ask the user things like username and <a href="/facts/Password/WEoul230">password</a>. It returns a new <i>Subject</i></li>
<li>a service that tests if a Subject was granted a permission by an administrator.</li></ul>
<h2 id="security-system-integration">Security system integration</h2>
<p>For the security system integrator, JAAS provides interfaces:
</p>
<ul><li>to provide your identity namespace to applications</li>
<li>to attach credentials to threads (<i>Subject</i>)</li>
<li>for developing <a href="/facts/Login/xNRgTVnV">login</a> modules. Your module invokes <a href="/facts/Callback_(computer_programming)/vPlrCJXG">callbacks</a> to query the user, checks their response and generates a <i>Subject</i>.</li></ul>
<h2 id="login-modules">Login Modules</h2>
<p>Login modules are primarily concerned with authentication rather than authorization and form a widely used component of JAAS.  A login module is required to implement the javax.security.auth.spi.LoginModule interface, which specifies the following methods:
</p><p>Note: A Subject is the user that is attempting to log in.
</p>
<ul><li>initialize:  Code to initialize the login module, usually by storing the parameters passed into appropriate fields of the Class.</li>
<li>login:  Actually check the credentials provided via an Object that implements the javax.security.auth.Callback interface (e.g. check against a database).  This method could prompt the user for their login and password or it could use details previously obtained.  It is important to note here that, if invalid credentials are supplied then a javax.security.auth.login.FailedLoginException should be thrown (rather than returning false, which indicates that this login module should be ignored, which potentially allows authentication to succeed).</li>
<li>commit:  The identity of the subject has been verified, so code in this method sets up the Principal and Groups (roles) for the successfully authenticated subject.  This method has to be written carefully in enterprise applications as Java EE application servers often expect the relationships between the Principal and Group objects to be set up in a certain way.  This method should throw a javax.security.auth.login.FailedLoginException if authentication fails (e.g. a user has specified an incorrect login or password).</li>
<li>abort:  Called if the authentication process itself fails.  If this method returns false, then this Login Module is ignored.</li>
<li>logout:  Code that should be executed upon logout (e.g. could remove the Principal from the Subject or could invalidate a web session).</li></ul>
<p>Login modules can provide single sign on (SSO) via a particular SSO protocol/framework (e.g. <a href="/facts/SAML/HbCY4ge6">SAML</a>, <a href="/facts/OpenID/Vpx5mbcV">OpenID</a>, and <a href="/facts/SPNEGO/Btqy4ffy">SPNEGO</a>), can check for the presence of hardware security tokens (e.g. USB token), etc.  In an n-tier application, LoginModules can be present on both the client side and server side.
</p>
<h3>LoginModule (javax.security.auth.spi.LoginModule)</h3>
<p>Login modules are written by implementing this interface; they contain the actual code for authentication. It can use various mechanisms to authenticate user credentials. The code could retrieve a password from a database and compare it to the password supplied to the module.
</p>
<h3>LoginContext (javax.security.auth.login.LoginContext)</h3>
<p>The login context is the core of the JAAS framework which kicks off the authentication process by creating a Subject. As the authentication process proceeds, the subject is populated with various principals and credentials for further processing.
</p>
<h3>Subject (javax.security.auth.Subject)</h3>
<p>A subject represents a single user, entity or system –in other words, a client– requesting authentication.
</p>
<h3>Principal (java.security.Principal)</h3>
<p>A principal represents the face of a subject. It encapsulates features or properties of a subject. A subject can contain multiple principals.
</p>
<h3>Credentials</h3>
<p>Credentials are nothing but pieces of information regarding the subject in consideration. They might be account numbers, passwords, certificates etc. As the credential represents some important information, the further interfaces might be useful for creating a proper and secure credential – javax.security.auth.Destroyable and javax.security.auth.Refreshable. Suppose that after the successful authentication of the user you populate the subject with a secret ID (in the form of a credential) with which the subject can execute some critical services, but the credential should be removed after a specific time. In that case, one might want to implement the Destroyable interface. Refreshable might be useful if a credential has only a limited timespan in which it is valid.
</p>
<h2 id="see-also">See also</h2>
<ul><li><a href="/facts/Apache_Shiro/JLLICLJa">Apache Shiro</a></li>
<li><a href="/facts/Keystore/Nh2pGjfD">Keystore</a></li>
<li><a href="http://oaccframework.org">OACC</a></li></ul>

<h2 id="external-links">External links</h2>
<ul><li><a href="https://javaranch.com/journal/2008/04/Journal200804.jsp#a6">JAAS Tutorial</a></li>
<li><a href="http://jguard.xwiki.com/">jGuard : open source project which can secure standalone or web applications based on JAAS</a> <a href="https://web.archive.org/web/20081202041403/http://jguard.xwiki.com/">Archived</a> 2008-12-02 at the <a href="/facts/Wayback_Machine/nmQ3a6JC">Wayback Machine</a></li>
<li>Musser, John; Feuer, Paul (September 23, 2002). <a href="https://www.infoworld.com/article/2074873/all-that-jaas.html">"All that JAAS"</a>. <i><a href="/facts/JavaWorld/EJ0zA8FV">JavaWorld</a></i>. Retrieved 2020-07-20.</li>
<li><a href="http://spnego.sourceforge.net/">SPNEGO Library - open source GNU LGPL project that relies on the JAAS framework to simplify Authentication and Authorization</a></li></ul>

<h2 id="references">References</h2>

<ol>
<li id="fn:1"><p>Theodore J. Shrader; Bruce A. Rich; Anthony J. Nadalin (2000). Java and internet security. iUniverse. p. 152. ISBN 9780595135004. <a href="9780595135004" target="_blank">9780595135004</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li>
<li id="fn:2"><p>"Java Authentication and Authorization Service (JAAS) Reference Guide". oracle.com. Oracle Corporation. Archived from the original on 6 June 2012. Retrieved 22 May 2012. <a href="https://web.archive.org/web/20120606055808/http://docs.oracle.com/javase/6/docs/technotes/guides/security/jaas/JAASRefGuide.html" target="_blank">https://web.archive.org/web/20120606055808/http://docs.oracle.com/javase/6/docs/technotes/guides/security/jaas/JAASRefGuide.html</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li>
<li id="fn:3"><p>Theodore J. Shrader; Bruce A. Rich; Anthony J. Nadalin (2000). Java and internet security. iUniverse. p. 152. ISBN 9780595135004. <a href="9780595135004" target="_blank">9780595135004</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li>
</ol>

Java Authentication and Authorization Service open-in-new

Java Authentication and Authorization Service