OSX/sec/securityd/SecRevocationServer.h

   1 /*
   2  * Copyright (c) 2017-2018 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 SecRevocationServer
  26  The functions provided in SecRevocationServer.h provide an interface to
  27  the trust evaluation engine for dealing with certificate revocation.
  28  */
  29
  30 #ifndef _SECURITY_SECREVOCATIONSERVER_H_
  31 #define _SECURITY_SECREVOCATIONSERVER_H_
  32
  33 #include <securityd/SecTrustServer.h>
  34 #include <securityd/SecRevocationDb.h>
  35 #include <securityd/SecOCSPRequest.h>
  36 #include <securityd/SecOCSPResponse.h>
  37
  38 typedef struct OpaqueSecORVC *SecORVCRef;
  39 #if ENABLE_CRLS
  40 typedef struct OpaqueSecCRVC *SecCRVCRef;
  41 #endif
  42
  43 /* Revocation verification context. */
  44 struct OpaqueSecRVC {
  45     /* Pointer to the builder for this revocation check */
  46     SecPathBuilderRef   builder;
  47
  48     /* Index of cert in pvc that this RVC is for 0 = leaf, etc. */
  49     CFIndex             certIX;
  50
  51     /* The OCSP Revocation verification context */
  52     SecORVCRef          orvc;
  53
  54 #if ENABLE_CRLS
  55     SecCRVCRef          crvc;
  56 #endif
  57
  58     /* Valid database info for this revocation check */
  59     SecValidInfoRef     valid_info;
  60
  61     bool                done;
  62 };
  63 typedef struct OpaqueSecRVC *SecRVCRef;
  64
  65 /* OCSP Revocation verification context. */
  66 struct OpaqueSecORVC {
  67     /* Pointer to the builder for this revocation check. */
  68     SecPathBuilderRef builder;
  69
  70     /* Pointer to the generic rvc for this revocation check */
  71     SecRVCRef rvc;
  72
  73     /* The ocsp request we send to each responder. */
  74     SecOCSPRequestRef ocspRequest;
  75
  76     /* The freshest response we received so far, from stapling or cache or responder. */
  77     SecOCSPResponseRef ocspResponse;
  78
  79     /* The best validated candidate single response we received so far, from stapling or cache or responder. */
  80     SecOCSPSingleResponseRef ocspSingleResponse;
  81
  82     /* Index of cert in builder that this RVC is for 0 = leaf, etc. */
  83     CFIndex certIX;
  84
  85     /* Date until which this revocation status is valid. */
  86     CFAbsoluteTime nextUpdate;
  87
  88     /* URL of current responder. For logging purposes. */
  89     CFURLRef responder;
  90
  91     bool done;
  92 };
  93
  94 bool SecPathBuilderCheckRevocation(SecPathBuilderRef builder);
  95 void SecPathBuilderCheckKnownIntermediateConstraints(SecPathBuilderRef builder);
  96 CFAbsoluteTime SecRVCGetEarliestNextUpdate(SecRVCRef rvc);
  97 void SecRVCDelete(SecRVCRef rvc);
  98 bool SecRVCHasDefinitiveValidInfo(SecRVCRef rvc);
  99 bool SecRVCHasRevokedValidInfo(SecRVCRef rvc);
 100 void SecRVCSetValidDeterminedErrorResult(SecRVCRef rvc);
 101
 102 /* OCSP verification callbacks */
 103 void SecORVCConsumeOCSPResponse(SecORVCRef rvc, SecOCSPResponseRef ocspResponse /*CF_CONSUMED*/,
 104                                 CFTimeInterval maxAge, bool updateCache, bool fromCache);
 105 void SecORVCUpdatePVC(SecORVCRef rvc);
 106
 107
 108 #endif /* _SECURITY_SECREVOCATIONSERVER_H_ */