Top Description Fields Constructors Methods

org.apache.hc.client5.http.impl.cookie

public Class PublicSuffixDomainFilter

Class Inheritance

extends Object
implements CommonCookieAttributeHandler

java.lang.Object
org.apache.hc.client5.http.impl.cookie.PublicSuffixDomainFilter

All Implemented Interfaces

org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler, org.apache.hc.client5.http.cookie.CookieAttributeHandler

Annotations

@Contract
threading:STATELESS

Imports

java.util.Map, java.util.concurrent.ConcurrentHashMap, org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler, .Cookie, .CookieOrigin, .MalformedCookieException, .SetCookie, org.apache.hc.client5.http.psl.PublicSuffixList, .PublicSuffixMatcher, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.util.Args

Wraps a org.apache.hc.client5.http.cookie.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.

Since: 4.4
See Also: PublicSuffixList, PublicSuffixMatcher

Field Summary

Modifier and Type	Field and Description
private final CommonCookieAttributeHandler	handler
private final Map<String, Boolean>	localDomainMap
private final PublicSuffixMatcher	publicSuffixMatcher

Constructor Summary

Access	Constructor and Description
public	PublicSuffixDomainFilter(final CommonCookieAttributeHandler handler, final PublicSuffixMatcher publicSuffixMatcher)
public	PublicSuffixDomainFilter(final CommonCookieAttributeHandler handler, final PublicSuffixList suffixList)

Method Summary

Modifier and Type	Method and Description
private static Map<String, Boolean>	createLocalDomainMap()
public static CommonCookieAttributeHandler	decorate(final CommonCookieAttributeHandler handler, final PublicSuffixMatcher publicSuffixMatcher)
public String	getAttributeName() Implements org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler.getAttributeName.
public boolean	match(final Cookie `org.apache.hc.client5.http.cookie.Cookie` to match cookie, final CookieOrigin the cookie source to match against origin) Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.match. Never matches if the cookie's domain is from the blacklist.
public void	parse(final SetCookie `org.apache.hc.client5.http.cookie.Cookie` to be updated cookie, final String cookie attribute value from the cookie response header value) Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.parse. Parse the given cookie attribute value and processChallenge the corresponding `org.apache.hc.client5.http.cookie.Cookie` property.
public void	validate(final Cookie `org.apache.hc.client5.http.cookie.Cookie` to validate cookie, final CookieOrigin the cookie source to validate against origin) Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.validate. Performs cookie validation for the given attribute value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

handler	back to summary
private final CommonCookieAttributeHandler handler

localDomainMap	back to summary
private final Map<String, Boolean> localDomainMap

publicSuffixMatcher	back to summary
private final PublicSuffixMatcher publicSuffixMatcher

Constructor Detail

Method Detail

createLocalDomainMap	back to summary
private static Map<String, Boolean> createLocalDomainMap()

getAttributeName

back to summary

public String getAttributeName()

Implements org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler.getAttributeName.

Annotations

@Override

match back to summary

public boolean match(final Cookie cookie, final CookieOrigin origin)

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

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

Parameters

cookie:Cookie

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

org.apache.hc.client5.http.cookie.Cookie to match

origin:CookieOrigin

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

the cookie source to match against

Returns:boolean

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

true if the match is successful; false otherwise

Annotations

@Override

parse back to summary

public void parse(final SetCookie cookie, final String value) throws MalformedCookieException

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

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

Parse the given cookie attribute value and processChallenge the corresponding org.apache.hc.client5.http.cookie.Cookie property.

Parameters

cookie:SetCookie: org.apache.hc.client5.http.cookie.Cookie to be updated
value:String: cookie attribute value from the cookie response header

Annotations

@Override

Exceptions

MalformedCookieException:: if cookie parsing fails for this attribute

validate back to summary

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

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

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

Performs cookie validation for the given attribute value.

Parameters

cookie:Cookie: org.apache.hc.client5.http.cookie.Cookie to validate
origin:CookieOrigin: the cookie source to validate against

Annotations

@Override

Exceptions

MalformedCookieException:: if cookie validation fails for this attribute