cdsa/cdsa_utilities/acl_keychain.h

   1 /*
   2  * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 //
  20 // acl_keychain - a subject type for the protected-path
  21 //                                keychain prompt interaction model.
  22 //
  23 #ifndef _ACL_KEYCHAIN
  24 #define _ACL_KEYCHAIN
  25
  26 #include <Security/cssmacl.h>
  27 #include <string>
  28
  29 #ifdef _CPP_ACL_KEYCHAIN
  30 #pragma export on
  31 #endif
  32
  33 class KeychainPromptInterface;
  34 class SecurityAgentClient;
  35
  36
  37 //
  38 // This is the actual subject implementation class
  39 //
  40 class KeychainPromptAclSubject : public SimpleAclSubject {
  41 public:
  42     bool validate(const AclValidationContext &baseCtx, const TypedList &sample) const;
  43     CssmList toList(CssmAllocator &alloc) const;
  44
  45     KeychainPromptAclSubject(KeychainPromptInterface &ifc, string description);
  46
  47     void exportBlob(Writer::Counter &pub, Writer::Counter &priv);
  48     void exportBlob(Writer &pub, Writer &priv);
  49
  50     class Maker : public AclSubject::Maker {
  51     public:
  52         Maker(KeychainPromptInterface &ifc)
  53          : AclSubject::Maker(CSSM_ACL_SUBJECT_TYPE_KEYCHAIN_PROMPT),
  54            interface(ifc) { }
  55         KeychainPromptAclSubject *make(const TypedList &list) const;
  56         KeychainPromptAclSubject *make(Reader &pub, Reader &priv) const;
  57
  58     private:
  59         KeychainPromptInterface &interface;
  60     };
  61
  62 private:
  63     KeychainPromptInterface &interface;
  64     string description;
  65 };
  66
  67
  68 //
  69 // A KeychainPromptAcl needs to use some I/O facility to validate a credential.
  70 // You must thus subclass this interface class (which acts as an AclSubject::Maker)
  71 // to provide the actual testing interface. The subject type will take care of
  72 // the formalities.
  73 //
  74 class KeychainPromptInterface {
  75 public:
  76     KeychainPromptInterface() : maker(*this) { }
  77
  78     virtual bool validate(string description) = 0;      // implement this
  79
  80 private:
  81     const KeychainPromptAclSubject::Maker maker;
  82 };
  83
  84
  85 #ifdef _CPP_ACL_KEYCHAIN
  86 #pragma export off
  87 #endif
  88
  89
  90 #endif //_ACL_KEYCHAIN