/* NSURLProtectionSpace.h Copyright (c) 2003-2015, Apple Inc. All rights reserved. Public header file. */ #import #import @class NSString; @class NSArray; @class NSData; NS_ASSUME_NONNULL_BEGIN /*! @const NSURLProtectionSpaceHTTP @abstract The protocol for HTTP */ FOUNDATION_EXPORT NSString * const NSURLProtectionSpaceHTTP NS_AVAILABLE(10_5, 2_0); /*! @const NSURLProtectionSpaceHTTPS @abstract The protocol for HTTPS */ FOUNDATION_EXPORT NSString * const NSURLProtectionSpaceHTTPS NS_AVAILABLE(10_5, 2_0); /*! @const NSURLProtectionSpaceFTP @abstract The protocol for FTP */ FOUNDATION_EXPORT NSString * const NSURLProtectionSpaceFTP NS_AVAILABLE(10_5, 2_0); /*! @const NSURLProtectionSpaceHTTPProxy @abstract The proxy type for http proxies */ FOUNDATION_EXPORT NSString * const NSURLProtectionSpaceHTTPProxy; /*! @const NSURLProtectionSpaceHTTPSProxy @abstract The proxy type for https proxies */ FOUNDATION_EXPORT NSString * const NSURLProtectionSpaceHTTPSProxy; /*! @const NSURLProtectionSpaceFTPProxy @abstract The proxy type for ftp proxies */ FOUNDATION_EXPORT NSString * const NSURLProtectionSpaceFTPProxy; /*! @const NSURLProtectionSpaceSOCKSProxy @abstract The proxy type for SOCKS proxies */ FOUNDATION_EXPORT NSString * const NSURLProtectionSpaceSOCKSProxy; /*! @const NSURLAuthenticationMethodDefault @abstract The default authentication method for a protocol */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodDefault; /*! @const NSURLAuthenticationMethodHTTPBasic @abstract HTTP basic authentication. Equivalent to NSURLAuthenticationMethodDefault for http. */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodHTTPBasic; /*! @const NSURLAuthenticationMethodHTTPDigest @abstract HTTP digest authentication. */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodHTTPDigest; /*! @const NSURLAuthenticationMethodHTMLForm @abstract HTML form authentication. Applies to any protocol. */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodHTMLForm; /*! @const NSURLAuthenticationMethodNTLM @abstract NTLM authentication. */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodNTLM NS_AVAILABLE(10_5, 2_0); /*! @const NSURLAuthenticationMethodNegotiate @abstract Negotiate authentication. */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodNegotiate NS_AVAILABLE(10_5, 2_0); /*! @const NSURLAuthenticationMethodClientCertificate @abstract SSL Client certificate. Applies to any protocol. */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodClientCertificate NS_AVAILABLE(10_6, 3_0); /*! @const NSURLAuthenticationMethodServerTrust @abstract SecTrustRef validation required. Applies to any protocol. */ FOUNDATION_EXPORT NSString * const NSURLAuthenticationMethodServerTrust NS_AVAILABLE(10_6, 3_0); @class NSURLProtectionSpaceInternal; /*! @class NSURLProtectionSpace @discussion This class represents a protection space requiring authentication. */ @interface NSURLProtectionSpace : NSObject { @private NSURLProtectionSpaceInternal *_internal; } /*! @method initWithHost:port:protocol:realm:authenticationMethod: @abstract Initialize a protection space representing an origin server, or a realm on one @param host The hostname of the server @param port The port for the server @param protocol The sprotocol for this server - e.g. "http", "ftp", "https" @param realm A string indicating a protocol-specific subdivision of a single host. For http and https, this maps to the realm string in http authentication challenges. For many other protocols it is unused. @param authenticationMethod The authentication method to use to access this protection space - valid values include nil (default method), @"digest" and @"form". @result The initialized object. */ - (instancetype)initWithHost:(NSString *)host port:(NSInteger)port protocol:(nullable NSString *)protocol realm:(nullable NSString *)realm authenticationMethod:(nullable NSString *)authenticationMethod; /*! @method initWithProxyHost:port:type:realm:authenticationMethod: @abstract Initialize a protection space representing a proxy server, or a realm on one @param host The hostname of the proxy server @param port The port for the proxy server @param type The type of proxy - e.g. "http", "ftp", "SOCKS" @param realm A string indicating a protocol-specific subdivision of a single host. For http and https, this maps to the realm string in http authentication challenges. For many other protocols it is unused. @param authenticationMethod The authentication method to use to access this protection space - valid values include nil (default method) and @"digest" @result The initialized object. */ - (instancetype)initWithProxyHost:(NSString *)host port:(NSInteger)port type:(nullable NSString *)type realm:(nullable NSString *)realm authenticationMethod:(nullable NSString *)authenticationMethod; /*! @method realm @abstract Get the authentication realm for which the protection space that needs authentication @discussion This is generally only available for http authentication, and may be nil otherwise. @result The realm string */ @property (nullable, readonly, copy) NSString *realm; /*! @method receivesCredentialSecurely @abstract Determine if the password for this protection space can be sent securely @result YES if a secure authentication method or protocol will be used, NO otherwise */ @property (readonly) BOOL receivesCredentialSecurely; /*! @method isProxy @abstract Determine if this authenticating protection space is a proxy server @result YES if a proxy, NO otherwise */ @property (readonly) BOOL isProxy; /*! @method host @abstract Get the proxy host if this is a proxy authentication, or the host from the URL. @result The host for this protection space. */ @property (readonly, copy) NSString *host; /*! @method port @abstract Get the proxy port if this is a proxy authentication, or the port from the URL. @result The port for this protection space, or 0 if not set. */ @property (readonly) NSInteger port; /*! @method proxyType @abstract Get the type of this protection space, if a proxy @result The type string, or nil if not a proxy. */ @property (nullable, readonly, copy) NSString *proxyType; /*! @method protocol @abstract Get the protocol of this protection space, if not a proxy @result The type string, or nil if a proxy. */ @property (nullable, readonly, copy) NSString *protocol; /*! @method authenticationMethod @abstract Get the authentication method to be used for this protection space @result The authentication method */ @property (readonly, copy) NSString *authenticationMethod; @end /*! @class NSURLProtectionSpace(NSClientCertificateSpace) @discussion This category supplies additional information for use when a client certificate is required by the server in order to complete authentication. */ @interface NSURLProtectionSpace(NSClientCertificateSpace) /*! @method distinguishedNames @abstract Returns an array of acceptable certificate issuing authorities for client certification authentication. Issuers are identified by their distinguished name and returned as a DER encoded data. @result An array of NSData objects. (Nil if the authenticationMethod is not NSURLAuthenticationMethodClientCertificate) */ @property (nullable, readonly, copy) NSArray *distinguishedNames NS_AVAILABLE(10_6, 3_0); @end /*! @class NSURLProtectionSpace(NSServerTrustValidationSpace) @discussion This category supplies additional information for use by the client to evaluate whether to trust a given server during a security handshake. */ @interface NSURLProtectionSpace(NSServerTrustValidationSpace) /*! @method serverTrust @abstract Returns a SecTrustRef which represents the state of the servers SSL transaction state @result A SecTrustRef from Security.framework. (Nil if the authenticationMethod is not NSURLAuthenticationMethodServerTrust) */ @property (nullable, readonly) SecTrustRef serverTrust NS_AVAILABLE(10_6, 3_0); @end NS_ASSUME_NONNULL_END