Package jenkins.security

Class DefaultConfidentialStore

java.lang.Object

jenkins.security.ConfidentialStore

jenkins.security.DefaultConfidentialStore

public class DefaultConfidentialStore
extends ConfidentialStore

Default portable implementation of ConfidentialStore that uses a directory inside $JENKINS_HOME.

The master key is stored by default in $JENKINS_HOME/secrets/master.key but another location can be provided using the system property jenkins.security.DefaultConfidentialStore.file.

It is also possible to prevent the generation of the master key file using the system property jenkins.security.DefaultConfidentialStore.readOnly. In this case, the master key file must be provided or startup will fail.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class jenkins.security.ConfidentialStore

ConfidentialStore.Mock

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultConfidentialStore()
	DefaultConfidentialStore(File rootDir)
protected	DefaultConfidentialStore(File rootDir, File keyFile)

Method Summary

Modifier and Type	Method	Description
protected byte[]	load(ConfidentialKey key)	Reverse operation of store(ConfidentialKey, byte[])
byte[]	randomBytes(int size)	Works like SecureRandom.nextBytes(byte[]).
protected void	store(ConfidentialKey key, byte[] payload)	Persists the payload of ConfidentialKey to the disk.

Methods inherited from class jenkins.security.ConfidentialStore

get

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultConfidentialStore

public DefaultConfidentialStore()
                         throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

DefaultConfidentialStore

public DefaultConfidentialStore(File rootDir)
                         throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

DefaultConfidentialStore

protected DefaultConfidentialStore(File rootDir,
 File keyFile)
                            throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

Method Details

store

protected void store(ConfidentialKey key,
 byte[] payload)
              throws IOException

Persists the payload of ConfidentialKey to the disk.

Specified by:

store in class ConfidentialStore

Throws:

IOException

load

protected byte[] load(ConfidentialKey key)
               throws IOException

Reverse operation of store(ConfidentialKey, byte[])

Specified by:

load in class ConfidentialStore

Returns:

null the data has not been previously persisted.

Throws:

IOException

randomBytes

public byte[] randomBytes(int size)

Description copied from class: ConfidentialStore

Works like SecureRandom.nextBytes(byte[]). This enables implementations to consult other entropy sources, if it's available.

Specified by:

randomBytes in class ConfidentialStore