com.ibm.as400.access.PasswordVault Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
The newest version!
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename:  PasswordVault.java
//
// The source code contained herein is licensed under the IBM Public License
// Version 1.0, which has been approved by the Open Source Initiative.
// Copyright (C) 2009-2009 International Business Machines Corporation and
// others.  All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.access;

import java.io.Serializable;

/**
 * A vault which holds a password for a user profile on an IBM i system.  The password
 * can be used for authenticating to one or more IBM i host servers.
 */
class PasswordVault extends CredentialVault implements Cloneable, Serializable
{
  private static final boolean PASSWORD_TRACE = false;


  /**
   * Constructs a PasswordVault object that does not contain a credential.
   */
  protected PasswordVault() {
    super();
  }

  /**
   * Constructs a PasswordVault object that contains the provided password
   * credential.  The password is stored internally as encoded raw bytes.
   *
   * @param thePassword The password
   */
  /* 
  protected PasswordVault(String thePassword) {
    super();
    encodedCredential_ = store(thePassword);
  }
*/ 
  
  /**
   * Constructs a PasswordVault object that contains the provided password
   * credential.  The password is stored internally as encoded raw bytes.
   * The caller is responsible for clearing the password after the call
   * returns. 
   *
   * @param thePassword The password
   */
  protected PasswordVault(char[] thePassword) {
    super();
    encodedCredential_ = store(thePassword);
  }

  /**
   * Constructs a PasswordVault object that contains the provided password
   * credential.  The password is stored internally as encoded raw bytes.
   *
   * @param rawBytes
   */
  protected PasswordVault(byte[] rawBytes) {
    super();
    encodedCredential_ = store(rawBytes);
  }

  /**
   * Returns a copy of this PasswordVault.  The new copy will be
   * an exact copy of this vault, which means the new copy will
   * contain the same encoded password credential as this vault.
   *
   * @return A newly created PasswordVault that is a copy of this one
   */
  public PasswordVault clone() {
    PasswordVault vaultClone = (PasswordVault)super.clone();
    return vaultClone;
  }

  /**
   * {@inheritDoc}
   */
  protected int getType() {
    return AS400.AUTHENTICATION_SCHEME_PASSWORD;
  }

  /**
   * Encodes the String credential using the parent class encode method.
   * The credential string is converted into an array of bytes
   * and, using this representation, is encoded and stored internally.
   *
   * @param credential The credential to encode
   * @return The encoded credential
   */
  /*
  private byte[] store(String credential)
  {
    if (PASSWORD_TRACE)
    {
      Trace.log(Trace.DIAGNOSTIC, "AS400 object store, password: '" + credential + "'");
    }
    if (AS400.onAS400) {
      if (credential.equalsIgnoreCase("*CURRENT") ||
          credential.equals("")) {
        return null;
      }
    }

    return super.store(BinaryConverter.charArrayToByteArray(credential.toCharArray()));
  }
  */ 

    /**
   * Encodes the String credential using the parent class encode method.
   * The credential string is converted into an array of bytes
   * and, using this representation, is encoded and stored internally.
   *
   * @param credential The credential to encode
   * @return The encoded credential
   */
  private byte[] store(char[] credential)
  {
    if (PASSWORD_TRACE)
    {
      Trace.log(Trace.DIAGNOSTIC, "AS400 object store, password: '" + credential + "'");
    }
    if (AS400.onAS400) {
      if (credential.length == 0) {
        return null; 
      }
      if (CredentialVault.isStarCurrent(credential)) {
        return null ;
            
      }
    }
    byte[] bytes = BinaryConverter.charArrayToByteArray(credential);
    byte[] encodedCredential =  super.store(bytes);
    clearArray(bytes);           /* Clear the bytes so the password isn't visible in memory */ 
    return encodedCredential; 
  }

 


}