sec/Security/SecBase.h

   1 /*
   2  * Copyright (c) 2000-2009,2011-2013 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         @header SecBase
  26         SecBase contains common declarations for the Security functions.
  27 */
  28
  29 #ifndef _SECURITY_SECBASE_H_
  30 #define _SECURITY_SECBASE_H_
  31
  32 #include <Availability.h>
  33 #include <sys/cdefs.h>
  34
  35 #if defined(__clang__)
  36 #define SEC_DEPRECATED_ATTRIBUTE DEPRECATED_ATTRIBUTE
  37 #else
  38 #define SEC_DEPRECATED_ATTRIBUTE
  39 #endif
  40
  41 __BEGIN_DECLS
  42
  43 /*!
  44     @typedef SecCertificateRef
  45     @abstract CFType representing a X.509 certificate.
  46     See SecCertificate.h for details.
  47 */
  48 typedef struct __SecCertificate *SecCertificateRef;
  49
  50 /*!
  51     @typedef SecIdentityRef
  52     @abstract CFType representing an identity, which contains
  53     a SecKeyRef and an associated SecCertificateRef. See
  54     SecIdentity.h for details.
  55 */
  56 typedef struct __SecIdentity *SecIdentityRef;
  57
  58 /*!
  59     @typedef SecKeyRef
  60     @abstract CFType representing a cryptographic key. See
  61     SecKey.h for details.
  62 */
  63 typedef struct __SecKey *SecKeyRef;
  64
  65 /*!
  66     @typedef SecPolicyRef
  67     @abstract CFType representing a X.509 certificate trust policy.
  68     See SecPolicy.h for details.
  69 */
  70 typedef struct __SecPolicy *SecPolicyRef;
  71
  72 /***********************************************
  73  *** OSStatus values unique to Security APIs ***
  74  ***********************************************/
  75
  76 /*
  77     Note: the comments that appear after these errors are used to create
  78     SecErrorMessages.strings. The comments must not be multi-line, and
  79     should be in a form meaningful to an end user. If a different or
  80     additional comment is needed, it can be put in the header doc format,
  81     or on a line that does not start with errZZZ.
  82 */
  83
  84 enum
  85 {
  86     errSecSuccess                               = 0,       /* No error. */
  87     errSecUnimplemented                         = -4,      /* Function or operation not implemented. */
  88     errSecIO                                    = -36,     /*I/O error (bummers)*/
  89     errSecOpWr                                  = -49,     /*file already open with with write permission*/
  90     errSecParam                                 = -50,     /* One or more parameters passed to a function where not valid. */
  91     errSecAllocate                              = -108,    /* Failed to allocate memory. */
  92     errSecUserCanceled                          = -128,    /* User canceled the operation. */
  93     errSecBadReq                                = -909,    /* Bad parameter or invalid state for operation. */
  94     errSecInternalComponent                     = -2070,
  95     errSecNotAvailable                          = -25291,  /* No keychain is available. You may need to restart your computer. */
  96     errSecDuplicateItem                         = -25299,  /* The specified item already exists in the keychain. */
  97     errSecItemNotFound                          = -25300,  /* The specified item could not be found in the keychain. */
  98     errSecInteractionNotAllowed                 = -25308,  /* User interaction is not allowed. */
  99     errSecDecode                                = -26275,  /* Unable to decode the provided data. */
 100     errSecAuthFailed                            = -25293,  /* The user name or passphrase you entered is not correct. */
 101 };
 102
 103 __END_DECLS
 104
 105 #endif /* !_SECURITY_SECBASE_H_ */