OSX/include/security_utilities/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
  59
  60 //
  61 // Genuine Unix-originated errors identified by an errno value.
  62 // This includes secondary sources such as pthreads.
  63 //
  64 class UnixError : public CommonError {
  65 protected:
  66     UnixError();
  67     UnixError(int err);
  68 public:
  69     const int error;
  70     virtual OSStatus osStatus() const;
  71         virtual int unixError() const;
  72     virtual const char *what () const throw ();
  73
  74     static void check(int result)               { if (result == -1) throwMe(); }
  75     static void throwMe(int err = errno) __attribute__((noreturn));
  76
  77     // @@@ This is a hack for the Network protocol state machine
  78     static UnixError make(int err = errno) DEPRECATED_ATTRIBUTE;
  79 };
  80
  81
  82 //
  83 // Genuine MacOS (X) errors identified by an OSStatus value.
  84 // Don't even think of working with OSErr values; use OSStatus.
  85 //
  86 class MacOSError : public CommonError {
  87 protected:
  88     MacOSError(int err);
  89 public:
  90     const int error;
  91     virtual OSStatus osStatus() const;
  92         virtual int unixError() const;
  93     virtual const char *what () const throw ();
  94
  95     static void check(OSStatus status)  { if (status != errSecSuccess) throwMe(status); }
  96     static void throwMe(int err) __attribute__((noreturn));
  97
  98     static MacOSError make(int err);
  99 };
 100
 101 typedef std::set<OSStatus> MacOSErrorSet;
 102
 103
 104 //
 105 // CoreFoundation errors.
 106 // Since CF prefers not to tell us *why* something didn't work, this
 107 // is not very useful - but it's better than faking it into one of the other
 108 // error spaces.
 109 //
 110 class CFError : public CommonError {
 111 protected:
 112         CFError();
 113 public:
 114         virtual OSStatus osStatus() const;
 115         virtual int unixError() const;
 116         virtual const char *what () const throw ();
 117
 118         template <class T>
 119         static void check(const T &p)           { if (!p) throwMe(); }
 120
 121         static void throwMe() __attribute__((noreturn));
 122 };
 123
 124
 125 // Something that gets thrown when ModuleNexus creation fails
 126 class ModuleNexusError : public CommonError {
 127 protected:
 128     ModuleNexusError() {}
 129
 130 public:
 131     virtual OSStatus osStatus() const;
 132         virtual int unixError() const;
 133     static void throwMe() __attribute__((noreturn));
 134 };
 135
 136 } // end namespace Security
 137
 138
 139 #endif //_H_UTILITIES_ERROR