org.eclipse.keyple.card.calypso.CommandSvGet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of keyple-card-calypso-java-lib Show documentation
Keyple add-on to manage Calypso cards
There is a newer version: 3.1.5
Show newest version
/* **************************************************************************************
 * Copyright (c) 2020 Calypso Networks Association https://calypsonet.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.card.calypso;

import static org.eclipse.keyple.card.calypso.DtoAdapters.*;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.keyple.core.util.ApduUtil;
import org.eclipse.keyple.core.util.ByteArrayUtil;
import org.eclipse.keypop.calypso.card.transaction.SvOperation;
import org.eclipse.keypop.card.ApduResponseApi;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Builds the SV Get command.
 *
 * @since 2.0.1
 */
final class CommandSvGet extends Command {

  private static final Logger logger = LoggerFactory.getLogger(CommandSvGet.class);

  private static final Map STATUS_TABLE;

  static {
    Map m = new HashMap<>(Command.STATUS_TABLE);
    m.put(
        0x6982,
        new StatusProperties(
            "Security conditions not fulfilled", CardSecurityContextException.class));
    m.put(
        0x6985,
        new StatusProperties(
            "Preconditions not satisfied (a store value operation was already done in the current session)",
            CardAccessForbiddenException.class));
    m.put(0x6A81, new StatusProperties("Incorrect P1 or P2", CardIllegalParameterException.class));
    m.put(
        0x6A86,
        new StatusProperties("Le inconsistent with P2", CardIllegalParameterException.class));
    m.put(
        0x6D00,
        new StatusProperties("SV function not present", CardIllegalParameterException.class));
    STATUS_TABLE = m;
  }

  private final byte[] header;

  /**
   * Instantiates a new CommandSvGet.
   *
   * @param transactionContext The global transaction context common to all commands.
   * @param commandContext The local command context specific to each command.
   * @param svOperation the desired SV operation.
   * @param useExtendedMode True if the extended mode must be used.
   * @throws IllegalArgumentException If the command is inconsistent
   * @since 2.3.2
   */
  CommandSvGet(
      TransactionContextDto transactionContext,
      CommandContextDto commandContext,
      SvOperation svOperation,
      boolean useExtendedMode) {

    super(
        CardCommandRef.SV_GET,
        computeLe(svOperation, useExtendedMode),
        transactionContext,
        commandContext);

    byte cla =
        transactionContext.getCard().getCardClass() == CalypsoCardClass.LEGACY
            ? CalypsoCardClass.LEGACY_STORED_VALUE.getValue()
            : CalypsoCardClass.ISO.getValue();

    byte p1 = useExtendedMode ? (byte) 0x01 : (byte) 0x00;
    byte p2 = svOperation == SvOperation.RELOAD ? (byte) 0x07 : (byte) 0x09;

    setApduRequest(
        new ApduRequestAdapter(
            ApduUtil.build(
                cla, getCommandRef().getInstructionByte(), p1, p2, null, (byte) getLe())));

    if (logger.isDebugEnabled()) {
      addSubName("operation: " + svOperation.toString());
    }

    header = new byte[4];
    header[0] = getCommandRef().getInstructionByte();
    header[1] = p1;
    header[2] = p2;
    header[3] = (byte) getLe();
  }

  private static int computeLe(SvOperation svOperation, boolean useExtendedMode) {
    if (useExtendedMode) {
      return 0x3D;
    } else {
      return svOperation == SvOperation.RELOAD ? 0x21 : 0x1E;
    }
  }

  /**
   * {@inheritDoc}
   *
   * @since 2.3.2
   */
  @Override
  void finalizeRequest() {
    encryptRequestAndUpdateTerminalSessionMacIfNeeded();
  }

  /**
   * {@inheritDoc}
   *
   * @since 2.3.2
   */
  @Override
  boolean isCryptoServiceRequiredToFinalizeRequest() {
    return getCommandContext().isEncryptionActive();
  }

  /**
   * {@inheritDoc}
   *
   * @since 2.3.2
   */
  @Override
  boolean synchronizeCryptoServiceBeforeCardProcessing() {
    return false;
  }

  /**
   * {@inheritDoc}
   *
   * @since 2.3.2
   */
  @Override
  void parseResponse(ApduResponseApi apduResponse) throws CardCommandException {
    decryptResponseAndUpdateTerminalSessionMacIfNeeded(apduResponse);
    super.setApduResponseAndCheckStatus(apduResponse);
    byte[] cardResponse = apduResponse.getDataOut();
    byte currentKvc;
    int transactionNumber;
    int balance;
    byte[] loadLog;
    byte[] debitLog;
    switch (cardResponse.length) {
      case 0x21: /* Compatibility mode, Reload */
      case 0x1E: /* Compatibility mode, Debit or Undebit */
        currentKvc = cardResponse[0];
        transactionNumber = ByteArrayUtil.extractInt(cardResponse, 1, 2, false);
        balance = ByteArrayUtil.extractInt(cardResponse, 8, 3, true);
        if (cardResponse.length == 0x21) {
          /* Reload */
          loadLog = Arrays.copyOfRange(cardResponse, 11, cardResponse.length);
          debitLog = null;
        } else {
          /* Debit */
          loadLog = null;
          debitLog = Arrays.copyOfRange(cardResponse, 11, cardResponse.length);
        }
        break;
      case 0x3D: /* Revision 3.2 mode */
        currentKvc = cardResponse[8];
        transactionNumber = ByteArrayUtil.extractInt(cardResponse, 9, 2, false);
        balance = ByteArrayUtil.extractInt(cardResponse, 17, 3, true);
        loadLog = Arrays.copyOfRange(cardResponse, 20, 42);
        debitLog = Arrays.copyOfRange(cardResponse, 42, cardResponse.length);
        break;
      default:
        throw new IllegalStateException("Incorrect data length in response to SVGet");
    }
    CalypsoCardAdapter calypsoCard = getTransactionContext().getCard();
    calypsoCard.setSvData(currentKvc, header, apduResponse.getApdu(), balance, transactionNumber);
    if (loadLog != null) {
      calypsoCard.addCyclicContent(CalypsoCardConstant.SV_RELOAD_LOG_FILE_SFI, loadLog);
    }
    if (debitLog != null) {
      calypsoCard.addCyclicContent(CalypsoCardConstant.SV_DEBIT_LOG_FILE_SFI, debitLog);
    }
    updateTerminalSessionIfNeeded();
  }

  /**
   * {@inheritDoc}
   *
   * @since 2.0.1
   */
  @Override
  Map getStatusTable() {
    return STATUS_TABLE;
  }
}