11 KiB
OAuth 2.0 Client Changelog
2.4.1
Released: 2018-11-22
- Revert to use of
AccessTokenin type hints to preserve backwards compatibility; this fixes the issue reported in #752 and #753
2.4.0
Released: 2018-11-21
- Add
HttpBasicAuthOptionProviderto ease implementation for providers requiring HTTP basic auth - Add
GuardedPropertyTraitto allow providers the ability to specify properties that may not be overridden by user-defined values passed to the provider constructor - Add
AccessTokenInterfaceandResourceOwnerAccessTokenInterfaceto allow providers the ability to override the defaultAccessToken
2.3.1
Released: 2018-11-19
- Allow paragonie/random_compat's empty 9.99.99 placeholder
- Throw an
UnexpectedValueExceptionon non-JSON responses from access token request (when callingAbstractProvider::getAccessToken())
2.3.0
Released: 2018-01-13
- Add
ProviderRedirectTraittool for 3rd-party provider libraries to use when handling provider redirections - Fix TypeError thrown because
getResourceOwner()receives a non-JSON Response - Gracefully handle non-standard errors received from providers
- Update README to reflect official support of PHP 7.2
2.2.1
Released: 2017-04-25
- Fix potential type error when HTTP 500 errors are encountered
- Allow broader range of
random_compatversions
2.2.0
Released: 2017-02-01
- Allow base URLs to contain query parameters
- Protect against
+being improperly encoded in URL parameters - Remove misleading
stateoption from authorization parameters - Stop generating more random bytes than necessary
2.1.0
Released: 2017-01-24
- Allow
expires_inwith a value of0
2.0.0
Released: 2017-01-12
- Rename
getResponse()togetParsedResponse() - Add
getResponse()method that returns the unparsed PSR-7Responseinstance - Removed
RandomFactory, switched to native random functions
1.4.1
Released: 2016-04-29
- Add
QueryBuilderTraitto standardize query string generation.
1.4.0
Released: 2016-04-19
- Add
AccessToken::getValues()to access additional vendor data provided with tokens.
1.3.0
Released: 2016-02-13
- Enable dynamic parameters being passed into the authorization URL.
- Minor documentation updates.
1.2.0
Released: 2016-01-23
- Add
resource_owner_idto the JSON-serialized representation of the access token. - Minor documentation updates and improved test coverage.
1.1.0
Released: 2015-11-13
- Add
ArrayAccessorTrait, updateAbstractProviderto utilize. - Use
expiresto serialize access tokens. - Documentation updates.
1.0.2
Released: 2015-09-22
- Allow access tokens to be created from storage (see #431).
- Minor fixes and documentation updates.
1.0.1
Released: 2015-08-26
- Allow required parameters checked using the
RequiredParameterTraitto be set asfalse,null,"0", etc.
1.0.0
Released: 2015-08-19
- We are running code-quality builds through Scrutinizer, and we are running unit test builds on the new Travis CI container-based infrastructure.
- Cleaned up code, as recommended by Scrutinizer.
- Documentation updates.
1.0.0-beta2
Released: 2015-08-12
- BREAK: Add toArray() to ResourceOwnerInterface.
- Always attempt to parse responses as JSON and fallback on failure.
- Add dot notation support to access token resource owner ID.
- Use the Bearer authorization header for the generic provider.
- Documentation updates.
1.0.0-beta1
Released: 2015-07-16
- API for 1.0 is now frozen!
- BREAK: Convert all uses of "User" to "ResourceOwner" to more closely match the OAuth 2.0 specification.
- BREAK: Rename
StandardProvidertoGenericProvider. - BREAK: Move access token creation to the
AbstractProvider. It was previously handled in theAbstractGrant. - FIX: Add
Content-Typeheader with value ofapplication/x-www-form-urlencodedto the request header when retrieving access tokens. This adheres to the OAuth 2.0 specification and fixes issues where certain OAuth servers expect this header. - Enhanced
json_encode()serialization of AccessToken; when usingjson_encode()on an AccessToken, it will return a JSON object with these properties:access_token,refresh_token, andexpires_in.
1.0.0-alpha2
Released: 2015-07-04
- BREAK: Renamed
AbstractProvider::ACCESS_TOKEN_METHOD_GETtoAbstractProvider::METHOD_GET. - BREAK: Renamed
AbstractProvider::ACCESS_TOKEN_METHOD_POSTtoAbstractProvider::METHOD_POST. - BREAK: Renamed
AbstractProvider::prepareUserDetails()toAbstractProvider::createUser(). - BREAK: Renamed
AbstractProvider::getUserDetails()toAbstractProvider::getUser(). - BREAK: Removed
$tokenparameter fromAbstractProvider::getDefaultHeaders(). - BREAK: Modify
AbstractProvider::getBaseAccessTokenUrl()to accept a required array of parameters, allowing providers the ability to vary the access token URL, based on the parameters. - Removed newline characters from MAC Authorization header.
- Documentation updates, notably:
- Moved list of providers to
README.PROVIDERS.md. - Moved provider creation notes to
README.PROVIDER-GUIDE.md.
- Moved list of providers to
1.0.0-alpha1
Released: 2015-06-25
This release contains numerous BC breaks from the 0.x series. Please note these breaks and refer to the upgrade guide.
- BREAK: Requires PHP 5.5.0 and greater.
- BREAK: All providers have been moved to separate repositories, one for each provider.
- BREAK: All
publicproperties have been set asprotectedorprivateand getters/setters have been introduced for access to these properties. - BREAK: The
Provider\ProviderInterfacehas been removed. Please extend from and overrideProvider\AbstractProvider. - BREAK: The
Entity\Userhas been removed. Providers should implement theProvider\UserInterfaceand provide user functionality instead of expecting it in this base library. - BREAK: The
Grant\GrantInterfacehas been removed. Providers needing to provide a new grant type should extend from and overrideGrant\AbstractGrant. - A generic
Provider\StandardProviderhas been introduced, which may be used as a client to integrate with most OAuth 2.0 compatible servers. - A
Grant\GrantFactoryhas been introduced as a means to register and retrieve singleton grants from a registry. - Introduced traits for bearer and MAC authorization (
Tool\BearerAuthorizationTraitandTool\MacAuthorizationTrait), which providers may use to enable these header authorization types.
0.12.1
Released: 2015-06-20
- FIX: Scope separators for LinkedIn and Instagram are now correctly a single space
0.12.0
Released: 2015-06-15
- BREAK: LinkedIn Provider: Default scopes removed from LinkedIn Provider. See "Managing LinkedIn Scopes" in the README for information on how to set scopes. See #327 and #307 for details on this change.
- FIX: LinkedIn Provider: A scenario existed in which
publicProfileUrlwas not set, generating a PHP notice; this has been fixed. - FIX: Instagram Provider: Fixed scope separator.
- Documentation updates and corrections.
0.11.0
Released: 2015-04-25
- Identity Provider: Better handling of error responses
- Documentation updates
0.10.1
Released: 2015-04-02
- FIX: Invalid JSON triggering fatal error
- FIX: Sending headers along with auth
getAccessToken()requests - Now running Travis CI tests on PHP 7
- Documentation updates
0.10.0
Released: 2015-03-10
- Providers: Added
getHeaders()to ProviderInterface and updated AbstractProvider to provide the method - Providers: Updated all bundled providers to support new
$authorizationHeaderproperty - Identity Provider: Update IDPException to account for empty strings
- Identity Provider: Added
getResponseBody()method to IDPException - Documentation updates, minor bug fixes, and coding standards fixes
0.9.0
Released: 2015-02-24
- Add
AbstractProvider::prepareAccessTokenResult()to provide additional token response preparation to providers - Remove custom provider code from AccessToken
- Add links to README for Dropbox and Square providers
0.8.1
Released: 2015-02-12
- Allow
approval_promptto be set by providers. This fixes an issue where some providers have problems if theapproval_promptis present in the query string.
0.8.0
Released: 2015-02-10
- Facebook Provider: Upgrade to Graph API v2.2
- Google Provider: Add
access_typeparameter for Google authorization URL - Get a more reliable response body on errors
0.7.2
Released: 2015-02-03
- GitHub Provider: Fix regression
- Documentation updates
0.7.1
Released: 2015-01-06
- Google Provider: fixed issue where Google API was not returning the user ID
0.7.0
Released: 2014-12-29
- Improvements to Provider\AbstractProvider (addition of
userUid(),userEmail(), anduserScreenName()) - GitHub Provider: Support for GitHub Enterprise
- GitHub Provider: Methods to allow fetching user email addresses
- Google Provider: Updated scopes and endpoints to remove deprecated values
- Documentation updates, minor bug fixes, and coding standards fixes
0.6.0
Released: 2014-12-03
- Added ability to specify a redirect handler for providers through use of a callback (see Provider\AbstractProvider::setRedirectHandler())
- Updated authorize and token URLs for the Microsoft provider; the old URLs had been phased out and were no longer working (see #146)
- Increased test coverage
- Documentation updates, minor bug fixes, and coding standards fixes
0.5.0
Released: 2014-11-28
- Added
ClientCredentialsandPasswordgrants - Added support for providers to set their own
uidparameter key name - Added support for Google's
hd(hosted domain) parameter - Added support for providing a custom
stateparameter to the authorization URL - LinkedIn
pictureUrlis now an optional response element - Added Battle.net provider package link to README
- Added Meetup provider package link to README
- Added
.gitattributesfile - Increased test coverage
- A number of documentation fixes, minor bug fixes, and coding standards fixes
0.4.0
Released: 2014-10-28
- Added
ProviderInterfaceand removedIdentityProvider. - Expose generated state to allow for CSRF validation.
- Renamed
League\OAuth2\Client\Provider\UsertoLeague\OAuth2\Client\Entity\User. - Entity: User: added
genderandlocaleproperties - Updating logic for populating the token expiration time.
0.3.0
Released: 2014-04-26
- This release made some huge leaps forward, including 100% unit-coverage and a bunch of new features.
0.2.0
Released: 2013-05-28
- No release notes available.
0.1.0
Released: 2013-05-25
- Initial release.