org.apache.knox.gateway.shirorealm

Class KnoxPamRealm

java.lang.Object

org.apache.shiro.realm.CachingRealm

org.apache.shiro.realm.AuthenticatingRealm

org.apache.shiro.realm.AuthorizingRealm

org.apache.knox.gateway.shirorealm.KnoxPamRealm

All Implemented Interfaces:

org.apache.shiro.authc.LogoutAware, org.apache.shiro.authz.Authorizer, org.apache.shiro.authz.permission.PermissionResolverAware, org.apache.shiro.authz.permission.RolePermissionResolverAware, org.apache.shiro.cache.CacheManagerAware, org.apache.shiro.realm.Realm, org.apache.shiro.util.Initializable, org.apache.shiro.util.Nameable

public class KnoxPamRealm
extends org.apache.shiro.realm.AuthorizingRealm

A Unix-style PAM Realm that uses libpam4j to interface with the PAM system libraries.

This is a single Shiro Realm that interfaces with the OS's PAM subsystem which itself can be connected to several authentication methods (unix-crypt,Samba, LDAP, etc.)

This Realm can also take part in Shiro's Pluggable Realms concept.

Using a KnoxPamRealm requires a PAM service name. This is the name of the file under /etc/pam.d that is used to initialise and configure the PAM subsystem. Normally, this file reflects the application using it. For example gdm, su, etc. There is no default value for this property.

For example, defining this realm in Shiro .ini:

 [main]
 pamRealm = org.apache.shiro.realm.libpam4j.KnoxPamRealm
 pamRealm.service = [ knox-pam-ldap-service | knox-pam-os-service | knox-pam-winbind-service ]
 [urls]
 **=authcBasic
 

Constructor Summary

Constructors

Constructor and Description
KnoxPamRealm()

Method Summary

Modifier and Type	Method and Description
protected org.apache.shiro.authc.AuthenticationInfo	doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)
protected org.apache.shiro.authz.AuthorizationInfo	doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection principals)
String	getService()
void	setService(String service)

Methods inherited from class org.apache.shiro.realm.AuthorizingRealm

afterCacheManagerSet, checkPermission, checkPermission, checkPermission, checkPermissions, checkPermissions, checkPermissions, checkRole, checkRole, checkRoles, checkRoles, checkRoles, clearCachedAuthorizationInfo, doClearCache, getAuthorizationCache, getAuthorizationCacheKey, getAuthorizationCacheName, getAuthorizationInfo, getPermissionResolver, getPermissions, getRolePermissionResolver, hasAllRoles, hasRole, hasRole, hasRoles, hasRoles, isAuthorizationCachingEnabled, isPermitted, isPermitted, isPermitted, isPermitted, isPermitted, isPermitted, isPermittedAll, isPermittedAll, isPermittedAll, onInit, setAuthorizationCache, setAuthorizationCacheName, setAuthorizationCachingEnabled, setName, setPermissionResolver, setRolePermissionResolver

Methods inherited from class org.apache.shiro.realm.AuthenticatingRealm

assertCredentialsMatch, clearCachedAuthenticationInfo, getAuthenticationCache, getAuthenticationCacheKey, getAuthenticationCacheKey, getAuthenticationCacheName, getAuthenticationInfo, getAuthenticationTokenClass, getCredentialsMatcher, init, isAuthenticationCachingEnabled, isAuthenticationCachingEnabled, setAuthenticationCache, setAuthenticationCacheName, setAuthenticationCachingEnabled, setAuthenticationTokenClass, setCredentialsMatcher, supports

Methods inherited from class org.apache.shiro.realm.CachingRealm

clearCache, getAvailablePrincipal, getCacheManager, getName, isCachingEnabled, onLogout, setCacheManager, setCachingEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.shiro.util.Initializable

init

Constructor Detail

KnoxPamRealm

public KnoxPamRealm()

Method Detail

setService

public void setService(String service)

getService

public String getService()

doGetAuthorizationInfo

protected org.apache.shiro.authz.AuthorizationInfo doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection principals)

Specified by:

doGetAuthorizationInfo in class org.apache.shiro.realm.AuthorizingRealm

doGetAuthenticationInfo

protected org.apache.shiro.authc.AuthenticationInfo doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)
                                                                     throws org.apache.shiro.authc.AuthenticationException

Specified by:

doGetAuthenticationInfo in class org.apache.shiro.realm.AuthenticatingRealm

Throws:

org.apache.shiro.authc.AuthenticationException