org.apereo.cas.adaptors.x509.authentication.handler.support.ldap

Class LdaptiveResourceCRLFetcher

java.lang.Object

org.apereo.cas.adaptors.x509.authentication.handler.support.ResourceCRLFetcher

org.apereo.cas.adaptors.x509.authentication.handler.support.ldap.LdaptiveResourceCRLFetcher

All Implemented Interfaces:

CRLFetcher

Direct Known Subclasses:

PoolingLdaptiveResourceCRLFetcher

@RefreshScope
 @Component(value="ldaptiveResourceCRLFetcher")
public class LdaptiveResourceCRLFetcher
extends ResourceCRLFetcher

Fetches a CRL from an LDAP instance.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field and Description
protected org.ldaptive.ConnectionConfig	connectionConfig The connection config to prep for connections.
protected org.ldaptive.SearchExecutor	searchExecutor Search exec that looks for the attribute.

Fields inherited from class org.apereo.cas.adaptors.x509.authentication.handler.support.ResourceCRLFetcher

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LdaptiveResourceCRLFetcher() Serialization support.
	LdaptiveResourceCRLFetcher(org.ldaptive.ConnectionConfig connectionConfig, org.ldaptive.SearchExecutor searchExecutor) Instantiates a new Ldap resource cRL fetcher.

Method Summary

Modifier and Type	Method and Description
java.security.cert.X509CRL	fetch(org.springframework.core.io.Resource crl) Fetch the resource.
java.security.cert.X509CRL	fetch(java.lang.String crl) Fetch the resource.
java.security.cert.X509CRL	fetch(java.net.URI crl) Fetch the resource.
java.security.cert.X509CRL	fetch(java.net.URL crl) Fetch the resource.
protected java.security.cert.X509CRL	fetchCRLFromLdap(java.lang.Object r) Downloads a CRL from given LDAP url.
protected java.security.cert.X509CRL	fetchX509CRLFromAttribute(org.ldaptive.LdapAttribute aval) Gets x509 cRL from attribute.
protected org.ldaptive.Response<org.ldaptive.SearchResult>	performLdapSearch(java.lang.String ldapURL) Executes an LDAP search against the supplied URL.
protected org.ldaptive.ConnectionFactory	prepareConnectionFactory(java.lang.String ldapURL) Prepare a new LDAP connection.
void	setConnectionConfig(org.ldaptive.ConnectionConfig connectionConfig)
void	setSearchExecutor(org.ldaptive.SearchExecutor searchExecutor)

Methods inherited from class org.apereo.cas.adaptors.x509.authentication.handler.support.ResourceCRLFetcher

fetch

Methods inherited from class java.lang.Object

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

Field Detail

searchExecutor

protected org.ldaptive.SearchExecutor searchExecutor

Search exec that looks for the attribute.

connectionConfig

protected org.ldaptive.ConnectionConfig connectionConfig

The connection config to prep for connections.

Constructor Detail

LdaptiveResourceCRLFetcher

protected LdaptiveResourceCRLFetcher()

Serialization support.

LdaptiveResourceCRLFetcher

public LdaptiveResourceCRLFetcher(org.ldaptive.ConnectionConfig connectionConfig,
                                  org.ldaptive.SearchExecutor searchExecutor)

Instantiates a new Ldap resource cRL fetcher.

Parameters:

connectionConfig - the connection configuration

searchExecutor - the search executor

Method Detail

fetch

public java.security.cert.X509CRL fetch(org.springframework.core.io.Resource crl)
                                 throws java.io.IOException,
                                        java.security.cert.CRLException,
                                        java.security.cert.CertificateException

Description copied from class: ResourceCRLFetcher

Fetch the resource. Designed so that extensions can decide how the resource should be retrieved.

Specified by:

fetch in interface CRLFetcher

Overrides:

fetch in class ResourceCRLFetcher

Parameters:

crl - the resource

Returns:

the x 509 cRL

Throws:

java.io.IOException - the exception thrown if resources cant be fetched

java.security.cert.CRLException - the exception thrown if resources cant be fetched

java.security.cert.CertificateException - the exception thrown if resources cant be fetched

fetch

public java.security.cert.X509CRL fetch(java.net.URI crl)
                                 throws java.io.IOException,
                                        java.security.cert.CRLException,
                                        java.security.cert.CertificateException

Description copied from class: ResourceCRLFetcher

Fetch the resource. Designed so that extensions can decide how the resource should be retrieved.

Specified by:

fetch in interface CRLFetcher

Overrides:

fetch in class ResourceCRLFetcher

Parameters:

crl - the resource

Returns:

the x 509 cRL

Throws:

java.io.IOException - the exception thrown if resources cant be fetched

java.security.cert.CRLException - the exception thrown if resources cant be fetched

java.security.cert.CertificateException - the exception thrown if resources cant be fetched

fetch

public java.security.cert.X509CRL fetch(java.net.URL crl)
                                 throws java.io.IOException,
                                        java.security.cert.CRLException,
                                        java.security.cert.CertificateException

Description copied from class: ResourceCRLFetcher

Fetch the resource. Designed so that extensions can decide how the resource should be retrieved.

Specified by:

fetch in interface CRLFetcher

Overrides:

fetch in class ResourceCRLFetcher

Parameters:

crl - the resource

Returns:

the x 509 cRL

Throws:

java.io.IOException - the exception thrown if resources cant be fetched

java.security.cert.CRLException - the exception thrown if resources cant be fetched

java.security.cert.CertificateException - the exception thrown if resources cant be fetched

fetch

public java.security.cert.X509CRL fetch(java.lang.String crl)
                                 throws java.io.IOException,
                                        java.security.cert.CRLException,
                                        java.security.cert.CertificateException

Description copied from class: ResourceCRLFetcher

Fetch the resource. Designed so that extensions can decide how the resource should be retrieved.

Specified by:

fetch in interface CRLFetcher

Overrides:

fetch in class ResourceCRLFetcher

Parameters:

crl - the resource

Returns:

the x 509 cRL

Throws:

java.io.IOException - the exception thrown if resources cant be fetched

java.security.cert.CRLException - the exception thrown if resources cant be fetched

java.security.cert.CertificateException - the exception thrown if resources cant be fetched

fetchCRLFromLdap

protected java.security.cert.X509CRL fetchCRLFromLdap(java.lang.Object r)
                                               throws java.security.cert.CertificateException,
                                                      java.io.IOException,
                                                      java.security.cert.CRLException

Downloads a CRL from given LDAP url.

Parameters:

r - the resource that is the ldap url.

Returns:

the x 509 cRL

Throws:

java.io.IOException - the exception thrown if resources cant be fetched

java.security.cert.CRLException - the exception thrown if resources cant be fetched

java.security.cert.CertificateException - if connection to ldap fails, or attribute to get the revocation list is unavailable

fetchX509CRLFromAttribute

protected java.security.cert.X509CRL fetchX509CRLFromAttribute(org.ldaptive.LdapAttribute aval)
                                                        throws java.security.cert.CertificateException,
                                                               java.io.IOException,
                                                               java.security.cert.CRLException

Gets x509 cRL from attribute. Retrieves the binary attribute value, decodes it to base64, and fetches it as a byte-array resource.

Parameters:

aval - the attribute, which may be null if it's not found

Returns:

the x 509 cRL from attribute

Throws:

java.io.IOException - the exception thrown if resources cant be fetched

java.security.cert.CRLException - the exception thrown if resources cant be fetched

java.security.cert.CertificateException - if connection to ldap fails, or attribute to get the revocation list is unavailable

performLdapSearch

protected org.ldaptive.Response<org.ldaptive.SearchResult> performLdapSearch(java.lang.String ldapURL)
                                                                      throws org.ldaptive.LdapException

Executes an LDAP search against the supplied URL.

Parameters:

ldapURL - to search

Returns:

search result

Throws:

org.ldaptive.LdapException - if an error occurs performing the search

prepareConnectionFactory

protected org.ldaptive.ConnectionFactory prepareConnectionFactory(java.lang.String ldapURL)

Prepare a new LDAP connection.

Parameters:

ldapURL - the ldap uRL

Returns:

connection factory

setSearchExecutor

@Autowired(required=false)
public void setSearchExecutor(@Qualifier(value="ldaptiveResourceCRLSearchExecutor")
                                                          org.ldaptive.SearchExecutor searchExecutor)

setConnectionConfig

@Autowired(required=false)
public void setConnectionConfig(@Qualifier(value="ldaptiveResourceCRLConnectionConfig")
                                                            org.ldaptive.ConnectionConfig connectionConfig)