com.google.gerrit.server.securestore

Class SecureStore

java.lang.Object

com.google.gerrit.server.securestore.SecureStore

Direct Known Subclasses:

DefaultSecureStore

public abstract class SecureStore
extends java.lang.Object

Abstract class for providing new SecureStore implementation for Gerrit.

SecureStore is responsible for storing sensitive data like passwords in a secure manner.

It is implementator's responsibility to encrypt and store values.

To deploy new SecureStore one needs to provide a jar file with explicitly one class that extends SecureStore and put it in Gerrit server. Then run:

`java -jar gerrit.war SwitchSecureStore -d $gerrit_site --new-secure-store-lib $path_to_new_secure_store.jar`

on stopped Gerrit instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecureStore.EntryKey Describes SecureStore entry

Constructor Summary

Constructors

Constructor and Description
SecureStore()

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String section, java.lang.String subsection, java.lang.String name) Extract decrypted value of stored property from SecureStore or null when property was not found.
java.lang.String	getForPlugin(java.lang.String pluginName, java.lang.String section, java.lang.String subsection, java.lang.String name) Extract decrypted value of stored plugin config property from SecureStore or null when property was not found.
abstract java.lang.String[]	getList(java.lang.String section, java.lang.String subsection, java.lang.String name) Extract list of values from SecureStore and decrypt every value in that list or null when property was not found.
abstract java.lang.String[]	getListForPlugin(java.lang.String pluginName, java.lang.String section, java.lang.String subsection, java.lang.String name) Extract list of plugin config values from SecureStore and decrypt every value in that list, or null when property was not found.
abstract boolean	isOutdated()
abstract java.lang.Iterable<SecureStore.EntryKey>	list()
abstract void	reload() Reload the values
void	set(java.lang.String section, java.lang.String subsection, java.lang.String name, java.lang.String value) Store single value in SecureStore.
abstract void	setList(java.lang.String section, java.lang.String subsection, java.lang.String name, java.util.List<java.lang.String> values) Store list of values in SecureStore.
abstract void	unset(java.lang.String section, java.lang.String subsection, java.lang.String name) Remove value for given section, subsection and name from SecureStore.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecureStore

public SecureStore()

Method Detail

get

public final java.lang.String get(java.lang.String section,
                                  java.lang.String subsection,
                                  java.lang.String name)

Extract decrypted value of stored property from SecureStore or null when property was not found.

Parameters:

section -

subsection -

name -

Returns:

decrypted String value or null if not found

getForPlugin

public final java.lang.String getForPlugin(java.lang.String pluginName,
                                           java.lang.String section,
                                           java.lang.String subsection,
                                           java.lang.String name)

Extract decrypted value of stored plugin config property from SecureStore or null when property was not found.

Parameters:

pluginName -

section -

subsection -

name -

Returns:

decrypted String value or null if not found

getListForPlugin

public abstract java.lang.String[] getListForPlugin(java.lang.String pluginName,
                                                    java.lang.String section,
                                                    java.lang.String subsection,
                                                    java.lang.String name)

Extract list of plugin config values from SecureStore and decrypt every value in that list, or null when property was not found.

Parameters:

pluginName -

section -

subsection -

name -

Returns:

decrypted list of string values or null

getList

public abstract java.lang.String[] getList(java.lang.String section,
                                           java.lang.String subsection,
                                           java.lang.String name)

Extract list of values from SecureStore and decrypt every value in that list or null when property was not found.

Parameters:

section -

subsection -

name -

Returns:

decrypted list of string values or null

set

public final void set(java.lang.String section,
                      java.lang.String subsection,
                      java.lang.String name,
                      java.lang.String value)

Store single value in SecureStore.

This method is responsible for encrypting value and storing it.

Parameters:

section -

subsection -

name -

value - plain text value

setList

public abstract void setList(java.lang.String section,
                             java.lang.String subsection,
                             java.lang.String name,
                             java.util.List<java.lang.String> values)

Store list of values in SecureStore.

This method is responsible for encrypting all values in the list and storing them.

Parameters:

section -

subsection -

name -

values - list of plain text values

unset

public abstract void unset(java.lang.String section,
                           java.lang.String subsection,
                           java.lang.String name)

Remove value for given section, subsection and name from SecureStore.

Parameters:

section -

subsection -

name -

list

public abstract java.lang.Iterable<SecureStore.EntryKey> list()

Returns:

list of stored entries.

isOutdated

public abstract boolean isOutdated()

Returns:

true if currently loaded values are outdated

reload

public abstract void reload()

Reload the values