cdsa/cdsa_client/cssmclient.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 // cssmclient - common client interface to CSSM and MDS
  21 //
  22 #ifndef _H_CDSA_CLIENT_CSSMCLIENT
  23 #define _H_CDSA_CLIENT_CSSMCLIENT  1
  24
  25 #include <Security/utilities.h>
  26 #include <Security/threading.h>
  27 #include <Security/globalizer.h>
  28 #include <Security/cssmalloc.h>
  29 #include <Security/refcount.h>
  30 #include <map>
  31 #include <stdio.h>      // debug
  32
  33 namespace Security
  34 {
  35
  36 namespace CssmClient
  37 {
  38
  39 //
  40 // Forward declarations
  41 //
  42 class Cssm;
  43 class Module;
  44 class Attachment;
  45
  46
  47 //
  48 // An mixin for objects that have (store) GUIDs.
  49 // The GUID value is meant to be set-once constant, and can be locked handled accordingly.
  50 //
  51 class HasGuid {
  52 public:
  53         HasGuid(const Guid &guid) { mGuid = guid; }
  54         HasGuid() { }
  55
  56         const Guid &guid() const { return mGuid; }
  57
  58 protected:
  59         void setGuid(const Guid &guid) { mGuid = guid; }
  60
  61 private:
  62         Guid mGuid;
  63 };
  64
  65
  66 //
  67 // Exceptions are based on the CssmError utility class. We add our own class of client-side exceptions.
  68 //
  69 class Error : public CssmError {
  70 public:
  71         Error(int err) : CssmError(err) { }
  72         CSSM_RETURN cssmError() const;
  73         virtual const char *what () const throw();
  74
  75         enum {
  76                 objectBusy = -1,
  77         };
  78 };
  79
  80
  81 //
  82 // The CssmObject abstract class models features common to different Cssm objects.
  83 // It handles a tree hierarchy of objects (parent/children) safely.
  84 //
  85 class Object;
  86
  87 class ObjectImpl : virtual public RefCount
  88 {
  89 public:
  90         explicit ObjectImpl(); // Constructor for Impl objects without a parent.
  91         explicit ObjectImpl(const Object &parent);
  92         virtual ~ObjectImpl();
  93
  94         bool isActive() const { return mActive; }
  95
  96         virtual CssmAllocator &allocator() const;
  97         virtual void allocator(CssmAllocator &alloc);
  98
  99         // Pointer comparison by default.  Subclasses may override.
 100         virtual bool operator <(const ObjectImpl &other) const;
 101         virtual bool operator ==(const ObjectImpl &other) const;
 102
 103         static void check(CSSM_RETURN status);
 104
 105 protected:
 106         bool mActive;                                   // loaded, attached, etc.
 107         mutable CssmAllocator *mAllocator; // allocator hierarchy (NULL => TBD)
 108
 109         template <class Obj> Obj parent() const
 110         { assert(mParent); return Obj(static_cast<typename Obj::Impl *>(&(*mParent))); }
 111
 112         void addChild();
 113         void removeChild();
 114         bool isIdle() const { return mChildCount == 0; }
 115
 116         // {de,}activate() assume you have locked *this
 117         virtual void activate() = 0;
 118         virtual void deactivate() = 0;
 119
 120 private:
 121         RefPointer<ObjectImpl> mParent;         // parent object
 122         AtomicCounter<uint32> mChildCount;
 123 };
 124
 125
 126 class Object
 127 {
 128         friend class ObjectImpl;
 129 public:
 130         typedef ObjectImpl Impl;
 131         explicit Object(Impl *impl) : mImpl(impl) {}
 132
 133 protected:
 134         // @@@ CSPDL subclass breaks if the is a static_cast
 135         template <class _Impl> _Impl &impl() const
 136         { return dynamic_cast<_Impl &>(*mImpl); }
 137
 138 public:
 139         Impl *operator ->() const { return &(*mImpl); }
 140         Impl &operator *() const { return *mImpl; }
 141
 142         // @@@ Why is this needed.  DbCursor which inheirits from Object wants to call this.
 143         template <class _Impl> _Impl &checkedImpl() const
 144         { return dynamic_cast<_Impl &>(*mImpl); }
 145
 146         bool operator !() const { return !mImpl; }
 147         operator bool() const { return mImpl; }
 148
 149     bool isActive() const                               { return mImpl && mImpl->isActive(); }
 150     CssmAllocator &allocator() const    { return mImpl->allocator(); }
 151
 152         bool operator <(const Object &other) const
 153         { return mImpl && other.mImpl ? *mImpl < *other.mImpl : mImpl < other.mImpl; }
 154         bool operator ==(const Object &other) const
 155         { return mImpl && other.mImpl ? *mImpl == *other.mImpl : mImpl == other.mImpl; }
 156
 157 private:
 158         RefPointer<Impl> mImpl;
 159 };
 160
 161
 162 //
 163 // A CSSM loadable module.
 164 // You rarely directly interact with these objects, but if you need to,
 165 // here they are.
 166 //
 167 class ModuleImpl : public ObjectImpl, public HasGuid
 168 {
 169 public:
 170         ModuleImpl(const Guid &guid);
 171         ModuleImpl(const Guid &guid, const Cssm &session);
 172         virtual ~ModuleImpl();
 173
 174         void load() { activate(); }
 175         void unload() { deactivate(); }
 176         bool isLoaded() const { return isActive(); }
 177
 178         Cssm session() const;
 179
 180 protected:
 181         void activate();
 182         void deactivate();
 183 };
 184
 185 class Module : public Object
 186 {
 187 public:
 188         typedef ModuleImpl Impl;
 189         explicit Module(Impl *impl) : Object(impl) {}
 190         Module() : Object(NULL) {} // XXX This might break operator <
 191         Module(const Guid &guid) : Object(new Impl(guid)) {}
 192         Module(const Guid &guid, const Cssm &session) : Object(new Impl(guid, session)) {}
 193
 194         Impl *operator ->() const { return &impl<Impl>(); }
 195         Impl &operator *() const { return impl<Impl>(); }
 196 };
 197
 198
 199 //
 200 // An Attachment object. This is the base class of all typed attachment classes.
 201 //
 202 class AttachmentImpl : public ObjectImpl
 203 {
 204 public:
 205         AttachmentImpl(const Guid &guid, CSSM_SERVICE_TYPE subserviceType);
 206         AttachmentImpl(const Module &module, CSSM_SERVICE_TYPE subserviceType);
 207         //AttachmentImpl(... mds reference ...);
 208         virtual ~AttachmentImpl();
 209
 210         // Virtual so that subclasses can return there true mask.
 211         virtual CSSM_SERVICE_MASK subserviceMask() const;
 212
 213         CSSM_SERVICE_TYPE subserviceType() const { return mSubserviceType; }
 214         CSSM_VERSION version() const { return mVersion; }
 215         void version(const CSSM_VERSION &v) { mVersion = v; }
 216         uint32 subserviceId() const { return mSubserviceId; }
 217         virtual void subserviceId(uint32 id);
 218         CSSM_ATTACH_FLAGS flags() const { return mAttachFlags; }
 219         void flags(CSSM_ATTACH_FLAGS f) { mAttachFlags = f; }
 220
 221         void attach() { activate(); }
 222         void detach() { deactivate(); }
 223         bool attached() const { return isActive(); }
 224
 225         Module module() const;
 226         const Guid &guid() const { return module()->guid(); }
 227         CSSM_MODULE_HANDLE handle() { attach(); return mHandle; }
 228
 229         CssmSubserviceUid subserviceUid() const;
 230
 231 protected:
 232         void activate();
 233         void deactivate();
 234
 235 private:
 236         void make(CSSM_SERVICE_TYPE subserviceType);    // common constructor
 237
 238         CSSM_MODULE_HANDLE mHandle;
 239
 240         CSSM_SERVICE_TYPE mSubserviceType;                              // set by constructor
 241         CSSM_VERSION mVersion;
 242         uint32 mSubserviceId;
 243         CSSM_ATTACH_FLAGS mAttachFlags;
 244
 245         CssmAllocatorMemoryFunctions mMemoryFunctions;  // set on attach()
 246 };
 247
 248 class Attachment : public Object
 249 {
 250 public:
 251         typedef AttachmentImpl Impl;
 252         explicit Attachment(Impl *impl) : Object(impl) {}
 253         Attachment(const Guid &guid, CSSM_SERVICE_TYPE subserviceType)
 254         : Object(new Impl(guid, subserviceType)) {}
 255         Attachment(const Module &module, CSSM_SERVICE_TYPE subserviceType)
 256         : Object(new Impl(module, subserviceType)) {}
 257         //Attachment(... mds reference ...);
 258
 259         Impl *operator ->() const { return &impl<Impl>(); }
 260         Impl &operator *() const { return impl<Impl>(); }
 261 };
 262
 263
 264 //
 265 // A CSSM session object.
 266 // You usually only have one per program, or library, or what-not.
 267 //
 268 class Cssm;
 269
 270 class CssmImpl : public ObjectImpl {
 271     class StandardCssm; friend class StandardCssm;
 272 public:
 273         CssmImpl();
 274         virtual ~CssmImpl();
 275
 276         void init() { activate(); }
 277         void terminate() { deactivate(); }
 278
 279         CSSM_PRIVILEGE_SCOPE scope() const { return mScope; }
 280         void scope(CSSM_PRIVILEGE_SCOPE sc) { mScope = sc; }
 281         const Guid &callerGuid() const { return mCallerGuid; }
 282         void callerGuid(const CSSM_GUID &guid) { mCallerGuid = Guid::overlay(guid); }
 283
 284         Module autoModule(const Guid &guid);
 285
 286 protected:
 287         explicit CssmImpl(bool);                                // internal constructor
 288
 289         void setup();                                                   // constructor setup
 290
 291         void activate();
 292         void deactivate();
 293
 294 private:
 295         // CSSM global configuration -- picked up on each Init
 296         CSSM_VERSION mVersion;
 297         CSSM_PRIVILEGE_SCOPE mScope;
 298         Guid mCallerGuid;
 299
 300         // module repository: modules by guid (protected by self)
 301         typedef map<Guid, Module> ModuleMap;
 302         ModuleMap moduleMap;
 303         Mutex mapLock;
 304
 305 public:
 306         static Cssm standard();
 307         static void catchExit();
 308
 309 private:
 310         static void atExitHandler();
 311
 312     class StandardCssm : public Mutex {
 313     public:
 314         StandardCssm() : mCssm(NULL) { }
 315         ~StandardCssm();
 316         void setCssm(CssmImpl *cssm);
 317         void unsetCssm(CssmImpl *cssm);
 318         CssmImpl *get();
 319
 320     private:
 321         CssmImpl *mCssm;
 322     };
 323     static ModuleNexus<StandardCssm> mStandard;
 324 };
 325
 326 class Cssm : public Object
 327 {
 328 public:
 329         typedef CssmImpl Impl;
 330         explicit Cssm(Impl *impl) : Object(impl) {}
 331         explicit Cssm() : Object(new Impl()) {}
 332
 333         Impl *operator ->() const { return &impl<Impl>(); }
 334         Impl &operator *() const { return impl<Impl>(); }
 335
 336         static Cssm standard() { return CssmImpl::standard(); }
 337 };
 338
 339 } // end namespace CssmClient
 340
 341 } // end namespace Security
 342
 343 #endif // _H_CDSA_CLIENT_CSSMCLIENT