org.jmrtd.protocol.SecureMessagingWrapper 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.
There is a newer version: 0.7.42
/*
 * 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: SecureMessagingWrapper.java 1763 2018-02-18 07:41:30Z martijno $
 */

package org.jmrtd.protocol;

import java.io.Serializable;

import javax.crypto.SecretKey;

import net.sf.scuba.smartcards.APDUWrapper;

/**
 * Secure messaging wrapper base class.
 *
 * @author The JMRTD team
 *
 * @version $Revision: 1763 $
 */
public abstract class SecureMessagingWrapper implements Serializable, APDUWrapper {

  private static final long serialVersionUID = 4709645514566992414L;

  private int maxTranceiveLength;

  private boolean shouldCheckMAC;

  /**
   * Creates a secure messaging wrapper.
   *
   * @param maxTranceiveLength  Returns the maximum tranceive length of wrapped command and response APDUs, typical values are 256 and 65536
   * @param shouldCheckMAC a boolean indicating whether this wrapper will check the MAC in wrapped response APDUs
   */
  public SecureMessagingWrapper(int maxTranceiveLength, boolean shouldCheckMAC) {
    this.maxTranceiveLength = maxTranceiveLength;
    this.shouldCheckMAC = shouldCheckMAC;
  }

  /**
   * Gets the send sequence counter.
   *
   * @return the send sequence counter
   */
  public abstract long getSendSequenceCounter();

  /**
   * Gets the shared key for encrypting APDU payloads.
   *
   * @return the encryption key
   */
  public abstract SecretKey getEncryptionKey();

  /**
   * Get the shared key for computing message authentication codes over APDU payloads.
   *
   * @return the MAC key
   */
  public abstract SecretKey getMACKey();

  /**
   * Returns a boolean indicating whether this wrapper will check the MAC in wrapped response APDUs.
   *
   * @return a boolean indicating whether this wrapper will check the MAC in wrapped response APDUs
   */
  public boolean shouldCheckMAC() {
    return shouldCheckMAC;
  }

  /**
   * Returns the maximum tranceive length of wrapped command and response APDUs,
   * typical values are 256 and 65536.
   *
   * @return the maximum tranceive length of wrapped command and response APDUs
   */
  public int getMaxTranceiveLength() {
    return maxTranceiveLength;
  }
}