com.github.javakeyring.Keyring Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-keyring Show documentation
A Java library to store password securely
The newest version!
/*
 * Copyright © 2019, Java Keyring
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the  nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.github.javakeyring;

import com.github.javakeyring.internal.KeyringBackend;
import com.github.javakeyring.internal.KeyringBackendFactory;

/**
 * Keyring.
 */
public class Keyring implements AutoCloseable {

  /**
   * Keyring Storage Back end.
   */
  private final KeyringBackend backend;
  
  /**
   * Creates an instance of Keyring using the a default backed based on operating system.
   * 
   * @return a functional Keyring or a BackendNotSupportedException is thrown.
   * @throws BackendNotSupportedException if the default backend for the operating system is unsupported.
   */
  public static Keyring create() throws BackendNotSupportedException {
    return new Keyring(KeyringBackendFactory.create());
  }

  /**
   * Creates an instance of Keyring with specified backend.
   *
   * @param keyring desired backend.
   * @return a functional Keyring or a BackendNotSupportedException is thrown.
   * @throws BackendNotSupportedException if the default backend for the operating system is unsupported.
   */
  public static Keyring create(KeyringStorageType keyring) throws BackendNotSupportedException {
    return new Keyring(KeyringBackendFactory.create(keyring));
  }

  /**
   * Initializes an instance of Keyring.
   *
   * @param backend Keyring backend instance
   */
  private Keyring(KeyringBackend backend) {
    this.backend = backend;
  }

  public KeyringStorageType getKeyringStorageType() {
    return KeyringStorageType.getLabelForBackend(backend.getClass());
  }

  /**
   * Gets password from key store (Proxy method of KeyringBackend.getPassword).
   *
   * @param service
   *          Service name
   * @param account
   *          Account name
   *
   * @return Password related to specified service and account
   *
   * @throws PasswordAccessException
   *           Thrown when an error happened while getting password
   */
  public String getPassword(String service, String account) throws PasswordAccessException {
    return backend.getPassword(service, account);
  }

  /**
   * Sets password to key store (Proxy method of KeyringBackend.setPassword)
   *
   * @param service
   *          Service name
   * @param account
   *          Account name
   * @param password
   *          Password
   *
   * @throws PasswordAccessException
   *           Thrown when an error happened while saving the password
   */
  public void setPassword(String service, String account, String password) throws PasswordAccessException {
    backend.setPassword(service, account, password);
  }
  
  /**
   * Sets password to key store (Proxy method of KeyringBackend.setPassword)
   *
   * @param service
   *          Service name
   * @param account
   *          Account name
   *
   * @throws PasswordAccessException
   *           Thrown when an error happened while saving the password
   */
  public void deletePassword(String service, String account) throws PasswordAccessException {
    backend.deletePassword(service, account);
  }

  /**
   * Closes resources used by the backend.
   *
   * @throws Exception
   *           Thrown if the backend can not be closed
   */
  @Override
  public void close() throws Exception {
    backend.close();
  }
}