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
  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 typedef struct OpaqueSecRVC *SecRVCRef;
  57
  58 /* OCSP Revocation verification context. */
  59 struct OpaqueSecORVC {
  60     /* Pointer to the builder for this revocation check. */
  61     SecPathBuilderRef builder;
  62
  63     /* Pointer to the generic rvc for this revocation check */
  64     SecRVCRef rvc;
  65
  66     /* The ocsp request we send to each responder. */
  67     SecOCSPRequestRef ocspRequest;
  68
  69     /* The freshest response we received so far, from stapling or cache or responder. */
  70     SecOCSPResponseRef ocspResponse;
  71
  72     /* The best validated candidate single response we received so far, from stapling or cache or responder. */
  73     SecOCSPSingleResponseRef ocspSingleResponse;
  74
  75     /* Index of cert in builder that this RVC is for 0 = leaf, etc. */
  76     CFIndex certIX;
  77
  78     /* Date until which this revocation status is valid. */
  79     CFAbsoluteTime nextUpdate;
  80
  81     /* URL of current responder. For logging purposes. */
  82     CFURLRef responder;
  83
  84     bool done;
  85 };
  86
  87 bool SecPathBuilderCheckRevocation(SecPathBuilderRef builder);
  88 void SecPathBuilderCheckKnownIntermediateConstraints(SecPathBuilderRef builder);
  89 CFAbsoluteTime SecRVCGetEarliestNextUpdate(SecRVCRef rvc);
  90 void SecRVCDelete(SecRVCRef rvc);
  91 bool SecRVCHasDefinitiveValidInfo(SecRVCRef rvc);
  92 bool SecRVCHasRevokedValidInfo(SecRVCRef rvc);
  93 void SecRVCSetValidDeterminedErrorResult(SecRVCRef rvc);
  94
  95 /* OCSP verification callbacks */
  96 void SecORVCConsumeOCSPResponse(SecORVCRef rvc, SecOCSPResponseRef ocspResponse /*CF_CONSUMED*/,
  97                                 CFTimeInterval maxAge, bool updateCache, bool fromCache);
  98 void SecORVCUpdatePVC(SecORVCRef rvc);
  99
 100
 101 #endif /* _SECURITY_SECREVOCATIONSERVER_H_ */