lib/cserror.h

   1 /*
   2  * Copyright (c) 2007 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 // cserror.h - extended-diagnostics Code Signing errors
  26 //
  27 #ifndef _H_CSERRORS
  28 #define _H_CSERRORS
  29
  30 #include <security_utilities/cfutilities.h>
  31 #include <security_utilities/debugging.h>
  32
  33
  34 namespace Security {
  35 namespace CodeSigning {
  36
  37
  38 //
  39 // Special tailored exceptions to transmit additional error information
  40 //
  41 class CSError : public MacOSError {
  42 public:
  43         CSError(OSStatus rc) : MacOSError(rc) { }
  44         CSError(OSStatus rc, CFDictionaryRef dict) : MacOSError(rc), mInfoDict(dict) { } // takes dict
  45         ~CSError() throw ();
  46
  47     static void throwMe(OSStatus rc) __attribute__((noreturn));
  48         static void throwMe(OSStatus rc, CFDictionaryRef info) __attribute__ ((noreturn)); // takes dict
  49     static void throwMe(OSStatus rc, CFStringRef key, CFTypeRef value) __attribute__((noreturn));
  50
  51         void augment(CFStringRef key, CFTypeRef value);
  52
  53         CFDictionaryRef infoDict() const { return mInfoDict; }
  54
  55 public:
  56         OSStatus cfError(CFErrorRef *errors) const;
  57         static OSStatus cfError(CFErrorRef *errors, OSStatus rc);
  58
  59 private:
  60         CFRef<CFDictionaryRef> mInfoDict;
  61 };
  62
  63
  64 }       // CodeSigning
  65 }       // Security
  66
  67 #endif //_H_CSERRORS