Inherits from NSObject
Declared in AFSecurityPolicy.h
AFSecurityPolicy.m

Overview

AFSecurityPolicy evaluates server trust against pinned X.509 certificates and public keys over secure connections.

Adding pinned SSL certificates to your app helps prevent man-in-the-middle attacks and other vulnerabilities. Applications dealing with sensitive customer data or financial information are strongly encouraged to route all communication over an HTTPS connection with SSL pinning configured and enabled.

Tasks

Other Methods

Getting Specific Security Policies

Initialization

Evaluating Server Trust

Properties

SSLPinningMode

The criteria by which server trust should be evaluated against the pinned SSL certificates. Defaults to AFSSLPinningModeNone.

@property (nonatomic, assign) AFSSLPinningMode SSLPinningMode

Declared In

AFSecurityPolicy.h

allowInvalidCertificates

Whether or not to trust servers with an invalid or expired SSL certificates. Defaults to NO.

@property (nonatomic, assign) BOOL allowInvalidCertificates

Declared In

AFSecurityPolicy.h

pinnedCertificates

The certificates used to evaluate server trust according to the SSL pinning mode. By default, this property is set to any (.cer) certificates included in the app bundle.

@property (nonatomic, strong) NSArray *pinnedCertificates

Declared In

AFSecurityPolicy.h

validatesCertificateChain

Whether to evaluate an entire SSL certificate chain, or just the leaf certificate. Defaults to YES.

@property (nonatomic, assign) BOOL validatesCertificateChain

Declared In

AFSecurityPolicy.h

validatesDomainName

Whether or not to validate the domain name in the certificates CN field. Defaults to YES for AFSSLPinningModePublicKey or AFSSLPinningModeCertificate, otherwise NO.

@property (nonatomic, assign) BOOL validatesDomainName

Declared In

AFSecurityPolicy.h

Class Methods

defaultPolicy

Returns the shared default security policy, which does not accept invalid certificates, and does not validate against pinned certificates or public keys.

+ (instancetype)defaultPolicy

Return Value

The default security policy.

Declared In

AFSecurityPolicy.h

policyWithPinningMode:

Creates and returns a security policy with the specified pinning mode.

+ (instancetype)policyWithPinningMode:(AFSSLPinningMode)pinningMode

Parameters

pinningMode

The SSL pinning mode.

Return Value

A new security policy.

Declared In

AFSecurityPolicy.h

Instance Methods

evaluateServerTrust:

Whether or not the specified server trust should be accepted, based on the security policy.

- (BOOL)evaluateServerTrust:(SecTrustRef)serverTrust

Parameters

serverTrust

The X.509 certificate trust of the server.

Return Value

Whether or not to trust the server.

Discussion

This method should be used when responding to an authentication challenge from a server.

Warning: This method has been deprecated in favor of evaluateServerTrust:forDomain:.

Declared In

AFSecurityPolicy.h

evaluateServerTrust:forDomain:

Whether or not the specified server trust should be accepted, based on the security policy.

- (BOOL)evaluateServerTrust:(SecTrustRef)serverTrust forDomain:(NSString *)domain

Parameters

serverTrust

The X.509 certificate trust of the server.

domain

The domain of serverTrust. If nil, the domain will not be validated.

Return Value

Whether or not to trust the server.

Discussion

This method should be used when responding to an authentication challenge from a server.

Declared In

AFSecurityPolicy.h