]> git.saurik.com Git - apple/security.git/blobdiff - sec/Security/SecPolicyPriv.h
Security-55163.44.tar.gz
[apple/security.git] / sec / Security / SecPolicyPriv.h
diff --git a/sec/Security/SecPolicyPriv.h b/sec/Security/SecPolicyPriv.h
new file mode 100644 (file)
index 0000000..96615ab
--- /dev/null
@@ -0,0 +1,247 @@
+/*
+ * Copyright (c) 2007-2009 Apple Inc. All Rights Reserved.
+ * 
+ * @APPLE_LICENSE_HEADER_START@
+ * 
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ * 
+ * @APPLE_LICENSE_HEADER_END@
+ */
+
+/*!
+    @header SecPolicyPriv
+    The functions provided in SecPolicyPriv provide an interface to various
+       X.509 certificate trust policies.
+*/
+
+#ifndef _SECURITY_SECPOLICYPRIV_H_
+#define _SECURITY_SECPOLICYPRIV_H_
+
+#include <Security/SecPolicy.h>
+#include <CoreFoundation/CFArray.h>
+#include <CoreFoundation/CFString.h>
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+/*!
+    @function SecPolicyCreateiPhoneActivation
+    @abstract Returns a policy object for verifying iPhone Activation
+    certificate chains.
+    @discussion This policy is like the Basic X.509 policy with the additional
+    requirements that the chain must contain exactly three certificates, the
+    anchor is the Apple Inc. CA, and the subject of the first intermediate
+    certificate has "Apple iPhone Certification Authority" as its only
+    Common Name entry.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateiPhoneActivation(void);
+
+/*!
+    @function SecPolicyCreateiPhoneDeviceCertificate
+    @abstract Returns a policy object for verifying iPhone Device certificate 
+    chains.
+    @discussion This policy is like the Basic X.509 policy with the additional
+    requirements that the chain must contain exactly four certificates, the
+    anchor is the Apple Inc. CA, and the subject of the first intermediate
+    certificate has "Apple iPhone Device CA" as its only Common Name entry.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateiPhoneDeviceCertificate(void);
+
+/*!
+    @function SecPolicyCreateFactoryDeviceCertificate
+    @abstract Returns a policy object for verifying Factory Device certificate 
+    chains.
+    @discussion This policy is like the Basic X.509 policy with the additional
+    requirements that the chain must be anchored to the factory device certificate
+    issuer.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateFactoryDeviceCertificate(void);
+
+/*!
+    @function SecPolicyCreateiAP
+    @abstract Returns a policy object for verifying iAP certificate chains.
+    @discussion This policy is like the Basic X.509 policy with these
+       additional requirements:
+        * The leaf's NotValidBefore should be greater than 5/31/06 midnight GMT.
+        * The Common Name of the leaf begins with the characters "IPA_".
+        * No validity checking is performed for any of the certificates.
+       The intended use of this policy is that the caller pass in the
+       intermediates for iAP1 and iAP2 to SecTrustSetAnchorCertificates().
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateiAP(void);
+
+/*!
+    @function SecPolicyCreateiTunesStoreURLBag
+    @abstract Returns a policy object for verifying iTunes Store URL bag
+    certificates.
+    @discussion This policy is like the Basic X.509 policy with these
+       additional requirements:
+        * The leaf's Organization is Apple Inc.
+        * The Common Name of the leaf is "iTunes Store URL Bag".
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateiTunesStoreURLBag(void);
+
+/*!
+    @function SecPolicyCreateEAP
+    @abstract Returns a policy object for verifying for 802.1x/EAP certificates.
+       @param server Passing true for this parameter create a policy for EAP
+       server certificates.
+       @param trustedServerNames Optional; if present, the hostname in the leaf
+    certificate must be in the trustedServerNames list.  Note that contrary
+    to all other policies the trustedServerNames list entries can have wildcards
+    whilst the certificate cannot.  This matches the existing deployments.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateEAP(Boolean server, CFArrayRef trustedServerNames);
+
+/*!
+    @function SecPolicyCreateIPSec
+    @abstract Returns a policy object for evaluating IPSec certificate chains.
+       @param server Passing true for this parameter create a policy for IPSec
+       server certificates.
+       @param hostname Optional; if present, the policy will require the specified
+       hostname or ip address to match the hostname in the leaf certificate.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateIPSec(Boolean server, CFStringRef hostname);
+
+/*!
+    @function SecPolicyCreateiPhoneApplicationSigning
+    @abstract Returns a policy object for evaluating signed application
+    signatures.  This is for apps signed directly by the app store.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateiPhoneApplicationSigning(void);
+
+/*!
+    @function SecPolicyCreateiPhoneProfileApplicationSigning
+    @abstract Returns a policy object for evaluating signed application
+    signatures.  This is meant for certificates inside a UPP or regular
+    profile.  Currently it only checks for experation of the leaf and
+    revocation status.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateiPhoneProfileApplicationSigning(void);
+
+/*!
+    @function SecPolicyCreateiPhoneProvisioningProfileSigning
+    @abstract Returns a policy object for evaluating provisioning profile signatures.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateiPhoneProvisioningProfileSigning(void);
+
+/*!
+    @function SecPolicyCreateOCSPSigner
+    @abstract Returns a policy object for evaluating ocsp response signers.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateOCSPSigner(void);
+
+/*!
+    @function SecPolicyCreateRevocation
+    @abstract Returns a policy object for checking revocation of certificates.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateRevocation(void);
+
+enum {
+    kSecSignSMIMEUsage = (1 << 0),
+    kSecKeyEncryptSMIMEUsage = (1 << 1),
+    kSecDataEncryptSMIMEUsage = (1 << 2),
+    kSecKeyExchangeDecryptSMIMEUsage = (1 << 3),
+    kSecKeyExchangeEncryptSMIMEUsage = (1 << 4),
+    kSecKeyExchangeBothSMIMEUsage = (1 << 5),
+    kSecAnyEncryptSMIME = kSecKeyEncryptSMIMEUsage | kSecDataEncryptSMIMEUsage |
+        kSecKeyExchangeDecryptSMIMEUsage | kSecKeyExchangeEncryptSMIMEUsage
+};
+
+/*!
+    @function SecPolicyCreateSMIME
+    @abstract Returns a policy object for evaluating S/MIME certificate chains.
+       @param smimeUsage Pass the bitwise or of one or more kSecXXXSMIMEUsage
+    flags, to indicated the intended usage of this certificate.  A certificate which allows 
+       @param email Optional; if present, the policy will require the specified
+       email to match the email in the leaf certificate.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateSMIME(CFIndex smimeUsage, CFStringRef email);
+
+/*!
+    @function SecPolicyCreateCodeSigning
+    @abstract Returns a policy object for evaluating code signing certificate chains.
+    @result A policy object. The caller is responsible for calling CFRelease
+       on this when it is no longer needed.
+*/
+SecPolicyRef SecPolicyCreateCodeSigning(void);
+
+/*!
+    @function SecPolicyCreateLockdownPairing
+    @abstract basic x509 policy for checking lockdown pairing certificate chains.
+        It explicitly allows for empty subjects
+*/
+SecPolicyRef SecPolicyCreateLockdownPairing(void);
+
+/*!
+ @function SecPolicyCreateURLBag
+ @abstract check for private CA, eku codesigning and certificate policy that
+ pertains to signing of URL bags.
+ */
+SecPolicyRef SecPolicyCreateURLBag(void);
+
+/*!
+ @function SecPolicyCreateOTATasking
+ @abstract check for 3 long chain through Apple Certification Policy with common name
+           "OTA Task Signing".
+ */
+SecPolicyRef SecPolicyCreateOTATasking(void);
+
+/*!
+ @function SecPolicyCreateMobileAsset
+ @abstract check for 3 long chain through Apple Certification Policy with common name
+           "Asset Manifest Signing".
+ */
+SecPolicyRef SecPolicyCreateMobileAsset(void);
+
+/*!
+    @function SecPolicyCreateAppleIDAuthorityPolicy
+    @abstract check for an Apple ID identity per marker in the leaf and marker in the intermediate, rooted in the Apple CA.
+ */
+SecPolicyRef SecPolicyCreateAppleIDAuthorityPolicy(void);
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* !_SECURITY_SECPOLICYPRIV_H_ */