OSX/libsecurity_utilities/lib/errors.h

   1 /*
   2  * Copyright (c) 2000-2004,2011-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 // Error hierarchy
  27 //
  28 #ifndef _H_UTILITIES_ERROR
  29 #define _H_UTILITIES_ERROR
  30
  31 #include <AvailabilityMacros.h>
  32 #include <exception>
  33 #include <errno.h>
  34 #include <Security/SecBase.h>
  35 #include <set>
  36 #undef check
  37
  38
  39 namespace Security {
  40
  41
  42 //
  43 // Common base of Security exceptions that represent error conditions.
  44 // All can yield Unix or OSStatus error codes as needed, though *how*
  45 // is up to the subclass implementation.
  46 // CSSM_RETURN conversions are done externally in (???).
  47 //
  48 class CommonError : public std::exception {
  49 protected:
  50     CommonError();
  51     CommonError(const CommonError &source);
  52 public:
  53     virtual ~CommonError() throw ();
  54
  55     virtual OSStatus osStatus() const = 0;
  56         virtual int unixError() const = 0;
  57
  58     char whatBuffer[128];
  59     const size_t whatBufferSize = sizeof(whatBuffer);
  60
  61     static void LogBacktrace();
  62 };
  63
  64
  65 //
  66 // Genuine Unix-originated errors identified by an errno value.
  67 // This includes secondary sources such as pthreads.
  68 //
  69 class UnixError : public CommonError {
  70 protected:
  71     UnixError();
  72     UnixError(int err);
  73 public:
  74     const int error;
  75     virtual OSStatus osStatus() const;
  76         virtual int unixError() const;
  77     virtual const char *what () const throw ();
  78
  79     static void check(int result)               { if (result == -1) throwMe(); }
  80     static void throwMe(int err = errno) __attribute__((noreturn));
  81
  82     // @@@ This is a hack for the Network protocol state machine
  83     static UnixError make(int err = errno) DEPRECATED_ATTRIBUTE;
  84 };
  85
  86
  87 //
  88 // Genuine MacOS (X) errors identified by an OSStatus value.
  89 // Don't even think of working with OSErr values; use OSStatus.
  90 //
  91 class MacOSError : public CommonError {
  92 protected:
  93     MacOSError(int err);
  94 public:
  95     const int error;
  96     virtual OSStatus osStatus() const;
  97         virtual int unixError() const;
  98     virtual const char *what () const throw ();
  99
 100     static void check(OSStatus status)  { if (status != errSecSuccess) throwMe(status); }
 101     static void throwMe(int err) __attribute__((noreturn));
 102
 103     static MacOSError make(int err);
 104 };
 105
 106 typedef std::set<OSStatus> MacOSErrorSet;
 107
 108
 109 //
 110 // CoreFoundation errors.
 111 // Since CF prefers not to tell us *why* something didn't work, this
 112 // is not very useful - but it's better than faking it into one of the other
 113 // error spaces.
 114 //
 115 class CFError : public CommonError {
 116 protected:
 117         CFError();
 118 public:
 119         virtual OSStatus osStatus() const;
 120         virtual int unixError() const;
 121         virtual const char *what () const throw ();
 122
 123         template <class T>
 124         static void check(const T &p)           { if (!p) throwMe(); }
 125
 126         static void throwMe() __attribute__((noreturn));
 127 };
 128
 129
 130 // Something that gets thrown when ModuleNexus creation fails
 131 class ModuleNexusError : public CommonError {
 132 protected:
 133     ModuleNexusError() {}
 134
 135 public:
 136     virtual OSStatus osStatus() const;
 137         virtual int unixError() const;
 138     static void throwMe() __attribute__((noreturn));
 139 };
 140
 141 } // end namespace Security
 142
 143
 144 #endif //_H_UTILITIES_ERROR