Merge pull request #446 from juliangut/unify_examples

V5 - unify examples

examples/README.md

@@ -16,10 +16,10 @@ Send the following cURL request:
 curl -X "POST" "http://localhost:4444/client_credentials.php/access_token" \
 	-H "Content-Type: application/x-www-form-urlencoded" \
 	-H "Accept: 1.0" \
+	--data-urlencode "grant_type=client_credentials" \
 	--data-urlencode "client_id=myawesomeapp" \
-	--data-urlencode "scope=basic email" \
 	--data-urlencode "client_secret=abc123" \
-	--data-urlencode "grant_type=client_credentials"
+	--data-urlencode "scope=basic email"
 ```
 
 ## Testing the password grant example
@@ -30,12 +30,12 @@ Send the following cURL request:
 curl -X "POST" "http://localhost:4444/password.php/access_token" \
 	-H "Content-Type: application/x-www-form-urlencoded" \
 	-H "Accept: 1.0" \
+	--data-urlencode "grant_type=password" \
 	--data-urlencode "client_id=myawesomeapp" \
-	--data-urlencode "scope=basic email" \
+	--data-urlencode "client_secret=abc123" \
 	--data-urlencode "username=alex" \
 	--data-urlencode "password=whisky" \
-	--data-urlencode "client_secret=abc123" \
+	--data-urlencode "scope=basic email"
-	--data-urlencode "grant_type=password"
 ```
 
 ## Testing the refresh token grant example
@@ -51,4 +51,3 @@ curl -X "POST" "http://localhost:4444/refresh_token.php/access_token" \
 	--data-urlencode "client_secret=abc123" \
 	--data-urlencode "refresh_token={{REFRESH_TOKEN}}"
 ```
-

examples/public/auth_code.php

@@ -9,23 +9,25 @@ use OAuth2ServerExamples\Repositories\ClientRepository;
 use OAuth2ServerExamples\Repositories\RefreshTokenRepository;
 use OAuth2ServerExamples\Repositories\ScopeRepository;
 use OAuth2ServerExamples\Repositories\UserRepository;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
-use Slim\Http\Request;
+use Zend\Diactoros\Stream;
-use Slim\Http\Response;
 
 include __DIR__ . '/../vendor/autoload.php';
 
-// App
 $app = new App([
+    'settings'    => [
+        'displayErrorDetails' => true,
+    ],
     Server::class => function () {
-
         // Init our repositories
         $clientRepository = new ClientRepository();
         $scopeRepository = new ScopeRepository();
         $accessTokenRepository = new AccessTokenRepository();
-        $userRepository = new UserRepository();
-        $refreshTokenRepository = new RefreshTokenRepository();
         $authCodeRepository = new AuthCodeRepository();
+        $refreshTokenRepository = new RefreshTokenRepository();
+        $userRepository = new UserRepository();
 
         $privateKeyPath = 'file://' . __DIR__ . '/../private.key';
         $publicKeyPath = 'file://' . __DIR__ . '/../public.key';
@@ -39,7 +41,7 @@ $app = new App([
             $publicKeyPath
         );
 
-        // Enable the password grant on the server with a token TTL of 1 hour
+        // Enable the authentication code grant on the server with a token TTL of 1 hour
         $server->enableGrantType(
             new AuthCodeGrant(
                 $authCodeRepository,
@@ -54,27 +56,35 @@ $app = new App([
     },
 ]);
 
-$app->any('/authorize', function (Request $request, Response $response) {
+$app->any('/authorize', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
-    /** @var Server $server */
+    /* @var \League\OAuth2\Server\Server $server */
-    $server = $this->get(Server::class);
+    $server = $app->getContainer()->get(Server::class);
+
     try {
         return $server->respondToRequest($request, $response);
-    } catch (OAuthServerException $e) {
+    } catch (OAuthServerException $exception) {
-        return $e->generateHttpResponse($response);
+        return $exception->generateHttpResponse($response);
-    } catch (\Exception $e) {
+    } catch (\Exception $exception) {
-        return $response->withStatus(500)->write($e->getMessage());
+        $body = new Stream('php://temp', 'r+');
+        $body->write($exception->getMessage());
+
+        return $response->withStatus(500)->withBody($body);
     }
 });
 
-$app->post('/access_token', function (Request $request, Response $response) {
+$app->post('/access_token', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
-    /** @var Server $server */
+    /* @var \League\OAuth2\Server\Server $server */
-    $server = $this->get(Server::class);
+    $server = $app->getContainer()->get(Server::class);
+
     try {
         return $server->respondToRequest($request, $response);
-    } catch (OAuthServerException $e) {
+    } catch (OAuthServerException $exception) {
-        return $e->generateHttpResponse($response);
+        return $exception->generateHttpResponse($response);
-    } catch (\Exception $e) {
+    } catch (\Exception $exception) {
-        return $response->withStatus(500)->write($e->getMessage());
+        $body = new Stream('php://temp', 'r+');
+        $body->write($exception->getMessage());
+
+        return $response->withStatus(500)->withBody($body);
     }
 });
 

examples/public/client_credentials.php

@@ -6,20 +6,22 @@ use League\OAuth2\Server\Server;
 use OAuth2ServerExamples\Repositories\AccessTokenRepository;
 use OAuth2ServerExamples\Repositories\ClientRepository;
 use OAuth2ServerExamples\Repositories\ScopeRepository;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
-use Slim\Http\Request;
+use Zend\Diactoros\Stream;
-use Slim\Http\Response;
 
 include __DIR__ . '/../vendor/autoload.php';
 
-// App
 $app = new App([
+    'settings'    => [
+        'displayErrorDetails' => true,
+    ],
     Server::class => function () {
-
         // Init our repositories
         $clientRepository = new ClientRepository();
-        $scopeRepository = new ScopeRepository();
         $accessTokenRepository = new AccessTokenRepository();
+        $scopeRepository = new ScopeRepository();
 
         $privateKeyPath = 'file://' . __DIR__ . '/../private.key';
         $publicKeyPath = 'file://' . __DIR__ . '/../public.key';
@@ -34,21 +36,28 @@ $app = new App([
         );
 
         // Enable the client credentials grant on the server with a token TTL of 1 hour
-        $server->enableGrantType(new ClientCredentialsGrant(), new \DateInterval('PT1H'));
+        $server->enableGrantType(
+            new ClientCredentialsGrant(),
+            new \DateInterval('PT1H')
+        );
 
         return $server;
     },
 ]);
 
-$app->post('/access_token', function (Request $request, Response $response) {
+$app->post('/access_token', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
-    /** @var Server $server */
+    /* @var \League\OAuth2\Server\Server $server */
-    $server = $this->get(Server::class);
+    $server = $app->getContainer()->get(Server::class);
+
     try {
         return $server->respondToRequest($request, $response);
-    } catch (OAuthServerException $e) {
+    } catch (OAuthServerException $exception) {
-        return $e->generateHttpResponse($response);
+        return $exception->generateHttpResponse($response);
-    } catch (\Exception $e) {
+    } catch (\Exception $exception) {
-        return $response->withStatus(500)->write($e->getMessage());
+        $body = new Stream('php://temp', 'r+');
+        $body->write($exception->getMessage());
+
+        return $response->withStatus(500)->withBody($body);
     }
 });
 

examples/public/implicit.php

@@ -1,31 +1,29 @@
 <?php
 
-use League\OAuth2\Server\Grant\PasswordGrant;
+use League\OAuth2\Server\Exception\OAuthServerException;
-use League\OAuth2\Server\Grant\RefreshTokenGrant;
+use League\OAuth2\Server\Grant\ImplicitGrant;
-use League\OAuth2\Server\Middleware\AuthenticationServerMiddleware;
 use League\OAuth2\Server\Server;
 use OAuth2ServerExamples\Repositories\AccessTokenRepository;
 use OAuth2ServerExamples\Repositories\ClientRepository;
-use OAuth2ServerExamples\Repositories\RefreshTokenRepository;
 use OAuth2ServerExamples\Repositories\ScopeRepository;
 use OAuth2ServerExamples\Repositories\UserRepository;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
+use Zend\Diactoros\Stream;
 
 include __DIR__ . '/../vendor/autoload.php';
 
-// App
 $app = new App([
     'settings'    => [
         'displayErrorDetails' => true,
     ],
     Server::class => function () {
-
         // Init our repositories
         $clientRepository = new ClientRepository();
-        $accessTokenRepository = new AccessTokenRepository();
         $scopeRepository = new ScopeRepository();
+        $accessTokenRepository = new AccessTokenRepository();
         $userRepository = new UserRepository();
-        $refreshTokenRepository = new RefreshTokenRepository();
 
         $privateKeyPath = 'file://' . __DIR__ . '/../private.key';
         $publicKeyPath = 'file://' . __DIR__ . '/../public.key';
@@ -39,13 +37,9 @@ $app = new App([
             $publicKeyPath
         );
 
-        // Enable the grants
+        // Enable the implicit grant on the server with a token TTL of 1 hour
         $server->enableGrantType(
-            new PasswordGrant($userRepository, $refreshTokenRepository),
+            new ImplicitGrant($userRepository),
-            new \DateInterval('PT1H')
-        );
-        $server->enableGrantType(
-            new RefreshTokenGrant($refreshTokenRepository),
             new \DateInterval('PT1H')
         );
 
@@ -53,7 +47,20 @@ $app = new App([
     },
 ]);
 
-$app->post('/access_token', function () {
+$app->any('/authorize', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
-})->add(new AuthenticationServerMiddleware($app->getContainer()->get(Server::class)));
+    /* @var \League\OAuth2\Server\Server $server */
+    $server = $app->getContainer()->get(Server::class);
+
+    try {
+        return $server->respondToRequest($request, $response);
+    } catch (OAuthServerException $exception) {
+        return $exception->generateHttpResponse($response);
+    } catch (\Exception $exception) {
+        $body = new Stream('php://temp', 'r+');
+        $body->write($exception->getMessage());
+
+        return $response->withStatus(500)->withBody($body);
+    }
+});
 
 $app->run();

examples/public/middleware_use.php

@@ -0,0 +1,95 @@
+<?php
+
+use League\OAuth2\Server\Grant\AuthCodeGrant;
+use League\OAuth2\Server\Grant\RefreshTokenGrant;
+use League\OAuth2\Server\Middleware\AuthenticationServerMiddleware;
+use League\OAuth2\Server\Middleware\ResourceServerMiddleware;
+use League\OAuth2\Server\Server;
+use OAuth2ServerExamples\Repositories\AccessTokenRepository;
+use OAuth2ServerExamples\Repositories\AuthCodeRepository;
+use OAuth2ServerExamples\Repositories\ClientRepository;
+use OAuth2ServerExamples\Repositories\RefreshTokenRepository;
+use OAuth2ServerExamples\Repositories\ScopeRepository;
+use OAuth2ServerExamples\Repositories\UserRepository;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Slim\App;
+use Zend\Diactoros\Stream;
+
+include __DIR__ . '/../vendor/autoload.php';
+
+$app = new App([
+    'settings'    => [
+        'displayErrorDetails' => true,
+    ],
+    Server::class => function () {
+        // Init our repositories
+        $clientRepository = new ClientRepository();
+        $accessTokenRepository = new AccessTokenRepository();
+        $scopeRepository = new ScopeRepository();
+        $authCodeRepository = new AuthCodeRepository();
+        $refreshTokenRepository = new RefreshTokenRepository();
+        $userRepository = new UserRepository();
+
+        $privateKeyPath = 'file://' . __DIR__ . '/../private.key';
+        $publicKeyPath = 'file://' . __DIR__ . '/../public.key';
+
+        // Setup the authorization server
+        $server = new Server(
+            $clientRepository,
+            $accessTokenRepository,
+            $scopeRepository,
+            $privateKeyPath,
+            $publicKeyPath
+        );
+
+        // Enable the authentication code grant on the server with a token TTL of 1 hour
+        $server->enableGrantType(
+            new AuthCodeGrant(
+                $authCodeRepository,
+                $refreshTokenRepository,
+                $userRepository,
+                new \DateInterval('PT10M')
+            ),
+            new \DateInterval('PT1H')
+        );
+
+        // Enable the refresh token grant on the server with a token TTL of 1 month
+        $server->enableGrantType(
+            new RefreshTokenGrant($refreshTokenRepository),
+            new \DateInterval('PT1M')
+        );
+
+        return $server;
+    },
+]);
+
+// Access token issuer
+$app->post('/access_token', function () {
+})->add(new AuthenticationServerMiddleware($app->getContainer()->get(Server::class)));
+
+// Secured API
+$app->group('/api', function () {
+    $this->get('/user', function (ServerRequestInterface $request, ResponseInterface $response) {
+        $params = [];
+
+        if (in_array('basic', $request->getAttribute('oauth_scopes', []))) {
+            $params = [
+                'id'   => 1,
+                'name' => 'Alex',
+                'city' => 'London',
+            ];
+        }
+
+        if (in_array('email', $request->getAttribute('oauth_scopes', []))) {
+            $params['email'] = 'alex@example.com';
+        }
+
+        $body = new Stream('php://temp', 'r+');
+        $body->write(json_encode($params));
+
+        return $response->withBody($body);
+    });
+})->add(new ResourceServerMiddleware($app->getContainer()->get(Server::class)));
+
+$app->run();

examples/public/password.php

@@ -8,20 +8,22 @@ use OAuth2ServerExamples\Repositories\ClientRepository;
 use OAuth2ServerExamples\Repositories\RefreshTokenRepository;
 use OAuth2ServerExamples\Repositories\ScopeRepository;
 use OAuth2ServerExamples\Repositories\UserRepository;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
-use Slim\Http\Request;
+use Zend\Diactoros\Stream;
-use Slim\Http\Response;
 
 include __DIR__ . '/../vendor/autoload.php';
 
-// App
 $app = new App([
+    'settings'    => [
+        'displayErrorDetails' => true,
+    ],
     Server::class => function () {
-
         // Init our repositories
         $clientRepository = new ClientRepository();
-        $scopeRepository = new ScopeRepository();
         $accessTokenRepository = new AccessTokenRepository();
+        $scopeRepository = new ScopeRepository();
         $userRepository = new UserRepository();
         $refreshTokenRepository = new RefreshTokenRepository();
 
@@ -47,15 +49,19 @@ $app = new App([
     },
 ]);
 
-$app->post('/access_token', function (Request $request, Response $response) {
+$app->post('/access_token', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
-    /** @var Server $server */
+    /* @var \League\OAuth2\Server\Server $server */
-    $server = $this->get(Server::class);
+    $server = $app->getContainer()->get(Server::class);
+
     try {
         return $server->respondToRequest($request, $response);
-    } catch (OAuthServerException $e) {
+    } catch (OAuthServerException $exception) {
-        return $e->generateHttpResponse($response);
+        return $exception->generateHttpResponse($response);
-    } catch (\Exception $e) {
+    } catch (\Exception $exception) {
-        return $response->withStatus(500)->write($e->getMessage());
+        $body = new Stream('php://temp', 'r+');
+        $body->write($exception->getMessage());
+
+        return $response->withStatus(500)->withBody($body);
     }
 });
 

examples/public/protected_api.php

@@ -1,64 +0,0 @@
-<?php
-
-use League\OAuth2\Server\Middleware\ResourceServerMiddleware;
-use League\OAuth2\Server\Server;
-use OAuth2ServerExamples\Repositories\AccessTokenRepository;
-use OAuth2ServerExamples\Repositories\ClientRepository;
-use OAuth2ServerExamples\Repositories\ScopeRepository;
-use Slim\App;
-use Slim\Http\Request;
-use Slim\Http\Response;
-
-include __DIR__ . '/../vendor/autoload.php';
-
-// App
-$app = new App([
-    'settings'    => [
-        'displayErrorDetails' => true,
-    ],
-    Server::class => function () {
-
-        // Init our repositories
-        $clientRepository = new ClientRepository();
-        $scopeRepository = new ScopeRepository();
-        $accessTokenRepository = new AccessTokenRepository();
-
-        $privateKeyPath = 'file://' . __DIR__ . '/../private.key';
-        $publicKeyPath = 'file://' . __DIR__ . '/../public.key';
-
-        // Setup the authorization server
-        $server = new Server(
-            $clientRepository,
-            $accessTokenRepository,
-            $scopeRepository,
-            $privateKeyPath,
-            $publicKeyPath
-        );
-
-        return $server;
-    },
-]);
-
-$app->add(new ResourceServerMiddleware($app->getContainer()->get(Server::class)));
-$app->post('/api/example', function (Request $request, Response $response) {
-
-    $params = [];
-
-    if (in_array('basic', $request->getAttribute('oauth_scopes', []))) {
-        $params = [
-            'id'   => 1,
-            'name' => 'Alex',
-            'city' => 'London',
-        ];
-    }
-
-    if (in_array('email', $request->getAttribute('oauth_scopes', []))) {
-        $params['email'] = 'alex@example.com';
-    }
-
-    $response->getBody()->write(json_encode($params));
-
-    return $response;
-});
-
-$app->run();

examples/public/refresh_token.php

@@ -7,18 +7,22 @@ use OAuth2ServerExamples\Repositories\AccessTokenRepository;
 use OAuth2ServerExamples\Repositories\ClientRepository;
 use OAuth2ServerExamples\Repositories\RefreshTokenRepository;
 use OAuth2ServerExamples\Repositories\ScopeRepository;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
-use Slim\Http\Request;
+use Zend\Diactoros\Stream;
-use Slim\Http\Response;
 
 include __DIR__ . '/../vendor/autoload.php';
 
-// App
+$app = new App([
-$app = new App([Server::class => function () {
+    'settings'    => [
+        'displayErrorDetails' => true,
+    ],
+    Server::class => function () {
         // Init our repositories
         $clientRepository = new ClientRepository();
-    $scopeRepository = new ScopeRepository();
         $accessTokenRepository = new AccessTokenRepository();
+        $scopeRepository = new ScopeRepository();
         $refreshTokenRepository = new RefreshTokenRepository();
 
         $privateKeyPath = 'file://' . __DIR__ . '/../private.key';
@@ -33,23 +37,29 @@ $app = new App([Server::class => function () {
             $publicKeyPath
         );
 
-    // Enable the refresh token grant on the server
+        // Enable the refresh token grant on the server with a token TTL of 1 hour
-    $server->enableGrantType(new RefreshTokenGrant($refreshTokenRepository), new \DateInterval('PT1H'));
+        $server->enableGrantType(
+            new RefreshTokenGrant($refreshTokenRepository),
+            new \DateInterval('PT1H')
+        );
 
         return $server;
-}]);
+    },
+]);
+
+$app->post('/access_token', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
+    /* @var \League\OAuth2\Server\Server $server */
+    $server = $app->getContainer()->get(Server::class);
 
-$app->post('/access_token', function (Request $request, Response $response) {
-    /** @var Server $server */
-    $server = $this->get(Server::class);
     try {
         return $server->respondToRequest($request, $response);
-    } catch (OAuthServerException $e) {
+    } catch (OAuthServerException $exception) {
-        return $e->generateHttpResponse($response);
+        return $exception->generateHttpResponse($response);
-    } catch (\Exception $e) {
+    } catch (\Exception $exception) {
-        return $response->withStatus(500)->write(
+        $body = new Stream('php://temp', 'r+');
-            sprintf('<h1>%s</h1><p>%s</p>', get_class($e), $e->getMessage())
+        $body->write($exception->getMessage());
-        );
+
+        return $response->withStatus(500)->withBody($body);
     }
 });