Skip to content
Branch: master
Find file History

README.md

Authorization code grant type example

This is a complete, working example that demonstrates an approach to implementing the OAuth 2.0 authorization code grant type with Apigee Edge as the authorization server.

If you are not familiar with OAuth 2.0 and terms like "grant type" and "authorization server", there are many resources available on the web. We recommend you start with the IETF specification. It includes a good, general introduction to the OAuth 2.0 framework and its use cases.

alt text

Prerequisites

To run this sample, you'll need:

tl;dr: Deploy

  1. Call Yeoman: yo oauth-auth-code-grant-sample

  2. Follow the prompts:

Sample Generator of OAuth Authorization Code Grant Type Proxies.
? Your user name:
? Password:
? Management API URL Endpoint: https://api.enterprise.apigee.com
? Organization Name:
? Environment Name:

Test the sample

  1. Open a browser and go to this URL:

    http://myorg-myenv.apigee.net/web

    For example:

    http://myorg-test.apigee.net/web

  2. Initiate the flow. Just click the "Login with Apigee Example Auth" button. This action sends a request to the authorization server (Apigee Edge), which redirects the browser to a login page.

  3. If you haven't registered, do so. Otherwise, log in.

    Note that there's a bug (#42) where certain passwords cause the registration to fail (throw a stacktrace error). For example, a password like 566559aa throws an error, while apigee123 does not. Until further notice, when trying out this sample, try using apigee123 as your password if see an error like this when you click the "Register" button.

  4. Give consent. The consent page gives you (the end user) a chance to limit the type of access the app will have to your resources. In this example, only one scope is offered, called "order". Click Allow to give the app access to your resources.

  5. Retrieve the access token. After you give consent, these things happen behind the scenes (refer to the flow diagram above for more a graphical view):

  • The login app communicates to the authorization server that the login was successful.
  • The authorization server generates an authorization code and returns it to the app.
  • The app puts the code into a request to the authorization server for an access token. The app also supplies the client ID and client secret keys.
  • The authorization server validates the auth code and other credentials, and if successful, returns an access token back to the client.
  • Now, with an access token, the client can request resources from the protected API.

Important! The app never saw the user's username and password entered in the login page.

If everything worked successfully, you'll see the access code and some extra information (the user's name) displayed in the user's browser.

What you need to know about this example

The authorization code grant type requires a step where the end user logs in to the resource server (where protected resources owned by the user are stored) and then gives explicit consent for the app to access those resources. The key to this flow is that the client app never gets to see the user's login credentials for the protected resources, as the authorization on the resource server is handled between the user, the resource server, and the OAuth authorization server.

Here's a flow diagram outlining the steps of this flow:

alt text

  1. User initiates the flow by clicking a button in a web page.
  2. The user's browser is redirected to a login page. This login page is not under the control of the client app. The client app does not participate in the login interaction, and the client app never sees the user's username or password.
  3. If login is successful, the user is directed to a consent page. The consent page allows the user to specify scopes (what the client app is authorized to do with on behalf of the user).
  4. After consent is given, the login app communicates with the authorization server. If redirect_URI matches the redirect_URI in Apigee Edge for that client_id, the authorization server generates an authorization code and sends it back to the client app (via a previously specified redirect URI).
  5. The client app now has an authorization code and uses it to ask the authorization server for an access token.
  6. Upon receiving an access token, the client app is able to access the protected APIs on the resource server by including the access token with each call.

What are the parts of this example?

This example has the following parts:

  • login-app -- A complete implementation that includes a login page and a consent page. Implements session management for extra security. Essentially, this is an API proxy deployed on Apigee Edge. Most of the implementation is in Node.js. For information on the session management feature, see login-app/README.
  • user-mgmt-v1 -- A key/value store implementation for storing the user's login information. Implemented as an API proxy and deployed on Apigee Edge. An interface to any user management system could be plugged in here, such as LDAP.
  • webserver-app -- A very simple web page implemented as an API proxy (runs on Apigee Edge to simplify this example). This is the client app -- the target of the redirect URL to which tokens and other information are sent from the authorization server. This client app never sees the user's login credentials for the resource server.
  • oauth2 -- An API proxy deployed on Apigee Edge that implements the OAuth 2.0 token endpoints. This is the Apigee Edge authorization server interface. Think of this as a service for requesting and managing OAuth tokens.

Note that all the parts of this example run on Apigee Edge. For the most part, this is just to simplify things. The login app, for example, could be designed to run on any platform, as long as it can communicate with Apigee Edge (the authorization server). Such details are obviously going to vary depending on the specific bundle.

Clean up

You can use the clean up scripts to remove the entities (developers, apps, products) that were installed with this sample.

  1. CD to provisioning

  2. Execute ./cleanup.sh <OrgName> <Environment> <Username> <Password> <MSURL>

    For example:

    ./cleanup.sh myorg prod test@example.com apigee123 https://api.enterprise.apigee.com

About login and consent session management

The login app includes session management to guarantee that only the logged-in user can access the consent page. Once a successful login has occurred, a user attribute is set in the server side session data. This attribute is checked when clients access the consent page. A valid logged-in session can only be used one time for consent to an authorization. The session is destroyed upon a successful consent in which an authorization code is generated for the client application. For more information, see ./login-app/README.

Further configuration

The following sections describe configuration steps that are separate from deployment. Depending on your setup, you may need to modify these configuration files.

Configure Loginapp

  1. Open login-app/apiproxy/resources/node/config/config.js
  2. Enter your environment information. The domain will typically be apigee.net. Some on-premise installations of Apigee Edge may use a different domain. For example:
          exports.envInfo = {
             org: 'Your org name on Edge',
             env: 'Your environment on Edge (test or prod)',
             domain: 'apigee.net'
          };
  1. Deploy the login-app bundle.

Provision the webserver-app

  1. CD to provisioning
  2. Open the file webserver-app.xml in an editor.
  3. Edit the <CallbackUrl> element as follows, substituting your Edge organization and environment names:
       <CallbackUrl>https://org-env.apigee.net/web/callback<CallbackUrl>

for example:

       <CallbackUrl>https://myorg-test.apigee.net/web/callback<CallbackUrl>

Important! Make a note of this exact callback URL. You will need to add it to another configuration file later.

  1. Execute: ./provision-webserver.sh username password orgName environment https://your-ms-url.com

The provisioning script creates the required entities on Apigee Edge and returns two keys: consumer key and consumer secret in your terminal window. You'll need these values when you configure the webserver app.

TIP: You can log in to the Apigee Edge UI and see that the developer, product, and app entities were created.

Configure the webserver-app bundle

  1. Open webserver-app/apiproxy/policies/SetConfigurationVariables.xml

  2. Enter your values for appKey, appSecret, environment, and organization, as shown below.

Important! You'll need to grab the Consumer ID and Consumer Secret that were returned when you provisioned the webserver-* entities in the previous step. Substitute those values in for the appKey and appSecret.

For example:

          <AssignMessage async="false" continueOnError="false" enabled="true" name="SetConfigurationVariables">
              <DisplayName>SetConfigurationVariables</DisplayName>
              <FaultRules/>
              <Properties/>
              <AssignVariable>
                  <Name>appKey</Name>
                  <Value>Substitute the Consumer key</Value>
              </AssignVariable>
              <AssignVariable>
                  <Name>appSecret</Name>
                  <Value>Substitute the Consumer secret</Value>
              </AssignVariable>
              <AssignVariable>
                  <Name>config.environment</Name>
                  <Value>Substitute your Edge environment (prod or test)</Value>
              </AssignVariable>
              <AssignVariable>
                  <Name>config.organization</Name>
                  <Value>Substitute your organization name on Edge</Value>
              </AssignVariable>
              <AssignVariable>
                  <Name>config.domain</Name>
                  <Value>apigee.net</Value>
              </AssignVariable>
              <AssignVariable>
                  <Name>config.protocol</Name>
                  <Value>https</Value>
              </AssignVariable>
              <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
          </AssignMessage>
  1. Save the file.
  2. Open webserver-app/apiproxy/policies/HTMLIndex.xml
  3. Edit the BASEURL, REDIRECT, and CLIENT_ID variables as follows:
  • BASEURL - The base URL for your environment -- use your organization and environment names on Edge. For example: https://myorg-prod.apigee.net

  • REDIRECT - This is the Redirect URI.

    Note that this URI must exactly match the CallbackUrl element that you added to the webserver-app.xml configuration previously. For example: https://myorg-test.apigee.net/web/callback

  • CLIENT_ID - The "Consumer Key" obtained from a developer app that is registered on Apigee Edge.

    Note that this key must match the one you configured previously in the webserver app.

  1. Save the file.
  2. Deploy webserver-app API proxy.

Ask the community

alt text


Copyright © 2015 Apigee Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.