org.jmrtd.ChipAuthenticationResult 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 - 2014  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: $
 */

package org.jmrtd;

import java.math.BigInteger;
import java.security.KeyPair;
import java.security.PublicKey;

/**
 * Result of EAC-CA protocol.
 * 
 * @author The JMRTD team ([email protected])
 * 
 * @version $Revision: $
 */
public class ChipAuthenticationResult {

	private BigInteger keyId;
	private PublicKey publicKey;
	private byte[] keyHash;
	private KeyPair keyPair;

	/**
	 * Creates a result.
	 * 
	 * @param keyId the key identifier of the ICC's public key or -1
	 * @param publicKey the ICC's public key
	 * @param keyHash the hash of the key
	 * @param keyPair the key pair
	 */
	public ChipAuthenticationResult(BigInteger keyId, PublicKey publicKey, byte[] keyHash, KeyPair keyPair) {
		this.keyId = keyId;
		this.publicKey = publicKey;
		this.keyHash = keyHash;
		this.keyPair = keyPair;
	}

	/**
	 * Gets the ICC's public key identifier
	 *
	 * @return the key id or -1
	 */
	public BigInteger getKeyId() {
		return keyId;
	}
	
	/**
	 * Gets the ICC's public key that was used as input to chip authentication protocol
	 *
	 * @return the public key
	 */
	public PublicKey getPublicKey() {
		return publicKey;
	}

	/**
	 * Gets the hash of the key.
	 * 
	 * @return the hash of the key
	 */
	public byte[] getKeyHash() {
		return keyHash;
	}

	/**
	 * The ephemeral key pair resulting from chip authentication.
	 * 
	 * @return a key pair
	 */
	public KeyPair getKeyPair() {
		return keyPair;
	}
}