securityd/src/reader.h

   1 /*
   2  * Copyright (c) 2004,2008,2014 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 #ifndef _H_READER
  29 #define _H_READER
  30
  31 #include "structure.h"
  32 #include "token.h"
  33 #include "tokencache.h"
  34 #include <security_utilities/pcsc++.h>
  35
  36
  37 //
  38 // A Reader object represents a token (card) reader device attached to the
  39 // system.
  40 //
  41 class Reader : public PerGlobal {
  42 public:
  43         Reader(TokenCache &cache, const PCSC::ReaderState &state);      // PCSC managed
  44         Reader(TokenCache &cache, const std::string &name);                     // software
  45         ~Reader();
  46
  47         enum Type {
  48                 pcsc,                           // represents PCSC-managed reader
  49                 software                        // software (virtual) reader,
  50         };
  51         Type type() const { return mType; }
  52         bool isType(Type type) const;
  53
  54         TokenCache &cache;
  55
  56         void kill();
  57
  58         const string &name() const { return mName; }
  59         const string &printName() const { return mPrintName; }
  60         const PCSC::ReaderState &pcscState() const { return mState; }
  61
  62         void insertToken(TokenDaemon *tokend);
  63         void update(const PCSC::ReaderState &state);
  64         void removeToken();
  65
  66         IFDUMP(void dumpNode());
  67
  68 protected:
  69
  70 private:
  71         Type mType;
  72         string mName;                   // PCSC reader name
  73         string mPrintName;              // human readable name of reader
  74         PCSC::ReaderState mState; // name field not valid (use mName)
  75         Token *mToken;                  // token inserted here (also in references)
  76 };
  77
  78
  79 #endif //_H_READER