IdentityFile.java

/*
 * Copyright (c) 2002-2018 ymnk, JCraft,Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
 * and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. The names of the authors may not be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 JCRAFT, INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE 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.jcraft.jsch;

class IdentityFile implements Identity {
  private KeyPair kpair;
  private String identity;

  static IdentityFile newInstance(String prvfile, String pubfile, JSch.InstanceLogger instLogger)
      throws JSchException {
    KeyPair kpair = KeyPair.load(instLogger, prvfile, pubfile);
    return new IdentityFile(prvfile, kpair);
  }

  static IdentityFile newInstance(String name, byte[] prvkey, byte[] pubkey,
      JSch.InstanceLogger instLogger) throws JSchException {

    KeyPair kpair = KeyPair.load(instLogger, prvkey, pubkey);
    return new IdentityFile(name, kpair);
  }

  private IdentityFile(String name, KeyPair kpair) {
    this.identity = name;
    this.kpair = kpair;
  }

  /**
   * Decrypts this identity with the specified pass-phrase.
   *
   * @param passphrase the pass-phrase for this identity.
   * @return <code>true</code> if the decryption is succeeded or this identity is not cyphered.
   */
  @Override
  public boolean setPassphrase(byte[] passphrase) throws JSchException {
    return kpair.decrypt(passphrase);
  }

  /**
   * Returns the public-key blob.
   *
   * @return the public-key blob
   */
  @Override
  public byte[] getPublicKeyBlob() {
    return kpair.getPublicKeyBlob();
  }

  /**
   * Signs on data with this identity, and returns the result.
   *
   * @param data data to be signed
   * @return the signature
   */
  @Override
  public byte[] getSignature(byte[] data) {
    return kpair.getSignature(data);
  }

  /**
   * Signs on data with this identity, and returns the result.
   *
   * @param data data to be signed
   * @param alg signature algorithm to use
   * @return the signature
   */
  @Override
  public byte[] getSignature(byte[] data, String alg) {
    return kpair.getSignature(data, alg);
  }

  /**
   * Returns the name of the key algorithm.
   *
   * @return the name of the key algorithm
   */
  @Override
  public String getAlgName() {
    return kpair.getKeyTypeString();
  }

  /**
   * Returns the name of this identity. It will be useful to identify this object in the
   * {@link IdentityRepository}.
   *
   * @return the name of this identity
   */
  @Override
  public String getName() {
    return identity;
  }

  /**
   * Returns <code>true</code> if this identity is cyphered.
   *
   * @return <code>true</code> if this identity is cyphered.
   */
  @Override
  public boolean isEncrypted() {
    return kpair.isEncrypted();
  }

  /** Disposes internally allocated data, like byte array for the private key. */
  @Override
  public void clear() {
    kpair.dispose();
    kpair = null;
  }

  /**
   * Returns an instance of {@link KeyPair} used in this {@link Identity}.
   *
   * @return an instance of {@link KeyPair} used in this {@link Identity}.
   */
  public KeyPair getKeyPair() {
    return kpair;
  }
}