如何获取JavaCard剩余空间

0x01应用场景

获取JavaCard卡内剩余空间，一方面是在评估一张卡的时候需要用到，另一方面是在应用个人化或者运行时需要用到。

例如：应用提供商为了保证自己的应用在卡内运行期间能够不受空间影响，一般会在个人化(安装应用)的时候先分配好需要用到的空间，以免空间被后来应用占用，导致运行失败。

0x02空间类型

卡内剩余空间包括获取卡内的剩余永久存储器(E2P or Flash），还有获取易失性存储器空间(RAM)，这里的RAM分为两部分，一部分是在卡片复位时清零的内存CLEAR_ON_RESET，缩写为COR或者RTR(Clear_on_Reset Transient RAM)；另一部分为应用在取消选择的时候清零的内存CLEAR_ON_DESELECT，缩写为COD或者DTR（Clear_on_Deselect Transient RAM）。本文将通过实例获取卡内的这三种存储器剩余空间。

0x03获取接口

对于获取JavaCard内可用空间，API提供了相应的接口JCSystem.getAvaliableMemory(byte memoryType) ，位于javacard.framework包下，如下所示，引用自JCAPI v2.2.2。

getAvailableMemory

public static short getAvailableMemory(byte memoryType)
                                throws SystemException

Obtains the amount of memory of the specified type that is available to the applet. Note that implementation-dependent memory overhead structures may also use the same memory pool.

Notes:

• The number of bytes returned is only an upper bound on the amount of memory available due to overhead requirements.
• Allocation of CLEAR_ON_RESET transient objects may affect the amount of CLEAR_ON_DESELECT transient memory available.
• Allocation of CLEAR_ON_DESELECT transient objects may affect the amount of CLEAR_ON_RESET transient memory available.
• If the number of available bytes is greater than 32767, then this method returns 32767.
• The returned count is not an indicator of the size of object which may be created since memory fragmentation is possible.

Parameters:

memoryType - the type of memory being queried. One of the MEMORY_TYPE_* constants defined above. See MEMORY_TYPE_PERSISTENT.

Returns:

the upper bound on available bytes of memory for the specified type

Throws:

SystemException - with the following reason codes:

• SystemException.ILLEGAL_VALUE if memoryType is not a valid memory type.

根据接口描述，如果可用字节数超过32767(0x3FFF)，则只返回32767。那如何返回超过32767的空间，可参考本文后面的代码实例。

0x04代码实例

1.获取DTR剩余空间

     /**
      * 获取剩余MEMORY_TYPE_TRANSIENT_DESELECT空间
      * @return
      */
     public int getFreeDTR(){
         //首先取得剩余空间大小
         short memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_DESELECT);
         int allmemsize = memsize;
         //如果返回值为0x3FFF，则剩余空间大于此值，可继续取得剩余空间
         while(memsize == (short)32767){
             JCSystem.makeTransientByteArray(memsize,JCSystem.MEMORY_TYPE_TRANSIENT_DESELECT);//不存储返回的数组对象
             memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_DESELECT);
             allmemsize += memsize;
         }
         return allmemsize;
     }

 2.获取RTR剩余空间

     /**
      * 获取剩余的MEMORY_TYPE_TRANSIENT_RESET空间
      * @return
      */
     public int getFreeRTR(){
         //首先取得剩余空间大小
         short memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_RESET);
         int allmemsize = memsize;
         //如果返回值为0x3FFF，则剩余空间大于此值，可继续取得剩余空间
         while(memsize == (short)32767){
             JCSystem.makeTransientByteArray(memsize,JCSystem.MEMORY_TYPE_TRANSIENT_RESET);//不存储返回的数组对象
             memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_RESET);
             allmemsize += memsize;
         }
         return allmemsize;
     }

 3.获取E2P/Flash的剩余空间

     /**
      * 获取剩余的E2P/Flash空间，如果剩余空间大于0x3FFF，则此接口将创建数组，然后再获取新的剩余空间，
      * 数组对象头将占用几个字节(根据对象存储结构不一样，可能占用字节数不同，一般数组头为7字节)，因此存在误差。
      * @return
      */
     public int getFreePersistent(){
         //首先取得剩余空间大小
         short memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_PERSISTENT);
         int allmemsize = memsize;
         //如果返回值为0x3FFF，则剩余空间大于此值，可继续取得剩余空间
         while(memsize == (short)32767){
             byte[] tmp=new byte[memsize]; //不存储返回的数组对象
             memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_PERSISTENT);
             allmemsize += memsize;
         }
         return allmemsize;
     }

注意

1.获取剩余空间的应用自身的代码需要占用部分空间，本例中的应用代码主468字节，存储在卡内空间为 278 字节.

2.DTR与RTR可能使用同一块区域。

3.以上代码在使用converter转成cap文件时需要加上支持int类型的选项，如果卡片本身不支持int，则代码中相应的地方需要做调整，譬如说如果卡内相应存储器空间大于0x3FFF时，可以将每次取得的值存储在apdubuffer中，一起返回到卡外，然后再计算。

完整代码

 package GetFreeSpacePkg;

 import javacard.framework.APDU;
 import javacard.framework.ISO7816;
 import javacard.framework.Applet;
 import javacard.framework.ISOException;
 import javacard.framework.JCSystem;

 /**
  * 获取卡内剩余空间，包括E2P/Flash与RAM.
  * 对于E2P/Flash来说，如果卡内剩余空间超过0x3FFF，则此应用返回的数据会有较小的误差。
  * 测试命令：
  *
  * 8000000000 //get DTR
  * 8001000000 //get RTR
  * 8002000000 //get E2P/Flash
  *
  * @author SCPlatform@outlook.com
  */
 public class GetFreeSpaceApplet extends Applet {
     public static void install(byte[] bArray, short bOffset, byte bLength) {
         new GetFreeSpaceApplet().register(bArray, (short) (bOffset + 1),bArray[bOffset]);
     }

     public void process(APDU apdu) {
         if (selectingApplet()) {
             return;
         }

         byte[] buf = apdu.getBuffer();
         int iFreeSpace=0;
         switch (buf[ISO7816.OFFSET_INS]) {
         case (byte) 0x00://DTR
             iFreeSpace = getFreeDTR();
             break;
         case (byte) 0x01://RTR
             iFreeSpace = getFreeRTR();
             break;
         case (byte) 0x02://persistent
             iFreeSpace = getFreePersistent();
             break;
         default:
             ISOException.throwIt(ISO7816.SW_INS_NOT_SUPPORTED);
         }
         JCSystem.requestObjectDeletion();
         buf[3]=(byte)(iFreeSpace);
         buf[2]=(byte)(iFreeSpace>>8);
         buf[1]=(byte)(iFreeSpace>>16);
         buf[0]=(byte)(iFreeSpace>>24);
         apdu.setOutgoingAndSend((short)0, (short)4);
     }
     /**
      * 获取剩余MEMORY_TYPE_TRANSIENT_DESELECT空间
      * @return
      */
     public int getFreeDTR(){
         //首先取得剩余空间大小
         short memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_DESELECT);
         int allmemsize = memsize;
         //如果返回值为0x3FFF，则剩余空间大于此值，可继续取得剩余空间
         while(memsize == (short)32767){
             JCSystem.makeTransientByteArray(memsize,JCSystem.MEMORY_TYPE_TRANSIENT_DESELECT);//不存储返回的数组对象
             memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_DESELECT);
             allmemsize += memsize;
         }
         return allmemsize;
     }

     /**
      * 获取剩余的MEMORY_TYPE_TRANSIENT_RESET空间
      * @return
      */
     public int getFreeRTR(){
         //首先取得剩余空间大小
         short memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_RESET);
         int allmemsize = memsize;
         //如果返回值为0x3FFF，则剩余空间大于此值，可继续取得剩余空间
         while(memsize == (short)32767){
             JCSystem.makeTransientByteArray(memsize,JCSystem.MEMORY_TYPE_TRANSIENT_RESET);//不存储返回的数组对象
             memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_TRANSIENT_RESET);
             allmemsize += memsize;
         }
         return allmemsize;
     }

     /**
      * 获取剩余的E2P/Flash空间，如果剩余空间大于0x3FFF，则此接口将创建数组，然后再获取新的剩余空间，
      * 数组对象头将占用几个字节(根据对象存储结构不一样，可能占用字节数不同，一般数组头为7字节)，因此存在误差。
      * @return
      */
     public int getFreePersistent(){
         //首先取得剩余空间大小
         short memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_PERSISTENT);
         int allmemsize = memsize;
         //如果返回值为0x3FFF，则剩余空间大于此值，可继续取得剩余空间
         while(memsize == (short)32767){
             byte[] tmp=new byte[memsize]; //不存储返回的数组对象
             memsize = JCSystem.getAvailableMemory(JCSystem.MEMORY_TYPE_PERSISTENT);
             allmemsize += memsize;
         }
         return allmemsize;
     }
 }

0x05资料参考

1.Application Programming Interface Java Card™ Platform, Version 2.2.2