org.jmrtd.lds.CardAccessFile.java Source code

Introduction

Here is the source code for org.jmrtd.lds.CardAccessFile.java

Source

/*
 * JMRTD - A Java API for accessing machine readable travel documents.
 *
 * Copyright (C) 2006 - 2015  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.lds;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Logger;

import org.bouncycastle.asn1.ASN1EncodableVector;
import org.bouncycastle.asn1.ASN1Encoding;
import org.bouncycastle.asn1.ASN1InputStream;
import org.bouncycastle.asn1.ASN1Primitive;
import org.bouncycastle.asn1.ASN1Set;
import org.bouncycastle.asn1.DLSet;

/**
 * Card access file stores a set of SecurityInfos for PACE.
 *
 * FIXME: Strictly speaking this file is not part of the LDS (or even the MRTD application)! Move it out of this package? -- MO
 *
 * @author The JMRTD team (info@jmrtd.org)
 *
 * @version $Revision$
 *
 * @since 0.5.1
 */
public class CardAccessFile {

    private static final long serialVersionUID = -3536507558193769951L;

    private static final Logger LOGGER = Logger.getLogger("org.jmrtd");

    /** The security infos that make up this file. */
    private Set<SecurityInfo> securityInfos;

    /**
     * Constructs a new file from the provided data.
     *
     * @param securityInfos a non-empty list of security infos
     */
    public CardAccessFile(Collection<SecurityInfo> securityInfos) {
        if (securityInfos == null) {
            throw new IllegalArgumentException("Null securityInfos");
        }
        this.securityInfos = new HashSet<SecurityInfo>(securityInfos);
    }

    /**
     * Constructs a new file from the data in an input stream.
     *
     * @param inputStream the input stream to parse the data from
     *
     * @throws IOException on error reading input stream
     */
    public CardAccessFile(InputStream inputStream) throws IOException {
        readContent(inputStream);
    }

    protected void readContent(InputStream inputStream) throws IOException {
        securityInfos = new HashSet<SecurityInfo>();
        ASN1InputStream asn1In = new ASN1InputStream(inputStream);
        ASN1Set set = (ASN1Set) asn1In.readObject();
        for (int i = 0; i < set.size(); i++) {
            ASN1Primitive object = set.getObjectAt(i).toASN1Primitive();
            SecurityInfo securityInfo = SecurityInfo.getInstance(object);
            if (securityInfo == null) {
                continue;
            } /* NOTE: skipping this unsupported SecurityInfo */
            securityInfos.add(securityInfo);
        }
    }

    /* FIXME: rewrite (using writeObject instead of getDERObject) to remove interface dependency on BC. */
    protected void writeContent(OutputStream outputStream) throws IOException {
        ASN1EncodableVector vector = new ASN1EncodableVector();
        for (SecurityInfo si : securityInfos) {
            vector.add(si.getDERObject());
        }
        ASN1Set derSet = new DLSet(vector);
        outputStream.write(derSet.getEncoded(ASN1Encoding.DER));
    }

    /**
     * Gets the security infos as an unordered collection.
     *
     * @return security infos
     */
    public Collection<SecurityInfo> getSecurityInfos() {
        return securityInfos;
    }

    /**
     * Gets the PACE infos embedded in this card access file.
     * If no infos are present, an empty list is returned.
     *
     * @return a list of PACE infos
     */
    public Collection<PACEInfo> getPACEInfos() {
        List<PACEInfo> paceInfos = new ArrayList<PACEInfo>(securityInfos.size());
        for (SecurityInfo securityInfo : securityInfos) {
            if (securityInfo instanceof PACEInfo) {
                paceInfos.add((PACEInfo) securityInfo);
            }
        }
        return paceInfos;
    }

    /**
     * Gets the signature algorithm object identifier.
     *
     * @return signature algorithm OID
     */
    public String toString() {
        return "CardAccessFile [" + securityInfos.toString() + "]";
    }

    /**
     * Tests equality with respect to another object.
     *
     * @param otherObj another object
     *
     * @return whether this object equals the other object
     */
    public boolean equals(Object otherObj) {
        if (otherObj == null) {
            return false;
        }
        if (!(otherObj.getClass().equals(this.getClass()))) {
            return false;
        }
        CardAccessFile other = (CardAccessFile) otherObj;
        if (securityInfos == null) {
            return other.securityInfos == null;
        }
        if (other.securityInfos == null) {
            return securityInfos == null;
        }
        return securityInfos.equals(other.securityInfos);
    }

    /**
     * Gets a hash code of this object.
     *
     * @return the hash code
     */
    public int hashCode() {
        return 7 * securityInfos.hashCode() + 61;
    }
}