KCD/CustomHTTPProtocol.h

   1 /*
   2      File: CustomHTTPProtocol.h
   3  Abstract: An NSURLProtocol subclass that overrides the built-in HTTP/HTTPS protocol.
   4   Version: 1.0
   5
   6  Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
   7  Inc. ("Apple") in consideration of your agreement to the following
   8  terms, and your use, installation, modification or redistribution of
   9  this Apple software constitutes acceptance of these terms.  If you do
  10  not agree with these terms, please do not use, install, modify or
  11  redistribute this Apple software.
  12
  13  In consideration of your agreement to abide by the following terms, and
  14  subject to these terms, Apple grants you a personal, non-exclusive
  15  license, under Apple's copyrights in this original Apple software (the
  16  "Apple Software"), to use, reproduce, modify and redistribute the Apple
  17  Software, with or without modifications, in source and/or binary forms;
  18  provided that if you redistribute the Apple Software in its entirety and
  19  without modifications, you must retain this notice and the following
  20  text and disclaimers in all such redistributions of the Apple Software.
  21  Neither the name, trademarks, service marks or logos of Apple Inc. may
  22  be used to endorse or promote products derived from the Apple Software
  23  without specific prior written permission from Apple.  Except as
  24  expressly stated in this notice, no other rights or licenses, express or
  25  implied, are granted by Apple herein, including but not limited to any
  26  patent rights that may be infringed by your derivative works or by other
  27  works in which the Apple Software may be incorporated.
  28
  29  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
  30  MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
  31  THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
  32  FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
  33  OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
  34
  35  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
  36  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  37  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  38  INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
  39  MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
  40  AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
  41  STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
  42  POSSIBILITY OF SUCH DAMAGE.
  43
  44  Copyright (C) 2013 Apple Inc. All Rights Reserved.
  45
  46  */
  47
  48 #import <Foundation/Foundation.h>
  49
  50 @protocol CustomHTTPProtocolDelegate;
  51
  52 @interface CustomHTTPProtocol : NSURLProtocol
  53
  54 // Subclass specific additions
  55
  56 + (void)start;
  57     // Call this to start the module.  Prior to this the module is just dormant, and
  58     // all HTTP requests proceed as normal.  After this all HTTP and HTTPS requests
  59     // go through this module.
  60
  61 // The delegate is not retained in general, but is retained for the duration of any given
  62 // call.  Once you set the delegate to nil you can be assured that it won't be called
  63 // unretained (that is, by the time that -setDelegate: returns, we've already done
  64 // all possible retains on the delegate).
  65
  66 + (id<CustomHTTPProtocolDelegate>)delegate;
  67 + (void)setDelegate:(id<CustomHTTPProtocolDelegate>)newValue;
  68
  69 @property (atomic, retain, readonly ) NSURLAuthenticationChallenge *    pendingChallenge;   // main thread only please
  70
  71 - (void)resolveAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge withCredential:(NSURLCredential *)credential;
  72     // must be called on the main thread
  73     // credential may be nil, to continue the request without a credential
  74
  75 @end
  76
  77 /*
  78     The delegate handles two different types of callbacks:
  79
  80     o authentication challenges
  81     o logging
  82
  83     The latter is very simple.  The former is quite tricky.  The basic idea is that each CustomHTTPProtocol
  84     sends the delegate a serialised stream of authentication challenges, each of which it is expected to
  85     resolve.  The sequence is as follows:
  86
  87     1. It calls -customHTTPProtocol:canAuthenticateAgainstProtectionSpace: to determine if your delegate
  88        can handle the challenge.  This can be call on an arbitrary background thread.
  89
  90     2. If the delegate returns YES, it calls -customHTTPProtocol:didReceiveAuthenticationChallenge: to
  91        actually process the challenge.  This is always called on the main thread.  The delegate can resolve
  92        the challenge synchronously (that is, before returning from the call) or it can return from the call
  93        and then, later on, resolve the challenge.  Resolving the challenge involves calling
  94        -[CustomHTTPProtocol resolveAuthenticationChallenge:withCredential:], which also must be called
  95        on the main thread.  Between the calls to -customHTTPProtocol:didReceiveAuthenticationChallenge:
  96        and -[CustomHTTPProtocol resolveAuthenticationChallenge:withCredential:], the protocol's
  97        pendingChallenge property will contain the challenge.
  98
  99     3. While there is a pending challenge, the protocol may call -customHTTPProtocol:didCancelAuthenticationChallenge:
 100        to cancel the challenge.  This is always called on the main thread.
 101 */
 102
 103 @protocol CustomHTTPProtocolDelegate <NSObject>
 104
 105 @optional
 106
 107 - (BOOL)customHTTPProtocol:(CustomHTTPProtocol *)protocol canAuthenticateAgainstProtectionSpace:(NSURLProtectionSpace *)protectionSpace;
 108     // called on an arbitrary thread
 109     // protocol will not be nil
 110     // protectionSpace will not be nil
 111
 112 - (void)customHTTPProtocol:(CustomHTTPProtocol *)protocol didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge;
 113     // called on the main thread
 114     // protocol will not be nil
 115     // challenge will not be nil
 116
 117 - (void)customHTTPProtocol:(CustomHTTPProtocol *)protocol didCancelAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge;
 118     // called on the main thread
 119     // protocol will not be nil
 120     // challenge will not be nil
 121
 122 - (void)customHTTPProtocol:(CustomHTTPProtocol *)protocol didRecieveResponse:(NSURLResponse *)response;
 123 - (void)customHTTPProtocol:(CustomHTTPProtocol *)protocol didRecieveData:(NSData *)data;
 124 - (void)customHTTPProtocolDidFinishLoading:(CustomHTTPProtocol *)protocol;
 125 - (void)customHTTPProtocol:(CustomHTTPProtocol *)protocol didFailWithError:(NSError *)error;
 126
 127
 128 - (void)customHTTPProtocol:(CustomHTTPProtocol *)protocol logWithFormat:(NSString *)format arguments:(va_list)argList;
 129     // called on an arbitrary thread
 130     // protocol may be nil, implying a log message from the class itself
 131     // format will not be nil
 132
 133 @end