org.eclipse.keyple.calypso.transaction.CalypsoSam Maven / Gradle / Ivy

Go to download
/* **************************************************************************************
 * Copyright (c) 2019 Calypso Networks Association https://www.calypsonet-asso.org/
 *
 * See the NOTICE file(s) distributed with this work for additional information
 * regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the terms of the
 * Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 ************************************************************************************** */
package org.eclipse.keyple.calypso.transaction;

import static org.eclipse.keyple.calypso.command.sam.SamRevision.*;

import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.keyple.calypso.command.sam.SamRevision;
import org.eclipse.keyple.core.card.message.CardSelectionResponse;
import org.eclipse.keyple.core.card.selection.AbstractSmartCard;
import org.eclipse.keyple.core.util.ByteArrayUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This POJO concentrates all the information we know about the SAM currently selected.
 *
 * An instance of CalypsoSam is obtained by casting the AbstractSmartCard object from the
 * selection process (e.g. (CalypsoSam)(cardSelectionsResult.getActiveSmartCard()))
 *
 * The information on the SAM is extracted from an analysis of the ATR.
 *
 * @since 0.9
 */
public class CalypsoSam extends AbstractSmartCard {
  private static final Logger logger = LoggerFactory.getLogger(CalypsoSam.class);

  private final SamRevision samRevision;
  private final byte[] serialNumber = new byte[4];
  private final byte platform;
  private final byte applicationType;
  private final byte applicationSubType;
  private final byte softwareIssuer;
  private final byte softwareVersion;
  private final byte softwareRevision;

  /**
   * Constructor.
   *
   * @param cardSelectionResponse the selection response from the SAM
   * @since 0.9
   */
  CalypsoSam(CardSelectionResponse cardSelectionResponse) {
    super(cardSelectionResponse);

    String atrString =
        ByteArrayUtil.toHex(cardSelectionResponse.getSelectionStatus().getAtr().getBytes());
    if (atrString.isEmpty()) {
      throw new IllegalStateException("ATR should not be empty.");
    }
    /* extract the historical bytes from T3 to T12 */
    String extractRegex = "3B(.{6}|.{10})805A(.{20})829000";
    Pattern pattern = Pattern.compile(extractRegex); // NOSONAR: hex strings here, regex is safe
    // to use
    Matcher matcher = pattern.matcher(atrString);
    if (matcher.find(0)) {
      byte[] atrSubElements = ByteArrayUtil.fromHex(matcher.group(2));
      platform = atrSubElements[0];
      applicationType = atrSubElements[1];
      applicationSubType = atrSubElements[2];

      // determine SAM revision from Application Subtype
      switch (applicationSubType) {
        case (byte) 0xC1:
          samRevision = C1;
          break;
        case (byte) 0xD0:
        case (byte) 0xD1:
        case (byte) 0xD2:
          samRevision = S1D;
          break;
        case (byte) 0xE1:
          samRevision = S1E;
          break;
        default:
          throw new IllegalStateException(
              String.format(
                  "Unknown SAM revision (unrecognized application subtype 0x%02X)",
                  applicationSubType));
      }

      softwareIssuer = atrSubElements[3];
      softwareVersion = atrSubElements[4];
      softwareRevision = atrSubElements[5];
      System.arraycopy(atrSubElements, 6, serialNumber, 0, 4);
      if (logger.isTraceEnabled()) {
        logger.trace(
            String.format(
                "SAM %s PLATFORM = %02X, APPTYPE = %02X, APPSUBTYPE = %02X, SWISSUER = %02X, SWVERSION = "
                    + "%02X, SWREVISION = %02X",
                samRevision.getName(),
                platform,
                applicationType,
                applicationSubType,
                softwareIssuer,
                softwareVersion,
                softwareRevision));
        logger.trace("SAM SERIALNUMBER = {}", ByteArrayUtil.toHex(serialNumber));
      }
    } else {
      throw new IllegalStateException("Unrecognized ATR structure: " + atrString);
    }
  }

  /**
   * Gets the SAM revision as an enum constant
   *
   * @return An enum entry of {@link SamRevision}
   * @since 0.9
   */
  public final SamRevision getSamRevision() {
    return samRevision;
  }

  /**
   * Gets the SAM serial number as an array of bytes
   *
   * @return A not null array of bytes
   * @since 0.9
   */
  public final byte[] getSerialNumber() {
    return serialNumber;
  }

  /**
   * Gets the platform identifier
   *
   * @return A byte
   * @since 0.9
   */
  public final byte getPlatform() {
    return platform;
  }

  /**
   * Gets the application type
   *
   * @return A byte
   * @since 0.9
   */
  public final byte getApplicationType() {
    return applicationType;
  }

  /**
   * Gets the application subtype
   *
   * @return A byte
   * @since 0.9
   */
  public final byte getApplicationSubType() {
    return applicationSubType;
  }

  /**
   * Gets the software issuer identifier
   *
   * @return A byte
   * @since 0.9
   */
  public final byte getSoftwareIssuer() {
    return softwareIssuer;
  }

  /**
   * Gets the software version number
   *
   * @return A byte
   * @since 0.9
   */
  public final byte getSoftwareVersion() {
    return softwareVersion;
  }

  /**
   * Gets the software revision number
   *
   * @return A byte
   * @since 0.9
   */
  public final byte getSoftwareRevision() {
    return softwareRevision;
  }
}