Package org.oa4mp.server.admin.oauth2.tools

Class KeyCommands

java.lang.Object

edu.uiuc.ncsa.security.util.cli.AbstractCommandsImpl

edu.uiuc.ncsa.security.util.cli.CommonCommands2

edu.uiuc.ncsa.security.storage.cli.StoreCommands2

org.oa4mp.server.admin.oauth2.base.OA4MPStoreCommands

org.oa4mp.server.admin.oauth2.tools.KeyCommands

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.Logable, edu.uiuc.ncsa.security.util.cli.Commands, Serializable

public class KeyCommands
extends OA4MPStoreCommands

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

edu.uiuc.ncsa.security.storage.cli.StoreCommands2.ChangeIDRecord, edu.uiuc.ncsa.security.storage.cli.StoreCommands2.RSRecord

Field Summary

Fields

Modifier and Type	Field	Description
static String	CREATE_KEYS_CURVE
static int	CREATE_KEYS_DEFAULT_SIZE
static String	CREATE_KEYS_SIZE
static String	CREATE_KEYS_TYPE
static String	CURRENT_EXP_FLAG
static String	CURRENT_SIGNING_KEYS
static String	CURRENT_VALID_FLAG
static String	DEFAULT_SERVER_VI
static String	KEY_ROTATION_SYSTEM_CFG
static String	KR_ALL
static String	KR_AT_LIFETIME
static String	KR_CACHE_LIFETIME
static String	KR_FORCE_FLAG
static String	KR_KID
static String	KR_TEST_FLAG
static String	KR_VI
static String	MIGRATE_ALL_VIS
static String	MIGRATE_CLEANUP
static String	MIGRATE_LIST
static String	MIGRATE_SERVER_KEYS
static String	SET_EXP
static String	SET_IAT
static String	SET_NBF

Fields inherited from class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

ALL_LIST_COMMAND, allEntries, DEFAULT_MAGIC_NUMBER, display_width, FILE_FLAG, FORCE_COPY_FLAG, KEY_SHORTHAND_PREFIX, LINE_LIST_COMMAND, LIST_EOL_MARKER, LOAD_ONLY_COMMAND, NEXT_N_COMMAND, RANDOM_ID_FLAG, RESULT_SET_KEY, resultSets, RM_FORCE_FLAG, RS_APPEND_ACTION, RS_CLEAR_ACTION, RS_DROP_ACTION, RS_FIELDS_ACTION, RS_FILE_KEY, RS_LIST_ACTION, RS_RANGE_KEY, RS_RANGE_SHORT_KEY, RS_READ_ACTION, RS_REMOVE_ACTION, RS_SAVE_ACTION, RS_SHOW_ACTION, RS_SIZE_ACTION, RS_SUBSET_ACTION, RS_WRITE_ACTION, SEARCH_AFTER_TS_FLAG, SEARCH_BEFORE_TS_FLAG, SEARCH_DATE_FLAG, SEARCH_DEBUG_FLAG, SEARCH_IS_NULL_FLAG, SEARCH_REGEX_FLAG, SEARCH_RESULT_SET_NAME, SEARCH_RETURNED_ATTRIBUTES_FLAG, SEARCH_SHORT_REGEX_FLAG, SEARCH_SIZE_FLAG, SEARCH_VERSIONS_FALSE_VALUE, SEARCH_VERSIONS_FLAG, SEARCH_VERSIONS_ONLY_VALUE, SEARCH_VERSIONS_TRUE_VALUE, SHORT_UPDATE_FLAG, SHOW_HEADER, SHOW_VERSIONS_LIST_COMMAND, SIZE_ALL_FLAG, SIZE_VERSIONS_FLAG, SKIP_UPDATE_PERMISSIONS_FLAG, sortable, STILE, UPDATE_FLAG, UPKEEP_FLAG_CFG, UPKEEP_FLAG_ENABLE, UPKEEP_FLAG_RUN, UPKEEP_FLAG_SHOW, UPKEEP_FLAG_TEST, VERBOSE_COMMAND

Fields inherited from class edu.uiuc.ncsa.security.util.cli.CommonCommands2

placeHolder

Fields inherited from class edu.uiuc.ncsa.security.util.cli.AbstractCommandsImpl

CL_INPUT_FILE_FLAG, CL_OUTPUT_FILE_FLAG, DEFAULT_NULL_VALUE_PLACEHOLDER, defaultIndent, INDENT, LOGO, logoName, NO_HEADER, NO_LOGO, showHeader, showLogo, SILENT

Constructor Summary

Constructors

Constructor	Description
KeyCommands(edu.uiuc.ncsa.security.util.cli.CLIDriver driver, String defaultIndent, OA2SE oa2SE)
KeyCommands(edu.uiuc.ncsa.security.util.cli.CLIDriver driver, OA2SE oa2SE)

Method Summary

Modifier and Type	Method	Description
protected String	columnHeader(int offset, int[] fieldWidths)
void	create_keys(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
int[]	fieldWidths(List<edu.uiuc.ncsa.security.core.Identifiable> identifiables)
protected String	format(edu.uiuc.ncsa.security.core.Identifiable identifiable)
protected String	format(edu.uiuc.ncsa.security.core.Identifiable identifiable, int offset, int[] fieldWidths)
protected void	formatKEC(KEConfiguration keConfiguration)
protected void	formatKEC(VirtualIssuer vi)
void	get_current(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
String	getName()
KEStore<KERecord>	getStore()
void	ls(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
List<edu.uiuc.ncsa.security.core.Identifier>	migrate(edu.uiuc.ncsa.security.storage.cli.FoundIdentifiables foundIdentifiables, boolean removeFromVI)	Migrate a list of VIs keys into the store.
void	migrate(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected void	migrateHelp(edu.uiuc.ncsa.security.util.cli.InputLine line)
void	policy(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected edu.uiuc.ncsa.security.core.Identifiable	preCopy(edu.uiuc.ncsa.security.core.Identifiable x)
protected edu.uiuc.ncsa.security.core.Identifiable	preCreation(edu.uiuc.ncsa.security.core.Identifiable identifiable, int magicNumber)
void	rotate(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected void	rotateHelp(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected void	rotationDefaults()
void	set(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	set_default(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	show(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected void	showCopyHelp()
protected void	showCreateHelp()
protected void	showHelp()
protected void	testBlurb(KERecord keRecord, long cache, long at)
protected int	updateStorePermissions(edu.uiuc.ncsa.security.core.Identifier newID, edu.uiuc.ncsa.security.core.Identifier oldID, boolean copy)

Methods inherited from class org.oa4mp.server.admin.oauth2.base.OA4MPStoreCommands

about, decode, encode, extraUpdates, getEnvironment, getState, initialize, load, printIndexHelp, processList, run_qdl, setState

Methods inherited from class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

actualCreate, addEntry, addEntry, archive, archiveFormat, bootstrap, change_id, clear_id, clear_store, clearEntries, copy, create, create, create, createEntry, deserialize, doChangeID, doCopy, edit, extractRawList, findByIDOrRS, findItem, findItem, findItem, findSingleton, findSingleton, formatCounter, formatLongLine, fromXMLMap, get_id, getAndCheckKeyArg, getArgList, getEditorEntry, getID, getIdentifierfromIndex, getKeyArg, getKeyArg, getKeys, getMapConverter, getMethodName, getPrompt, getResultSets, getSerializationKeys, getSortable, getStoreArchiver, getTempDir, hasEntries, hasId, hasID, hasKey, initHelp, inputJSON, isBadID, isMonitored, list_keys, listEntries, loadAllEntries, loadQDLScript, longFormat, longFormat, longFormat, multiLineInput, multiLinePropertyInput, oldrm, oldUpdate, print_help, printLS, printRS, rangeHelpSnippet, removeEntries, removeEntry, rm, rmCleanup, rs, search, serialize, serialize, set_id, setEnvironment, setID, setIDFromInputLine, setResultSets, setSortable, setStore, showArchiveHelp, showCommandLineSwitchesHelp, showDeserializeHelp, showEntry, showEntrySubset, showKeyShorthandHelp, showListKeysHelp, showLSHelp, showResultSetHelp, showRMHelp, showSearchHelp, showSearchHelpExamples, showSerializeHelp, showSizeHelp, showUpdateHelp, showUpkeepHelp, size, time, toXMLMap, update, update, update, updateSingleValue, updateSingleValue, upkeep

Methods inherited from class edu.uiuc.ncsa.security.util.cli.CommonCommands2

getIOInterface, getPlaceHolder, getValue, isEmpty, isThrowExceptions, isVerbose, say2, sayii, set_output_on, set_verbose_on, setOutputOnHelp, setPlaceHolder, setThrowExceptions, setVerboseHelp, version, versionHelp

Methods inherited from class edu.uiuc.ncsa.security.util.cli.AbstractCommandsImpl

bootstrap, clear_env, clearEnvHelp, configureCommands, debug, error, error, get_env, getDriver, getHelpUtil, getInput, getLogoName, getPropertyHelp, gracefulExit, hasLogger, indentWidth, info, isDebugOn, isOk, isShowHeader, isShowLogo, print_env, printEnvHelp, printGetEnvHelp, printReadEnvHelp, printSaveEnvHelp, printSetEnvHelp, read_env, readJSON, readline, readline, save_env, say, say, sayi, sayv, set_env, setDebugOn, setDriver, setLogoName, setShowHeader, setShowLogo, showHelp, warn

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERVER_VI

public static final String DEFAULT_SERVER_VI

See Also:

Constant Field Values

MIGRATE_LIST

public static final String MIGRATE_LIST

See Also:

Constant Field Values

MIGRATE_ALL_VIS

public static final String MIGRATE_ALL_VIS

See Also:

Constant Field Values

MIGRATE_CLEANUP

public static final String MIGRATE_CLEANUP

See Also:

Constant Field Values

MIGRATE_SERVER_KEYS

public static final String MIGRATE_SERVER_KEYS

See Also:

Constant Field Values

SET_NBF

public static final String SET_NBF

See Also:

Constant Field Values

SET_IAT

public static final String SET_IAT

See Also:

Constant Field Values

SET_EXP

public static final String SET_EXP

See Also:

Constant Field Values

CURRENT_EXP_FLAG

public static String CURRENT_EXP_FLAG

CURRENT_VALID_FLAG

public static String CURRENT_VALID_FLAG

CURRENT_SIGNING_KEYS

public static String CURRENT_SIGNING_KEYS

KR_ALL

public static String KR_ALL

KR_KID

public static String KR_KID

KR_VI

public static String KR_VI

KR_CACHE_LIFETIME

public static String KR_CACHE_LIFETIME

KR_AT_LIFETIME

public static String KR_AT_LIFETIME

KR_FORCE_FLAG

public static String KR_FORCE_FLAG

KR_TEST_FLAG

public static String KR_TEST_FLAG

CREATE_KEYS_CURVE

public static String CREATE_KEYS_CURVE

CREATE_KEYS_TYPE

public static String CREATE_KEYS_TYPE

CREATE_KEYS_SIZE

public static String CREATE_KEYS_SIZE

CREATE_KEYS_DEFAULT_SIZE

public static int CREATE_KEYS_DEFAULT_SIZE

KEY_ROTATION_SYSTEM_CFG

public static final String KEY_ROTATION_SYSTEM_CFG

See Also:

Constant Field Values

Constructor Detail

KeyCommands

public KeyCommands(edu.uiuc.ncsa.security.util.cli.CLIDriver driver,
                   String defaultIndent,
                   OA2SE oa2SE)
            throws Throwable

Throws:

Throwable

KeyCommands

public KeyCommands(edu.uiuc.ncsa.security.util.cli.CLIDriver driver,
                   OA2SE oa2SE)
            throws Throwable

Throws:

Throwable

Method Detail

getStore

public KEStore<KERecord> getStore()

Overrides:

getStore in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

format

protected String format(edu.uiuc.ncsa.security.core.Identifiable identifiable)

Specified by:

format in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

format

protected String format(edu.uiuc.ncsa.security.core.Identifiable identifiable,
                        int offset,
                        int[] fieldWidths)

Overrides:

format in class OA4MPStoreCommands

fieldWidths

public int[] fieldWidths(List<edu.uiuc.ncsa.security.core.Identifiable> identifiables)

Specified by:

fieldWidths in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

columnHeader

protected String columnHeader(int offset,
                              int[] fieldWidths)

Overrides:

columnHeader in class OA4MPStoreCommands

updateStorePermissions

protected int updateStorePermissions(edu.uiuc.ncsa.security.core.Identifier newID,
                                     edu.uiuc.ncsa.security.core.Identifier oldID,
                                     boolean copy)

Specified by:

updateStorePermissions in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

getName

public String getName()

migrate

public List<edu.uiuc.ncsa.security.core.Identifier> migrate(edu.uiuc.ncsa.security.storage.cli.FoundIdentifiables foundIdentifiables,
                                                            boolean removeFromVI)

Migrate a list of VIs keys into the store. Note that if the store contains the given keys already, this will update the records as needed.

Parameters:

foundIdentifiables -

removeFromVI - -- if true, remove the keys in the VI

Returns:

returns list of un-migrated ids

migrateHelp

protected void migrateHelp(edu.uiuc.ncsa.security.util.cli.InputLine line)

migrate

public void migrate(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
             throws Throwable

Throws:

Throwable

set

public void set(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
         throws Throwable

Throws:

Throwable

get_current

public void get_current(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                 throws Throwable

Throws:

Throwable

rotateHelp

protected void rotateHelp(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)

rotate

public void rotate(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
            throws Throwable

Throws:

Throwable

testBlurb

protected void testBlurb(KERecord keRecord,
                         long cache,
                         long at)

create_keys

public void create_keys(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                 throws Throwable

Throws:

Throwable

showHelp

protected void showHelp()

show

public void show(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
          throws Throwable

Throws:

Throwable

policy

public void policy(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
            throws Throwable

Throws:

Throwable

rotationDefaults

protected void rotationDefaults()

formatKEC

protected void formatKEC(KEConfiguration keConfiguration)

formatKEC

protected void formatKEC(VirtualIssuer vi)

ls

public void ls(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
        throws Throwable

Overrides:

ls in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

Throws:

Throwable

set_default

public void set_default(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)

preCreation

protected edu.uiuc.ncsa.security.core.Identifiable preCreation(edu.uiuc.ncsa.security.core.Identifiable identifiable,
                                                               int magicNumber)

Overrides:

preCreation in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

preCopy

protected edu.uiuc.ncsa.security.core.Identifiable preCopy(edu.uiuc.ncsa.security.core.Identifiable x)

Overrides:

preCopy in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

showCreateHelp

protected void showCreateHelp()

Overrides:

showCreateHelp in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

showCopyHelp

protected void showCopyHelp()

Overrides:

showCopyHelp in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2