Top Description Fields Constructors Methods
org.apache.http.impl.cookie

public Class PublicSuffixFilter

extends Object
implements CookieAttributeHandler
Class Inheritance
All Implemented Interfaces
org.apache.http.cookie.CookieAttributeHandler
Annotations
@Deprecated
Imports
java.util.Collection, org.apache.http.conn.util.PublicSuffixMatcher, org.apache.http.cookie.Cookie, .CookieAttributeHandler, .CookieOrigin, .MalformedCookieException, .SetCookie

Deprecated

(4.4) use org.apache.http.impl.cookie.PublicSuffixDomainFilter

Wraps a CookieAttributeHandler and leverages its match method to never match a suffix from a black list. May be used to provide additional security for cross-site attack types by preventing cookies from apparent domains that are not publicly available. An uptodate list of suffixes can be obtained from publicsuffix.org
Since
4.0

Field Summary

Modifier and TypeField and Description
private Collection<String>
exceptions

private PublicSuffixMatcher
matcher

private Collection<String>
suffixes

private final CookieAttributeHandler
wrapped

Constructor Summary

AccessConstructor and Description
public
PublicSuffixFilter(final CookieAttributeHandler wrapped)

Method Summary

Modifier and TypeMethod and Description
private boolean
isForPublicSuffix(final Cookie cookie)

public boolean
match(final Cookie
org.apache.http.cookie.Cookie to match
cookie, final CookieOrigin
the cookie source to match against
origin)

Implements org.apache.http.cookie.CookieAttributeHandler.match.

Never matches if the cookie's domain is from the blacklist.
public void
parse(final SetCookie
org.apache.http.cookie.Cookie to be updated
cookie, final String
cookie attribute value from the cookie response header
value)

Implements org.apache.http.cookie.CookieAttributeHandler.parse.

Parse the given cookie attribute value and update the corresponding org.apache.http.cookie.Cookie property.
public void
setExceptions(final Collection<String> exceptions)

Sets the exceptions from the blacklist.

public void
setPublicSuffixes(final Collection<String> suffixes)

Sets the suffix blacklist patterns.

public void
validate(final Cookie
org.apache.http.cookie.Cookie to validate
cookie, final CookieOrigin
the cookie source to validate against
origin)

Implements org.apache.http.cookie.CookieAttributeHandler.validate.

Peforms cookie validation for the given attribute value.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

exceptionsback to summary
private Collection<String> exceptions
matcherback to summary
private PublicSuffixMatcher matcher
suffixesback to summary
private Collection<String> suffixes
wrappedback to summary
private final CookieAttributeHandler wrapped

Constructor Detail

PublicSuffixFilterback to summary
public PublicSuffixFilter(final CookieAttributeHandler wrapped)

Method Detail

isForPublicSuffixback to summary
private boolean isForPublicSuffix(final Cookie cookie)
matchback to summary
public boolean match(final Cookie cookie, final CookieOrigin origin)

Implements org.apache.http.cookie.CookieAttributeHandler.match.

Never matches if the cookie's domain is from the blacklist.

Parameters
cookie:Cookie

Doc from org.apache.http.cookie.CookieAttributeHandler.match.

org.apache.http.cookie.Cookie to match

origin:CookieOrigin

Doc from org.apache.http.cookie.CookieAttributeHandler.match.

the cookie source to match against

Returns:boolean

Doc from org.apache.http.cookie.CookieAttributeHandler.match.

true if the match is successful; false otherwise

Annotations
@Override
parseback to summary
public void parse(final SetCookie cookie, final String value) throws MalformedCookieException

Implements org.apache.http.cookie.CookieAttributeHandler.parse.

Doc from org.apache.http.cookie.CookieAttributeHandler.parse.

Parse the given cookie attribute value and update the corresponding org.apache.http.cookie.Cookie property.

Parameters
cookie:SetCookie

org.apache.http.cookie.Cookie to be updated

value:String

cookie attribute value from the cookie response header

Annotations
@Override
setExceptionsback to summary
public void setExceptions(final Collection<String> exceptions)

Sets the exceptions from the blacklist. Exceptions can not be patterns. TODO add support for patterns

setPublicSuffixesback to summary
public void setPublicSuffixes(final Collection<String> suffixes)

Sets the suffix blacklist patterns. A pattern can be "com", "*.jp" TODO add support for patterns like "lib.*.us"

validateback to summary
public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException

Implements org.apache.http.cookie.CookieAttributeHandler.validate.

Doc from org.apache.http.cookie.CookieAttributeHandler.validate.

Peforms cookie validation for the given attribute value.

Parameters
cookie:Cookie

org.apache.http.cookie.Cookie to validate

origin:CookieOrigin

the cookie source to validate against

Annotations
@Override
Exceptions
MalformedCookieException:
if cookie validation fails for this attribute