Class BasicKeystoreKeyStrategyTool

java.lang.Object
net.shibboleth.utilities.java.support.security.BasicKeystoreKeyStrategyTool

public class BasicKeystoreKeyStrategyTool
extends Object
Implements a tool for managing secret keys in accordance with the BasicKeystoreKeyStrategy.
  • Field Details

  • Constructor Details

    • BasicKeystoreKeyStrategyTool

      public BasicKeystoreKeyStrategyTool()
      Constructor.
  • Method Details

    • setKeyType

      public void setKeyType​(@Nonnull @NotEmpty String type)
      Set the type of key that will be generated. Defaults to AES.
      Parameters:
      type - type of key that will be generated
    • setKeySize

      public void setKeySize​(@Positive int size)
      Set the size of the generated key. Defaults to 128
      Parameters:
      size - size of the generated key
    • setKeyAlias

      public void setKeyAlias​(@Nonnull @NotEmpty String alias)
      Set the encryption key alias base name.
      Parameters:
      alias - the encryption key alias base
    • setKeyCount

      public void setKeyCount​(@Positive int count)
      Set the number of keys to maintain. Defaults to 30.
      Parameters:
      count - number of keys to maintain
    • setKeystoreType

      public void setKeystoreType​(@Nonnull @NotEmpty String type)
      Set the type of keystore to create. Defaults to JCEKS.
      Parameters:
      type - keystore type
    • setKeystoreFile

      public void setKeystoreFile​(@Nonnull File file)
      Set the keystore file to create or modify.
      Parameters:
      file - keystore file
    • setKeystorePassword

      public void setKeystorePassword​(@Nullable String password)
      Set the password for the keystore.
      Parameters:
      password - password for the keystore
    • setVersionFile

      public void setVersionFile​(@Nonnull File file)
      Set the key versioning file to create or modify.
      Parameters:
      file - key versioning file
    • changeKey

      public void changeKey() throws Exception
      The main routine.
      Throws:
      Exception - if an error occurs
    • main

      public static void main​(@Nonnull String[] args) throws Exception
      Command line entry point.
      Parameters:
      args - command line arguments
      Throws:
      Exception - if something goes wrong