Check in with Apple utilizing Vapor 4

Apple developer portal setup

With a view to make the Check in with Apple work in your web site you will want a payed developer account. That’ll value you $99 / yr in case you are a person developer. You’ll be able to evaluate numerous membership choices or simply merely enroll utilizing this hyperlink, however you will want an present Apple ID.

I assume that you just made it up to now and you’ve got a working Apple developer account by now. A typical misbelief about Check in with Apple (SiwA) is that you just want an present iOS utility publised to the App Retailer to make it work, however that is not the case. It really works and not using a companion app, nonetheless you will want an utility identifier registered within the dev portal.

App identifier

Choose the Identifiers menu merchandise from the checklist on the left, press the plus (+) button, choose the App IDs possibility and press the Proceed button. Fill out the outline discipline and enter a customized bunde indentifier that you just’d like to make use of (e.g. com.mydomain.ios.app). Scroll down the Capabilities checklist till you discover the Check in With Apple possibility, mark the checkbox (the Allow as main App ID ought to seem proper subsequent to an edit button) and press the Proceed button on the highest proper nook. Register the applying identifier utilizing the highest proper button, after you discover every thing all proper.

It’s best to see the newly created AppID within the checklist, if not there’s a search icon on the precise aspect of the display. Choose the AppIDs possibility and the applying identifer merchandise ought to seem. 🔍

Service identifier

Subsequent we want a service identifier for SiwA. Press the add button once more and now choose the Companies IDs possibility. Enter an outline and fill out the identifier utilizing the identical reverse-domain identify fashion. I favor to make use of my area identify with a suffix, that may be one thing like com.instance.siwa.service. Press the Proceed and the Register buttons, we’re nearly prepared with the configuration half.

Filter the checklist of identifiers by Service IDs and click on on the newly created one. There’s a Configure button, that it is best to press. Now affiliate the Main App ID to this service identifier by choosing the applying id that we made beforehand from the choice checklist. Press the plus button subsequent to the Web site URLs textual content and enter the given area that you just’d like to make use of (e.g. instance.com).

You will even have so as to add no less than one Return URL, which is principally a redirect URL that the service can use after an auth request. It’s best to all the time use HTTPS, however aside from this constraint the redirect URL may be something (e.g. https://instance.com/siwa-redirect). #notrailingslash

You’ll be able to add or take away URLs at any time utilizing this display, fortunately there’s a take away possibility for each area and redirect URL. Press Subsequent to avoid wasting the URLs and Completed if you end up prepared with the Check in with Apple service configuration course of.

Keys

The very last thing that we have to create on the dev portal is a non-public key for shopper authentication. Choose the Keys menu merchandise on the left and press the add new button. Title the important thing as you need, choose the Check in with Apple possibility from the checklist. Within the Configure menu choose the Main App ID, it ought to be linked with the applying identifier we made earlier. Click on Save to return to the earlier display and press Proceed. Evaluate the information and at last press the Register button.

Now that is your solely likelihood to get the registered non-public key, for those who pressed the accomplished button with out downloading it, you’ll lose the important thing ceaselessly, you must make a brand new one, however don’t fret an excessive amount of for those who messed it up you’ll be able to click on on the important thing, press the massive purple Revoke button to delete it and begin the method once more. This comes helpful if the important thing will get compromised, so do not share it with anyone else in any other case you will should make a brand new one. 🔑

Workforce & JWK identifier

I nearly overlook that you’re going to want your staff identifier and the JWK identifier for the sign up course of. The JWK id may be discovered underneath the beforehand generated key particulars web page. If you happen to click on on the identify of the important thing you’ll be able to view the small print. The Key ID is on that web page alongside with the revoke button and the Check in with Apple configuration part the place you will get the staff identifier too, because the service bundle identifier is prefixed with that. Alternatively you’ll be able to copy the staff id from the very prime proper nook of the dev portal, it is proper subsequent to your identify.

Implementing Check in With Apple

Earlier than we write a single line of Swift code let me clarify a simplified model of your complete course of.

All the login circulate has 3 primary parts:

• Provoke an online auth request utilizing the SiwA button (begin the OAuth circulate)
• Validate the returned person id token utilizing Apple’s JWK service
• Change the person id token for an entry token

Among the tutorials overcomplicate this, however you will see how straightforward is to jot down your complete circulate utilizing Vapor 4. We do not even want extra scripts that generate tokens we will do every thing in pure Swift, which is nice. Lets begin a brand new Vapor challenge. You will want the JWT bundle as nicely.

import PackageDescription

let bundle = Bundle(
    identify: "binarybirds",
    platforms: [
       .macOS(.v10_15)
    ],
    dependencies: [
        .package(url: "https://github.com/vapor/vapor.git", from: "4.4.0"),
        .package(url: "https://github.com/vapor/leaf.git", from: "4.0.0-rc"),
        .package(url: "https://github.com/vapor/jwt.git", from: "4.0.0-rc"),
    ],
    targets: [
        .target(name: "App", dependencies: [
            .product(name: "Vapor", package: "vapor"),
            .product(name: "Leaf", package: "leaf"),
            .product(name: "JWT", package: "jwt"),
        ]),
        .goal(identify: "Run", dependencies: ["App"]),
    ]
)

If you do not know easy methods to construct the challenge it is best to learn my learners information about Vapor 4.

The Check in with Apple button

We’ll use the Leaf template engine to render our views, it is fairly easy to make it work, I will present you the configuration file in a second. We’ll use only one easy template this time. We are able to name it index.leaf and save the file into the Sources/Views listing.

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <meta identify="viewport" content material="width=device-width, initial-scale=1">
        <fashion>
            .signin-button {
                width: 240px;
                peak: 40px;
            }
            .signin-button > div > div > svg {
                width: 100%;
                peak: 100%;
                colour: purple;
            }
            .signin-button:hover {
                cursor: pointer;
            }
            .signin-button > div {
                define: none;
            }
      </fashion>
    </head>
    <physique>
        <script kind="textual content/javascript" src="https://appleid.cdn-apple.com/appleauth/static/jsapi/appleid/1/en_US/appleid.auth.js"></script>
        <div id="appleid-signin" data-color="black" data-border="false" data-type="sign up" class="signin-button"></div>
        <script kind="textual content/javascript">
            AppleID.auth.init({
                clientId : '#(clientId)',
                scope : '#(scope)',
                redirectURI: '#(redirectUrl)',
                state : '#(state)',
                usePopup : #(popup),
            });
        </script>
    </physique>
</html>

The Check in with Apple JS framework can be utilized to render the login button on the web site. There’s a related factor for iOS referred to as AuthenticationServices, however this time we’re solely going to focus on the internet. Sadly the sign up button is kind of buggy so we’ve so as to add some further CSS hack to repair the underlying points. Come on Apple, why do we’ve to hack these items? 😅

Beginning the AppleID auth course of is absolutely easy you simply should configure a couple of parameters. The shopper id is service the bundle identifier that we entered on the developer portal. The scope may be both identify or electronic mail, however you need to use each if you’d like. The redirect URI is the redirect URL that we registered on the dev portal, and the state ought to be one thing distinctive that you need to use to determine the request. Apple will ship this state again to you within the response.

Noone talks concerning the usePopup parameter, so we’ll depart it that manner too… 🤔

Alternatively you need to use meta tags to configure the authorization object, you’ll be able to learn extra about this within the Configuring your webpage for Check in with Apple documentation.

Vapor configuration

It is time to configure our Vapor utility so we will render this Leaf template file and use the signing key that we aquired from Apple utilizing the dev portal. We’re coping with some secret information right here, so it is best to by no means retailer it within the repository, however you need to use Vapor’s surroundings for this function. I favor to have an extension for the out there surroundings variables.

extension Setting {
    
    static var siwaId = Setting.get("SIWA_ID")!
    
    static let siwaRedirectUrl = Setting.get("SIWA_REDIRECT_URL")!
    
    static var siwaTeamId = Setting.get("SIWA_TEAM_ID")!
    
    static var siwaJWKId = Setting.get("SIWA_JWK_ID")!
    
    static var siwaKey = Setting.get("SIWA_KEY")!
}

In Vapor 4 you’ll be able to setup a customized JWT signer that may signal the payload with the right keys and different values primarily based on the configuration. This JWT signer can be utilized to confirm the token within the response. It really works like magic. JWT & JWTKit is an official Vapor bundle, there may be undoubtedly no have to implement your individual answer. On this first instance we’ll simply put together the signer for later use and render the index web page so we will initalize the OAuth request utilizing the web site.

import Vapor
import Leaf
import JWT

extension JWKIdentifier {
    static let apple = JWKIdentifier(string: Setting.siwaJWKId)
}

extension String {
    var bytes: [UInt8] {
        return .init(self.utf8)
    }
}

public func configure(_ app: Software) throws {
    
    app.views.use(.leaf)
    

    app.middleware.use(SessionsMiddleware(session: app.classes.driver))

    app.jwt.apple.applicationIdentifier = Setting.siwaId
    
    let signer = strive JWTSigner.es256(key: .non-public(pem: Setting.siwaKey.bytes))
    app.jwt.signers.use(signer, child: .apple, isDefault: false)

    app.get { req -> EventLoopFuture<View> in
        struct ViewContext: Encodable {
            var clientId: String
            var scope: String = "identify electronic mail"
            var redirectUrl: String
            var state: String
            var popup: Bool = false
        }

        let state = [UInt8].random(depend: 16).base64
        req.session.knowledge["state"] = state
        let context = ViewContext(clientId: Setting.siwaId,
                                  redirectUrl: Setting.siwaRedirectUrl,
                                  state: state)
        return req.view.render("index", context)
    }
}

The session middleware is used to switch a random generated code between the index web page and the redirect handler. Now for those who run the app and click on on the Check in with Apple button you will see that the circulate begins, but it surely’ll fail after you recognized your self. That is okay, the first step is accomplished. ✅

The redirect handler

Apple will attempt to ship a POST request with an object that incorporates the Apple ID token to the registered redirect URI after you have recognized your self utilizing their login field. We are able to mannequin this response object as an AppleAuthResponse struct within the following manner:

import Basis

struct AppleAuthResponse: Decodable {

    enum CodingKeys: String, CodingKey {
        case code
        case state
        case idToken = "id_token"
        case person
    }

    let code: String
    let state: String
    let idToken: String
    let person: String
}

The authorization code is the primary parameter, the state shuld be equal along with your state worth that you just ship as a parameter while you press the login button, if they do not match do not belief the response any individual is attempting to hack you. The idToken is the Apple ID token, we’ve to validate that utilizing the JWKS validation endpoint. The person string is the e-mail deal with of the person.

app.submit("siwa-redirect") { req in
    let state = req.session.knowledge["state"] ?? ""
    let auth = strive req.content material.decode(AppleAuthResponse.self)
    guard !state.isEmpty, state == auth.state else {
        return req.eventLoop.future("Invalid state")
    }

    return req.jwt.apple.confirm(auth.idToken, applicationIdentifier: Setting.siwaId)
    .flatMap { token in
        
    }
}

The code above will deal with the incoming response. First it will attempt to decode the AppleAuthResponse object from the physique, subsequent it will name the Apple verification service utilizing your non-public key and the idToken worth from the response. This validation service returns an AppleIdentityToken object. That is a part of the JWTKit bundle. We have simply accomplished Step 2. ☺️

Exchanging the entry token

The AppleIdentityToken solely lives for a brief time period so we’ve to trade it for an entry token that can be utilized for for much longer. We’ve to assemble a request, we’re going to use the next request physique to trade tokens:

struct AppleTokenRequestBody: Encodable {
    
    enum CodingKeys: String, CodingKey {
        case clientId = "client_id"
        case clientSecret = "client_secret"
        case code
        case grantType = "grant_type"
        case redirectUri = "redirect_uri"
    }
    
    
    let clientId: String

    
    let clientSecret: String

    
    let code: String
    
    
    let redirectUri: String
    
    
    let grantType: String = "authorization_code"
}

We’ll additionally have to generate the shopper secret, primarily based on the response we’re going to make a brand new AppleAuthToken object for this that may be signed utilizing the already configured JWT service.

struct AppleAuthToken: JWTPayload {
    let iss: String
    let iat = Int(Date().timeIntervalSince1970)
    let exp: Int
    let aud = "https://appleid.apple.com"
    let sub: String

    init(clientId: String, teamId: String, expirationSeconds: Int = 86400 * 180) {
        sub = clientId
        iss = teamId
        exp = self.iat + expirationSeconds
    }

    func confirm(utilizing signer: JWTSigner) throws {
        guard iss.depend == 10 else {
            throw JWTError.claimVerificationFailure(identify: "iss", cause: "TeamId should be your 10-character Workforce ID from the developer portal")
        }

        let lifetime = exp - iat
        guard 0...15777000 ~= lifetime else {
            throw JWTError.claimVerificationFailure(identify: "exp", cause: "Expiration should be between 0 and 15777000")
        }
    }
}

Since we’ve to make a brand new request we will use the built-in AysncHTTPClient service. I’ve made a bit of extension across the HTTPClient object to simplify the request creation course of.

extension HTTPClient {
    static func appleAuthTokenRequest(_ physique: AppleTokenRequestBody) throws -> HTTPClient.Request {
        var request = strive HTTPClient.Request(url: "https://appleid.apple.com/auth/token", methodology: .POST)
        request.headers.add(identify: "Person-Agent", worth: "Mozilla/5.0 (Home windows NT 6.2) AppleWebKit/536.6 (KHTML, like Gecko) Chrome/20.0.1090.0 Safari/536.6'")
        request.headers.add(identify: "Settle for", worth: "utility/json")
        request.headers.add(identify: "Content material-Sort", worth: "utility/x-www-form-urlencoded")
        request.physique = .string(strive URLEncodedFormEncoder().encode(physique))
        return request
    }
}

The humorous factor right here is for those who do not add the Person-Agent header the SiwA service will return with an error, the issue was talked about in this text additionally mentioned on the Apple Developer Fourms.

Anyway, let me present you the entire redirect handler. 🤓

app.submit("siwa-redirect") { req -> EventLoopFuture<String> in
    let state = req.session.knowledge["state"] ?? ""
    let auth = strive req.content material.decode(AppleAuthResponse.self)
    guard !state.isEmpty, state == auth.state else {
        return req.eventLoop.future("Invalid state")
    }

    return req.jwt.apple.confirm(auth.idToken, applicationIdentifier: Setting.siwaId)
    .flatMap { token -> EventLoopFuture<HTTPClient.Response> in
        do {
            let secret = AppleAuthToken(clientId: Setting.siwaId, teamId: Setting.siwaTeamId)
            let secretJwtToken = strive app.jwt.signers.signal(secret, child: .apple)

            let physique = AppleTokenRequestBody(clientId: Setting.siwaId,
                                             clientSecret: secretJwtToken,
                                             code: auth.code,
                                             redirectUri: Setting.siwaRedirectUrl)

            let request = strive HTTPClient.appleAuthTokenRequest(physique)
            return app.http.shopper.shared.execute(request: request)
        }
        catch {
            return req.eventLoop.future(error: error)
        }
    }
    .map { response -> String in
        guard var physique = response.physique else {
            return "n/a"
        }
        return physique.readString(size: physique.readableBytes) ?? "n/a"
    }
}

As you’ll be able to see I am simply sending the trade request and map the ultimate response to a string. From this level it’s very easy to implement a decoder, the response is one thing like this:

struct AppleAccessToken: Decodable {

    enum CodingKeys: String, CodingKey {
        case accessToken = "access_token"
        case tokenType = "token_type"
        case expiresIn = "expires_in"
        case refreshToken = "refresh_token"
        case idToken = "id_token"
    }

    let accessToken: String
    let tokenType: String
    let expiresIn: Int
    let refreshToken: String
    let idToken: String
}

You need to use this response to authenticate your customers, however that is up-to-you primarily based by yourself enterprise logic & necessities. You need to use the identical authTokenRequest methodology to refresh the token, you simply should set the grant kind to refresh_token as a substitute of authorization_code

I do know that there’s nonetheless room for enhancements, the code is much from excellent, but it surely’s a working proof of idea. The article is getting actually lengthy, so possibly that is the precise time cease. 😅

If you’re on the lookout for a superb place to be taught extra about SiwA, it is best to examine this hyperlink.

Conclusion

You’ll be able to have a working Check in with Apple implementation inside an hour in case you are utilizing Vapor 4. The toughest half right here is that you must determine each single little element by your self, different folks’s supply code. I am attempting to clarify issues as straightforward as attainable however hey, I am nonetheless placing collectively the items for myself too.

That is a particularly enjoyable journey for me. Transferring again to the server aspect after nearly a decade of iOS improvement is a refreshing expertise. I can solely hope you will get pleasure from my upcoming e book referred to as Sensible Server Facet Swift, as a lot as I get pleasure from studying and writing concerning the Vapor. ❤️