X-Git-Url: https://git.saurik.com/apple/security.git/blobdiff_plain/80e2389990082500d76eb566d4946be3e786c3ef..d8f41ccd20de16f8ebe2ccc84d47bf1cb2b26bbb:/Security/libsecurity_smime/lib/SecCmsMessage.h

diff --git a/Security/libsecurity_smime/lib/SecCmsMessage.h b/Security/libsecurity_smime/lib/SecCmsMessage.h
new file mode 100644
index 00000000..39aa7275
--- /dev/null
+++ b/Security/libsecurity_smime/lib/SecCmsMessage.h
@@ -0,0 +1,163 @@
+/*
+ *  Copyright (c) 2004,2011-2012,2014 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 SecCmsMessage.h
+    @Copyright (c) 2004,2011-2012,2014 Apple Inc. All Rights Reserved.
+
+    @availability 10.4 and later
+    @abstract CMS message object interfaces
+    @abstract Interfaces of the CMS implementation.
+    @discussion A SecCmsMessage represent a Cryptographic Message
+                Syntax (CMS) object as described in rfc3369.
+                It can be encoded using a SecCmsEncoder into BER
+                data or obtained from a SecCmsDecoder and examined
+                using the functions below.
+ */
+
+#ifndef _SECURITY_SECCMSMESSAGE_H_
+#define _SECURITY_SECCMSMESSAGE_H_  1
+
+#include <Security/SecCmsBase.h>
+
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+
+/*!
+    @function
+    @abstract Create a CMS message object.
+    @param poolp Arena to allocate memory from, or NULL if new arena should
+        be created.
+    @result A pointer to a newly created SecCmsMessage.  When finished using
+        this the caller should call SecCmsMessageDestroy().  On failure
+        returns NULL.  In this case call PR_GetError() to find out what went
+        wrong.
+ */
+extern SecCmsMessageRef
+SecCmsMessageCreate(SecArenaPoolRef poolp);
+
+/*!
+    @function
+    @abstract Destroy a CMS message and all of its sub-pieces.
+    @param cmsg Pointer to a SecCmsMessage object.
+ */
+extern void
+SecCmsMessageDestroy(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract Return a copy of the given message.
+    @discussion  The copy may be virtual or may be real -- either way, the
+        result needs to be passed to SecCmsMessageDestroy later (as does the
+        original).
+    @param cmsg Pointer to a SecCmsMessage object.
+ */
+extern SecCmsMessageRef
+SecCmsMessageCopy(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract Return a pointer to the message's arena pool.
+ */
+extern SecArenaPoolRef
+SecCmsMessageGetArena(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract Return a pointer to the top level contentInfo.
+ */
+extern SecCmsContentInfoRef
+SecCmsMessageGetContentInfo(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract Return a pointer to the actual content. 
+    @discussion In the case of those types which are encrypted, this returns the *plain* content.
+                In case of nested contentInfos, this descends and retrieves the innermost content.
+ */
+extern CSSM_DATA_PTR
+SecCmsMessageGetContent(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract Count number of levels of CMS content objects in this message.
+    @discussion CMS data content objects do not count.
+ */
+extern int
+SecCmsMessageContentLevelCount(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract Find content level #n.
+    @discussion CMS data content objects do not count.
+ */
+extern SecCmsContentInfoRef
+SecCmsMessageContentLevel(SecCmsMessageRef cmsg, int n);
+
+/*!
+    @function
+    @abstract See if message contains certs along the way.
+ */
+extern Boolean
+SecCmsMessageContainsCertsOrCrls(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract See if message contains a encrypted submessage.
+ */
+extern Boolean
+SecCmsMessageIsEncrypted(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract See if message contains a signed submessage
+    @discussion If the CMS message has a SignedData with a signature (not just a SignedData)
+                return true; false otherwise.  This can/should be called before calling
+                VerifySignature, which will always indicate failure if no signature is
+                present, but that does not mean there even was a signature!
+                Note that the content itself can be empty (detached content was sent
+                another way); it is the presence of the signature that matters.
+ */
+extern Boolean
+SecCmsMessageIsSigned(SecCmsMessageRef cmsg);
+
+/*!
+    @function
+    @abstract See if content is empty.
+    @result Returns PR_TRUE is innermost content length is < minLen
+    @discussion XXX need the encrypted content length (why?)
+ */
+extern Boolean
+SecCmsMessageIsContentEmpty(SecCmsMessageRef cmsg, unsigned int minLen);
+
+extern Boolean
+SecCmsMessageContainsTSTInfo(SecCmsMessageRef cmsg);
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* _SECURITY_SECCMSMESSAGE_H_ */