Package jenkins.security.seed

Class UserSeedProperty

java.lang.Object

hudson.model.UserProperty

jenkins.security.seed.UserSeedProperty

All Implemented Interfaces:

ExtensionPoint, Describable<UserProperty>, ReconfigurableDescribable<UserProperty>

public class UserSeedProperty
extends UserProperty

The seed stored in this property is used to have a revoke feature on the session without having to hack the session management that depends on the application server used to run the instance. The seed is added to the session when a user just logged in and then for every request, before using the session information, we check the seed was not changed in the meantime. This feature allows the admin to revoke all the sessions that are in the wild without having to keep a list of them.

See Also:

• for the addition of seed inside the session
• for the seed check from the session before using it

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserSeedProperty.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DISABLE_USER_SEED	Escape hatch for User seed based revocation feature.
static boolean	HIDE_USER_SEED_SECTION	Hide the user seed section from the UI to prevent accidental use
static final String	USER_SESSION_SEED

Fields inherited from class hudson.model.UserProperty

user

Method Summary

Modifier and Type	Method	Description
String	getSeed()
void	renewSeed()

Methods inherited from class hudson.model.UserProperty

all, allByCategoryClass, getDescriptor, reconfigure, reconfigure, setUser

Methods inherited from class java.lang.Object

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

Field Details

DISABLE_USER_SEED

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean DISABLE_USER_SEED

Escape hatch for User seed based revocation feature. If we disable the seed, we can still use it to write / store information but not verifying the data using it.

HIDE_USER_SEED_SECTION

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean HIDE_USER_SEED_SECTION

Hide the user seed section from the UI to prevent accidental use

USER_SESSION_SEED

public static final String USER_SESSION_SEED

See Also:

• Constant Field Values

Method Details

getSeed

@NonNull
public String getSeed()

renewSeed

public void renewSeed()