Helper.java

/*
 ***************************************************************************
 * File: Helper.java
 ***************************************************************************
 ***************************************************************************
 * This file demonstrates the following common functions shared by other samples
 * 1. Initialization library
 * 2. Startup session
 * 3. Close down session
 * 4. Create key
 * 5. Create Key Object
 * 6. Find Key by Name
 * 7. Find Vormetric PKCS11 library path
 */

import java.io.*;
import java.security.*;
import sun.security.pkcs11.wrapper.*;
import static sun.security.pkcs11.wrapper.PKCS11Constants.*;
import sun.security.pkcs11.Secmod.*;
import java.util.Arrays;


class Vpkcs11Session {
   public PKCS11 p11;
   long   sessionHandle;
}

public class Helper {
    public static final String UnixInstallPath = "/opt/vormetric/DataSecurityExpert/agent/pkcs11/lib/libvorpkcs11.so";
    public static final String WinX86InstallPath = "C:\\Program Files (x86)\\Vormetric\\DataSecurityExpert\\Agent\\pkcs11\\bin\\vorpkcs11.dll";
    public static final String WinX64InstallPath = "C:\\Program Files\\Vormetric\\DataSecurityExpert\\Agent\\pkcs11\\bin\\vorpkcs11.dll";
    public static void saveKey(byte[] keyValue, String keyFileName)
    {
        FileOutputStream out = null;
        try {
            out = new FileOutputStream(keyFileName);
            out.write(keyValue);
            out.close();
        }
        catch (IOException e) {
            e.printStackTrace();
        }
        finally {

        }
    }
    public static boolean isFileExist(String filePath)
    {
        File f = new File(filePath);
        return f.exists();
    }

    public static long findKey(Vpkcs11Session session, String keyName)
    {
        /* Find the key on the DSM */
        CK_ATTRIBUTE[] attrs = new CK_ATTRIBUTE[]
                {
                       new CK_ATTRIBUTE (CKA_LABEL, keyName),
                };

        try
        {
            /* Call C_FindObjectsFinal in case there is another find objects going on  */
            session.p11.C_FindObjectsFinal (session.sessionHandle);
            session.p11.C_FindObjectsInit (session.sessionHandle, attrs);
            long[] keyID = session.p11.C_FindObjects (session.sessionHandle, 1);
            session.p11.C_FindObjectsFinal (session.sessionHandle);
            if (keyID.length > 0)
            {
                return keyID[0];
            }
            else
            {
                /* System.out.println ("The key: " + keyName + " is not found."); */
                return 0;
            }
        }
        catch (PKCS11Exception e)
        {
            System.out.println (e.getMessage());
            e.printStackTrace();
        }
        catch (Exception e)
        {
            System.out.println ("Exception thrown.");
            System.out.println (e.getMessage());
            e.printStackTrace();
        }
        return 0;
    }

    public static String getPKCS11LibPath(String libPath)
    {
      String path = null;
      if (( libPath != null ) && (!libPath.equals("")))
      {
          path = libPath;
      }
      else
      {
          path = System.getenv("VPKCS11LIBPATH");

          if ((path == null) || (path.equals("")))
          {
              String osName = System.getProperty("os.name");
              if (osName.contains("Windows"))
              {
                  if (isFileExist(WinX64InstallPath))
                  {
                      path = WinX64InstallPath;
                  }else if ( isFileExist(WinX86InstallPath))
                  {
                      path = WinX86InstallPath;
                  }
              }
              else
              {
                  if (isFileExist(UnixInstallPath))
                  {
                      path = UnixInstallPath;
                  }
              }

              if ((path == null )|| (path.equals("")))
              {
                  System.out.println ("Cannot find Vormetric PKCS11 library, please install Vormetric key agent. " );
                  System.exit(4);
              }
          }
          else
          {
              if ( isFileExist(path))
              {
                  // this is okay
              }
              else
              {
                  System.out.println ("VPKCS11LIBPATH point to a file that does not exist: " + path);
                  System.exit(4);
              }
          }
      }
      System.out.println ("Loading the Vormetric PKCS11 library from : " + path);
      return  path;
    }

    // compare two binary files return true if the content is equal false otherwise
    public static boolean CompareTwoFiles(String pathA, String pathB)
    {
        boolean match = false;
        try
        {
          int BLOCK_SIZE = 4096;
          int bytesReadA, bytesReadB;
          // assume inputStreamA and inputStreamB are streams from your two files.
          byte[] streamABlock = new byte[BLOCK_SIZE];
          byte[] streamBBlock = new byte[BLOCK_SIZE];
          FileInputStream inputStreamA = new FileInputStream(pathA);
          FileInputStream inputStreamB = new FileInputStream(pathB);

          do
          {
            bytesReadA = inputStreamA.read(streamABlock);
            bytesReadB = inputStreamB.read(streamBBlock);
            match = ((bytesReadA == bytesReadB) && Arrays.equals( streamABlock, streamBBlock));
          } while (match && (bytesReadA > -1));
        }
        catch (Exception e)
        {
            System.out.println ("Exception thrown.");
            System.out.println (e.getMessage());
        }

        return match;
    }

    public static long createKey(Vpkcs11Session session, String keyName)
    {
        long keyID = 0;
        /* Create an AES 256 key on the DSM without pass in key value */
        try {
            CK_MECHANISM mechanism = new CK_MECHANISM (CKM_AES_KEY_GEN);

            CK_ATTRIBUTE[] attrs = new CK_ATTRIBUTE[]
                    {
                            new CK_ATTRIBUTE (CKA_LABEL, keyName),
                            new CK_ATTRIBUTE (CKA_CLASS, CKO_SECRET_KEY),
                            new CK_ATTRIBUTE (CKA_KEY_TYPE, CKK_AES),
                            new CK_ATTRIBUTE (CKA_VALUE_LEN, 32),
                            new CK_ATTRIBUTE (CKA_TOKEN, true),
                            new CK_ATTRIBUTE (CKA_ENCRYPT, true),
                            new CK_ATTRIBUTE (CKA_DECRYPT, true),
                            new CK_ATTRIBUTE (CKA_SIGN, false),
                            new CK_ATTRIBUTE (CKA_VERIFY, false),
                            new CK_ATTRIBUTE (CKA_WRAP, true),
                            new CK_ATTRIBUTE (CKA_UNWRAP, true),
                            new CK_ATTRIBUTE (CKA_EXTRACTABLE, false),
                            new CK_ATTRIBUTE (CKA_ALWAYS_SENSITIVE, false),
                            new CK_ATTRIBUTE (CKA_NEVER_EXTRACTABLE, true),
                            new CK_ATTRIBUTE (CKA_SENSITIVE, true),
                            new CK_ATTRIBUTE (0x80000061, true),
                            new CK_ATTRIBUTE (0x80000063, 44640)
                    };

            System.out.println ("Before generating Key. Key Handle: " + keyID);
            keyID = session.p11.C_GenerateKey (session.sessionHandle, mechanism, attrs);
            System.out.println ("Key successfully Generated. Key Handle: " + keyID);
        }
        catch (PKCS11Exception e)
        {
            e.printStackTrace();
        }
        return keyID;
    }

    public static long createKeyObject(Vpkcs11Session session, String keyName, String appName, String keyValue)
    {
        long keyID = 0;
        try {
            /* Create an AES 256 key on the DSM */

            /* AES key template.
	         * CKA_LABEL is the name of the key and will be displayed on the DSM
	         * CKA_VALUE is the bytes that make up the AES key.
	        */

            CK_ATTRIBUTE[] attrs = new CK_ATTRIBUTE[]
                    {
                            new CK_ATTRIBUTE (CKA_LABEL, keyName),
                            new CK_ATTRIBUTE( CKA_APPLICATION, appName),
                            new CK_ATTRIBUTE (CKA_CLASS, CKO_SECRET_KEY),
                            new CK_ATTRIBUTE (CKA_KEY_TYPE, CKK_AES),
                            new CK_ATTRIBUTE (CKA_VALUE, keyValue) ,
                            new CK_ATTRIBUTE (CKA_VALUE_LEN, 32),
                            new CK_ATTRIBUTE (CKA_TOKEN, true),
                            new CK_ATTRIBUTE (CKA_ENCRYPT, true),
                            new CK_ATTRIBUTE (CKA_DECRYPT, true),
                            new CK_ATTRIBUTE (CKA_SIGN, false),
                            new CK_ATTRIBUTE (CKA_VERIFY, false),
                            new CK_ATTRIBUTE (CKA_WRAP, true),
                            new CK_ATTRIBUTE (CKA_UNWRAP, true),
                            new CK_ATTRIBUTE (CKA_EXTRACTABLE, false),
                            new CK_ATTRIBUTE (CKA_ALWAYS_SENSITIVE, false),
                            new CK_ATTRIBUTE (CKA_NEVER_EXTRACTABLE, true),
                            new CK_ATTRIBUTE (CKA_SENSITIVE, true)
                    };

            keyID = session.p11.C_CreateObject(session.sessionHandle, attrs);
            System.out.println ("Object successfully created. Object Handle: " + keyID);
        } catch (PKCS11Exception e) {
            e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
        }
        return keyID;

    }
    public static Vpkcs11Session startUp(String libPath, String pin)
    {
        try
        {
            Vpkcs11Session session = new Vpkcs11Session();

            /* Initialization of the PKCS11 instance, open session and login */
            session.p11 = PKCS11.getInstance(libPath, "C_GetFunctionList", null, false);
            long[] slots = session.p11.C_GetSlotList (false);

            session.sessionHandle = session.p11.C_OpenSession (slots[0], 0,  null, null);
            System.out.println ("Session successfully opened. Handle: " + session.sessionHandle);
            session.p11.C_Login (session.sessionHandle, CKU_USER, pin.toCharArray());
            System.out.println ("Successfully Logged in");
        return session;
      }
      catch (PKCS11Exception e)
      {
        System.out.println (e.getMessage());
        e.printStackTrace();
      }
      catch (Exception e)
      {
        System.out.println ("Exception thrown.");
        System.out.println (e.getMessage());
      }
      return null;
    }

    public static void closeDown(Vpkcs11Session session)
    {
        /* Logout and close session */
        try
        {
            session.p11.C_Logout(session.sessionHandle);
            System.out.println ("Successfully logged out.");
            session.p11.C_CloseSession (session.sessionHandle);
            System.out.println ("Successfully closed session.");
        }
        catch (PKCS11Exception e)
        {
            System.out.println (e.getMessage());
            e.printStackTrace();
        }
        catch (Exception e)
        {
            System.out.println ("Exception thrown.");
            System.out.println (e.getMessage());
        }
     }


}