Git Product home page Git Product logo

yoonit-labs / ios-yoonit-handshake Goto Github PK

View Code? Open in Web Editor NEW
7.0 2.0 0.0 50 KB

A iOS Cocoa project written in Swift implementing dynamic SSL pinning

License: MIT License

Ruby 31.37% Swift 63.81% Objective-C 4.82%
ssl-pinning dynamic-ssl-pinning update-fingerprint ios-update-fingerprint ios-ssl-pinning ios-dynamic-ssl-pinning certificate-handshake ios-certificate-handshake hacktoberfest

ios-yoonit-handshake's Introduction

ios-yoonit-handshake

A iOS Cocoa project written in Swift implementing dynamic SSL pinning.

About

The SSL pinning is a technique mitigating man-in-the-middle attacks against the secure HTTP communication, but has a drawback, the certificate's expiration date. This resolve this problem, implementing dynamic SSL pinning, providing easy to use fingerprint validation on the TLS handshake. The remote server must be the responsible to update the certificate(s).

Installation

target '<Your Target App>' do
  pod 'YoonitHandshake'
end

Special thanks and credits...

The current version of the library depends on [Wultra SSL Pinning](https://github.com/wultra/ssl-pinning-ios)

Usage

First, in the Development.xcconfig, insert the SERVICE_URL and PUBLIC_KEY values.

import UIKit
import YoonitHandshake

class HandshakeViewController: HandshakeListener {
                        
    private var handshake = Handshake()
                        
    func updateFingerprints() {
        self.handshake.handshakeListener = self
        self.handshake.updateFingerprints(
            "YOUR PUBLIC KEY",
            "YOUR SERVICE URL"
        )
    }
        
    func onResult(_ result: HandshakeResult) {
        switch result {
        case HandshakeResult.OK:
            // - Everything is OK;
            // - No Action is required;

        case HandshakeResult.STORE_IS_EMPTY:
            // - The update request succeeded;
            // - Result is still an empty list of certificates;
            // - May loading & validating of remote data succeeded;
            // - All loaded certificates are already expired;"

        case HandshakeResult.NETWORK_ERROR:
            // - The update request failed on a network communication.

        case HandshakeResult.INVALID_DATA:
            // The update request returned the data which did not pass the signature validation.

        case HandshakeResult.INVALID_SIGNATURE:
            // The update request returned the data which did not pass the signature validation.
            
        case HandshakeResult.INVALID_URL_SERVICE:
            // The url service does not exist or is invalid.
        }
    }
}

API

Method

Function Parameters Description
updateFingerprint publicKey: String, serviceUrl: String Update the list of fingerprints from the remote server. The method is asynchronous. Response can get in the HandshakeListener interface.

Event

Event Parameters Description
onResult result: HandshakeResult The update fingerprint request result.

Handshake Result

HandshakeResult Description
OK
  • Everything is OK;
  • No Action is required;
STORE_IS_EMPTY
  • The update request succeeded;
  • Result is still an empty list of certificates;
  • May loading & validating of remote data succeeded;
  • All loaded certificates are already expired;
  • All loaded certificates are already expired;
NETWORK_ERROR The update request failed on a network communication.
INVALID_DATA The update request returned the data which did not pass the signature validation.
INVALID_SIGNATURE The update request returned the data which did not pass the signature validation.
INVALID_URL_SERVICE The url service does not exist or is invalid.

To contribute and make it better

Clone the repo, change what you want and send PR.

For commit messages we use Conventional Commits.

Contributions are always welcome!


Code with โค by the Cyberlabs AI Front-End Team

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.