Merge pull request #92 from trikoder/release-2.0.0

Release v2.0.0

Author: spideyfusion

CHANGELOG.md

@@ -4,6 +4,37 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2019-08-08
+## Added
+- Ability to specify a [Defuse](https://github.com/defuse/php-encryption/blob/master/docs/classes/Key.md) key as the encryption key ([d83fefe](https://github.com/trikoder/oauth2-bundle/commit/d83fefe149c1add841d4225ebc2a32aa9333308d))
+- Ability to use different PSR-7/17 HTTP transport implementations ([4973e1c](https://github.com/trikoder/oauth2-bundle/commit/4973e1c7ddfc4afcca85989bde1b8d28dcd7fd4a))
+- Allow configuration of the private key passphrase ([f16ec67](https://github.com/trikoder/oauth2-bundle/commit/f16ec67f2fa8dbf8fedd78488d625cef2db5b90d))
+- Checks if dependent bundles are enabled in the application kernel ([38f6641](https://github.com/trikoder/oauth2-bundle/commit/38f66418b5f28b8666d5bbde1e36a45cfc166afa))
+- Console command for clearing expired access and refresh tokens ([de3e338](https://github.com/trikoder/oauth2-bundle/commit/de3e338a24e0b03ab634c4982c46034715635379))
+- Console commands for client management ([2425b3d](https://github.com/trikoder/oauth2-bundle/commit/2425b3d149cadb1706eb70b321491bf894114784), [56aafba](https://github.com/trikoder/oauth2-bundle/commit/56aafba995f06e45fd6521735be780c327e67d65))
+- Server grant types can now be enabled/disabled through bundle configuration ([baffa92](https://github.com/trikoder/oauth2-bundle/commit/baffa928d9f489bd642fff7ae2bc88ce93badcbf))
+- Support for the "authorization_code" server grant type ([a61114a](https://github.com/trikoder/oauth2-bundle/commit/a61114a7f2449bdb28b0779b0a4a7d21b9fff2c2))
+- Support for the "implicit" server grant type ([91b3d75](https://github.com/trikoder/oauth2-bundle/commit/91b3d7583e269d5151927f24fbaec9d2fc4cea3d))
+- Support for Symfony 4.3 ([e4cf668](https://github.com/trikoder/oauth2-bundle/commit/e4cf6680ddfb7d1327b2c83ed22f46c0db56c67a))
+- The bundle is now additionally tested against PHP 7.3 ([9f5937b](https://github.com/trikoder/oauth2-bundle/commit/9f5937bda2a112337a9b375ed3923918bcc06370))
+
+## Changed
+- Authentication exceptions are now thrown instead of setting the response object ([8a505f6](https://github.com/trikoder/oauth2-bundle/commit/8a505f61f52d6ce924ab7119a411a17efdf1bbef))
+- Modernize bundle service definitions ([fc1f855](https://github.com/trikoder/oauth2-bundle/commit/fc1f8556c180ba961bd6f2c973d36ff7439cbf34), [ef2f557](https://github.com/trikoder/oauth2-bundle/commit/ef2f557f357de8cf39bd87da3499cb38563ad82f))
+- Previously [documented](https://github.com/trikoder/oauth2-bundle/blob/v1.1.0/docs/controlling-token-scopes.md) client scope inheriting and restricting is now the new default behavior ([af9bffc](https://github.com/trikoder/oauth2-bundle/commit/af9bffcbcab7b02036c36ba0e1bc7d7b6921280))
+- Relaxed the [league/oauth2-server](https://github.com/thephpleague/oauth2-server) package version constraint to allow non-braking changes ([26d9c0b](https://github.com/trikoder/oauth2-bundle/commit/26d9c0b14a4d31e3fd5f620facfa374795f9adeb))
+- Use `DateTimeInterface` instead of `DateTime` whenever possible ([4549252](https://github.com/trikoder/oauth2-bundle/commit/454925249bfba1b6fd5c8e07fd64a4e87039759e))
+
+## Fixed
+- [DoctrineBundle](https://github.com/doctrine/DoctrineBundle) related deprecation notices ([fbde15b](https://github.com/trikoder/oauth2-bundle/commit/fbde15bfd2295b10563136701f668c839dcc1e5e))
+- Not being able to override the "persistence" config tree from other configuration files ([b62b331](https://github.com/trikoder/oauth2-bundle/commit/b62b331834c77609893a1b70633ef7683ada7edc))
+- [Symfony](https://github.com/symfony/symfony) related deprecation notices ([601d482](https://github.com/trikoder/oauth2-bundle/commit/601d482351e67d3d22b6ca600e26ed1da7f33866))
+
+## Removed
+- Redundant configuration node options ([5fa60ef](https://github.com/trikoder/oauth2-bundle/commit/5fa60efb81fddea79989e502f67bc7aca1bcac16))
+- Support for Symfony 4.1 ([4973e1c](https://github.com/trikoder/oauth2-bundle/commit/4973e1c7ddfc4afcca85989bde1b8d28dcd7fd4a))
+- Unsupported HTTP verbs on the `/authorize` and `/token` endpoints ([51ef5ae](https://github.com/trikoder/oauth2-bundle/commit/51ef5ae7e659afaf63c024e7da070464d318fd67))
+
 ## [1.1.0] - 2019-01-07
 ### Added
 - The bundle is now compatible with Symfony 3.4 ([0ba9cb3](https://github.com/trikoder/oauth2-bundle/commit/0ba9cb306157a9ad89691eb3d20054a6803af472))

README.md

@@ -44,68 +44,69 @@ This package is currently in the active development.
 
     ```yaml
     trikoder_oauth2:
-
-        authorization_server:
+        authorization_server: # Required
 
             # Full path to the private key file.
             # How to generate a private key: https://oauth2.thephpleague.com/installation/#generating-public-and-private-keys
-            private_key:    # Required, Example: /var/oauth/private.key
+            private_key:          ~ # Required, Example: /var/oauth/private.key
 
-            # Passphrase of the private key, if any.
-            private_key_passphrase: ~  # Optional, default null
+            # Passphrase of the private key, if any
+            private_key_passphrase: null
 
-            # The string used as an encryption key.
+            # The plain string or the ascii safe string used to create a Defuse\Crypto\Key to be used as an encryption key.
             # How to generate an encryption key: https://oauth2.thephpleague.com/installation/#string-password
-            encryption_key:    # Required
-            
-            # The type of encryption key. Is the key a plain value or a ascii safe string that should be passed to Defuse\Crypto\Key?
-            encryption_key_type: 'plain'   # Possible values: "plain", "defuse"
+            encryption_key:       ~ # Required
+
+            # The type of value of 'encryption_key'
+            encryption_key_type:  plain # One of "plain"; "defuse"
 
             # How long the issued access token should be valid for.
             # The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
-            access_token_ttl: PT1H
+            access_token_ttl:     PT1H
 
             # How long the issued refresh token should be valid for.
             # The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
-            refresh_token_ttl: P1M
-         
+            refresh_token_ttl:    P1M
+
+            # How long the issued auth code should be valid for.
+            # The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
+            auth_code_ttl:        PT10M
+
             # Whether to enable the client credentials grant
             enable_client_credentials_grant: true
-         
+
             # Whether to enable the password grant
             enable_password_grant: true
-         
+
             # Whether to enable the refresh token grant
             enable_refresh_token_grant: true
 
-            # How long the issued auth code should be valid for.
-            # The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
-            auth_code_ttl: PT10M
+            # Whether to enable the authorization code grant
+            enable_auth_code_grant: true
 
-        resource_server:
+            # Whether to enable the implicit grant
+            enable_implicit_grant: true
+        resource_server:      # Required
 
             # Full path to the public key file
             # How to generate a public key: https://oauth2.thephpleague.com/installation/#generating-public-and-private-keys
-            public_key:    # Required, Example: /var/oauth/public.key
+            public_key:           ~ # Required, Example: /var/oauth/public.key
 
         # Scopes that you wish to utilize in your application.
         # This should be a simple array of strings.
-        scopes: []
+        scopes:               []
 
         # Configures different persistence methods that can be used by the bundle for saving client and token data.
         # Only one persistence method can be configured at a time.
-        persistence:
-
+        persistence:          # Required
             doctrine:
 
                 # Name of the entity manager that you wish to use for managing clients and tokens.
-                entity_manager: default # Required
+                entity_manager:       default
+            in_memory:            ~
 
-            in_memory: ~
-         
         # The priority of the event listener that converts an Exception to a Response
-        exception_event_listener_priority: 10 
-       
+        exception_event_listener_priority: 10
     ```
 
 3. Enable the bundle in `config/bundles.php` by adding it to the array:

UPGRADE.md

@@ -0,0 +1,42 @@
+# Upgrade
+Here you will find upgrade steps between major releases.
+
+## From 1.x to 2.x
+
+### PSR-7/17 HTTP transport implementation
+
+The bundle removed a direct dependency on the [zendframework/zend-diactoros](https://github.com/zendframework/zend-diactoros) package. You now need to explicitly install a PSR 7/17 implementation. We recommand that you use [nyholm/psr7](https://github.com/Nyholm/psr7). Check out this [document](https://github.com/trikoder/oauth2-bundle/blob/v2.0.0/docs/psr-implementation-switching.md) if you wish to use a different implementation.
+
+### Scope resolving changes
+
+Previously [documented](https://github.com/trikoder/oauth2-bundle/blob/v1.1.0/docs/controlling-token-scopes.md) client scope inheriting and restricting is now the new default behavior. You can safely remove the listener from your project.
+
+### SQL schema changes
+
+The bundle adds new tables and constraints to the existing schema. You will need to run the Doctrine schema update process to sync the changes:
+
+```sh
+bin/console doctrine:schema:update
+```
+
+The schema changes include:
+
+* New `oauth2_authorization_code` table for storing authorization codes
+* `access_token` field on the `oauth2_refresh_token` table is now nullable
+
+### Interface changes
+
+The following interfaces have been changed:
+
+#### `Trikoder\Bundle\OAuth2Bundle\Manager\ClientManagerInterface`
+
+- [Added the remove() method](https://github.com/trikoder/oauth2-bundle/blob/v2.0.0/Manager/ClientManagerInterface.php#L15)
+- [Added the list() method](https://github.com/trikoder/oauth2-bundle/blob/v2.0.0/Manager/ClientManagerInterface.php#L20)
+
+#### `Trikoder\Bundle\OAuth2Bundle\Manager\AccessTokenManagerInterface`
+
+- [Added the clearExpired() method](https://github.com/trikoder/oauth2-bundle/blob/v2.0.0/Manager/AccessTokenManagerInterface.php#L15)
+
+#### `Trikoder\Bundle\OAuth2Bundle\Manager\RefreshTokenManagerInterface`
+
+- [Added the clearExpired() method](https://github.com/trikoder/oauth2-bundle/blob/v2.0.0/Manager/RefreshTokenManagerInterface.php#L15)