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