Package org.jenkinsci.plugins.oic.properties

Class EscapeHatch

java.lang.Object

hudson.model.AbstractDescribableImpl<OidcProperty>

org.jenkinsci.plugins.oic.OidcProperty

org.jenkinsci.plugins.oic.properties.EscapeHatch

All Implemented Interfaces:

Describable<OidcProperty>

public class EscapeHatch
extends OidcProperty

Escape hatch for authentication, allowing users to log in with a username and password. This is intended for emergency access and should be used with caution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EscapeHatch.CrumbExclusionImpl	Excluding the escapeHatch login from CSRF protection as the crumb is calculated based on the authentication mirroring behavior of the normal login page.
static class	EscapeHatch.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	B_CRYPT_PATTERN

Constructor Summary

Constructors

Constructor	Description
EscapeHatch(String username, String group, Secret secret)

Method Summary

Modifier and Type	Method	Description
Optional<org.springframework.security.core.Authentication>	authenticate(org.springframework.security.core.Authentication authentication)	Allows a property to authenticate the user.
String	getGroup()
Secret	getSecret()
String	getUsername()

Methods inherited from class org.jenkinsci.plugins.oic.OidcProperty

contributeLogoutQueryParameters, newExecution

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Details

B_CRYPT_PATTERN

public static final Pattern B_CRYPT_PATTERN

Constructor Details

EscapeHatch

@DataBoundConstructor
public EscapeHatch(@NonNull
 String username,
 @CheckForNull
 String group,
 @NonNull
 Secret secret)
            throws Descriptor.FormException

Throws:

Descriptor.FormException

Method Details

getUsername

@CheckForNull
public String getUsername()

getGroup

@CheckForNull
public String getGroup()

getSecret

@NonNull
public Secret getSecret()

authenticate

@NonNull
public Optional<org.springframework.security.core.Authentication> authenticate(@NonNull
 org.springframework.security.core.Authentication authentication)

Description copied from class: OidcProperty

Allows a property to authenticate the user.

Overrides:

authenticate in class OidcProperty

See Also:

• EscapeHatch