Skip to content

Commit 7a738fc

Browse files
oleggnidets-oktaoleggnidets-okta
authored
Generic error code is returned for all authorization (#321)
* Fix error returning discovery document * Add status code for .unexpectedAuthCodeResponse * Refactoring of APIError * Argument renaming underlyingError * Minor fix * Handle error and error_description parameters for authorization response * Handle error and error_description parameters for token response * Support CustomNSError * Fix error returning * Minor fix * Add tests for errors * Minor updates for example project. Update documentation * Fix comments
1 parent ed43488 commit 7a738fc

14 files changed

+362
-112
lines changed

‎Example/AuthViewController.swift‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,9 @@ final class AuthViewController: UIViewController {
4646
showProgress()
4747
oktaAppAuth?.authenticate(withSessionToken: token) { authStateManager, error in
4848
self.hideProgress()
49+
4950
if let error = error {
50-
self.presentError(error)
51+
self.showMessage(error)
5152
return
5253
}
5354

@@ -56,8 +57,12 @@ final class AuthViewController: UIViewController {
5657
}
5758
}
5859

59-
func presentError(_ error: Error) {
60-
self.showMessage("Error: \(error.localizedDescription)")
60+
func showMessage(_ error: Error) {
61+
if let oidcError = error as? OktaOidcError {
62+
messageView.text = oidcError.displayMessage
63+
} else {
64+
messageView.text = error.localizedDescription
65+
}
6166
}
6267

6368
func showMessage(_ message: String) {

‎Example/ViewController.swift‎

Lines changed: 50 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ final class ViewController: UIViewController {
6565
super.viewWillAppear(animated)
6666

6767
guard oktaAppAuth != nil else {
68-
self.updateUI(updateText: "SDK is not configured!")
68+
self.showMessage("SDK is not configured!")
6969
return
7070
}
7171

@@ -103,14 +103,14 @@ final class ViewController: UIViewController {
103103
@IBAction func userInfoButton(_ sender: Any) {
104104
authStateManager?.getUser() { response, error in
105105
if let error = error {
106-
self.updateUI(updateText: "Error: \(error)")
106+
self.showMessage(error)
107107
return
108108
}
109109

110110
if response != nil {
111111
var userInfoText = ""
112112
response?.forEach { userInfoText += ("\($0): \($1) \n") }
113-
self.updateUI(updateText: userInfoText)
113+
self.showMessage(userInfoText)
114114
}
115115
}
116116
}
@@ -121,11 +121,11 @@ final class ViewController: UIViewController {
121121

122122
authStateManager?.introspect(token: accessToken, callback: { payload, error in
123123
guard let isValid = payload?["active"] as? Bool else {
124-
self.updateUI(updateText: "Error: \(error?.localizedDescription ?? "Unknown")")
124+
self.showMessage("Error: \(error?.localizedDescription ?? "Unknown")")
125125
return
126126
}
127127

128-
self.updateUI(updateText: "Is the AccessToken valid? - \(isValid)")
128+
self.showMessage("Is the AccessToken valid? - \(isValid)")
129129
})
130130
}
131131

@@ -134,16 +134,16 @@ final class ViewController: UIViewController {
134134
guard let accessToken = authStateManager?.accessToken else { return }
135135

136136
authStateManager?.revoke(accessToken) { _, error in
137-
if error != nil { self.updateUI(updateText: "Error: \(error!)") }
138-
self.updateUI(updateText: "AccessToken was revoked")
137+
if error != nil { self.showMessage("Error: \(error!)") }
138+
self.showMessage("AccessToken was revoked")
139139
}
140140
}
141141

142142
func signInWithBrowser() {
143143
oktaAppAuth?.signInWithBrowser(from: self) { authStateManager, error in
144144
if let error = error {
145145
self.authStateManager = nil
146-
self.updateUI(updateText: "Error: \(error)")
146+
self.showMessage("Error: \(error.localizedDescription)")
147147
return
148148
}
149149

@@ -158,9 +158,9 @@ final class ViewController: UIViewController {
158158
oktaAppAuth?.signOut(authStateManager: authStateManager, from: self, progressHandler: { currentOption in
159159
switch currentOption {
160160
case .revokeAccessToken, .revokeRefreshToken, .removeTokensFromStorage, .revokeTokensOptions:
161-
self.updateUI(updateText: "Revoking tokens...")
161+
self.showMessage("Revoking tokens...")
162162
case .signOutFromOkta:
163-
self.updateUI(updateText: "Signing out from Okta...")
163+
self.showMessage("Signing out from Okta...")
164164
default:
165165
break
166166
}
@@ -169,13 +169,21 @@ final class ViewController: UIViewController {
169169
self.authStateManager = nil
170170
self.buildTokenTextView()
171171
} else {
172-
self.updateUI(updateText: "Error: failed to logout")
172+
self.showMessage("Error: failed to logout")
173173
}
174174
})
175175
}
176-
177-
func updateUI(updateText: String) {
178-
tokenView.text = updateText
176+
177+
func showMessage(_ message: String) {
178+
tokenView.text = message
179+
}
180+
181+
func showMessage(_ error: Error) {
182+
if let oidcError = error as? OktaOidcError {
183+
tokenView.text = oidcError.displayMessage
184+
} else {
185+
tokenView.text = error.localizedDescription
186+
}
179187
}
180188

181189
func buildTokenTextView() {
@@ -197,7 +205,7 @@ final class ViewController: UIViewController {
197205
tokenString += "\nRefresh Token: \(refreshToken)\n"
198206
}
199207

200-
self.updateUI(updateText: tokenString)
208+
self.showMessage(tokenString)
201209
}
202210
}
203211

@@ -215,3 +223,30 @@ extension ViewController: OktaNetworkRequestCustomizationDelegate {
215223
}
216224
}
217225
}
226+
227+
extension OktaOidcError {
228+
var displayMessage: String {
229+
switch self {
230+
case let .api(message, _):
231+
switch (self as NSError).code {
232+
case NSURLErrorNotConnectedToInternet,
233+
NSURLErrorNetworkConnectionLost,
234+
NSURLErrorCannotLoadFromNetwork,
235+
NSURLErrorCancelled:
236+
return "No Internet Connection"
237+
case NSURLErrorTimedOut:
238+
return "Connection timed out"
239+
default:
240+
break
241+
}
242+
243+
return "API Error occurred: \(message)"
244+
case let .authorization(error, _):
245+
return "Authorization error: \(error)"
246+
case let .unexpectedAuthCodeResponse(statusCode):
247+
return "Authorization failed due to incorrect status code: \(statusCode)"
248+
default:
249+
return localizedDescription
250+
}
251+
}
252+
}

‎README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ You can learn more on the [Okta + iOS](https://developer.okta.com/code/ios/) pag
3838
- [Development](#development)
3939
- [Running Tests](#running-tests)
4040
- [Modify network requests](#modify-network-requests)
41+
- [Migration](#migration)
4142
- [Known issues](#known-issues)
4243
- [Contributing](#contributing)
4344

@@ -507,6 +508,20 @@ extension SomeNSObject: OktaNetworkRequestCustomizationDelegate {
507508

508509
***Note:*** It is highly recommended to copy all of the existing parameters from the original URLRequest object to modified request without any changes. Altering of this data could lead network request to fail. If `customizableURLRequest(_:)` method returns `nil` default request will be used.
509510

511+
## Migration
512+
513+
### Migrating from 3.10.x to 3.11.x
514+
515+
The SDK `okta-oidc-ios` has a major changes in error handling. Consider these guidelines to update your code.
516+
517+
- `APIError` is renamed as `api`.
518+
- `api` error has the additional parameter `underlyingError`, it's an optional and indicates the origin of the error.
519+
- Introduced a new error `authorization(error:description:)`.
520+
- `authorization` error appears when authorization server fails due to errors during authorization.
521+
- `unexpectedAuthCodeResponse(statusCode:)` has an error code parameter.
522+
- `OktaOidcError` conforms to `CustomNSError` protocol. It means you can convert the error to `NSError` and get `code`, `userInfo`, `domain`, `underlyingErrors`.
523+
- `OktaOidcError` conforms to `Equatable` protocol. The errors can be compared for equality using the operator `==` or inequality using the operator `!=`.
524+
510525
## Known issues
511526

512527
### iOS shows permission dialog(`{App} Wants to Use {Auth Domain} to Sign In`) for Okta Sign Out flows

‎Sources/OktaOidc/Common/Internal/OIDAuthState+Okta.swift‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,37 @@ import OktaOidc_AppAuth
1717
// Okta Extension of OIDAuthState
1818
extension OKTAuthState {
1919

20-
static func getState(withAuthRequest authRequest: OKTAuthorizationRequest, delegate: OktaNetworkRequestCustomizationDelegate? = nil, callback: @escaping (OKTAuthState?, OktaOidcError?) -> Void ) {
20+
static func getState(withAuthRequest authRequest: OKTAuthorizationRequest, delegate: OktaNetworkRequestCustomizationDelegate? = nil, callback finalize: @escaping (OKTAuthState?, OktaOidcError?) -> Void ) {
2121

22-
let finalize: ((OKTAuthState?, OktaOidcError?) -> Void) = { state, error in
23-
callback(state, error)
24-
}
25-
2622
// Make authCode request
27-
OKTAuthorizationService.perform(authRequest: authRequest, delegate: delegate, callback: { authResponse, error in
23+
OKTAuthorizationService.perform(authRequest: authRequest, delegate: delegate) { authResponse, error in
2824
guard let authResponse = authResponse else {
29-
finalize(nil, OktaOidcError.APIError("Authorization Error: \(error?.localizedDescription ?? "No authentication response.")"))
25+
finalize(nil, .api(message: "Authorization Error: \(error?.localizedDescription ?? "No authentication response.")", underlyingError: error))
3026
return
3127
}
32-
28+
29+
if let oauthError = authResponse.additionalParameters?[OKTOAuthErrorFieldError] as? String {
30+
let oauthErrorDescription = authResponse.additionalParameters?[OKTOAuthErrorFieldErrorDescription] as? String
31+
finalize(nil, .authorization(error: oauthError, description: oauthErrorDescription))
32+
return
33+
}
34+
3335
guard authResponse.authorizationCode != nil,
3436
let tokenRequest = authResponse.tokenExchangeRequest() else {
35-
finalize(nil, OktaOidcError.unableToGetAuthCode)
37+
finalize(nil, .unableToGetAuthCode)
3638
return
3739
}
3840

3941
// Make token request
40-
OKTAuthorizationService.perform(tokenRequest, originalAuthorizationResponse: authResponse, delegate: delegate, callback: { tokenResponse, error in
42+
OKTAuthorizationService.perform(tokenRequest, originalAuthorizationResponse: authResponse, delegate: delegate) { tokenResponse, error in
4143
guard let tokenResponse = tokenResponse else {
42-
finalize(nil, OktaOidcError.APIError("Authorization Error: \(error?.localizedDescription ?? "No token response.")"))
44+
finalize(nil, OktaOidcError.api(message: "Authorization Error: \(error?.localizedDescription ?? "No token response.")", underlyingError: error))
45+
return
46+
}
47+
48+
if let oauthError = tokenResponse.additionalParameters?[OKTOAuthErrorFieldError] as? String {
49+
let oauthErrorDescription = tokenResponse.additionalParameters?[OKTOAuthErrorFieldErrorDescription] as? String
50+
finalize(nil, .authorization(error: oauthError, description: oauthErrorDescription))
4351
return
4452
}
4553

@@ -48,7 +56,7 @@ extension OKTAuthState {
4856
registrationResponse: nil,
4957
delegate: delegate)
5058
finalize(authState, nil)
51-
})
52-
})
59+
}
60+
}
5361
}
5462
}

‎Sources/OktaOidc/Common/Internal/OIDAuthorizationService+Okta.swift‎

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,33 +35,43 @@ extension OKTAuthorizationService {
3535

3636
delegate?.didReceive(response)
3737
guard let response = response as? HTTPURLResponse else {
38-
callback(nil, error)
38+
callback(nil, OktaOidcError.api(message: "Authentication Error: No response", underlyingError: error))
3939
return
4040
}
4141

42-
guard response.statusCode == 302,
43-
let locationHeader = response.allHeaderFields["Location"] as? String,
44-
let urlComonents = URLComponents(string: locationHeader),
45-
let queryItems = urlComonents.queryItems else {
46-
callback(nil, OktaOidcError.unexpectedAuthCodeResponse)
47-
return
42+
guard response.statusCode == 302 else {
43+
callback(nil, OktaOidcError.unexpectedAuthCodeResponse(statusCode: response.statusCode))
44+
return
4845
}
46+
47+
guard let locationHeader = response.allHeaderFields["Location"] as? String,
48+
let urlComponents = URLComponents(string: locationHeader),
49+
let queryItems = urlComponents.queryItems else {
50+
callback(nil, OktaOidcError.noLocationHeader)
51+
return
52+
}
4953

50-
var parameters = [String: NSString]()
51-
queryItems.forEach({ item in
54+
var parameters: [String: NSString] = [:]
55+
queryItems.forEach { item in
5256
parameters[item.name] = item.value as NSString?
53-
})
54-
55-
if let allHeaderFields = response.allHeaderFields as? [String: String],
56-
let url = response.url {
57-
let httpCookies = HTTPCookie.cookies(withResponseHeaderFields: allHeaderFields, for: url)
58-
for cookie in httpCookies {
59-
HTTPCookieStorage.shared.setCookie(cookie)
60-
}
6157
}
62-
58+
6359
let authResponse = OKTAuthorizationResponse(request: authRequest, parameters: parameters)
60+
61+
setCookie(from: response)
62+
6463
callback(authResponse, error)
6564
}.resume()
6665
}
66+
67+
private static func setCookie(from response: HTTPURLResponse) {
68+
guard let allHeaderFields = response.allHeaderFields as? [String: String],
69+
let url = response.url else {
70+
return
71+
}
72+
73+
HTTPCookie.cookies(withResponseHeaderFields: allHeaderFields, for: url).forEach {
74+
HTTPCookieStorage.shared.setCookie($0)
75+
}
76+
}
6777
}

‎Sources/OktaOidc/Common/Internal/OktaOidcRestApi.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ class OktaOidcRestApi: OktaOidcHttpApiProtocol {
2828
let httpResponse = response as? HTTPURLResponse else {
2929
let errorMessage = error?.localizedDescription ?? "No response data"
3030
DispatchQueue.main.async {
31-
onError(OktaOidcError.APIError(errorMessage))
31+
onError(OktaOidcError.api(message: errorMessage, underlyingError: error))
3232
}
3333
return
3434
}
3535

3636
guard 200 ..< 300 ~= httpResponse.statusCode else {
3737
DispatchQueue.main.async {
38-
onError(OktaOidcError.APIError(HTTPURLResponse.localizedString(forStatusCode: httpResponse.statusCode)))
38+
onError(OktaOidcError.api(message: HTTPURLResponse.localizedString(forStatusCode: httpResponse.statusCode), underlyingError: nil))
3939
}
4040
return
4141
}

‎Sources/OktaOidc/Common/Internal/Tasks/OktaOidcBrowserTask.swift‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class OktaOidcBrowserTask: OktaOidcTask {
4040
responseType: OKTResponseTypeCode,
4141
additionalParameters: self.config.additionalParams)
4242
guard let externalUserAgent = self.externalUserAgent() else {
43-
callback(nil, OktaOidcError.APIError("Authorization Error: \(error?.localizedDescription ?? "No external User Agent.")"))
43+
callback(nil, OktaOidcError.api(message: "Authorization Error: \(error?.localizedDescription ?? "No external User Agent.")", underlyingError: nil))
4444
return
4545
}
4646

@@ -49,17 +49,22 @@ class OktaOidcBrowserTask: OktaOidcTask {
4949
delegate: delegate) { authorizationResponse, error in
5050
defer { self.userAgentSession = nil }
5151

52-
guard let authResponse = authorizationResponse else {
53-
guard let error = error else {
54-
return callback(nil, OktaOidcError.APIError("Authorization Error"))
55-
}
56-
if (error as NSError).code == OKTErrorCode.userCanceledAuthorizationFlow.rawValue {
57-
return callback(nil, OktaOidcError.userCancelledAuthorizationFlow)
58-
} else {
59-
return callback(nil, OktaOidcError.APIError("Authorization Error: \(error.localizedDescription)"))
60-
}
52+
if let authResponse = authorizationResponse {
53+
callback(authResponse, nil)
54+
return
6155
}
62-
callback(authResponse, nil)
56+
57+
guard let error = error else {
58+
callback(nil, OktaOidcError.api(message: "Authorization Error: No authorization response", underlyingError: nil))
59+
return
60+
}
61+
62+
if (error as NSError).code == OKTErrorCode.userCanceledAuthorizationFlow.rawValue {
63+
callback(nil, OktaOidcError.userCancelledAuthorizationFlow)
64+
return
65+
}
66+
67+
return callback(nil, OktaOidcError.api(message: "Authorization Error: \(error.localizedDescription)", underlyingError: error))
6368
}
6469
self.userAgentSession = userAgentSession
6570
}
@@ -83,7 +88,7 @@ class OktaOidcBrowserTask: OktaOidcTask {
8388
postLogoutRedirectURL: successRedirectURL,
8489
additionalParameters: self.config.additionalParams)
8590
guard let externalUserAgent = self.externalUserAgent() else {
86-
callback(nil, OktaOidcError.APIError("Authorization Error: \(error?.localizedDescription ?? "No external User Agent.")"))
91+
callback(nil, OktaOidcError.api(message: "Authorization Error: \(error?.localizedDescription ?? "No external User Agent.")", underlyingError: nil))
8792
return
8893
}
8994

@@ -92,7 +97,7 @@ class OktaOidcBrowserTask: OktaOidcTask {
9297

9398
var error: OktaOidcError?
9499
if let responseError = responseError {
95-
error = OktaOidcError.APIError("Sign Out Error: \(responseError.localizedDescription)")
100+
error = OktaOidcError.api(message: "Sign Out Error: \(responseError.localizedDescription)", underlyingError: nil)
96101
}
97102

98103
callback((), error)

0 commit comments

Comments
 (0)