sec/securityd/SecOCSPRequest.h

   1 /*
   2  * Copyright (c) 2009 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 SecOCSPRequest
  26         The functions and data types in SecOCSPRequest implement ocsp request
  27     creation.
  28 */
  29
  30 #ifndef _SECURITY_SECOCSPREQUEST_H_
  31 #define _SECURITY_SECOCSPREQUEST_H_
  32
  33 #include <Security/SecAsn1Coder.h>
  34 #include <CoreFoundation/CFData.h>
  35
  36 #if defined(__cplusplus)
  37 extern "C" {
  38 #endif
  39
  40 /*!
  41         @typedef SecOCSPRequestRef
  42         @abstract Object used for ocsp response decoding.
  43 */
  44 typedef struct __SecOCSPRequest *SecOCSPRequestRef;
  45
  46 struct __SecOCSPRequest {
  47     SecCertificateRef certificate; // Nonretained
  48     SecCertificateRef issuer; // Nonretained
  49     CFDataRef der;
  50 };
  51
  52 /*!
  53         @function SecOCSPRequestCreate
  54         @abstract Returns a SecOCSPRequestRef from a BER encoded ocsp response.
  55         @param certificate The certificate for which we want a OCSP request created.
  56         @param issuer The parent of certificate.
  57         @result A SecOCSPRequestRef.
  58 */
  59 SecOCSPRequestRef SecOCSPRequestCreate(SecCertificateRef certificate,
  60     SecCertificateRef issuer);
  61
  62 /*!
  63         @function SecOCSPRequestCopyDER
  64         @abstract Returns a DER encoded ocsp request.
  65         @param ocspRequest A SecOCSPRequestRef.
  66         @result DER encoded ocsp request.
  67 */
  68 CFDataRef SecOCSPRequestGetDER(SecOCSPRequestRef ocspRequest);
  69
  70 /*!
  71         @function SecOCSPRequestFinalize
  72         @abstract Frees a SecOCSPRequestRef.
  73         @param ocspRequest A SecOCSPRequestRef.
  74         @result The passed in SecOCSPRequestRef is deallocated
  75 */
  76 void SecOCSPRequestFinalize(SecOCSPRequestRef ocspRequest);
  77
  78 #if defined(__cplusplus)
  79 }
  80 #endif
  81
  82 #endif /* !_SECURITY_SECOCSPREQUEST_H_ */