Changelog

All notable changes to this project will be documented in this file.

Any release before 1.0.0 may contain breaking changes. After 1.0.0 this project will adhere to Semantic Versioning.

Versions

• 1.2.0 - 2020-09-30
• 1.1.0 - 2020-07-15
• 1.0.0 - 2020-04-29
• 0.9.3 - 2020-03-02
• 0.9.2 - 2020-01-22
• 0.9.1 - 2019-11-25
• 0.9.0 - 2019-10-21

Updating

When the Unreleased section becomes a new version, duplicate the Template to create a new Unreleased section. Breaking changes should begin with a [breaking] tag.

[Template]

Added

Changed

Removed

Deprecated

Fixed

Security

[Unreleased]

Added

Changed

Removed

Deprecated

Fixed

Security

[1.2.0] - 2020-09-30

Added

• Example app: Documentation comments on user carrier migration
• Xcode 12 support

Changed

• Update README.md files to fix broken links
• Update the name of the Developer Portal throughout the docs

Fixed

• Buildtime/linter warnings

[1.1.0] - 2020-07-15

Added

• Basic SceneDelegate support using ZenKeySceneDelegate.
• Shows alert when app is launched by a redirect that cannot be handled.

Fixed

• The podspec to properly package Localizable.strings.

Security

• Example app: Disable 3rd party keyboards.
• Example app: Check for jailbreak or un-lockable device.
• Example app: Hide secure user info when backgrounded.
• Example app: Clear password UI when sign-in completes.

[1.0.0] - 2020-04-29

Added

• Example app that demonstrates a simple programmatic integration of the SDK.
• clientId added to AuthorizedResponse.
• Optional theme parameter to override light/dark theme for authorization UX.
• Enums for address and birthdate scopes.
• Support for IBDesignable to ZenKeyBrandedButton.

Changed

• AuthorizedResponse conforms to Encodable to simplify forwarding to server.

Fixed

• Allow inferred optional dependencies to resolve without error.

[0.9.3] - 2020-03-02

Added

• New mccmnc parameter to AuthorizedResponse, use instead of mcc and mnc.
• CONTRIBUTING.md file, defining the open source contribution policy.
• Enum for new last_4_social scope.

Removed

• [breaking] mcc and mnc parameters removed from AuthorizedResponse. Use .mccmnc instead.

Fixed

• PKCE codeChallenge generation now avoids extra hex encoding and padding.

[0.9.2] - 2020-01-22

Added

• Description and documentation added to ZenKeySDK.podspec.
• Changelog link in README.md.
• Open source attribution in RandomStringGenerator.swift.

Changed

• Copyright in file headers.

Removed

• [breaking] ZenKeyButtonView made private until carrier endorsement work is completed. Use ZenKeyAuthorizeButton instead.

[0.9.1] - 2019-11-25

Added

• New ZenKeyButtonView provides carrier endorsement UI; now preferred over ZenKeyAuthorizeButton.
• PKCE: auto-generated codeChallenge and method are included in auth code request.
• PKCE: codeVerifier returned in authenticatedResponse for use in token requests.
• SDK version parameter included in API requests.
• Presented ViewControllers use .fullScreen modalPresentationStyle.
• CHANGELOG.md

Changed

• ACR values passed to API are now a1, a2, a3 instead of aal1, aal2, aal3. API and ZenKey app update required.
• Updated to iOS 13 SDK, Xcode 11.
• How rootViewController is determined to avoid problems in apps with multiple windows/scenes

Removed

• [breaking] Depreciated scopes: authorize, register, secondFactor, authenticate, birthdate, isAdult, picture, address, location, events, offlineAccess, score, match.
• base64url encoding of the context parameter in auth code request. ZenKey app update required.
• ACR value no longer defaults to a1; a request may contain no ACR parameter.

[0.9.0] - 2019-10-21

Added

• First public release