io.github.mmm.crypto.key.store.KeyStoreConfig Maven / Gradle / Ivy

Go to download
package io.github.mmm.crypto.key.store;

import java.util.Locale;
import java.util.Objects;

import io.github.mmm.crypto.io.CryptoResource;
import io.github.mmm.crypto.provider.SecurityProvider;

/**
 * Configuration for {@link KeyStoreFacade}.

 * Additional proprietary configs:
 * 
 * "Windows-MY" / "SunMSCAPI"
 * "KeychainStore" / "Apple"
 * 
 *
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public class KeyStoreConfig {

  private final String type;

  private final SecurityProvider provider;

  private final CryptoResource resource;

  private final String password;

  /**
   * The constructor.
   *
   * @param type the {@link #getType() type}.
   * @param resource the {@link #getResource() resource}.
   * @param password the {@link #getPassword() password}.
   */
  public KeyStoreConfig(String type, CryptoResource resource, String password) {

    this(type, null, resource, password);
  }

  /**
   * The constructor.
   *
   * @param type the {@link #getType() type}.
   * @param provider the {@link SecurityProvider}.
   * @param resource the {@link #getResource() resource}.
   * @param password the {@link #getPassword() password}.
   */
  public KeyStoreConfig(String type, SecurityProvider provider, CryptoResource resource, String password) {

    super();
    Objects.requireNonNull(type, "type");
    Objects.requireNonNull(resource, "resource");
    Objects.requireNonNull(password, "password");
    this.type = type;
    if (provider == null) {
      this.provider = SecurityProvider.DEFAULT;
    } else {
      this.provider = provider;
    }
    this.resource = resource;
    this.password = password;
  }

  /**
   * @return the (default) file extension for the keystore.
   */
  public String getExtension() {

    return "." + this.type.toLowerCase(Locale.US);
  }

  /**
   * @return type the {@link java.security.KeyStore} {@link java.security.KeyStore#getType() type}. For details see the
   *         available sub-classes as well as this overview.
   */
  public String getType() {

    return this.type;
  }

  /**
   * @return the {@link SecurityProvider}.
   */
  public SecurityProvider getProvider() {

    return this.provider;
  }

  /**
   * @return resource the {@link CryptoResource} to read/write the {@link java.security.KeyStore} from/to.
   * @see java.security.KeyStore#load(java.io.InputStream, char[])
   * @see java.security.KeyStore#store(java.io.OutputStream, char[])
   */
  public CryptoResource getResource() {

    return this.resource;
  }

  /**
   * @return the password used to protect the {@link java.security.KeyStore}.
   * @see java.security.KeyStore#load(java.io.InputStream, char[])
   * @see java.security.KeyStore#store(java.io.OutputStream, char[])
   */
  public String getPassword() {

    return this.password;
  }

}