FWSecurityPolicy


@interface FWSecurityPolicy : NSObject <NSSecureCoding, NSCopying>

FWSecurityPolicy 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.

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) FWSSLPinningMode SSLPinningMode;
  • The certificates used to evaluate server trust according to the SSL pinning mode.

    Note that if pinning is enabled, evaluateServerTrust:forDomain: will return true if any pinned certificate matches.

    See

    policyWithPinningMode:withPinnedCertificates:

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSSet<NSData *> *pinnedCertificates;
  • Whether or not to trust servers with an invalid or expired SSL certificates. Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowInvalidCertificates;
  • Whether or not to validate the domain name in the certificate’s CN field. Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL validatesDomainName;

Getting Certificates from the Bundle

  • Returns any certificates included in the bundle. If you are using AFNetworking as an embedded framework, you must use this method to find the certificates you have included in your app bundle, and use them when creating your security policy by calling policyWithPinningMode:withPinnedCertificates.

    Declaration

    Objective-C

    + (nonnull NSSet<NSData *> *)certificatesInBundle:(nonnull NSBundle *)bundle;

    Return Value

    The certificates included in the given bundle.

Getting Specific Security Policies

  • Returns the shared default security policy, which does not allow invalid certificates, validates domain name, and does not validate against pinned certificates or public keys.

    Declaration

    Objective-C

    + (nonnull instancetype)defaultPolicy;

    Return Value

    The default security policy.

Initialization

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

    Certificates with the .cer extension found in the main bundle will be pinned. If you want more control over which certificates are pinned, please use policyWithPinningMode:withPinnedCertificates: instead.

    See

    -policyWithPinningMode:withPinnedCertificates:

    Declaration

    Objective-C

    + (nonnull instancetype)policyWithPinningMode:(FWSSLPinningMode)pinningMode;

    Parameters

    pinningMode

    The SSL pinning mode.

    Return Value

    A new security policy.

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

    See

    +certificatesInBundle:

    See

    -pinnedCertificates

    Declaration

    Objective-C

    + (nonnull instancetype)policyWithPinningMode:(FWSSLPinningMode)pinningMode
                           withPinnedCertificates:
                               (nonnull NSSet<NSData *> *)pinnedCertificates;

    Parameters

    pinningMode

    The SSL pinning mode.

    pinnedCertificates

    The certificates to pin against.

    Return Value

    A new security policy.

Evaluating Server Trust

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

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

    Declaration

    Objective-C

    - (BOOL)evaluateServerTrust:(nonnull SecTrustRef)serverTrust
                      forDomain:(nullable 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.