Package org.kohsuke.stapler

Class CrumbIssuer

java.lang.Object

org.kohsuke.stapler.CrumbIssuer

public abstract class CrumbIssuer
extends Object

Generates a nonce value that allows us to protect against cross-site request forgery (CSRF) attacks.

We send this with each JavaScript proxy and verify them when we receive a request.

Author:

Kohsuke Kawaguchi

See Also:

• WebApp.getCrumbIssuer()
• WebApp.setCrumbIssuer(CrumbIssuer)

Field Summary

Fields

Modifier and Type	Field	Description
static final CrumbIssuer	DEFAULT	Default crumb issuer.

Constructor Summary

Constructors

Constructor	Description
CrumbIssuer()

Method Summary

Modifier and Type	Method	Description
HttpResponse	doCrumb()	Sends the crumb value in plain text, enabling retrieval through XmlHttpRequest.
final String	issueCrumb()
String	issueCrumb(StaplerRequest request)	Deprecated. use issueCrumb(StaplerRequest2)
String	issueCrumb(StaplerRequest2 request)	Issues a crumb for the given request.
void	validateCrumb(StaplerRequest2 request, String submittedCrumb)	Validates a crumb that was submitted along with the request.
void	validateCrumb(StaplerRequest request, String submittedCrumb)	Deprecated. use validateCrumb(StaplerRequest2, String)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final CrumbIssuer DEFAULT

Default crumb issuer.

Constructor Details

CrumbIssuer

public CrumbIssuer()

Method Details

issueCrumb

public String issueCrumb(StaplerRequest2 request)

Issues a crumb for the given request.

issueCrumb

@Deprecated
public String issueCrumb(StaplerRequest request)

Deprecated.

use issueCrumb(StaplerRequest2)

issueCrumb

public final String issueCrumb()

doCrumb

public HttpResponse doCrumb()

Sends the crumb value in plain text, enabling retrieval through XmlHttpRequest.

validateCrumb

public void validateCrumb(StaplerRequest2 request,
 String submittedCrumb)

Validates a crumb that was submitted along with the request.

Parameters:

request - The request that submitted the crumb

submittedCrumb - The submitted crumb value to be validated.

Throws:

SecurityException - If the crumb doesn't match and the request processing should abort.

validateCrumb

@Deprecated
public void validateCrumb(StaplerRequest request,
 String submittedCrumb)

Deprecated.

use validateCrumb(StaplerRequest2, String)