ios/web/net/crw_cert_verification_controller.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef IOS_WEB_NET_CRW_CERT_VERIFICATION_CONTROLLER_H_
   6 #define IOS_WEB_NET_CRW_CERT_VERIFICATION_CONTROLLER_H_
   7
   8 #import <Foundation/Foundation.h>
   9
  10 #import "base/memory/ref_counted.h"
  11 #include "net/cert/cert_status_flags.h"
  12
  13 namespace net {
  14 class X509Certificate;
  15 }
  16
  17 namespace web {
  18
  19 class BrowserState;
  20
  21 // Accept policy for valid or invalid SSL cert.
  22 typedef NS_ENUM(NSInteger, CertAcceptPolicy) {
  23   // Cert status can't be determined due to an error. Caller should not proceed
  24   // with the load, but show net error page instead.
  25   CERT_ACCEPT_POLICY_NON_RECOVERABLE_ERROR = 0,
  26   // Cert is not valid. Caller may present SSL warning and ask user if they
  27   // want to proceed with the load.
  28   CERT_ACCEPT_POLICY_RECOVERABLE_ERROR,
  29   // Cert is valid. Caller should proceed with the load.
  30   CERT_ACCEPT_POLICY_ALLOW,
  31 };
  32
  33 // Completion handler called by decidePolicyForCert:host:completionHandler:.
  34 typedef void (^PolicyDecisionHandler)(web::CertAcceptPolicy, net::CertStatus);
  35
  36 }  // namespace web
  37
  38 // Provides various cert verification API that can be used for blocking requests
  39 // with bad SSL cert, presenting SSL interstitials and determining SSL status
  40 // for Navigation Items. Must be used on UI thread.
  41 @interface CRWCertVerificationController : NSObject
  42
  43 - (instancetype)init NS_UNAVAILABLE;
  44
  45 // Initializes CRWCertVerificationController with the given |browserState| which
  46 // cannot be null and must outlive CRWCertVerificationController.
  47 - (instancetype)initWithBrowserState:(web::BrowserState*)browserState
  48     NS_DESIGNATED_INITIALIZER;
  49
  50 // TODO(eugenebut): add API for:
  51 // - accepting bad SSL cert using CertPolicyCache
  52 // - querying SSL cert status for Navigation Item
  53
  54 // Decides the policy for the given |cert| for the given |host| and calls
  55 // |completionHandler| on completion. |completionHandler| cannot be null and
  56 // will be called synchronously or asynchronously on UI thread.
  57 - (void)decidePolicyForCert:(const scoped_refptr<net::X509Certificate>&)cert
  58                        host:(NSString*)host
  59           completionHandler:(web::PolicyDecisionHandler)handler;
  60
  61 // Cancels all pending verification requests. Completion handlers will not be
  62 // called after |shutDown| call. Must always be called before object's
  63 // deallocation.
  64 - (void)shutDown;
  65
  66 @end
  67
  68 #endif  // IOS_WEB_NET_CRW_CERT_VERIFICATION_CONTROLLER_H_