SecurityToken: remove unused smartcadio stuff
This commit is contained in:
@@ -1,165 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code 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 General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.sufficientlysecure.keychain.securitytoken.smartcardio;
|
|
||||||
|
|
||||||
import java.util.*;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A Smart Card's answer-to-reset bytes. A Card's ATR object can be obtained
|
|
||||||
* by calling {@linkplain Card#getATR}.
|
|
||||||
* This class does not attempt to verify that the ATR encodes a semantically
|
|
||||||
* valid structure.
|
|
||||||
*
|
|
||||||
* <p>Instances of this class are immutable. Where data is passed in or out
|
|
||||||
* via byte arrays, defensive cloning is performed.
|
|
||||||
*
|
|
||||||
* @see Card#getATR
|
|
||||||
*
|
|
||||||
* @since 1.6
|
|
||||||
* @author Andreas Sterbenz
|
|
||||||
* @author JSR 268 Expert Group
|
|
||||||
*/
|
|
||||||
public final class ATR implements java.io.Serializable {
|
|
||||||
|
|
||||||
private static final long serialVersionUID = 6695383790847736493L;
|
|
||||||
|
|
||||||
private byte[] atr;
|
|
||||||
|
|
||||||
private transient int startHistorical, nHistorical;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs an ATR from a byte array.
|
|
||||||
*
|
|
||||||
* @param atr the byte array containing the answer-to-reset bytes
|
|
||||||
* @throws NullPointerException if <code>atr</code> is null
|
|
||||||
*/
|
|
||||||
public ATR(byte[] atr) {
|
|
||||||
this.atr = atr.clone();
|
|
||||||
parse();
|
|
||||||
}
|
|
||||||
|
|
||||||
private void parse() {
|
|
||||||
if (atr.length < 2) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if ((atr[0] != 0x3b) && (atr[0] != 0x3f)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
int t0 = (atr[1] & 0xf0) >> 4;
|
|
||||||
int n = atr[1] & 0xf;
|
|
||||||
int i = 2;
|
|
||||||
while ((t0 != 0) && (i < atr.length)) {
|
|
||||||
if ((t0 & 1) != 0) {
|
|
||||||
i++;
|
|
||||||
}
|
|
||||||
if ((t0 & 2) != 0) {
|
|
||||||
i++;
|
|
||||||
}
|
|
||||||
if ((t0 & 4) != 0) {
|
|
||||||
i++;
|
|
||||||
}
|
|
||||||
if ((t0 & 8) != 0) {
|
|
||||||
if (i >= atr.length) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
t0 = (atr[i++] & 0xf0) >> 4;
|
|
||||||
} else {
|
|
||||||
t0 = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
int k = i + n;
|
|
||||||
if ((k == atr.length) || (k == atr.length - 1)) {
|
|
||||||
startHistorical = i;
|
|
||||||
nHistorical = n;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a copy of the bytes in this ATR.
|
|
||||||
*
|
|
||||||
* @return a copy of the bytes in this ATR.
|
|
||||||
*/
|
|
||||||
public byte[] getBytes() {
|
|
||||||
return atr.clone();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a copy of the historical bytes in this ATR.
|
|
||||||
* If this ATR does not contain historical bytes, an array of length
|
|
||||||
* zero is returned.
|
|
||||||
*
|
|
||||||
* @return a copy of the historical bytes in this ATR.
|
|
||||||
*/
|
|
||||||
public byte[] getHistoricalBytes() {
|
|
||||||
byte[] b = new byte[nHistorical];
|
|
||||||
System.arraycopy(atr, startHistorical, b, 0, nHistorical);
|
|
||||||
return b;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a string representation of this ATR.
|
|
||||||
*
|
|
||||||
* @return a String representation of this ATR.
|
|
||||||
*/
|
|
||||||
public String toString() {
|
|
||||||
return "ATR: " + atr.length + " bytes";
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Compares the specified object with this ATR for equality.
|
|
||||||
* Returns true if the given object is also an ATR and its bytes are
|
|
||||||
* identical to the bytes in this ATR.
|
|
||||||
*
|
|
||||||
* @param obj the object to be compared for equality with this ATR
|
|
||||||
* @return true if the specified object is equal to this ATR
|
|
||||||
*/
|
|
||||||
public boolean equals(Object obj) {
|
|
||||||
if (this == obj) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
if (obj instanceof ATR == false) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
ATR other = (ATR)obj;
|
|
||||||
return Arrays.equals(this.atr, other.atr);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the hash code value for this ATR.
|
|
||||||
*
|
|
||||||
* @return the hash code value for this ATR.
|
|
||||||
*/
|
|
||||||
public int hashCode() {
|
|
||||||
return Arrays.hashCode(atr);
|
|
||||||
}
|
|
||||||
|
|
||||||
private void readObject(java.io.ObjectInputStream in)
|
|
||||||
throws java.io.IOException, ClassNotFoundException {
|
|
||||||
atr = (byte[])in.readUnshared();
|
|
||||||
parse();
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,167 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code 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 General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.sufficientlysecure.keychain.securitytoken.smartcardio;
|
|
||||||
|
|
||||||
import java.nio.ByteBuffer;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A Smart Card with which a connection has been established. Card objects
|
|
||||||
* are obtained by calling {@link CardTerminal#connect CardTerminal.connect()}.
|
|
||||||
*
|
|
||||||
* @see CardTerminal
|
|
||||||
*
|
|
||||||
* @since 1.6
|
|
||||||
* @author Andreas Sterbenz
|
|
||||||
* @author JSR 268 Expert Group
|
|
||||||
*/
|
|
||||||
public abstract class Card {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new Card object.
|
|
||||||
*
|
|
||||||
* <p>This constructor is called by subclasses only. Application should
|
|
||||||
* call the {@linkplain CardTerminal#connect CardTerminal.connect()}
|
|
||||||
* method to obtain a Card
|
|
||||||
* object.
|
|
||||||
*/
|
|
||||||
protected Card() {
|
|
||||||
// empty
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the ATR of this card.
|
|
||||||
*
|
|
||||||
* @return the ATR of this card.
|
|
||||||
*/
|
|
||||||
public abstract ATR getATR();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the protocol in use for this card.
|
|
||||||
*
|
|
||||||
* @return the protocol in use for this card, for example "T=0" or "T=1"
|
|
||||||
*/
|
|
||||||
public abstract String getProtocol();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the CardChannel for the basic logical channel. The basic
|
|
||||||
* logical channel has a channel number of 0.
|
|
||||||
*
|
|
||||||
* @throws SecurityException if a SecurityManager exists and the
|
|
||||||
* caller does not have the required
|
|
||||||
* {@linkplain CardPermission permission}
|
|
||||||
* @throws IllegalStateException if this card object has been disposed of
|
|
||||||
* via the {@linkplain #disconnect disconnect()} method
|
|
||||||
*/
|
|
||||||
public abstract CardChannel getBasicChannel();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Opens a new logical channel to the card and returns it. The channel is
|
|
||||||
* opened by issuing a <code>MANAGE CHANNEL</code> command that should use
|
|
||||||
* the format <code>[00 70 00 00 01]</code>.
|
|
||||||
*
|
|
||||||
* @throws SecurityException if a SecurityManager exists and the
|
|
||||||
* caller does not have the required
|
|
||||||
* {@linkplain CardPermission permission}
|
|
||||||
* @throws CardException is a new logical channel could not be opened
|
|
||||||
* @throws IllegalStateException if this card object has been disposed of
|
|
||||||
* via the {@linkplain #disconnect disconnect()} method
|
|
||||||
*/
|
|
||||||
public abstract CardChannel openLogicalChannel() throws CardException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Requests exclusive access to this card.
|
|
||||||
*
|
|
||||||
* <p>Once a thread has invoked <code>beginExclusive</code>, only this
|
|
||||||
* thread is allowed to communicate with this card until it calls
|
|
||||||
* <code>endExclusive</code>. Other threads attempting communication
|
|
||||||
* will receive a CardException.
|
|
||||||
*
|
|
||||||
* <p>Applications have to ensure that exclusive access is correctly
|
|
||||||
* released. This can be achieved by executing
|
|
||||||
* the <code>beginExclusive()</code> and <code>endExclusive</code> calls
|
|
||||||
* in a <code>try ... finally</code> block.
|
|
||||||
*
|
|
||||||
* @throws SecurityException if a SecurityManager exists and the
|
|
||||||
* caller does not have the required
|
|
||||||
* {@linkplain CardPermission permission}
|
|
||||||
* @throws CardException if exclusive access has already been set
|
|
||||||
* or if exclusive access could not be established
|
|
||||||
* @throws IllegalStateException if this card object has been disposed of
|
|
||||||
* via the {@linkplain #disconnect disconnect()} method
|
|
||||||
*/
|
|
||||||
public abstract void beginExclusive() throws CardException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Releases the exclusive access previously established using
|
|
||||||
* <code>beginExclusive</code>.
|
|
||||||
*
|
|
||||||
* @throws SecurityException if a SecurityManager exists and the
|
|
||||||
* caller does not have the required
|
|
||||||
* {@linkplain CardPermission permission}
|
|
||||||
* @throws IllegalStateException if the active Thread does not currently have
|
|
||||||
* exclusive access to this card or
|
|
||||||
* if this card object has been disposed of
|
|
||||||
* via the {@linkplain #disconnect disconnect()} method
|
|
||||||
* @throws CardException if the operation failed
|
|
||||||
*/
|
|
||||||
public abstract void endExclusive() throws CardException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Transmits a control command to the terminal device.
|
|
||||||
*
|
|
||||||
* <p>This can be used to, for example, control terminal functions like
|
|
||||||
* a built-in PIN pad or biometrics.
|
|
||||||
*
|
|
||||||
* @param controlCode the control code of the command
|
|
||||||
* @param command the command data
|
|
||||||
*
|
|
||||||
* @throws SecurityException if a SecurityManager exists and the
|
|
||||||
* caller does not have the required
|
|
||||||
* {@linkplain CardPermission permission}
|
|
||||||
* @throws NullPointerException if command is null
|
|
||||||
* @throws CardException if the card operation failed
|
|
||||||
* @throws IllegalStateException if this card object has been disposed of
|
|
||||||
* via the {@linkplain #disconnect disconnect()} method
|
|
||||||
*/
|
|
||||||
public abstract byte[] transmitControlCommand(int controlCode,
|
|
||||||
byte[] command) throws CardException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disconnects the connection with this card. After this method returns,
|
|
||||||
* calling methods on this object or in CardChannels associated with this
|
|
||||||
* object that require interaction with the card will raise an
|
|
||||||
* IllegalStateException.
|
|
||||||
*
|
|
||||||
* @param reset whether to reset the card after disconnecting.
|
|
||||||
*
|
|
||||||
* @throws CardException if the card operation failed
|
|
||||||
* @throws SecurityException if a SecurityManager exists and the
|
|
||||||
* caller does not have the required
|
|
||||||
* {@linkplain CardPermission permission}
|
|
||||||
*/
|
|
||||||
public abstract void disconnect(boolean reset) throws CardException;
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,184 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code 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 General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.sufficientlysecure.keychain.securitytoken.smartcardio;
|
|
||||||
|
|
||||||
import java.nio.*;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A logical channel connection to a Smart Card. It is used to exchange APDUs
|
|
||||||
* with a Smart Card.
|
|
||||||
* A CardChannel object can be obtained by calling the method
|
|
||||||
* {@linkplain Card#getBasicChannel} or {@linkplain Card#openLogicalChannel}.
|
|
||||||
*
|
|
||||||
* @see Card
|
|
||||||
* @see CommandAPDU
|
|
||||||
* @see ResponseAPDU
|
|
||||||
*
|
|
||||||
* @since 1.6
|
|
||||||
* @author Andreas Sterbenz
|
|
||||||
* @author JSR 268 Expert Group
|
|
||||||
*/
|
|
||||||
public abstract class CardChannel {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardChannel object.
|
|
||||||
*
|
|
||||||
* <p>This constructor is called by subclasses only. Application should
|
|
||||||
* call the {@linkplain Card#getBasicChannel} and
|
|
||||||
* {@linkplain Card#openLogicalChannel} methods to obtain a CardChannel
|
|
||||||
* object.
|
|
||||||
*/
|
|
||||||
protected CardChannel() {
|
|
||||||
// empty
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the Card this channel is associated with.
|
|
||||||
*
|
|
||||||
* @return the Card this channel is associated with
|
|
||||||
*/
|
|
||||||
public abstract Card getCard();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the channel number of this CardChannel. A channel number of
|
|
||||||
* 0 indicates the basic logical channel.
|
|
||||||
*
|
|
||||||
* @return the channel number of this CardChannel.
|
|
||||||
*
|
|
||||||
* @throws IllegalStateException if this channel has been
|
|
||||||
* {@linkplain #close closed} or if the corresponding Card has been
|
|
||||||
* {@linkplain Card#disconnect disconnected}.
|
|
||||||
*/
|
|
||||||
public abstract int getChannelNumber();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Transmits the specified command APDU to the Smart Card and returns the
|
|
||||||
* response APDU.
|
|
||||||
*
|
|
||||||
* <p>The CLA byte of the command APDU is automatically adjusted to
|
|
||||||
* match the channel number of this CardChannel.
|
|
||||||
*
|
|
||||||
* <p>Note that this method cannot be used to transmit
|
|
||||||
* <code>MANAGE CHANNEL</code> APDUs. Logical channels should be managed
|
|
||||||
* using the {@linkplain Card#openLogicalChannel} and {@linkplain
|
|
||||||
* CardChannel#close CardChannel.close()} methods.
|
|
||||||
*
|
|
||||||
* <p>Implementations should transparently handle artifacts
|
|
||||||
* of the transmission protocol.
|
|
||||||
* For example, when using the T=0 protocol, the following processing
|
|
||||||
* should occur as described in ISO/IEC 7816-4:
|
|
||||||
*
|
|
||||||
* <ul>
|
|
||||||
* <li><p>if the response APDU has an SW1 of <code>61</code>, the
|
|
||||||
* implementation should issue a <code>GET RESPONSE</code> command
|
|
||||||
* using <code>SW2</code> as the <code>Le</code>field.
|
|
||||||
* This process is repeated as long as an SW1 of <code>61</code> is
|
|
||||||
* received. The response body of these exchanges is concatenated
|
|
||||||
* to form the final response body.
|
|
||||||
*
|
|
||||||
* <li><p>if the response APDU is <code>6C XX</code>, the implementation
|
|
||||||
* should reissue the command using <code>XX</code> as the
|
|
||||||
* <code>Le</code> field.
|
|
||||||
* </ul>
|
|
||||||
*
|
|
||||||
* <p>The ResponseAPDU returned by this method is the result
|
|
||||||
* after this processing has been performed.
|
|
||||||
*
|
|
||||||
* @param command the command APDU
|
|
||||||
* @return the response APDU received from the card
|
|
||||||
*
|
|
||||||
* @throws IllegalStateException if this channel has been
|
|
||||||
* {@linkplain #close closed} or if the corresponding Card has been
|
|
||||||
* {@linkplain Card#disconnect disconnected}.
|
|
||||||
* @throws IllegalArgumentException if the APDU encodes a
|
|
||||||
* <code>MANAGE CHANNEL</code> command
|
|
||||||
* @throws NullPointerException if command is null
|
|
||||||
* @throws CardException if the card operation failed
|
|
||||||
*/
|
|
||||||
public abstract ResponseAPDU transmit(CommandAPDU command) throws CardException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Transmits the command APDU stored in the command ByteBuffer and receives
|
|
||||||
* the reponse APDU in the response ByteBuffer.
|
|
||||||
*
|
|
||||||
* <p>The command buffer must contain valid command APDU data starting
|
|
||||||
* at <code>command.position()</code> and the APDU must be
|
|
||||||
* <code>command.remaining()</code> bytes long.
|
|
||||||
* Upon return, the command buffer's position will be equal
|
|
||||||
* to its limit; its limit will not have changed. The output buffer
|
|
||||||
* will have received the response APDU bytes. Its position will have
|
|
||||||
* advanced by the number of bytes received, which is also the return
|
|
||||||
* value of this method.
|
|
||||||
*
|
|
||||||
* <p>The CLA byte of the command APDU is automatically adjusted to
|
|
||||||
* match the channel number of this CardChannel.
|
|
||||||
*
|
|
||||||
* <p>Note that this method cannot be used to transmit
|
|
||||||
* <code>MANAGE CHANNEL</code> APDUs. Logical channels should be managed
|
|
||||||
* using the {@linkplain Card#openLogicalChannel} and {@linkplain
|
|
||||||
* CardChannel#close CardChannel.close()} methods.
|
|
||||||
*
|
|
||||||
* <p>See {@linkplain #transmit transmit()} for a discussion of the handling
|
|
||||||
* of response APDUs with the SW1 values <code>61</code> or <code>6C</code>.
|
|
||||||
*
|
|
||||||
* @param command the buffer containing the command APDU
|
|
||||||
* @param response the buffer that shall receive the response APDU from
|
|
||||||
* the card
|
|
||||||
* @return the length of the received response APDU
|
|
||||||
*
|
|
||||||
* @throws IllegalStateException if this channel has been
|
|
||||||
* {@linkplain #close closed} or if the corresponding Card has been
|
|
||||||
* {@linkplain Card#disconnect disconnected}.
|
|
||||||
* @throws NullPointerException if command or response is null
|
|
||||||
* @throws ReadOnlyBufferException if the response buffer is read-only
|
|
||||||
* @throws IllegalArgumentException if command and response are the
|
|
||||||
* same object, if <code>response</code> may not have
|
|
||||||
* sufficient space to receive the response APDU
|
|
||||||
* or if the APDU encodes a <code>MANAGE CHANNEL</code> command
|
|
||||||
* @throws CardException if the card operation failed
|
|
||||||
*/
|
|
||||||
public abstract int transmit(ByteBuffer command, ByteBuffer response)
|
|
||||||
throws CardException;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Closes this CardChannel. The logical channel is closed by issuing
|
|
||||||
* a <code>MANAGE CHANNEL</code> command that should use the format
|
|
||||||
* <code>[xx 70 80 0n]</code> where <code>n</code> is the channel number
|
|
||||||
* of this channel and <code>xx</code> is the <code>CLA</code>
|
|
||||||
* byte that encodes this logical channel and has all other bits set to 0.
|
|
||||||
* After this method returns, calling other
|
|
||||||
* methods in this class will raise an IllegalStateException.
|
|
||||||
*
|
|
||||||
* <p>Note that the basic logical channel cannot be closed using this
|
|
||||||
* method. It can be closed by calling {@link Card#disconnect}.
|
|
||||||
*
|
|
||||||
* @throws CardException if the card operation failed
|
|
||||||
* @throws IllegalStateException if this CardChannel represents a
|
|
||||||
* connection the basic logical channel
|
|
||||||
*/
|
|
||||||
public abstract void close() throws CardException;
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code 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 General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.sufficientlysecure.keychain.securitytoken.smartcardio;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Exception for errors that occur during communication with the
|
|
||||||
* Smart Card stack or the card itself.
|
|
||||||
*
|
|
||||||
* @since 1.6
|
|
||||||
* @author Andreas Sterbenz
|
|
||||||
* @author JSR 268 Expert Group
|
|
||||||
*/
|
|
||||||
public class CardException extends Exception {
|
|
||||||
|
|
||||||
private static final long serialVersionUID = 7787607144922050628L;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardException with the specified detail message.
|
|
||||||
*
|
|
||||||
* @param message the detail message
|
|
||||||
*/
|
|
||||||
public CardException(String message) {
|
|
||||||
super(message);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardException with the specified cause and a detail message
|
|
||||||
* of <code>(cause==null ? null : cause.toString())</code>.
|
|
||||||
*
|
|
||||||
* @param cause the cause of this exception or null
|
|
||||||
*/
|
|
||||||
public CardException(Throwable cause) {
|
|
||||||
super(cause);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardException with the specified detail message and cause.
|
|
||||||
*
|
|
||||||
* @param message the detail message
|
|
||||||
* @param cause the cause of this exception or null
|
|
||||||
*/
|
|
||||||
public CardException(String message, Throwable cause) {
|
|
||||||
super(message, cause);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code 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 General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.sufficientlysecure.keychain.securitytoken.smartcardio;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Exception thrown when an application tries to establish a connection with a
|
|
||||||
* terminal that has no card present.
|
|
||||||
*
|
|
||||||
* @since 1.6
|
|
||||||
* @author Andreas Sterbenz
|
|
||||||
* @author JSR 268 Expert Group
|
|
||||||
*/
|
|
||||||
public class CardNotPresentException extends CardException {
|
|
||||||
|
|
||||||
private final static long serialVersionUID = 1346879911706545215L;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardNotPresentException with the specified detail message.
|
|
||||||
*
|
|
||||||
* @param message the detail message
|
|
||||||
*/
|
|
||||||
public CardNotPresentException(String message) {
|
|
||||||
super(message);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardNotPresentException with the specified cause and a detail message
|
|
||||||
* of <code>(cause==null ? null : cause.toString())</code>.
|
|
||||||
*
|
|
||||||
* @param cause the cause of this exception or null
|
|
||||||
*/
|
|
||||||
public CardNotPresentException(Throwable cause) {
|
|
||||||
super(cause);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardNotPresentException with the specified detail message and cause.
|
|
||||||
*
|
|
||||||
* @param message the detail message
|
|
||||||
* @param cause the cause of this exception or null
|
|
||||||
*/
|
|
||||||
public CardNotPresentException(String message, Throwable cause) {
|
|
||||||
super(message, cause);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,301 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code 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 General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.sufficientlysecure.keychain.securitytoken.smartcardio;
|
|
||||||
|
|
||||||
import java.io.*;
|
|
||||||
|
|
||||||
import java.security.Permission;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A permission for Smart Card operations. A CardPermission consists of the
|
|
||||||
* name of the card terminal the permission applies to and a set of actions
|
|
||||||
* that are valid for that terminal.
|
|
||||||
*
|
|
||||||
* <p>A CardPermission with a name of <code>*</code> applies to all
|
|
||||||
* card terminals. The actions string is a comma separated list of the actions
|
|
||||||
* listed below, or <code>*</code> to signify "all actions."
|
|
||||||
*
|
|
||||||
* <p>Individual actions are:
|
|
||||||
* <dl>
|
|
||||||
* <dt>connect
|
|
||||||
* <dd>connect to a card using
|
|
||||||
* {@linkplain CardTerminal#connect CardTerminal.connect()}
|
|
||||||
*
|
|
||||||
* <dt>reset
|
|
||||||
* <dd>reset the card using {@linkplain Card#disconnect Card.disconnect(true)}
|
|
||||||
*
|
|
||||||
* <dt>exclusive
|
|
||||||
* <dd>establish exclusive access to a card using
|
|
||||||
* {@linkplain Card#beginExclusive} and {@linkplain Card#endExclusive
|
|
||||||
* endExclusive()}
|
|
||||||
*
|
|
||||||
* <dt>transmitControl
|
|
||||||
* <dd>transmit a control command using
|
|
||||||
* {@linkplain Card#transmitControlCommand Card.transmitControlCommand()}
|
|
||||||
*
|
|
||||||
* <dt>getBasicChannel
|
|
||||||
* <dd>obtain the basic logical channel using
|
|
||||||
* {@linkplain Card#getBasicChannel}
|
|
||||||
*
|
|
||||||
* <dt>openLogicalChannel
|
|
||||||
* <dd>open a new logical channel using
|
|
||||||
* {@linkplain Card#openLogicalChannel}
|
|
||||||
*
|
|
||||||
* </dl>
|
|
||||||
*
|
|
||||||
* @since 1.6
|
|
||||||
* @author Andreas Sterbenz
|
|
||||||
* @author JSR 268 Expert Group
|
|
||||||
*/
|
|
||||||
public class CardPermission extends Permission {
|
|
||||||
|
|
||||||
private static final long serialVersionUID = 7146787880530705613L;
|
|
||||||
|
|
||||||
private final static int A_CONNECT = 0x01;
|
|
||||||
private final static int A_EXCLUSIVE = 0x02;
|
|
||||||
private final static int A_GET_BASIC_CHANNEL = 0x04;
|
|
||||||
private final static int A_OPEN_LOGICAL_CHANNEL = 0x08;
|
|
||||||
private final static int A_RESET = 0x10;
|
|
||||||
private final static int A_TRANSMIT_CONTROL = 0x20;
|
|
||||||
|
|
||||||
// sum of all the actions above
|
|
||||||
private final static int A_ALL = 0x3f;
|
|
||||||
|
|
||||||
private final static int[] ARRAY_MASKS = {
|
|
||||||
A_ALL,
|
|
||||||
A_CONNECT,
|
|
||||||
A_EXCLUSIVE,
|
|
||||||
A_GET_BASIC_CHANNEL,
|
|
||||||
A_OPEN_LOGICAL_CHANNEL,
|
|
||||||
A_RESET,
|
|
||||||
A_TRANSMIT_CONTROL,
|
|
||||||
};
|
|
||||||
|
|
||||||
private final static String S_CONNECT = "connect";
|
|
||||||
private final static String S_EXCLUSIVE = "exclusive";
|
|
||||||
private final static String S_GET_BASIC_CHANNEL = "getBasicChannel";
|
|
||||||
private final static String S_OPEN_LOGICAL_CHANNEL = "openLogicalChannel";
|
|
||||||
private final static String S_RESET = "reset";
|
|
||||||
private final static String S_TRANSMIT_CONTROL = "transmitControl";
|
|
||||||
|
|
||||||
private final static String S_ALL = "*";
|
|
||||||
|
|
||||||
private final static String[] ARRAY_STRINGS = {
|
|
||||||
S_ALL,
|
|
||||||
S_CONNECT,
|
|
||||||
S_EXCLUSIVE,
|
|
||||||
S_GET_BASIC_CHANNEL,
|
|
||||||
S_OPEN_LOGICAL_CHANNEL,
|
|
||||||
S_RESET,
|
|
||||||
S_TRANSMIT_CONTROL,
|
|
||||||
};
|
|
||||||
|
|
||||||
private transient int mask;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @serial
|
|
||||||
*/
|
|
||||||
private volatile String actions;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs a new CardPermission with the specified actions.
|
|
||||||
* <code>terminalName</code> is the name of a CardTerminal or <code>*</code>
|
|
||||||
* if this permission applies to all terminals. <code>actions</code>
|
|
||||||
* contains a comma-separated list of the individual actions
|
|
||||||
* or <code>*</code> to signify all actions. For more information,
|
|
||||||
* see the documentation at the top of this {@linkplain CardPermission
|
|
||||||
* class}.
|
|
||||||
*
|
|
||||||
* @param terminalName the name of the card terminal, or <code>*</code>
|
|
||||||
* @param actions the action string (or null if the set of permitted
|
|
||||||
* actions is empty)
|
|
||||||
*
|
|
||||||
* @throws NullPointerException if terminalName is null
|
|
||||||
* @throws IllegalArgumentException if actions is an invalid actions
|
|
||||||
* specification
|
|
||||||
*/
|
|
||||||
public CardPermission(String terminalName, String actions) {
|
|
||||||
super(terminalName);
|
|
||||||
if (terminalName == null) {
|
|
||||||
throw new NullPointerException();
|
|
||||||
}
|
|
||||||
mask = getMask(actions);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static int getMask(String actions) {
|
|
||||||
if ((actions == null) || (actions.length() == 0)) {
|
|
||||||
throw new IllegalArgumentException("actions must not be empty");
|
|
||||||
}
|
|
||||||
|
|
||||||
// try exact matches for simple actions first
|
|
||||||
for (int i = 0; i < ARRAY_STRINGS.length; i++) {
|
|
||||||
if (actions == ARRAY_STRINGS[i]) {
|
|
||||||
return ARRAY_MASKS[i];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (actions.endsWith(",")) {
|
|
||||||
throw new IllegalArgumentException("Invalid actions: '" + actions + "'");
|
|
||||||
}
|
|
||||||
int mask = 0;
|
|
||||||
String[] split = actions.split(",");
|
|
||||||
outer:
|
|
||||||
for (String s : split) {
|
|
||||||
for (int i = 0; i < ARRAY_STRINGS.length; i++) {
|
|
||||||
if (ARRAY_STRINGS[i].equalsIgnoreCase(s)) {
|
|
||||||
mask |= ARRAY_MASKS[i];
|
|
||||||
continue outer;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
throw new IllegalArgumentException("Invalid action: '" + s + "'");
|
|
||||||
}
|
|
||||||
|
|
||||||
return mask;
|
|
||||||
}
|
|
||||||
|
|
||||||
private static String getActions(int mask) {
|
|
||||||
if (mask == A_ALL) {
|
|
||||||
return S_ALL;
|
|
||||||
}
|
|
||||||
boolean first = true;
|
|
||||||
StringBuilder sb = new StringBuilder();
|
|
||||||
for (int i = 0; i < ARRAY_MASKS.length; i++) {
|
|
||||||
int action = ARRAY_MASKS[i];
|
|
||||||
if ((mask & action) == action) {
|
|
||||||
if (first == false) {
|
|
||||||
sb.append(",");
|
|
||||||
} else {
|
|
||||||
first = false;
|
|
||||||
}
|
|
||||||
sb.append(ARRAY_STRINGS[i]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return sb.toString();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the canonical string representation of the actions.
|
|
||||||
* It is <code>*</code> to signify all actions defined by this class or
|
|
||||||
* the string concatenation of the comma-separated,
|
|
||||||
* lexicographically sorted list of individual actions.
|
|
||||||
*
|
|
||||||
* @return the canonical string representation of the actions.
|
|
||||||
*/
|
|
||||||
public String getActions() {
|
|
||||||
if (actions == null) {
|
|
||||||
actions = getActions(mask);
|
|
||||||
}
|
|
||||||
return actions;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if this CardPermission object implies the specified permission.
|
|
||||||
* That is the case, if and only if
|
|
||||||
* <ul>
|
|
||||||
* <li><p><code>permission</code> is an instance of CardPermission,</p>
|
|
||||||
* <li><p><code>permission</code>'s actions are a proper subset of this
|
|
||||||
* object's actions, and</p>
|
|
||||||
* <li><p>this object's <code>getName()</code> method is either
|
|
||||||
* <code>*</code> or equal to <code>permission</code>'s <code>name</code>.
|
|
||||||
* </p>
|
|
||||||
* </ul>
|
|
||||||
*
|
|
||||||
* @param permission the permission to check against
|
|
||||||
* @return true if and only if this CardPermission object implies the
|
|
||||||
* specified permission.
|
|
||||||
*/
|
|
||||||
public boolean implies(Permission permission) {
|
|
||||||
if (permission instanceof CardPermission == false) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
CardPermission other = (CardPermission)permission;
|
|
||||||
if ((this.mask & other.mask) != other.mask) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
String thisName = getName();
|
|
||||||
if (thisName.equals("*")) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
if (thisName.equals(other.getName())) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Compares the specified object with this CardPermission for equality.
|
|
||||||
* This CardPermission is equal to another Object <code>object</code>, if
|
|
||||||
* and only if
|
|
||||||
* <ul>
|
|
||||||
* <li><p><code>object</code> is an instance of CardPermission,</p>
|
|
||||||
* <li><p><code>this.getName()</code> is equal to
|
|
||||||
* <code>((CardPermission)object).getName()</code>, and</p>
|
|
||||||
* <li><p><code>this.getActions()</code> is equal to
|
|
||||||
* <code>((CardPermission)object).getActions()</code>.</p>
|
|
||||||
* </ul>
|
|
||||||
*
|
|
||||||
* @param obj the object to be compared for equality with this CardPermission
|
|
||||||
* @return true if and only if the specified object is equal to this
|
|
||||||
* CardPermission
|
|
||||||
*/
|
|
||||||
public boolean equals(Object obj) {
|
|
||||||
if (this == obj) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
if (obj instanceof CardPermission == false) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
CardPermission other = (CardPermission)obj;
|
|
||||||
return this.getName().equals(other.getName()) && (this.mask == other.mask);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the hash code value for this CardPermission object.
|
|
||||||
*
|
|
||||||
* @return the hash code value for this CardPermission object.
|
|
||||||
*/
|
|
||||||
public int hashCode() {
|
|
||||||
return getName().hashCode() + 31 * mask;
|
|
||||||
}
|
|
||||||
|
|
||||||
private void writeObject(ObjectOutputStream s) throws IOException {
|
|
||||||
// Write out the actions. The superclass takes care of the name.
|
|
||||||
// Call getActions to make sure actions field is initialized
|
|
||||||
if (actions == null) {
|
|
||||||
getActions();
|
|
||||||
}
|
|
||||||
s.defaultWriteObject();
|
|
||||||
}
|
|
||||||
|
|
||||||
private void readObject(ObjectInputStream s)
|
|
||||||
throws IOException, ClassNotFoundException {
|
|
||||||
// Read in the actions, then restore the mask.
|
|
||||||
s.defaultReadObject();
|
|
||||||
mask = getMask(actions);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -56,7 +56,6 @@ import java.nio.ByteBuffer;
|
|||||||
* via byte arrays, defensive cloning is performed.
|
* via byte arrays, defensive cloning is performed.
|
||||||
*
|
*
|
||||||
* @see ResponseAPDU
|
* @see ResponseAPDU
|
||||||
* @see CardChannel#transmit CardChannel.transmit
|
|
||||||
*
|
*
|
||||||
* @since 1.6
|
* @since 1.6
|
||||||
* @author Andreas Sterbenz
|
* @author Andreas Sterbenz
|
||||||
|
|||||||
@@ -37,7 +37,6 @@ import java.util.Arrays;
|
|||||||
* via byte arrays, defensive cloning is performed.
|
* via byte arrays, defensive cloning is performed.
|
||||||
*
|
*
|
||||||
* @see CommandAPDU
|
* @see CommandAPDU
|
||||||
* @see CardChannel#transmit CardChannel.transmit
|
|
||||||
*
|
*
|
||||||
* @since 1.6
|
* @since 1.6
|
||||||
* @author Andreas Sterbenz
|
* @author Andreas Sterbenz
|
||||||
|
|||||||
Reference in New Issue
Block a user