OSX/libsecurity_cdsa_utilities/lib/cssmerrors.h

   1 /*
   2  * Copyright (c) 2000-2004,2006,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  * cssmerrors
  27  */
  28 #ifndef _H_CSSMERRORS
  29 #define _H_CSSMERRORS
  30
  31 #include <security_utilities/errors.h>
  32 #include <Security/cssmtype.h>
  33
  34 namespace Security
  35 {
  36
  37 //
  38 // A CSSM-originated error condition, represented by a CSSM_RETURN value.
  39 // This can represent both a convertible base error, or a module-specific
  40 // error condition.
  41 //
  42 class CssmError : public CommonError {
  43 protected:
  44     CssmError(CSSM_RETURN err, bool suppresslogging);
  45 public:
  46     const CSSM_RETURN error;
  47     virtual OSStatus osStatus() const;
  48         virtual int unixError() const;
  49     virtual const char *what () const _NOEXCEPT;
  50
  51     static CSSM_RETURN merge(CSSM_RETURN error, CSSM_RETURN base);
  52
  53         static void check(CSSM_RETURN error)    { if (error != CSSM_OK) throwMe(error); }
  54     static void throwMe(CSSM_RETURN error) __attribute__((noreturn));
  55     static void throwMeNoLogging(CSSM_RETURN err) __attribute__((noreturn));
  56
  57         //
  58         // Obtain a CSSM_RETURN from any CommonError
  59         //
  60         static CSSM_RETURN cssmError(CSSM_RETURN error, CSSM_RETURN base);
  61         static CSSM_RETURN cssmError(const CommonError &error, CSSM_RETURN base);
  62 };
  63
  64
  65
  66 } // end namespace Security
  67
  68
  69 #endif //_H_CSSMERRORS