Dissect the PKCE Authorization Code Grant Circulation on iOS

Learn to use Proof Key for Code Change (PKCE) authentication move to entry APIs along with your Swift iOS apps.

Proof Key for Code Change (PKCE) is an addition to the OAuth authorization framework that protects the authorization move from safety assaults. As knowledge house owners undertake the protocol, it’s necessary for purposes utilizing their APIs to authorize entry utilizing this new protocol.

On this tutorial, you’ll construct an app referred to as MyGoogleInfo. The app authenticates customers with Google utilizing the OAuth authorization move with PKCE, and it makes use of the Google API to retrieve customers’ profile names and photos.

Right here’s what you’ll study:

• The OAuth 2.0 authorization code grant move particulars and its vulnerability.
• What the PKCE authorization move is and the way it strengthens the OAuth move.
• How one can configure entry to the Google API on the Google Cloud console.
• How one can implement the PKCE authorization move in Swift to authenticate the consumer.
• How one can use the offered token to entry the Google API.

You probably have ever puzzled how the authentication protocol works or should you’re fascinated by utilizing an API from one of many outstanding suppliers on your subsequent venture, keep tuned. You’ll get all the small print on this article.

Getting Began

Obtain the starter venture by clicking the Obtain Supplies button on the prime or backside of the tutorial.

Open MyGoogleInfo.xcodeproj within the starter folder. Construct and run. The Login display will seem like this.

The Login button doesn’t do something but. You’ll implement the PKCE move with the Google OAuth service in PKCEAuthenticationService.

As soon as that’s achieved, when the consumer logs in, MyGoogleInfo presents the consumer’s profile data.

Introducing the OAuth 2.0 Authorization Framework

The OAuth 2 Authorization framework is the usual protocol used for consumer authentication. The primary concept behind OAuth authorization is the separation of roles. Particularly, the usual defines a protocol to permit knowledge house owners to delegate purchasers to entry their knowledge, with out giving them their credentials.

Listed below are some phrases to know:

• Useful resource Proprietor: That is the entity that owns the sources your app wish to entry. Usually, that is you, holding your knowledge.
• Consumer: The appliance that desires to entry the information on the useful resource server, akin to MyGoogleInfo on this case.
• Authorization server: The server accountable for authenticating the consumer and issuing the tokens to the consumer.
• Useful resource Server: The server internet hosting the information to entry. An entry token protects the entry to the useful resource server.

Authorization Code Grant Circulation

This diagram represents the OAuth 2.0 Authorization code grant move that cellular purposes implement:

1. The consumer begins the login move by tapping the MyGoogleInfo Login button.
2. Consequently, the app asks the authorization server to determine the consumer and ask their consent to entry the information. The request features a client_id in order that the server can determine the app requesting the entry.
3. So, the authorization server redirects the consumer to its login display (e.g. Google) and asks the consumer’s consent to provide the app entry to the API.
4. The consumer logs in and approves the request.
5. If the consumer approves the entry, the authorization server returns a grant code to the consumer.
6. The consumer requests a token to the authorization server, passing its client_id and the obtained grant code.
7. In response, the authorization server emits a token after verifying the client_id and the grant code.
8. Lastly, the consumer accesses the information to the useful resource server, authenticating its requests with the token.

For all the small print on this move and the opposite ones outlined in the usual, seek the advice of the RFC 6749: The OAuth 2.0 Authorization Framework (RFC 6749).

Attacking the Authorization Code Grant Circulation

Though the authorization code grant move is the best way to go for cellular apps, it’s topic to consumer impersonation assaults. A malicious app can impersonate a authentic consumer and obtain a sound authentication token to entry the consumer knowledge.

For the move diagram above, to obtain a token the attacker ought to know these two parameters:

• The app’s client_id.
• The code obtained within the callback URL from the authorization token.

Beneath sure circumstances, a malicious app can get better each. The app’s consumer ID is normally hardcoded, for instance, and an attacker may discover it by reverse-engineering the app. Or, by registering the malicious app as a authentic invoker of the callback URL, the attacker may also sniff the callback URL.

As soon as the attacker is aware of the consumer ID and the grant code, they will request a token to the token endpoint. From that time ahead, they use the entry token to retrieve knowledge illegally.

Introducing PKCE

Proof Key for Code Change (PKCE) is an addition to the Authorization Code Grant move to mitigate the assault depicted above. In observe, it provides a code to every request that’s dynamically generated by the consumer so an attacker can’t guess or intercept it.

The next diagram depicts how PKCE strengthens the Authorization Code Grant move in observe:

That’s to say, PKCE introduces the next adjustments with respect to the plain move:

• [1] That is the place the login move begins.
• [2] On every login request, the consumer generates a random code (code_verifier) and derives a code_challenge from it.
• [3] When beginning the move, the consumer consists of the code_challenge within the request to the authorization server. On receiving the authorization request, the authorization server saves this code for later verification.
• [7] The consumer sends the code_verifier when requesting an entry token.
• [8] Subsequently, the authorization server verifies that code_verifier matches code_challenge. If these two codes match, the server is aware of the consumer is legit and emits the token.

Close to the earlier assault state of affairs, even when the attacker can intercept the authorization grant code and the code code_challenge, it’s far more troublesome — if not unattainable — to intercept the code_verifier.

PKCE is safe, and it’s the easiest way to implement OAuth authorization move in cellular apps.

You will discover all of the PKCE particulars on the RFC 7636 – Proof Key for Code Change by OAuth Public Shoppers.

Now, you’ll take a look at the code verifier/problem technology and easy methods to transmit the PKCE parameters with the HTTP requests.

Producing Code Verifier and Problem

The usual itself specifies easy methods to generate the code_verifier and code_challenge.

Open PKCECodeGenerator.swift and exchange the physique of generateCodeVerifier() with:

// 1
var buffer = [UInt8](repeating: 0, depend: 32)
_ = SecRandomCopyBytes(kSecRandomDefault, buffer.depend, &buffer)
// 2
return Knowledge(buffer).base64URLEncodedString()

This generates the code_verifier as follows:

1. Get a 32-byte random sequence.
2. Go the 32 bytes sequence to base64 URL encoder to generate a 43 octet URL protected string.

Now, exchange the physique of generateCodeChallenge(codeVerifier:) with:

guard let knowledge = codeVerifier.knowledge(utilizing: .utf8) else { return nil }

let dataHash = SHA256.hash(knowledge: knowledge)
return Knowledge(dataHash).base64URLEncodedString()

This derives the code_challenge because the SHA256 hash of the code verifier after which base64 URL encodes it.

Producing HTTP Requests

As well as, the usual specifies two totally different endpoints on the Authorization server for the 2 authorization phases.

Open PKCERequestBuilder.swift and observe the properties for every of those endpoints on the prime:

• Authorization endpoint at /authorize is accountable for emitting the authorization code grant.
• Token endpoint at /token-generation, to emit and refresh tokens.

Based on the RFC, the consumer ought to talk with these two endpoints with two totally different HTTP request varieties:

• Utilizing a GET with all of the required parameters handed as URL parameters, for the authorization endpoint.
• Sending a POST with the parameters handed within the request’s physique, encoded as URL parameters, for the token endpoint.

PKCERequestBuilder already incorporates the whole lot it’s essential generate the 2 requests.

• createAuthorizationRequestURL(codeChallenge:) generates a URL with the required parameters.
• createTokenExchangeURLRequest(code:codeVerifier:) generates a URLRequest for the token alternate.

Getting ready Server Facet (Google Cloud Platform)

Earlier than continuing with the consumer implementation, it’s a must to arrange the backend service.

This setup course of permits you to register your utility and its redirection URI used all through the authorization move and obtain the clientID.

On this particular instance, since Google already presents a service for consumer authentication with OAuth, you need to use their service.

The service setup course of consists of the next steps:

• Creating a brand new venture.
• Enabling the precise APIs your app intend to make use of.
• Producing the authorization credentials for the app (the consumer ID).

You’ll want a Google account to register an app.

Making a New Undertaking

First, open the Google API Console and click on Create Undertaking.

For those who’ve beforehand created a venture, you would possibly must click on the title of the venture within the blue bar to convey up a dialog with a New Undertaking button.

You could be requested to enroll within the Google Cloud Developer program. For those who’re not already in, don’t fear — it’s so simple as accepting their phrases and circumstances.

Enter MyGoogleInfo within the venture’s title. Then, Google assigns you a consumer ID that you just’ll want when you generate the authorization requests from the app.

Click on CREATE.

Enabling the Required API

Now, it’s time to inform Google what sort of API your app will use.

Declaring the required APIs is twofold.

First, it impacts the type of permission Google presents to the consumer through the authorization section.

And, extra vital, it permits Google to implement the information scope when your app requests knowledge. Every token has a scope that defines which API the token grants entry to.

For example, within the case of MyGoogleInfo, it’s essential allow the Google Folks API to permit the app to question the consumer data.

From the venture web page, click on ENABLE APIS AND SERVICES.

Then, seek for Google Folks API and click on ENABLE.

Producing the Authorization Credentials

Lastly, it’s essential create the authorization credentials earlier than you need to use the API.

Click on Credentials within the sidebar.

For those who see a immediate to configure a consent display, choose exterior consumer sort and fill out the registration type for the required fields. Then, click on Credentials within the sidebar once more.

Click on CREATE CREDENTIALS, then select OAuth Consumer ID.

These credentials allow you to specify which entry degree and to which API your customers’ tokens have entry.

Fill within the required fields as proven within the determine under.

Most significantly, the Bundle ID ought to have the identical worth because the one set in Xcode on your app. For instance, within the instance under, it’s com.alessandrodn.MyGoogleInfo. In your case, it’s your app bundle ID.

Lastly, click on CREATE. It is best to have an OAuth consumer definition for iOS as within the image under:

Substitute REPLACE_WITH_CLIENTID_FROM_GOOGLE_APP within the definition under with the Consumer ID out of your Google app in PKCERequestBuilder.

It took some time to arrange, however you’re now able to implement the PKCE consumer in Swift!

Implementing PKCE Consumer in Swift

In spite of everything that idea, it’s now time to get your fingers soiled in Xcode :]

Authenticating the Consumer

First, implement the primary section of the authorization move, asking the authorization endpoint to confirm the consumer identification.

Open PKCEAuthenticationService.swift. Add the next code to the top of startAuthentication():

// 1
let codeVerifier = PKCECodeGenerator.generateCodeVerifier()
guard
  let codeChallenge = PKCECodeGenerator.generateCodeChallenge(
    codeVerifier: codeVerifier
  ),
  // 2
  let authenticationURL = requestBuilder.createAuthorizationRequestURL(
    codeChallenge: codeChallenge
  )
else {
  print("[Error] Cannot construct authentication URL!")
  standing = .error(error: .internalError)
  return
}
print("[Debug] Authentication with: (authenticationURL.absoluteString)")
guard let bundleIdentifier = Bundle.major.bundleIdentifier else {
  print("[Error] Bundle Identifier is nil!")
  standing = .error(error: .internalError)
  return
}
// 3
let session = ASWebAuthenticationSession(
  url: authenticationURL,
  callbackURLScheme: bundleIdentifier
) { callbackURL, error in
  // 4
  self.handleAuthenticationResponse(
    callbackURL: callbackURL,
    error: error,
    codeVerifier: codeVerifier
  )
}
// 5
session.presentationContextProvider = self
// 6
session.begin()

The code above implements the primary a part of the authorization move:

1. Generates the code verifier and derives the code problem from it.
2. Put together the authorization endpoint URL with all of the required parameters.
3. Instantiate ASWebAuthenticationSession to carry out the authentication, passing authenticationURL generated earlier than.
4. In its completion handler, ASWebAuthenticationSession returns the parameters obtained from the server as callbackURL.
5. Inform the browser occasion that your class is its presentation context supplier. So, iOS instantiates the system browser window on prime of the app’s major window.
6. Lastly, begin the session.

ASWebAuthenticationSession provides you again an non-compulsory callback URL and an non-compulsory error.

For now, handleAuthenticationResponse(callbackURL:error:codeVerifier:) parses the error and prints the callback URL.

Construct and run. Faucet the Login button, and also you’ll see an alert saying MyGoogleInfo needs to make use of google.com to register.

Faucet Proceed and also you’ll see the Google login display.

Notice the Google request to share the consumer’s profile data.

Enter your credentials, authorize the app and examine the logs.
Test the app’s log for the callback URL returned from Google with the authorization response parameters.

Parsing the Callback URL

To proceed with the authorization move, you now must do two issues.

First, in PKCEAuthenticationService.swift, add the perform getToken(code:codeVerifier:) as follows.

non-public func getToken(code: String, codeVerifier: String) async {
  guard let tokenURLRequest = requestBuilder.createTokenExchangeURLRequest(
    code: code,
    codeVerifier: codeVerifier
  ) else {
    print("[Error] Cannot construct token alternate URL!")
    standing = .error(error: .internalError)
    return
  }
  let tokenURLRequestBody = tokenURLRequest.httpBody ?? Knowledge()
  print("[Debug] Get token parameters: (String(knowledge: tokenURLRequestBody, encoding: .utf8) ?? "")")
  //TODO: make request
}

createTokenExchangeURLRequest() generates the HTTP request, given the grant code and code_verifier.

Notice: The perform getToken(code:codeVerifier:) is async, because it’ll return instantly and full the community name within the background. Because you invoke it from a synchronous context, you employ a Process.

Then, exchange the implementation of handleAuthenticationResponse(callbackURL:error:codeVerifier:) with the next.

if let error = error {
  print("[Error] Authentication failed with: (error.localizedDescription)")
  standing = .error(error: .authenticationFailed)
  return
}
guard let code = extractCodeFromCallbackURL(callbackURL) else {
  standing = .error(error: .authenticationFailed)
  return
}
Process {
  await getToken(code: code, codeVerifier: codeVerifier)
}

The code above extracts the code parameter worth within the callback URL and passes it to getToken(code:codeVerifier:).

Construct and run, then log in along with your credentials. Confirm the log now incorporates the parameters for the credential alternate.

Getting the Entry Token

Lastly, you’re able to get the token.

Substitute the //TODO: make request remark in getToken(code:codeVerifier:) with the next:

do {
  // 1
  let (knowledge, response) = strive await URLSession.shared.knowledge(for: tokenURLRequest)
  // 2
  guard let response = response as? HTTPURLResponse else {
    print("[Error] HTTP response parsing failed!")
    standing = .error(error: .tokenExchangeFailed)
    return
  }
  guard response.isOk else {
    let physique = String(knowledge: knowledge, encoding: .utf8) ?? "EMPTY"
    print("[Error] Get token failed with standing: (response.statusCode), physique: (physique)")
    standing = .error(error: .tokenExchangeFailed)
    return
  }
  print("[Debug] Get token response: (String(knowledge: knowledge, encoding: .utf8) ?? "EMPTY")")
  // 3
  let decoder = JSONDecoder()
  decoder.keyDecodingStrategy = .convertFromSnakeCase
  let token = strive decoder.decode(GoogleToken.self, from: knowledge)
  // TODO: Retailer the token within the Keychain
  // 4
  standing = .authenticated(token: token)
} catch {
  print("[Error] Get token failed with: (error.localizedDescription)")
  standing = .error(error: .tokenExchangeFailed)
}

The perform getToken(code:codeVerifier:) performs the next actions:

1. Use the tokenURLRequest to begin the token alternate session with the token endpoint. Because of this, it receives again a URLResponse and an non-compulsory Knowledge.
2. Parse the server response standing.
3. If there are not any errors, decode the end result as a GoogleToken.
4. Lastly, set the standing to authenticated, together with the entry token as a parameter.

Now you’re prepared to begin querying knowledge. :]

When you get the token, you can begin utilizing it to entry the API.

The code in ViewModel listens to the authentication service standing and passes the token to the GoogleProfileInfoService. Then, the profile data service makes use of the token to entry your profile data.

Construct and run. Log in a single final time. Lastly, you may see your Google profile data.

You may also see within the logs the token response from the server:

Storing the Token

Thus far, you didn’t save the entry token in persistent storage. In different phrases, each time the app begins, the consumer must log in once more.

To make the consumer expertise flawless, the app ought to do two extra issues.
First, it ought to save each the entry and the refresh tokens in persistent storage, as quickly as they’re obtained from the server.
Second, it ought to restore the token from the persistent storage when the app begins.

Because the tokens include credential entry, it is best to keep away from UserDefaults and use the Apple keychain.

Refreshing the Token

The entry token and the refresh token have a restricted timeframe. In different phrases, they’ve a time expiration date enforced on the server.

As soon as the entry token expires, your API calls will fail with error 401. In these instances, it’s essential set off the token refresh move with the token endpoint. The HTTP request physique incorporates the consumer ID and the refresh token encoded as URL parameters.

For a reference, createRefreshTokenURLRequest(refreshToken:) within the last venture generates the URLRequest for the token refresh.

The place to Go From Right here?

Obtain the finished venture information by clicking the Obtain Supplies button on the prime or backside of the tutorial.

You dug into the small print of the OAuth Authorization move with PKCE, and now you’re able to implement the authentication service on your subsequent app. You may also experiment with issues like token administration and higher error dealing with.

For all the small print on easy methods to retailer and retrieve the token within the keychain, take a look at How To Safe iOS Consumer Knowledge: Keychain Providers and Biometrics with SwiftUI.

Then again, if you wish to undertake one of many SDKs obtainable for OAuth, you now understand how PKCE works underneath the hood to completely management the package deal conduct.

For reference, listed here are some third-party SDKs that implement OAuth with PKCE.

• AppAuth is an open-source SDK from the OpenID consortium; it helps native apps (iOS and Android) and all the opposite Apple OSs and Native JS.
• Auth0 presents an entire answer for OpenID authentication and, as part of it, they supply an SDK that helps each iOS and macOS.

We hope you loved this tutorial. You probably have any questions or feedback, please be part of the discussion board dialogue under!