Keychain/KCUtilities.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 #ifdef _KC_UTILS
  20 # pragma export on
  21 #endif
  22
  23 #include <Security/SecKeychainAPI.h>
  24 #include <Security/utilities.h>
  25 #include <CoreServices/../Frameworks/CarbonCore.framework/Headers/MacErrors.h>
  26 #include <memory>
  27
  28 namespace Security
  29 {
  30
  31 OSStatus GetKeychainErrFromCSSMErr(OSStatus cssmError);
  32
  33 //
  34 // Helpers for memory pointer validation
  35 //
  36 template <class T>
  37 inline T &RequiredParam(T *ptr,OSStatus err = paramErr)
  38 {
  39     if (ptr == NULL)
  40         MacOSError::throwMe(err);
  41     return *ptr;
  42 }
  43
  44 class StKCAttribute
  45 {
  46 public:
  47                     StKCAttribute( SecKeychainAttribute* attr );
  48         virtual         ~StKCAttribute( void );
  49 private:
  50         SecKeychainAttribute*   fAttr;
  51 };
  52
  53 // Class for cleaning up a KCItemRef when finished with it
  54 // if an error occurs at any time when dealing with the item.
  55 //
  56 class StKCItem
  57 {
  58 public:
  59                     StKCItem( SecKeychainItemRef* item, OSStatus* result );
  60         virtual         ~StKCItem( void );
  61 private:
  62         SecKeychainItemRef*     fItem;
  63         OSStatus*       fResult;
  64 };
  65
  66 } // end namespace Security
  67
  68 #ifdef _KC_UTILS
  69 #pragma export off
  70 #endif