org.jmrtd.protocol.PACECAMResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmrtd Show documentation
Java Machine Readable Travel Documents API.
The newest version!
/*
 * JMRTD - A Java API for accessing machine readable travel documents.
 *
 * Copyright (C) 2006 - 2018  The JMRTD team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * $Id: PACECAMResult.java 1763 2018-02-18 07:41:30Z martijno $
 */

package org.jmrtd.protocol;

import java.security.KeyPair;
import java.security.PublicKey;
import java.util.Arrays;

import org.jmrtd.AccessKeySpec;
import org.jmrtd.lds.PACEInfo.MappingType;

import net.sf.scuba.util.Hex;

/**
 * The result of a PACE-CAM protocol execution.
 *
 * @author The JMRTD team ([email protected])
 *
 * @version $Revision: $
 */
public class PACECAMResult extends PACEResult {

  private static final long serialVersionUID = -4288710920347109329L;

  private byte[] encryptedChipAuthenticationData;

  private byte[] chipAuthenticationData;

  /**
   * Constructs a result.
   *
   * @param paceKey the static PACE key (derived from MRZ, CAN, PIN, or PUK)
   * @param agreementAlg the agreement algorithm that was used
   * @param cipherAlg the cipher algorithm that was used
   * @param digestAlg the digest algorithm that was used
   * @param keyLength the key length that was used
   * @param mappingResult the result from the mapping step
   * @param pcdKeyPair the key-pair generated by the PCD
   * @param piccPublicKey the public key sent by the chip
   * @param encryptedChipAuthenticationData the encrypted Chip Authentication data sent by the PICC
   * @param chipAuthenticationData the decrypted Chip Authentication data
   * @param wrapper the secure messaging wrapper that resulted
   */
  public PACECAMResult(AccessKeySpec paceKey,
      String agreementAlg, String cipherAlg, String digestAlg, int keyLength,
      PACEMappingResult mappingResult,
      KeyPair pcdKeyPair, PublicKey piccPublicKey,
      byte[] encryptedChipAuthenticationData, byte[] chipAuthenticationData, SecureMessagingWrapper wrapper) {
    super(paceKey, MappingType.CAM, agreementAlg, cipherAlg, digestAlg, keyLength, mappingResult, pcdKeyPair, piccPublicKey, wrapper);

    this.encryptedChipAuthenticationData = null;
    if (encryptedChipAuthenticationData != null) {
      this.encryptedChipAuthenticationData = new byte[encryptedChipAuthenticationData.length];
      System.arraycopy(encryptedChipAuthenticationData, 0, this.encryptedChipAuthenticationData, 0, encryptedChipAuthenticationData.length);
    }

    this.chipAuthenticationData = null;
    if (chipAuthenticationData != null) {
      this.chipAuthenticationData = new byte[chipAuthenticationData.length];
      System.arraycopy(chipAuthenticationData, 0, this.chipAuthenticationData, 0, chipAuthenticationData.length);
    }
  }

  /**
   * Returns the encrypted Chip Authentication data.
   *
   * @return the encrypted Chip Authentication data
   */
  public byte[] getEncryptedChipAuthenticationData() {
    if (encryptedChipAuthenticationData == null) {
      return null;
    }

    byte[] result = new byte[encryptedChipAuthenticationData.length];
    System.arraycopy(encryptedChipAuthenticationData, 0, result, 0, encryptedChipAuthenticationData.length);
    return result;
  }

  /**
   * Returns the result of decrypting the encrypted Chip Authentication data.
   *
   * @return the decrypted Chip Authentication data
   */
  public byte[] getChipAuthenticationData() {
    if (chipAuthenticationData == null) {
      return null;
    }

    byte[] result = new byte[chipAuthenticationData.length];
    System.arraycopy(chipAuthenticationData, 0, result, 0, chipAuthenticationData.length);
    return result;
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = super.hashCode();
    result = prime * result + Arrays.hashCode(chipAuthenticationData);
    result = prime * result + Arrays.hashCode(encryptedChipAuthenticationData);
    return result;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (!super.equals(obj)) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }

    PACECAMResult other = (PACECAMResult) obj;
    return Arrays.equals(chipAuthenticationData, other.chipAuthenticationData)
        && Arrays.equals(encryptedChipAuthenticationData, other.encryptedChipAuthenticationData);
  }

  @Override
  public String toString() {
    return new StringBuilder()
        .append("PACECAMResult [")
        .append("paceKey: ").append(getPACEKey()).append(", ")
        .append("mappingType: ").append(getMappingType()).append(", ")
        .append("agreementAlg: ").append(getAgreementAlg()).append(", ")
        .append("cipherAlg: ").append(getCipherAlg()).append(", ")
        .append("digestAlg: ").append(getDigestAlg()).append(", ")
        .append("keyLength: ").append(getKeyLength()).append(", ")
        .append("mappingResult: ").append(getMappingResult()).append(", ")
        .append("pcdKeyPair: ").append(getPCDKeyPair()).append(", ")
        .append("piccPublicKey: ").append(getPICCPublicKey()).append(", ")
        .append("encryptedChipAuthenticationData: ").append(Hex.bytesToHexString(encryptedChipAuthenticationData)).append(", ")
        .append("wrapper: ").append(getWrapper()).append(", ")
        .append("chipAuthenticationData: ").append(Hex.bytesToHexString(chipAuthenticationData))
        .append("]").toString();
  }
}