1/*
2 * Copyright (c) 2004,2007-2008 Apple Inc. All Rights Reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24
25//
26// reader - token reader objects
27//
28#include "reader.h"
29
30
31//
32// Construct a Reader
33// This does not commence state tracking; call update to start up the reader.
34//
35Reader::Reader(TokenCache &tc, const PCSC::ReaderState &state)
36	: cache(tc), mType(pcsc), mToken(NULL)
37{
38	mName = state.name();	// remember separate copy of name
39	mPrintName = mName;		//@@@ how to make this readable? Use IOKit information?
40	secdebug("reader", "%p (%s) new PCSC reader", this, name().c_str());
41}
42
43Reader::Reader(TokenCache &tc, const string &identifier)
44	: cache(tc), mType(software), mToken(NULL)
45{
46	mName = identifier;
47	mPrintName = mName;
48	secdebug("reader", "%p (%s) new software reader", this, name().c_str());
49}
50
51Reader::~Reader()
52{
53	secdebug("reader", "%p (%s) destroyed", this, name().c_str());
54}
55
56
57//
58// Type qualification. None matches anything.
59//
60bool Reader::isType(Type reqType) const
61{
62	return reqType == this->type();
63}
64
65
66//
67// Killing a reader forcibly removes its Token, if any
68//
69void Reader::kill()
70{
71	if (mToken)
72		removeToken();
73	NodeCore::kill();
74}
75
76
77//
78// State transition matrix for a reader, based on PCSC state changes
79//
80void Reader::update(const PCSC::ReaderState &state)
81{
82	// set new state
83	unsigned long oldState = mState.state();
84	mState = state;
85	mState.name(mName.c_str());		// (fix name pointer, unchanged)
86
87	try {
88		if (state.state(SCARD_STATE_UNAVAILABLE)) {
89			// reader is unusable (probably being removed)
90			secdebug("reader", "%p (%s) unavailable (0x%lx)",
91				this, name().c_str(), state.state());
92			if (mToken)
93				removeToken();
94		} else if (state.state(SCARD_STATE_EMPTY)) {
95			// reader is empty (no token present)
96			secdebug("reader", "%p (%s) empty (0x%lx)",
97				this, name().c_str(), state.state());
98			if (mToken)
99				removeToken();
100		} else if (state.state(SCARD_STATE_PRESENT)) {
101			// reader has a token inserted
102			secdebug("reader", "%p (%s) card present (0x%lx)",
103				this, name().c_str(), state.state());
104			//@@@ is this hack worth it (with notifications in)??
105			if (mToken && CssmData(state) != CssmData(pcscState()))
106				removeToken();  // incomplete but better than nothing
107			//@@@ or should we call some verify-still-the-same function of tokend?
108			//@@@ (I think pcsc will return an error if the card changed?)
109			if (!mToken)
110				insertToken(NULL);
111		} else {
112			secdebug("reader", "%p (%s) unexpected state change (0x%lx to 0x%lx)",
113				this, name().c_str(), oldState, state.state());
114		}
115	} catch (...) {
116		secdebug("reader", "state update exception (ignored)");
117	}
118}
119
120
121void Reader::insertToken(TokenDaemon *tokend)
122{
123	RefPointer<Token> token = new Token();
124	token->insert(*this, tokend);
125	mToken = token;
126	addReference(*token);
127	secdebug("reader", "%p (%s) inserted token %p",
128		this, name().c_str(), mToken);
129}
130
131
132void Reader::removeToken()
133{
134	secdebug("reader", "%p (%s) removing token %p",
135		this, name().c_str(), mToken);
136	assert(mToken);
137	mToken->remove();
138	removeReference(*mToken);
139	mToken = NULL;
140}
141
142
143//
144// Debug dump support
145//
146#if defined(DEBUGDUMP)
147
148void Reader::dumpNode()
149{
150	PerGlobal::dumpNode();
151	Debug::dump(" [%s] state=0x%lx", name().c_str(), mState.state());
152}
153
154#endif //DEBUGDUMP
155